Metric library

Dashmark includes reusable metric definitions for supported services.

Search metrics

Provider

All providers

51 metrics

Provider	Metric	Label
`adguard`	`blocked`	Blocked
Required inputs None Credential options DASHMARK_ADGUARD_PASSWORD or dashmark.metric_password (optional), DASHMARK_ADGUARD_USERNAME or dashmark.metric_username (optional) Notes None
`adguard`	`filtered`	Filtered
Required inputs None Credential options DASHMARK_ADGUARD_PASSWORD or dashmark.metric_password (optional), DASHMARK_ADGUARD_USERNAME or dashmark.metric_username (optional) Notes None
`adguard`	`latency`	Latency
Required inputs None Credential options DASHMARK_ADGUARD_PASSWORD or dashmark.metric_password (optional), DASHMARK_ADGUARD_USERNAME or dashmark.metric_username (optional) Notes None
`adguard`	`queries`	DNS queries
Required inputs None Credential options DASHMARK_ADGUARD_PASSWORD or dashmark.metric_password (optional), DASHMARK_ADGUARD_USERNAME or dashmark.metric_username (optional) Notes None
`authentik`	`logged-in-users`	Logged-in users
Required inputs None Credential options DASHMARK_AUTHENTIK_TOKEN or dashmark.metric_token Notes None
`authentik`	`users`	Users
Required inputs None Credential options DASHMARK_AUTHENTIK_TOKEN or dashmark.metric_token Notes None
`bazarr`	`wanted-episodes`	Wanted episodes
Required inputs None Credential options DASHMARK_BAZARR_API_KEY or dashmark.metric_api_key Notes None
`bazarr`	`wanted-movies`	Wanted movies
Required inputs None Credential options DASHMARK_BAZARR_API_KEY or dashmark.metric_api_key Notes None
`crowdsec-web-ui`	`alerts`	Alerts
Required inputs None Credential options DASHMARK_CROWDSEC_WEB_UI_PASSWORD or dashmark.metric_password (optional), DASHMARK_CROWDSEC_WEB_UI_USERNAME or dashmark.metric_username (optional) Notes None
`crowdsec-web-ui`	`decisions`	Active decisions
Required inputs None Credential options DASHMARK_CROWDSEC_WEB_UI_PASSWORD or dashmark.metric_password (optional), DASHMARK_CROWDSEC_WEB_UI_USERNAME or dashmark.metric_username (optional) Notes None
`crowdsec-web-ui`	`lapi-status`	LAPI status
Required inputs None Credential options DASHMARK_CROWDSEC_WEB_UI_PASSWORD or dashmark.metric_password (optional), DASHMARK_CROWDSEC_WEB_UI_USERNAME or dashmark.metric_username (optional) Notes None
`gatus`	`uptime`	Uptime
Required inputs group (Gatus group), name (Gatus endpoint name) Credential options None Notes Dashmark retrieves the configured Gatus history once, then polls the newest 100 results. Use persistent SQLite or Postgres storage and increase storage.maximum-number-of-results to retain the uptime history you want Dashmark to display.
`homeassistant`	`entities`	Entities
Required inputs None Credential options DASHMARK_HOMEASSISTANT_TOKEN or dashmark.metric_token Notes None
`homeassistant`	`entity-state`	Entity State
Required inputs entity_id (Entity ID) Credential options DASHMARK_HOMEASSISTANT_TOKEN or dashmark.metric_token Notes None
`homeassistant`	`template-state`	Template State
Required inputs template (Template) Credential options DASHMARK_HOMEASSISTANT_TOKEN or dashmark.metric_token Notes None
`nzbget`	`download-rate`	Download
Required inputs None Credential options DASHMARK_NZBGET_PASSWORD or dashmark.metric_password (optional), DASHMARK_NZBGET_USERNAME or dashmark.metric_username (optional) Notes None
`nzbget`	`downloaded`	Downloaded
Required inputs None Credential options DASHMARK_NZBGET_PASSWORD or dashmark.metric_password (optional), DASHMARK_NZBGET_USERNAME or dashmark.metric_username (optional) Notes None
`nzbget`	`remaining`	Remaining
Required inputs None Credential options DASHMARK_NZBGET_PASSWORD or dashmark.metric_password (optional), DASHMARK_NZBGET_USERNAME or dashmark.metric_username (optional) Notes None
`opnsense`	`cpu`	CPU
Required inputs None Credential options DASHMARK_OPNSENSE_API_KEY or dashmark.metric_api_key, DASHMARK_OPNSENSE_API_SECRET or dashmark.metric_api_secret Notes None
`opnsense`	`memory`	Memory
Required inputs None Credential options DASHMARK_OPNSENSE_API_KEY or dashmark.metric_api_key, DASHMARK_OPNSENSE_API_SECRET or dashmark.metric_api_secret Notes None
`opnsense`	`wan-received`	WAN received
Required inputs None Credential options DASHMARK_OPNSENSE_API_KEY or dashmark.metric_api_key, DASHMARK_OPNSENSE_API_SECRET or dashmark.metric_api_secret Notes None
`opnsense`	`wan-transmitted`	WAN sent
Required inputs None Credential options DASHMARK_OPNSENSE_API_KEY or dashmark.metric_api_key, DASHMARK_OPNSENSE_API_SECRET or dashmark.metric_api_secret Notes None
`paperless`	`documents`	Documents
Required inputs None Credential options DASHMARK_PAPERLESS_TOKEN or dashmark.metric_token Notes None
`paperless`	`inbox`	Inbox
Required inputs None Credential options DASHMARK_PAPERLESS_TOKEN or dashmark.metric_token Notes None
`plex`	`active-streams`	Active streams
Required inputs None Credential options DASHMARK_PLEX_TOKEN or dashmark.metric_token (optional) Notes None
`plex`	`albums`	Albums
Required inputs None Credential options DASHMARK_PLEX_TOKEN or dashmark.metric_token (optional) Notes None
`plex`	`movies`	Movies
Required inputs None Credential options DASHMARK_PLEX_TOKEN or dashmark.metric_token (optional) Notes None
`plex`	`shows`	Shows
Required inputs None Credential options DASHMARK_PLEX_TOKEN or dashmark.metric_token (optional) Notes None
`prowlarr`	`failed-grabs`	Failed grabs
Required inputs None Credential options DASHMARK_PROWLARR_API_KEY or dashmark.metric_api_key (optional) Notes None
`prowlarr`	`failed-queries`	Failed queries
Required inputs None Credential options DASHMARK_PROWLARR_API_KEY or dashmark.metric_api_key (optional) Notes None
`prowlarr`	`grabs`	Grabs
Required inputs None Credential options DASHMARK_PROWLARR_API_KEY or dashmark.metric_api_key (optional) Notes None
`prowlarr`	`indexers`	Indexers
Required inputs None Credential options DASHMARK_PROWLARR_API_KEY or dashmark.metric_api_key (optional) Notes None
`prowlarr`	`queries`	Queries
Required inputs None Credential options DASHMARK_PROWLARR_API_KEY or dashmark.metric_api_key (optional) Notes None
`qbittorrent`	`download_speed`	Download
Required inputs None Credential options DASHMARK_QBITTORRENT_PASSWORD or dashmark.metric_password (optional), DASHMARK_QBITTORRENT_USERNAME or dashmark.metric_username (optional) Notes None
`qbittorrent`	`leechers`	Leeches
Required inputs None Credential options DASHMARK_QBITTORRENT_PASSWORD or dashmark.metric_password (optional), DASHMARK_QBITTORRENT_USERNAME or dashmark.metric_username (optional) Notes None
`qbittorrent`	`seeds`	Seeding
Required inputs None Credential options DASHMARK_QBITTORRENT_PASSWORD or dashmark.metric_password (optional), DASHMARK_QBITTORRENT_USERNAME or dashmark.metric_username (optional) Notes None
`qbittorrent`	`upload_speed`	Upload
Required inputs None Credential options DASHMARK_QBITTORRENT_PASSWORD or dashmark.metric_password (optional), DASHMARK_QBITTORRENT_USERNAME or dashmark.metric_username (optional) Notes None
`radarr`	`have`	Movies
Required inputs None Credential options DASHMARK_RADARR_API_KEY or dashmark.metric_api_key (optional) Notes None
`radarr`	`missing`	Missing
Required inputs None Credential options DASHMARK_RADARR_API_KEY or dashmark.metric_api_key (optional) Notes None
`radarr`	`queue`	Queued
Required inputs None Credential options DASHMARK_RADARR_API_KEY or dashmark.metric_api_key (optional) Notes None
`radarr`	`wanted`	Wanted
Required inputs None Credential options DASHMARK_RADARR_API_KEY or dashmark.metric_api_key (optional) Notes None
`seerr`	`approved`	Approved requests
Required inputs None Credential options DASHMARK_SEERR_API_KEY or dashmark.metric_api_key Notes None
`seerr`	`completed`	Completed requests
Required inputs None Credential options DASHMARK_SEERR_API_KEY or dashmark.metric_api_key Notes None
`seerr`	`issues`	Issues
Required inputs None Credential options DASHMARK_SEERR_API_KEY or dashmark.metric_api_key Notes None
`seerr`	`open-issues`	Open issues
Required inputs None Credential options DASHMARK_SEERR_API_KEY or dashmark.metric_api_key Notes None
`seerr`	`pending`	Pending requests
Required inputs None Credential options DASHMARK_SEERR_API_KEY or dashmark.metric_api_key Notes None
`seerr`	`processing`	Processing requests
Required inputs None Credential options DASHMARK_SEERR_API_KEY or dashmark.metric_api_key Notes None
`sonarr`	`queue`	Queued
Required inputs None Credential options DASHMARK_SONARR_API_KEY or dashmark.metric_api_key (optional) Notes None
`sonarr`	`series`	Series
Required inputs None Credential options DASHMARK_SONARR_API_KEY or dashmark.metric_api_key (optional) Notes None
`sonarr`	`wanted`	Wanted
Required inputs None Credential options DASHMARK_SONARR_API_KEY or dashmark.metric_api_key (optional) Notes None
`zerobyte`	`backup-health`	Backup health
Required inputs None Credential options DASHMARK_ZEROBYTE_API_KEY or dashmark.metric_api_key Notes None

Docker labels

Add a library metric as provider/metric in dashmark.metrics. Use dashmark.metrics_source.<provider> when Dashmark should connect to that provider over a private Docker-network address instead of the card URL.

labels:
  dashmark.url: https://radarr.example.com
  dashmark.metrics: cpu,memory,radarr/queue
  dashmark.metrics_source.radarr: http://radarr:7878

Library metrics that need credentials use dashmark.metric_* labels. Docker labels are visible through Docker APIs and inspect output, so prefer YAML with environment variables or secret files for secrets.

labels:
  dashmark.metrics: gatus/uptime
  dashmark.metrics_source.gatus: http://gatus:8080
  dashmark.metrics_input.gatus.uptime.group: Media Servers
  dashmark.metrics_input.gatus.uptime.name: Plex / Main

Use dashmark.metrics_source.<provider> for a provider-specific API base URL. Use dashmark.metrics_input.<provider>.<metric>.<input> for a library input. Replace / in the metric key with .. A provider with no source label uses the card URL.

YAML configuration

Add library metric keys under metrics.entries. This is the recommended path when a metric needs credentials or must be configured independently of Docker labels.

radarr:
  url: https://radarr.example.com
  metrics:
    sources:
      radarr: http://radarr:7878
    entries:
      radarr/queue:

Some library metrics accept inputs. Refer to the catalogue, then set them under inputs:

office:
  metrics:
    entries:
      homeassistant/entity-state:
        inputs:
          entity_id: sensor.office_temperature

Restrict one metric

Use visible_to in YAML to limit an individual metric to matching access entries:

radarr:
  metrics:
    entries:
      radarr/queue:
        visible_to: [admins]

METRICS_ACCESS restricts all metrics server-side. See Access control for group and identity configuration.