feat(aws-cloudwatch): query results widget #7114

OliverGavin · 2020-04-01T10:40:17Z

Commit Message

feat(cloudwatch): LogGroup Query Widget

Add a LogQueryWidget to generate a dashboard widget
showing the results of a query from Logs Insights.
This was a missing feature which is available in
the console.

closes #3681

End Commit Message

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

aws-cdk-automation · 2020-04-01T11:25:10Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 3a819db
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

rix0rrr · 2020-04-06T12:13:34Z

packages/@aws-cdk/aws-cloudwatch/lib/query.ts

+  /**
+   * Log group to query
+   */
+  readonly logGroup: string;


Feels like this should accept an ILogGroup.

Ok I'll check that out, I'm pretty new with CDK

This would add a cyclic dependency:

lerna ERR! ECYCLE @aws-cdk/aws-cloudwatch -> @aws-cdk/aws-logs -> @aws-cdk/aws-cloudwatch

So I'm think that renaming it to logGroupName and keeping it a string would be the best course of action

I'd really really like users to be able to pass the object though. We will have to follow the existing dependency arrows while coming up with our solution. I'm thinking something like this:

// cloudwatch interface IQueryLogGroup { public readonly logGroupName: string; } // logs interface ILogGroup extends cloudwatch.IQueryLogGroup { // ... }

Ok so I rebased and added an IQueryLogGroup.

Is the ILogGroup extends cloudwatch.IQueryLogGroup required? For TypeScript an ILogGroup can be supplied where an IQueryLogGroup is required without this inheritance (it is sort of an ugly dependency - I don't know if such a thing already exists in CDK).

Perhaps it is required for other languages using JSII etc? It might be a fair trade off to not add this inheritance (until the full solution is decided). I'm thinking that would only impact users who are using more type strict languages like Java but even so an anonymous class could still work.

The other option is to make QueryWidgetProps#logGroup take an IQueryLogGroup or a string and at least then with TypeScript you can pass the ILogGroup and in other languages you still have the option to pass the name directly as a string?

Let me know which you prefer and I will make the change.

Perhaps it is required for other languages using JSII etc?

Exactly. This class could not be used in typed languages that use nominal subtyping (Java, C#), which would be a shame. Treating them as second class citizens (by forcing them to custom-implement an anonymous subclass) is not really acceptable in my opinion. It's not very discoverable either, and would present a big hurdle to adoption.

I agree with you that this solution is not fantastic, but it's at least pragmatic and works well enough until we have better alternatives.

The other option is to make QueryWidgetProps#logGroup take an IQueryLogGroup or a string

You are thinking a union type here, which we as a rule don't use in L2 constructs because they won't translate well to Go.

I can understand you feeling dissatisfied with the available options. If it helps, I will take all of the design blame :).

I mean I don't personally mind; you have the bigger picture here. So will I go with what you originally proposed?

Done and rebased

(sorry about the noise below; I'm having issues building the latest version for some reason)

packages/@aws-cdk/aws-cloudwatch/lib/query.ts

Pull request has been modified.

aws-cdk-automation · 2020-04-18T14:29:38Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: f7c21e3
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-04-18T23:06:23Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: c862e3c
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-04-19T00:04:45Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: d33df6b
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

rix0rrr · 2020-04-21T08:25:21Z

packages/@aws-cdk/aws-cloudwatch/README.md

+```ts
+dashboard.addWidgets(new QueryWidget({
+  logGroup: LogGroup.fromLogGroupName(stack, 'MyLogGroup', 'my-log-group'),
+  query: `fields @message


One more thing, can you rename query to queryString ? I feel it will help us in the future if we ever want to provide query builder objects, which can then be used as query: Query.fromFields(...) or whatever.

aws-cdk-automation · 2020-04-25T15:47:03Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 9507731
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-04-25T16:21:52Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 23e93ca
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-04-25T16:41:58Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 300a79f
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Add a `QueryWidget` to generate a dashboard widget showing the results of a query from Logs Insights. This was a missing feature which is available in the console. Also make `ILogGroup` extend `cloudwatch.IQueryLogGroup` so it can be passed as a property for a `QueryWidget`. closes aws#3681

aws-cdk-automation · 2020-04-25T17:30:13Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 867de12
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

…fier

Pull request has been modified.

rix0rrr · 2020-05-04T13:55:50Z

You know what? You were right the first time. Just specifying the log group names makes way more sense. My apologies for making you change this.

I added in a convenience property for specifying the query string as well, because that whitespace sensitivity is something we can make a lot easier :).

Pull request has been modified.

aws-cdk-automation · 2020-05-04T14:02:03Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 2826c8c
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-05-04T14:05:47Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 17bfbe2
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-05-04T14:29:43Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 94635cf
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-05-04T18:30:23Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: afc36c3
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

OliverGavin · 2020-05-04T22:49:33Z

You know what? You were right the first time. Just specifying the log group names makes way more sense. My apologies for making you change this.

I added in a convenience property for specifying the query string as well, because that whitespace sensitivity is something we can make a lot easier :).

Awesome, no worries. I'm using dedent for the whitespacing in my own project but I didn't want to add the dependency here of course. But the query lines idea is a nice trade off to have too.

