Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide telemetry dashboard templates #2233

Closed
rturner3 opened this issue Apr 20, 2021 · 4 comments · Fixed by #5188
Closed

Provide telemetry dashboard templates #2233

rturner3 opened this issue Apr 20, 2021 · 4 comments · Fixed by #5188
Assignees
Labels
priority/backlog Issue is approved and in the backlog unscoped The issue needs more design or understanding in order for the work to progress

Comments

@rturner3
Copy link
Collaborator

In order to effectively operate SPIRE in a production environment, users need to develop visualization of SPIRE telemetry to have adequate observability into the system. These dashboards can be time-consuming and tedious to develop, so it may be helpful to users to provide dashboard templates for common open-source observability dashboard systems like Grafana. Metrics dashboards also provide a way for newer users to quickly familiarize themselves with frequently exercised RPCs in the SPIRE control plane.

SPIRE supports emission of metrics to several metrics systems, such as Prometheus, statsd, and M3. Given that dashboards are powered by metrics queries whose query languages differ by observability system, it may make sense to have separate dashboards for different supported query languages (e.g. PromQL, M3QL).

@rturner3 rturner3 added help wanted Issues with this label are ready to start work but are in need of someone to do it priority/backlog Issue is approved and in the backlog unscoped The issue needs more design or understanding in order for the work to progress labels May 1, 2023
Copy link

This issue is stale because it has been open for 365 days with no activity.

@github-actions github-actions bot added the stale label Apr 30, 2024
@FedeNQ
Copy link
Contributor

FedeNQ commented May 15, 2024

We're working in something related to this and we'll happy to contribute here.

@FedeNQ
Copy link
Contributor

FedeNQ commented May 15, 2024

We are planning to add a .JSON file to be used for generating the dashboards. Does anyone have suggestions on where we should place it within our project structure?

@github-actions github-actions bot removed the stale label May 15, 2024
@amartinezfayo
Copy link
Member

We are planning to add a .JSON file to be used for generating the dashboards

That's awesome!

Does anyone have suggestions on where we should place it within our project structure?

We discussed this a little bit in the last contributors sync, and we think that having this close to the Telemetry documentation would be good.
Considering that, I think that this should be placed in this repository under the /doc path. It's probably a good idea to have a dedicated folder for telemetry, since I believe that what will be contributed will contain not only the .json file but also a .md document. We could have all related telemetry things under /doc/telemetry.

@amartinezfayo amartinezfayo removed the help wanted Issues with this label are ready to start work but are in need of someone to do it label May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority/backlog Issue is approved and in the backlog unscoped The issue needs more design or understanding in order for the work to progress
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants