Observability
FunkArr exposes a Prometheus-compatible /metrics endpoint. Use it with any Prometheus-compatible monitoring stack to observe download queues, search activity, scoring results, enrichment caching, and ruleset management.
Metrics
Download (FunkArr.Download)
| Metric | Type | Description |
|---|---|---|
funkarr_download_completed_total | Counter | Completed downloads |
funkarr_download_failed_total | Counter | Failed downloads (tag: reason) |
funkarr_download_duration_seconds | Histogram | Download (FFmpeg) duration (tag: status = completed/failed) |
funkarr_download_bytes_total | Counter | Total bytes downloaded |
funkarr_download_enqueued_total | Counter | Downloads added to queue |
funkarr_download_cancelled_total | Counter | Downloads cancelled |
funkarr_download_retries_total | Counter | Retry attempts (tag: reason) |
funkarr_download_move_failed_total | Counter | File move failures |
funkarr_download_subtitle_total | Counter | Subtitle preparation attempts (tags: status = succeeded/failed/unavailable, format) |
funkarr_download_subtitle_duration_seconds | Histogram | Subtitle preparation duration |
funkarr_download_queue_size | Gauge | Current queue depth |
funkarr_download_active | Gauge | Currently active downloads |
funkarr_download_paused | Gauge | Whether downloads are paused (0/1) |
funkarr_download_schedule_enabled | Gauge | Whether schedule is active (0/1) |
Search (FunkArr.Search)
| Metric | Type | Description |
|---|---|---|
funkarr_search_requests_total | Counter | Search requests (tag: source) |
funkarr_search_matches_total | Counter | Searches with accepted results (tag: source) |
funkarr_search_no_match_total | Counter | Searches with no accepted results (tag: source) |
funkarr_search_duration_seconds | Histogram | End-to-end search duration (tags: source, type) |
funkarr_search_timeouts_total | Counter | Search timeouts (tag: source) |
funkarr_search_failed_total | Counter | Search failures (tag: source) |
funkarr_search_mediathek_errors_total | Counter | MediathekViewWeb API errors |
funkarr_search_results_per_request | Histogram | Result count distribution |
funkarr_search_evaluations_total | Counter | Evaluations run by the evaluation workers (tags: source, type, status) |
funkarr_search_evaluation_duration_seconds | Histogram | Evaluation duration from ruleset resolution to releases (tags: source, type) |
funkarr_search_mediathek_cache_hits_total | Counter | MediathekViewWeb response cache hits |
funkarr_search_mediathek_cache_misses_total | Counter | MediathekViewWeb response cache misses |
Feed (FunkArr.Feed)
| Metric | Type | Description |
|---|---|---|
funkarr_feed_crawls_total | Counter | Feed ingest runs by outcome (tag: status) |
funkarr_feed_probes_unchanged_total | Counter | Ingest runs that found no new Filmliste update |
funkarr_feed_items_seen_total | Counter | New Mediathek entries collected by the ingest |
funkarr_feed_unmatched_total | Counter | New entries without a matching ruleset |
funkarr_feed_published_total | Counter | Releases published to the feed |
funkarr_feed_rejected_total | Counter | Releases rejected by the feed gate (tag: reason; currently not populated) |
funkarr_feed_gaps_total | Counter | Ingest runs that could not cover the whole window |
funkarr_feed_crawl_duration_seconds | Histogram | Ingest run duration |
funkarr_feed_entries | Gauge | Releases currently in the feed |
Scoring (FunkArr.Scoring)
| Metric | Type | Description |
|---|---|---|
funkarr_scoring_accepted_total | Counter | Accepted results (tag: ruleSetId) |
funkarr_scoring_rejected_total | Counter | Rejected results (tag: ruleSetId) |
funkarr_scoring_duration_seconds | Histogram | Scoring duration |
funkarr_scoring_runs_total | Counter | Scoring invocations |
funkarr_scoring_regex_timeouts_total | Counter | Regex match timeouts |
funkarr_scoring_no_config_total | Counter | Requests with no matching config |
Enrichment (FunkArr.Enrichment)
| Metric | Type | Description |
|---|---|---|
funkarr_enrichment_requests_total | Counter | Enrichment requests (tags: api = tmdb/tvdb, status = hit/miss) |
funkarr_enrichment_failed_total | Counter | Enrichment failures (tag: api) |
funkarr_enrichment_duration_seconds | Histogram | API call duration (tag: api) |
funkarr_enrichment_items_enriched_total | Counter | Items enriched (tag: api) |
funkarr_enrichment_cache_entries | Gauge | Current cache entries |
funkarr_enrichment_cache_hits_total | Counter | Cache hits |
funkarr_enrichment_cache_misses_total | Counter | Cache misses |
History (FunkArr.History)
| Metric | Type | Description |
|---|---|---|
funkarr_history_recordings_total | Counter | Scoring history recordings |
funkarr_history_trimmed_total | Counter | Old entries trimmed |
funkarr_history_queries_total | Counter | History queries served (tag: type) |
RuleSet (FunkArr.RuleSet)
| Metric | Type | Description |
|---|---|---|
funkarr_ruleset_loaded_total | Counter | Rulesets loaded (tag: source) |
funkarr_ruleset_removed_total | Counter | Rulesets removed |
funkarr_ruleset_active | Gauge | Active ruleset count |
funkarr_ruleset_update_checks_total | Counter | Community update checks |
funkarr_ruleset_updates_applied_total | Counter | Community updates applied |
funkarr_ruleset_update_errors_total | Counter | Community update errors |
funkarr_ruleset_validation_errors_total | Counter | Ruleset validation errors |
funkarr_ruleset_scans_total | Counter | Scan/rescan invocations |
funkarr_ruleset_file_events_total | Counter | Filesystem watcher events (tag: type) |
Standard metrics
ASP.NET Core HTTP metrics and .NET runtime metrics (CPU, memory, GC, threads) are exported under their standard OpenTelemetry names. Distinguish from other .NET services via the Prometheus job label in the scrape configuration.
Configuration
The /metrics endpoint is always active and requires no configuration. It is available at http://<host>:6969/metrics. Metric names are exported in Prometheus format (dots become underscores, e.g. funkarr.download.queue_size becomes funkarr_download_queue_size).
Health checks
/healthz runs these checks:
| Check | Failure status |
|---|---|
data-directory, complete-directory, incomplete-directory (must be writable) | Unhealthy (503) |
ffmpeg (found on PATH) | Unhealthy (503) |
mediathekviewweb (reachable, 3 s timeout) | Degraded (still 200) |
/alive is a plain liveness probe and always returns 200.
Prometheus scrape configuration
scrape_configs:
- job_name: funkarr
static_configs:
- targets: ['funkarr:6969']Grafana
The metrics can be visualized directly in Grafana. Example queries:
- Queue depth:
funkarr_download_queue_size - Download rate:
rate(funkarr_download_completed_total[5m]) - Search success rate:
rate(funkarr_search_matches_total[5m]) / rate(funkarr_search_requests_total[5m]) - Scoring duration (p95):
histogram_quantile(0.95, rate(funkarr_scoring_duration_seconds_bucket[5m])) - Subtitle failure rate:
rate(funkarr_download_subtitle_total{status="failed"}[5m]) - MediathekViewWeb cache hit rate:
rate(funkarr_search_mediathek_cache_hits_total[5m]) / (rate(funkarr_search_mediathek_cache_hits_total[5m]) + rate(funkarr_search_mediathek_cache_misses_total[5m])) - Enrichment cache hit rate:
rate(funkarr_enrichment_requests_total{status="hit"}[5m]) / rate(funkarr_enrichment_requests_total[5m]) - Active rulesets:
funkarr_ruleset_active - Download retry rate:
rate(funkarr_download_retries_total[5m])