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

Expand Prometheus Metrics to state device/folder names #9519

Open
simonmicro opened this issue Apr 26, 2024 · 0 comments
Open

Expand Prometheus Metrics to state device/folder names #9519

simonmicro opened this issue Apr 26, 2024 · 0 comments
Labels
enhancement New features or improvements of some kind, as opposed to a problem (bug)

Comments

@simonmicro
Copy link

Feature description

Currently, metrics like:

  • syncthing_protocol_recv_bytes_total
  • syncthing_model_folder_processed_bytes_total

State only the object ids as label to be scraped. I would welcome the addition of the clear-text values as labels in addition to the ids.

Problem or use case

After scraping a Syncthing server using Prometheus, I can display the metrics with tools like Grafana. Sadly, I can only display the unresolved ids of the folders / devices inside the UI, as no further information is available.

This leads to problems that alerts cannot contain easy-to-interepret descriptions - for admins to decide if they want to start investigation. In addition, admins cannot interpret e.g. if spikes in traffic are legitimate (as the device is only visible as ID) in Grafana, which makes anomaly-investigations harder.

Finally, with growing numbers of devices and folders connected to an instance (for me >40 folders / >8 devices) the metrics get more and more hard to read - pie charts containing statistics about specific folders in comparison to each other are just unreadable.

Here are some samples (blue = mask for privacy):

Screenshot from 2024-04-26 18-18-52
Screenshot from 2024-04-26 18-19-03

Alternatives or workarounds

  • Write an own exporter to scrape Syncthing-metrics and label them with the metadata available over the api.
  • Relabel all ids by hand in the Prometheus config?
@simonmicro simonmicro added enhancement New features or improvements of some kind, as opposed to a problem (bug) needs-triage New issues needed to be validated labels Apr 26, 2024
@calmh calmh removed the needs-triage New issues needed to be validated label Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New features or improvements of some kind, as opposed to a problem (bug)
Projects
None yet
Development

No branches or pull requests

2 participants