Skip to content

feat(inputs.webhooks.github): Add run_id field to workflow_run events#19157

Open
warintara wants to merge 4 commits into
influxdata:masterfrom
warintara:master
Open

feat(inputs.webhooks.github): Add run_id field to workflow_run events#19157
warintara wants to merge 4 commits into
influxdata:masterfrom
warintara:master

Conversation

@warintara

@warintara warintara commented Jun 24, 2026

Copy link
Copy Markdown

Summary

Added run_id field to the Telegraf GitHub webhook plugin's workflow_run event parsing.

Changes:

  • Added ID int64 to the workflowRun struct to deserialize the id field from the GitHub webhook JSON payload
  • Added run_id to the InfluxDB fields map in workflowRunEvent.newMetric() so the value is stored in the database

Why: The GitHub Actions run ID is the unique identifier used in GitHub Action URLs (/actions/runs/<run_id>). Without
storing it, there was no way to build direct links from the Grafana dashboard back to the specific GitHub Actions
run. This change enables linking each row in the dashboard to its corresponding GitHub Actions page.

Checklist

Related issues

resolves #19158

@telegraf-tiger

Copy link
Copy Markdown
Contributor

Thanks so much for the pull request!
🤝 ✒️ Just a reminder that the CLA has not yet been signed, and we'll need it before merging. Please sign the CLA when you get a chance, then post a comment here saying !signed-cla

@warintara

warintara commented Jun 29, 2026

Copy link
Copy Markdown
Author

!signed-cla

@warintara
warintara marked this pull request as ready for review June 29, 2026 08:49
@warintara warintara changed the title Added run_id field to the Telegraf GitHub webhook plugin's workflow_r… feat(github_webhooks): add run_id field to workflow_run events Jun 30, 2026
@telegraf-tiger telegraf-tiger Bot added the feat Improvement on an existing feature such as adding a new setting/mode to an existing plugin label Jun 30, 2026
@warintara
warintara marked this pull request as draft June 30, 2026 11:54
@warintara
warintara marked this pull request as ready for review June 30, 2026 11:54
@warintara

Copy link
Copy Markdown
Author

Hello @srebhan @skartikey, could you please take a look at this PR when you have a moment? Let me know if you have any questions or need any clarifications. Thank you!

@skartikey

Copy link
Copy Markdown
Contributor

plugins/inputs/webhooks/github/README.md:456-459 - the workflow_run event section documents every emitted field (the "Fields:" list at line 454), and the new run_id is missing. Please add it to that list:

* 'run_id' = `event.workflow_run.id` int

@skartikey skartikey changed the title feat(github_webhooks): add run_id field to workflow_run events feat(inputs.webhooks.github): Add run_id field to workflow_run events Jul 13, 2026
@skartikey skartikey self-assigned this Jul 13, 2026
@telegraf-tiger

Copy link
Copy Markdown
Contributor

@warintara

Copy link
Copy Markdown
Author

Done, I have added run_id to the Fields list in the README. Thanks for the feedback! @skartikey

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feat Improvement on an existing feature such as adding a new setting/mode to an existing plugin

Projects

None yet

Development

Successfully merging this pull request may close these issues.

inputs/webhooks/github: add run_id field to workflow_run event

2 participants