GitHub pipeline observability #22

johannes-b · 2025-01-09T09:39:47Z

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:

OpenPipeline configuration in the SDLC.event scope
2 Dashboards for GitHub pipeline/PR observability
- GitHub Pull Request monitoring
- GitHub Workflows monitoring

Signed-off-by: Johannes Bräuer <[email protected]>

...vability/pipeline_observability/document-dashboard/0a635714-5545-4413-95e1-023333e8edac.json

Signed-off-by: Johannes Bräuer <[email protected]>

stefaneberl

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

Signed-off-by: Johannes Bräuer <[email protected]>

johannes-b · 2025-02-06T13:03:19Z

github_pipeline_observability/change.finished.md

@@ -0,0 +1,35 @@
+### Change event for Semantic Dictionary
+
+`task.change.[open/merged/closed]`


@stefaneberl this is a proposal for a task.change.* event.

johannes-b · 2025-02-06T13:04:55Z

github_pipeline_observability/change.finished.md

+| task.outcome | `success` | Outcome of a task run.
+| | | |
+| vcs.change.id  | `4711` | The identifier of the change, for example, pull request ID or merge request ID. It is typically unique per repository and generated by the version control system itself.
+| vcs.change.title  | `docs: Update of Readme.md`  | The human-readable title of the change, for example, pull request title or merge request title.  **Attention:** Ident to: "task.name"


@stefaneberl The OTel and our SemDic define the property vcs.change.title. This would be a duplicate of task.name (see value). Should we duplicate the information?

johannes-b · 2025-02-06T13:05:14Z

github_pipeline_observability/change.finished.md

+| | | |
+| vcs.change.id  | `4711` | The identifier of the change, for example, pull request ID or merge request ID. It is typically unique per repository and generated by the version control system itself.
+| vcs.change.title  | `docs: Update of Readme.md`  | The human-readable title of the change, for example, pull request title or merge request title.  **Attention:** Ident to: "task.name"
+| vcs.change.state  | [`merged`, `closed`, `open`]  | The state of the change (pull request/merge request/changelist). **Attention:** Ident to: "event.status"


@stefaneberl The OTel and our SemDic define the property vcs.change.state. This would be a duplicate of event.status (see value). Should we duplicate the information?

johannes-b · 2025-02-06T13:07:15Z

github_pipeline_observability/change.finished.md

+| vcs.ref.base.name  | `main` | The name of the reference in the repository. This can be a branch name or a tag name.
+| vcs.ref.base.revision  | `05a7199180e7df5f38c9c78efcf0e4474eb52065` | The revision in the repository. For Git this is a synonym for a commit hash, whereas in SVN it is a revision number.
+| | | |
+| **NEW** vcs.change.number  | `40`  | A human-readable number for the pull request or merge request. 


@stefaneberl I would like to propose the two properties: vcs.change.numer and vcs.change.url.full. vcs.change.url.full should point to the URL of the PR, and vcs.change.number represents a human-readable number of the PR. GitHub differentiates between an ID and number; see:

"action": "opened", "number": 58, "pull_request": { "url": "https://api.github.com/repos/johannes-b/platform-engineering-demo/pulls/58", "id": 2318069049, "node_id": "PR_kwDONk-fDM6KKu05", "html_url": "https://github.com/johannes-b/platform-engineering-demo/pull/58", ...

Signed-off-by: Johannes Bräuer <[email protected]>

github_pipeline_observability/README.md

Co-authored-by: Christian Kreuzberger <[email protected]>

stefaneberl

More comments will follow.

stefaneberl · 2025-02-10T07:37:57Z

...ub_pipeline_observability/pipeline_observability/document-dashboard/github.pull_request.json

+        },
+        "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()",


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.

stefaneberl · 2025-02-10T10:19:03Z

...ub_pipeline_observability/pipeline_observability/document-dashboard/github.pull_request.json

+        },
+        "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)",


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

stefaneberl · 2025-02-10T10:24:39Z

...ub_pipeline_observability/pipeline_observability/document-dashboard/github.pull_request.json

+        },
+        "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()",


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.

stefaneberl · 2025-02-10T10:26:15Z

...ub_pipeline_observability/pipeline_observability/document-dashboard/github.pull_request.json

+        },
+        "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",


Is the sort timestamp desc necessary?

I think the summarize by attributes should be reconsidered, similarly to my previous comments.

martin-hoelbling · 2025-02-13T13:10:47Z

Tested the Monaco setup (prerequisites steps 1-5) and deployed configuration incl. merge - everything works as expected.

johannes-b added 6 commits January 9, 2025 10:38

First version of GitHub pipeline observability

2df5c20

Signed-off-by: Johannes Bräuer <[email protected]>

Update of readme

09e7ad4

Signed-off-by: Johannes Bräuer <[email protected]>

Minor change in readme

e1d4f43