OliverGavin · 2020-05-04T22:54:18Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu

Commit ID: afc36c3

Result: FAILED

Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

You might want to add the logGroupName I moved out of ILogGroup back in ;) (I moved it to the IQueryLogGroup)

aws-cdk-automation · 2020-05-05T08:37:16Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 7835c7d
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Pull request has been modified.

aws-cdk-automation · 2020-05-05T09:42:56Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 84ef063
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2020-05-05T11:07:45Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2020-05-05T11:54:03Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: d71d82e
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2020-05-05T11:54:25Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

SomayaB assigned rix0rrr Apr 3, 2020

rix0rrr previously requested changes Apr 6, 2020

View reviewed changes

OliverGavin force-pushed the OliverGavin/query-results-widget branch from 3a819db to f7c21e3 Compare April 18, 2020 14:24

OliverGavin force-pushed the OliverGavin/query-results-widget branch from f7c21e3 to c862e3c Compare April 18, 2020 23:01

OliverGavin force-pushed the OliverGavin/query-results-widget branch from c862e3c to d33df6b Compare April 18, 2020 23:32

rix0rrr reviewed Apr 21, 2020

View reviewed changes

OliverGavin force-pushed the OliverGavin/query-results-widget branch from d33df6b to 9507731 Compare April 25, 2020 15:39

OliverGavin force-pushed the OliverGavin/query-results-widget branch from 9507731 to 23e93ca Compare April 25, 2020 16:13

OliverGavin force-pushed the OliverGavin/query-results-widget branch from 23e93ca to 300a79f Compare April 25, 2020 16:33

OliverGavin force-pushed the OliverGavin/query-results-widget branch from 300a79f to 867de12 Compare April 25, 2020 16:46

Reverse log group parameter decision, add more convenient query speci…

2826c8c

…fier

rix0rrr previously approved these changes May 4, 2020

View reviewed changes

Add renamed file

17bfbe2

eslint

94635cf

Whoopsie

afc36c3

Re-add missing logGroupName

7835c7d

rix0rrr previously approved these changes May 5, 2020

View reviewed changes

Merge branch 'master' into OliverGavin/query-results-widget

84ef063

rix0rrr approved these changes May 5, 2020

View reviewed changes

Merge branch 'master' into OliverGavin/query-results-widget

d71d82e

mergify bot merged commit 1275952 into aws:master May 5, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(aws-cloudwatch): query results widget #7114

feat(aws-cloudwatch): query results widget #7114

OliverGavin commented Apr 1, 2020 •

edited by rix0rrr

Loading

aws-cdk-automation commented Apr 1, 2020

rix0rrr Apr 6, 2020

OliverGavin Apr 7, 2020

OliverGavin Apr 15, 2020

rix0rrr Apr 17, 2020

OliverGavin Apr 19, 2020

rix0rrr Apr 20, 2020

OliverGavin Apr 20, 2020

rix0rrr Apr 21, 2020

OliverGavin Apr 25, 2020

aws-cdk-automation commented Apr 18, 2020

aws-cdk-automation commented Apr 18, 2020

aws-cdk-automation commented Apr 19, 2020

rix0rrr Apr 21, 2020

OliverGavin Apr 25, 2020

aws-cdk-automation commented Apr 25, 2020

aws-cdk-automation commented Apr 25, 2020

aws-cdk-automation commented Apr 25, 2020

aws-cdk-automation commented Apr 25, 2020

rix0rrr commented May 4, 2020 •

edited

Loading

aws-cdk-automation commented May 4, 2020

aws-cdk-automation commented May 4, 2020

aws-cdk-automation commented May 4, 2020

aws-cdk-automation commented May 4, 2020

OliverGavin commented May 4, 2020

OliverGavin commented May 4, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented May 5, 2020

aws-cdk-automation commented May 5, 2020

mergify bot commented May 5, 2020

aws-cdk-automation commented May 5, 2020

mergify bot commented May 5, 2020

feat(aws-cloudwatch): query results widget #7114

feat(aws-cloudwatch): query results widget #7114

Conversation

OliverGavin commented Apr 1, 2020 • edited by rix0rrr Loading

Commit Message

End Commit Message

aws-cdk-automation commented Apr 1, 2020

AWS CodeBuild CI Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aws-cdk-automation commented Apr 18, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Apr 18, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Apr 19, 2020

AWS CodeBuild CI Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aws-cdk-automation commented Apr 25, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Apr 25, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Apr 25, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Apr 25, 2020

AWS CodeBuild CI Report

rix0rrr commented May 4, 2020 • edited Loading

aws-cdk-automation commented May 4, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented May 4, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented May 4, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented May 4, 2020

AWS CodeBuild CI Report

OliverGavin commented May 4, 2020

OliverGavin commented May 4, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented May 5, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented May 5, 2020

AWS CodeBuild CI Report

mergify bot commented May 5, 2020

aws-cdk-automation commented May 5, 2020

AWS CodeBuild CI Report

mergify bot commented May 5, 2020

OliverGavin commented Apr 1, 2020 •

edited by rix0rrr

Loading

rix0rrr commented May 4, 2020 •

edited

Loading