GitHub pipeline observability #22
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Johannes Bräuer <[email protected]>
Signed-off-by: Johannes Bräuer <[email protected]>
Signed-off-by: Johannes Bräuer <[email protected]>
Signed-off-by: Johannes Bräuer <[email protected]>
Signed-off-by: Johannes Bräuer <[email protected]>
Signed-off-by: Johannes Bräuer <[email protected]>
wlfghdr
reviewed
Jan 23, 2025
...vability/pipeline_observability/document-dashboard/0a635714-5545-4413-95e1-023333e8edac.json
Outdated
Show resolved
Hide resolved
Signed-off-by: Johannes Bräuer <[email protected]>
Signed-off-by: Johannes Bräuer <[email protected]>
Signed-off-by: Johannes Bräuer <[email protected]>
Signed-off-by: Johannes Bräuer <[email protected]>
Signed-off-by: Johannes Bräuer <[email protected]>
Signed-off-by: Johannes Bräuer <[email protected]>
Signed-off-by: Johannes Bräuer <[email protected]>
Signed-off-by: Johannes Bräuer <[email protected]>
Signed-off-by: Johannes Bräuer <[email protected]>
Signed-off-by: Johannes Bräuer <[email protected]>
Signed-off-by: Johannes Bräuer <[email protected]>
Signed-off-by: Johannes Bräuer <[email protected]>
Signed-off-by: Johannes Bräuer <[email protected]>
Signed-off-by: Johannes Bräuer <[email protected]>
stefaneberl
requested changes
Feb 5, 2025
There was a problem hiding this comment.
Please double check the usage of join and joinNested.
Example 5 of https://docs.dynatrace.com/docs/discover-dynatrace/references/dynatrace-query-language/commands/aggregation-commands#summarize describes a way to use summarize instead of join, which reduces the amount of data read by half.
github_pipeline_observability/pipeline_observability/document-dashboard/github.workflow.json
Outdated
Show resolved
Hide resolved
github_pipeline_observability/pipeline_observability/document-dashboard/github.workflow.json
Outdated
Show resolved
Hide resolved
github_pipeline_observability/pipeline_observability/document-dashboard/github.workflow.json
Outdated
Show resolved
Hide resolved
github_pipeline_observability/pipeline_observability/document-dashboard/github.workflow.json
Outdated
Show resolved
Hide resolved
github_pipeline_observability/pipeline_observability/document-dashboard/github.workflow.json
Outdated
Show resolved
Hide resolved
github_pipeline_observability/pipeline_observability/document-dashboard/github.workflow.json
Outdated
Show resolved
Hide resolved
Signed-off-by: Johannes Bräuer <[email protected]>
Signed-off-by: Johannes Bräuer <[email protected]>
johannes-b
commented
Feb 6, 2025
Signed-off-by: Johannes Bräuer <[email protected]>
Co-authored-by: Christian Kreuzberger <[email protected]>
stefaneberl
reviewed
Feb 10, 2025
| }, | ||
| "enabled": false | ||
| }, | ||
| "query": "fetch events \n| filter event.kind == \"SDLC_EVENT\" \n| filter event.category == \"task\" \n| filter event.type == \"change\" \n| filter event.provider == \"github.com\"\n| sort timestamp desc\n| summarize { statuses = collectArray(event.status) }, by: { task.id, task.name, start_time, number, vcs.repository.name, vcs.ref.base.name, vcs.ref.base.revision, vcs.ref.head.name, vcs.ref.head.revision, ext.vcs.change.pull_request.url } \n| filter not in(statuses[0],array(\"merged\",\"closed\")) \n| filter in(vcs.repository.name, $Repository) \n| filter in(vcs.ref.base.name, $Branch)\n| summarize count()", |
There was a problem hiding this comment.
Shouldn't the PR ID & full repo URL be sufficient for aggregation?
I'm a bit hesitant to have vcs.ref.base.revision in, especially since a user can rebase their PR & force push. I'm not sure if this will stay stable here.
In addition, certain filters, e.g. vcs.repository.name and the like should be applied before aggregating, limiting the number of records to aggregate.
| }, | ||
| "enabled": false | ||
| }, | ||
| "query": "fetch events \n| filter event.kind == \"SDLC_EVENT\" \n| filter event.category == \"task\" \n| filter event.type == \"change\" \n| filter event.provider == \"github.com\"\n| filter in(vcs.repository.name, $Repository) \n| filter in(vcs.ref.base.name, $Branch)\n| sort timestamp desc\n| summarize { statuses = collectArray(event.status) }, by: { task.id, task.name, start_time,number, vcs.ref.base.name, vcs.ref.base.revision, vcs.ref.head.name, vcs.ref.head.revision, ext.vcs.change.pull_request.url } \n| filter not in(statuses[0],array(\"merged\",\"closed\")) \n| fieldsAdd OpenedPrDuration = toTimestamp(now()) - toTimestamp(start_time) \n| summarize max(OpenedPrDuration)", |
There was a problem hiding this comment.
Similar to above. I think certain summarize by attributes may change over the lifetime of a PR. I would consider the PR ID & the full URL to the repo as unique
| }, | ||
| "enabled": false | ||
| }, | ||
| "query": "fetch events \n| filter event.kind == \"SDLC_EVENT\" \n| filter event.category == \"task\" \n| filter event.type == \"change\" \n| filter event.provider == \"github.com\"\n| sort timestamp desc\n| summarize { statuses = collectArray(event.status), actions = collectArray(vcs.change.state) }, by: { task.id, task.name, start_time,number, vcs.repository.name, vcs.ref.base.name, vcs.ref.base.revision, vcs.ref.head.name, vcs.ref.head.revision, ext.vcs.change.pull_request.url } \n| filter not in(statuses[0],array(\"merged\", \"closed\")) \n| filter contains(toString(actions),\"reopened\")\n| filter in(vcs.repository.name, $Repository) \n| filter in(vcs.ref.base.name, $Branch)\n| summarize count()", |
There was a problem hiding this comment.
The filter applied after the summariz should be reconsidered. It would make sense to apply it before the aggregation.
Furthermore, there is a sort timestamp desc, which is IMHO not necessary, or at least I don't see it.
| }, | ||
| "enabled": false | ||
| }, | ||
| "query": "fetch events \n| filter event.kind == \"SDLC_EVENT\" \n| filter event.category == \"task\" \n| filter event.type == \"change\" \n| filter event.provider == \"github.com\"\n| filter in(vcs.repository.name, $Repository) \n| filter in(vcs.ref.base.name, $Branch)\n| sort timestamp desc\n| summarize { statuses = collectArray(event.status) }, by: { task.id, task.name, start_time, ext.vcs.change.pull_request.number, vcs.ref.base.name, vcs.ref.base.revision, vcs.ref.head.name, vcs.ref.head.revision, ext.vcs.change.pull_request.url, vcs.change.id } \n| filter not in(statuses[0],array(\"merged\",\"closed\")) \n| fields \nIn_open_status = toTimestamp(now()) - toTimestamp(start_time),\nPR = ext.vcs.change.pull_request.number, \nTitle = task.name,\nURL = ext.vcs.change.pull_request.url,\nHeadName = vcs.ref.head.name, \nHeadRevision = vcs.ref.head.revision, \nBaseName = vcs.ref.base.name, \nBaseRevision = vcs.ref.base.revision,\nCreatedAt = start_time, \nGlobalId = vcs.change.id \n| sort In_open_status desc", |
There was a problem hiding this comment.
Is the sort timestamp desc necessary?
I think the summarize by attributes should be reconsidered, similarly to my previous comments.
|
Tested the Monaco setup (prerequisites steps 1-5) and deployed configuration incl. merge - everything works as expected. |
johannes-b
commented
Feb 19, 2025
Signed-off-by: Johannes Bräuer <[email protected]>
…hannes-b/dynatrace-configuration-as-code-samples into github_pipeline_observability
|
During a meeting with @johannes-b on Feb 19th, it was agreed on to optimize the dashboard queries at a later stage. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This package provides the artifacts to configure GitHub pipeline observability in Dynatrace using Monaco.
Besides, it contains a how to guide to configure GitHub to send the relevant data to Dynatrace.
The artifacts include: