feat: reusable component to download kibana dashboards #388
Conversation
This file contains hidden or 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
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new reusable GitHub Action component to download Kibana dashboards as PNG files. The feature helps consolidate and simplify existing scripts across the Elastic organization that perform similar functionality.
Key Changes:
- New composite action that generates and downloads Kibana dashboard screenshots via Kibana's reporting API
- Includes polling mechanism with retry logic and configurable parameters for dashboard rendering
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| download-kibana-dashboard/run.sh | Core bash script implementing the Kibana API interaction and polling logic |
| download-kibana-dashboard/action.yml | GitHub Action definition with input parameters and composite action steps |
| download-kibana-dashboard/README.md | Documentation for the new action including usage examples |
| .github/workflows/test-download-kibana-dashboard.yml | Test workflow to validate the action using OIDC and real Kibana cluster |
| .github/workflows/no-test.yml | Updated exclusion list to include the new action directory |
Comment on lines
+2
to
+4
| name: 'download-kibana-dashboard' | ||
| description: | | ||
| An Action to download a Kibana dashboard in png. |
There was a problem hiding this comment.
Corrected spelling of 'compoonent' to 'component' (note: issue is in PR title, but documenting here as it relates to this action).
v1v
commented
Oct 23, 2025
| kibana-host: ${{ env.KIBANA_HOST }} | ||
| kibana-user: ${{ env.KIBANA_USERNAME }} | ||
| kibana-password: ${{ env.KIBANA_PASSWORD }} | ||
| dashboard-id: "2c0daa02-35e8-4dd3-aa0a-6a24a48d857d" |
Member
Author
There was a problem hiding this comment.
I created this dashboard manually
v1v
changed the title
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.
Superseedes #387
What
New feature to download a Kibana Dashboard in a png format
Why
This should help to simplify our scripts:
I decided to avoid running e2e tests, but using it directly.