Signed-off-by: Johannes Bräuer <[email protected]>

Changed Dashboards

12f4ed4

Signed-off-by: Johannes Bräuer <[email protected]>

Clean up sample data

c493575

Signed-off-by: Johannes Bräuer <[email protected]>

Update of artifacts

200aae9

Signed-off-by: Johannes Bräuer <[email protected]>

wlfghdr reviewed Jan 23, 2025

View reviewed changes

...vability/pipeline_observability/document-dashboard/0a635714-5545-4413-95e1-023333e8edac.json Outdated Show resolved Hide resolved

johannes-b added 14 commits January 23, 2025 15:03

Changed file name

a7ee597

Signed-off-by: Johannes Bräuer <[email protected]>

Renamed files

bed3e3c

Signed-off-by: Johannes Bräuer <[email protected]>

Removed images

959496a

Signed-off-by: Johannes Bräuer <[email protected]>

Upate of OpenPipeline and Dashboards

3579d10

Signed-off-by: Johannes Bräuer <[email protected]>

Set version number

480b288

Signed-off-by: Johannes Bräuer <[email protected]>

added fields

16159f3

Signed-off-by: Johannes Bräuer <[email protected]>

Removed DT_TOKEN

3ee8138

Signed-off-by: Johannes Bräuer <[email protected]>

Update of IDs and remove DT_TOKEN from manifest

08be9c4

Signed-off-by: Johannes Bräuer <[email protected]>

Update of how to guide

c9b3f28

Signed-off-by: Johannes Bräuer <[email protected]>

Minor changes

d61d725

Signed-off-by: Johannes Bräuer <[email protected]>

Added a security disclaimer

6967ed8

Signed-off-by: Johannes Bräuer <[email protected]>

Added the origin of the dashboard

894c56b

Signed-off-by: Johannes Bräuer <[email protected]>

Added FAQ section

2a8e891

Signed-off-by: Johannes Bräuer <[email protected]>

Added a share feedback section

9cacca3

Signed-off-by: Johannes Bräuer <[email protected]>

stefaneberl requested changes Feb 5, 2025

View reviewed changes

johannes-b added 2 commits February 5, 2025 10:50

Changed title of a tile

97dc44e

Signed-off-by: Johannes Bräuer <[email protected]>

Proposal for change event

e6c24c8

Signed-off-by: Johannes Bräuer <[email protected]>

johannes-b commented Feb 6, 2025

View reviewed changes

Changed queries to remove join

6288dbc

Signed-off-by: Johannes Bräuer <[email protected]>

christian-kreuzberger-dtx reviewed Feb 10, 2025

View reviewed changes

github_pipeline_observability/README.md Outdated Show resolved Hide resolved

Update github_pipeline_observability/README.md

a742ee5

Co-authored-by: Christian Kreuzberger <[email protected]>

stefaneberl reviewed Feb 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub pipeline observability #22

GitHub pipeline observability #22

johannes-b commented Jan 9, 2025 •

edited

Loading

stefaneberl left a comment

johannes-b Feb 6, 2025

johannes-b Feb 6, 2025 •

edited

Loading

johannes-b Feb 6, 2025 •

edited

Loading

johannes-b Feb 6, 2025 •

edited

Loading

stefaneberl left a comment

stefaneberl Feb 10, 2025

stefaneberl Feb 10, 2025

stefaneberl Feb 10, 2025

stefaneberl Feb 10, 2025

martin-hoelbling commented Feb 13, 2025

		@@ -0,0 +1,35 @@
		### Change event for Semantic Dictionary

		`task.change.[open/merged/closed]`

GitHub pipeline observability #22

Are you sure you want to change the base?

GitHub pipeline observability #22

Conversation

johannes-b commented Jan 9, 2025 • edited Loading

stefaneberl left a comment

Choose a reason for hiding this comment

johannes-b Feb 6, 2025

Choose a reason for hiding this comment

johannes-b Feb 6, 2025 • edited Loading

Choose a reason for hiding this comment

johannes-b Feb 6, 2025 • edited Loading

Choose a reason for hiding this comment

johannes-b Feb 6, 2025 • edited Loading

Choose a reason for hiding this comment

stefaneberl left a comment

Choose a reason for hiding this comment

stefaneberl Feb 10, 2025

Choose a reason for hiding this comment

stefaneberl Feb 10, 2025

Choose a reason for hiding this comment

stefaneberl Feb 10, 2025

Choose a reason for hiding this comment

stefaneberl Feb 10, 2025

Choose a reason for hiding this comment

martin-hoelbling commented Feb 13, 2025

johannes-b commented Jan 9, 2025 •

edited

Loading

johannes-b Feb 6, 2025 •

edited

Loading

johannes-b Feb 6, 2025 •

edited

Loading

johannes-b Feb 6, 2025 •

edited

Loading