search

spiffe / spire

The SPIFFE Runtime Environment
https://spiffe.io
Apache License 2.0
1.72k stars 458 forks source link

Provide telemetry dashboard templates #2233

Closed rturner3 closed 2 weeks ago

rturner3 commented 3 years ago

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).

github-actions[bot] commented 2 months ago

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

FedeNQ commented 1 month ago

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

FedeNQ commented 1 month ago

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?

amartinezfayo commented 1 month ago

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.