(cloudwatch-dashboards): Add support for queryLanguage property

[Xarno]

Describe the feature

The current LogQueryWidget construct does not support the queryLanguage property, so i can not generate a widget with an SQL query for example.

Please add a that property for all supported query languages.

Use Case

        const clientWidget = new cloudWatch.LogQueryWidget({
           height: 6,
            width: 8, 
            logGroupNames: ['/aws/appsync/apis/72nizn776jgsxppswuklp5d4oe'],
            queryString: "SELECT window.start, count(`statusCode`) as graph_QL_Requests, \n    count(if(`statusCode` = 200, true, null)) as OK_200,\n    count(if(`statusCode` = 401, true, null)) as Fail_401, \n    count(if(`logType` not like \"%Summary%\", true, null)) as errors\nFROM `/aws/appsync/apis/72nizn776jgsxppswuklp5d4oe`\nWHERE `@message` like \"%logType%\"\nGROUP BY window(`@timestamp`, '5 minute')",
            queryLanguage: "SQL",
            region: "eu-central-1",
            title: "Graph QL Requests. One request can produce multiple errors.",
            view: cloudWatch.LogQueryVisualizationType.LINE
        })

Proposed Solution

No response

Other Information

Creating the widget from the aws web console generates the needed queryLanguage property.

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

AWS CDK Library version (aws-cdk-lib)

2.196.0

AWS CDK CLI version

2.1014.0

Environment details (OS name and version, etc.)

mac os

[ykethan]

Hey @Xarno, thank you for reaching and reporting this. On diving into this, in the current CDK implementation (packages/aws-cdk-lib/aws-cloudwatch/lib/log-query.ts), the LogQueryWidgetProps interface does not provide a queryLanguage property:

export interface LogQueryWidgetProps {
  readonly title?: string;
  readonly logGroupNames: string[];
  readonly queryString?: string;
  readonly queryLines?: string[];
  readonly region?: string;
  readonly view?: LogQueryVisualizationType;
  readonly width?: number;
  readonly height?: number;
}

Workaround

As a workaround i was able to access the queryLanguage property. This approach modifies the widget's JSON representation directly:

// Create a log query widget with SQL query
const logQueryWidget = new cloudwatch.LogQueryWidget({
  title: 'SQL Query Test',
  logGroupNames: ['/aws/lambda/your-lambda-function'], // Use your actual log group
  queryString: 'SELECT count(*) as count FROM `/aws/lambda/your-lambda-function`',
  view: cloudWatch.LogQueryVisualizationType.LINE,
  width: 24,
  height: 6,
});

// Get the JSON representation of the widget
const widgetJson = logQueryWidget.toJson()[0];

// Add queryLanguage property to the widget JSON
widgetJson.properties.queryLanguage = 'SQL';

// Create dashboard with modified widget directly in the dashboard body
const dashboardBody = {
  widgets: [widgetJson],
};

// Create the dashboard with our custom body
const dashboard = new cloudwatch.CfnDashboard(this, 'TestDashboard', {
  dashboardName: 'MyDashboard',
  dashboardBody: JSON.stringify(dashboardBody),
});

I've tested this workaround by deploying a stack that successfully added the queryLanguage property to a CloudWatch Dashboard. The generated dashboard JSON confirms the property was included correctly:

{
    "widgets": [
        {
            "height": 6,
            "width": 24,
            "type": "log",
            "x": 0,
            "y": 0,
            "properties": {
                "view": "timeSeries",
                "title": "SQL Query Test",
                "region": "us-east-1",
                "query": "SOURCE '/aws/lambda/testgroup' | SELECT count(*) as count FROM `/aws/lambda/testgroup`",
                "stacked": false,
                "queryLanguage": "SQL"
            }
        }
    ]
}

Suggested implementation

Off the top we may need to update the LogQueryWidgetProps interface to include the queryLanguage property and modify the LogQueryWidget.toJson() method to include this property in the generated JSON:

1. Update LogQueryWidgetProps in packages/aws-cdk-lib/aws-cloudwatch/lib/log-query.ts:

export interface LogQueryWidgetProps {
  // Existing properties...
  
  /**
   * The query language to use for the query.
   * Supported values include: 'Logs', 'SQL', 'PPL'
   * @default - Logs Insights Query Language (default CloudWatch Logs query language)
   */
  readonly queryLanguage?: string;
}

2. Update LogQueryWidget.toJson() method:

public toJson(): any[] {
  const sources = this.props.logGroupNames.map(l => `SOURCE '${l}'`).join(' | ');
  const query = this.props.queryLines
    ? this.props.queryLines.join('\n| ')
    : this.props.queryString;

  const properties: any = {
    view: this.props.view ? this.props.view : LogQueryVisualizationType.TABLE,
    title: this.props.title,
    region: this.props.region || cdk.Aws.REGION,
    query: `${sources} | ${query}`,
  };

  // Add queryLanguage property if specified
  if (this.props.queryLanguage) {
    properties.queryLanguage = this.props.queryLanguage;
  }

  // Adding stacked property in case of LINE or STACKEDAREA
  if (this.props.view === LogQueryVisualizationType.LINE || this.props.view === LogQueryVisualizationType.STACKEDAREA) {
    // assign the right native view value. both types share the same value
    properties.view = 'timeSeries',
    properties.stacked = this.props.view === LogQueryVisualizationType.STACKEDAREA ? true : false;
  }

  return [{
    type: 'log',
    width: this.width,
    height: this.height,
    x: this.x,
    y: this.y,
    properties: properties,
  }];
}

Marking this as P2 feature request.
We greatly appreciate community contributions! If you or someone else is interested in implementing this, we'd be happy to review a Pull Request. Please check our contribution guidelines. Meanwhile, welcome to add 👍 to help us prioritize.