Grafana example is out of date

[csikb]

The Grafana dashboard is out of date. The metrics has changed since, the uuid of the dashbaord and the data source is hard coded.

[glime-ai[bot]]

Please note this response was created using generative AI leveraging previously available information from the repository. This information may be helpful however it is our strong recommendation that you carefully consider the information before blindly applying it.

---

To address the issue with the Grafana dashboard being out of date due to changes in metrics, and the UUID of the dashboard and the data source being hardcoded, you will need to take a few steps. Unfortunately, as per the information provided, Authelia does not formally have any dashboards for Grafana that use Prometheus metrics for Authelia, but they welcome contributions under the Apache 2.0 license. This means you might need to manually update or create a new dashboard that reflects the current metrics used by Authelia.

1. Review Authelia's Current Metrics: First, review the current metrics that Authelia exports to Prometheus. This information can be found in the Authelia documentation under the metrics section. Pay special attention to the names of the metrics, the labels they use, and any new metrics that have been added or old ones that have been removed since the Grafana dashboard was last updated.

2. Update the Grafana Dashboard JSON: Modify the Grafana dashboard JSON to reflect the changes in the metrics. This includes updating the metric names in the panel queries and ensuring that any hardcoded UUIDs for the dashboard or data sources are either removed or updated to the correct values. If you're not the original creator of the dashboard, you might need to export the current dashboard to JSON format first.

3. Adjust Data Source Configuration: If the data source (Prometheus) UUID is hardcoded and has changed, you'll need to update this in the dashboard settings. It's generally recommended to use a variable for the data source when possible, to avoid such issues.

4. Test the Dashboard: After making the necessary changes, import the updated dashboard JSON into Grafana and verify that the metrics are being correctly displayed. Make sure to check for any errors or missing data.

5. Contribute Back: If you've made significant improvements or updates to the dashboard, consider contributing it back to the community. As mentioned, Authelia welcomes contributions, and sharing your updated dashboard could help others facing the same issue.

Remember, the specific steps to update the dashboard JSON will depend on the changes in the metrics and how the original dashboard was configured. If you're not familiar with Grafana dashboard JSON structure, you might need to refer to the Grafana documentation for guidance on how to properly format and update dashboard JSON files.

This comment was generated by Glime.

[csikb]

I think it would be worthwhile to add a link to the dashboard example. And update the example in the repo:
https://github.com/authelia/authelia/blob/master/examples/grafana-dashboards/simple.json

[james-d-elliott]

This is a community contributed example, additional contributions are welcomed.

[TroRon]

Does anyone already have a running example with the new metrics?

Mine is running now, but with the repo example and I can't customize it myself, because I don't know what, how and where ;)

If someone has a finished, running dashboard, I would be happy to update the repo :)

[hendrik1120]

I completely recreated the dashboard and fixed the outstanding issues.
https://github.com/hendrik1120/authelia/blob/grafana-dash/examples/grafana-dashboards/simple.json

It's more focused towards detecting issues and changes in the data compared to the previous example. Also features multi instance and selectable data sources. May still contain some bugs, though.

Edit: You might need to set the scrape_interval to 15s in order for the rate function to have enough data points to correctly approximate the curve.

[TroRon]

Moin Hendrik ;)

Many thanks for the answer.
Here is the answer to the requested query:

Also exciting, I get answers to everything here ....

Which is actually a good thing, if I've interpreted that correctly

Best regards from Switzerland

Ronny

[TroRon]

Found:

when I select my instance in the dropdown, data appears ....

[hendrik1120]

Then you can completely disregard my previous comment and just select your instance in the global variable at the top left of the dashboard. I will take a look at the top slow request data, I still have to check that accuracy anyway...

[hendrik1120]

The issue was that for some panels, I used the = operator to match the instance instead of the =~ operator. Which does not work if no instance is selected. I committed the fix to https://github.com/hendrik1120/authelia/blob/grafana-dash/examples/grafana-dashboards/simple.json Feel free to check it out. All panels should be working now.

[TroRon]

Hi Hendrik

Just tested it, now works as expected ;)

Thank you very much for your work and support