v2.0.0

Added

• Comprehensive metrics documentation:
  • New METRICS. md file documenting all available Prometheus metrics, their types, labels, and usage patterns.
  • Includes PromQL query examples and best practices for joining metrics.
• Client connection metrics (optional, disabled by default):
  • New dispatcharr_active_clients gauge showing total active client connections.
  • New dispatcharr_client_info gauge with client metadata (IP address, user agent, worker ID).
  • New dispatcharr_client_connection_duration_seconds gauge tracking connection duration.
  • New dispatcharr_client_bytes_sent counter for total bytes transferred to each client.
  • New dispatcharr_client_avg_transfer_rate_kbps and dispatcharr_client_current_transfer_rate_kbps gauges for transfer rates.
  • Controlled via new include_client_stats setting (privacy-focused, off by default).
• Improved stream metrics structure:
  • New layered metric design separating static metadata from dynamic values to avoid creating new time series on value changes.
  • New dispatcharr_stream_metadata gauge with all enrichment labels (channel name, provider, state, logo, codec, resolution).
  • New separate value gauges: dispatcharr_stream_channel_number, dispatcharr_stream_id, dispatcharr_stream_index, dispatcharr_stream_available_streams.
  • New dispatcharr_stream_uptime_seconds counter, dispatcharr_stream_active_clients gauge, dispatcharr_stream_fps gauge, and bitrate/transfer metrics.
  • All metrics use minimal channel_uuid and channel_number labels for efficient joining.
• Improved M3U and EPG metrics:
  • New dispatcharr_m3u_account_stream_count gauge (stream count as a value, not a label).
  • New dispatcharr_epg_source_priority gauge (priority as a value, not a label).
  • Separate info metrics (dispatcharr_m3u_account_info, dispatcharr_epg_source_info) for static metadata.
• Exporter metadata improvements:
  • New dispatcharr_exporter_port gauge showing the configured port number.
  • Renamed dispatcharr_exporter_settings to dispatcharr_exporter_settings_info for clarity.
• Root endpoint landing page:
  • New HTML landing page at / showing plugin name, version, description, and links to /metrics and /health.

Changed

• Stream metrics now detect and report the actual active stream ID from Redis metadata (handles fallback/failover correctly).
• Stream metrics include channel group information in metadata labels.
• Legacy metric formats (v1.1.0 and earlier) are now opt-in via the new include_legacy_metrics setting (disabled by default).
• Plugin configuration updated to include include_client_stats and include_legacy_metrics settings.
• README updated to reference the new METRICS.md documentation and clarify privacy-focused client metrics.

Deprecated

• Legacy metric formats (dispatcharr_stream_info with all values as labels, dispatcharr_m3u_account_info with stream_count as label, dispatcharr_epg_source_info with priority as label) are deprecated and disabled by default.
  • Only enable via include_legacy_metrics=true if you need time to migrate existing dashboards.
  • Use the new layered metrics instead (static metadata + separate value gauges).

---

Installing: https://github.com/sethwv/dispatcharr-exporter?tab=readme-ov-file#installation
Upgrading: https://github.com/sethwv/dispatcharr-exporter?tab=readme-ov-file#updating-the-plugin
Full Changelog: v1.1.0...v2.0.0