Skip to content

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) ​

MetricTypeDescription
funkarr_download_completed_totalCounterCompleted downloads
funkarr_download_failed_totalCounterFailed downloads (tag: reason)
funkarr_download_duration_secondsHistogramDownload (FFmpeg) duration (tag: status = completed/failed)
funkarr_download_bytes_totalCounterTotal bytes downloaded
funkarr_download_enqueued_totalCounterDownloads added to queue
funkarr_download_cancelled_totalCounterDownloads cancelled
funkarr_download_retries_totalCounterRetry attempts (tag: reason)
funkarr_download_move_failed_totalCounterFile move failures
funkarr_download_subtitle_totalCounterSubtitle preparation attempts (tags: status = succeeded/failed/unavailable, format)
funkarr_download_subtitle_duration_secondsHistogramSubtitle preparation duration
funkarr_download_queue_sizeGaugeCurrent queue depth
funkarr_download_activeGaugeCurrently active downloads
funkarr_download_pausedGaugeWhether downloads are paused (0/1)
funkarr_download_schedule_enabledGaugeWhether schedule is active (0/1)
MetricTypeDescription
funkarr_search_requests_totalCounterSearch requests (tag: source)
funkarr_search_matches_totalCounterSearches with accepted results (tag: source)
funkarr_search_no_match_totalCounterSearches with no accepted results (tag: source)
funkarr_search_duration_secondsHistogramEnd-to-end search duration (tags: source, type)
funkarr_search_timeouts_totalCounterSearch timeouts (tag: source)
funkarr_search_failed_totalCounterSearch failures (tag: source)
funkarr_search_mediathek_errors_totalCounterMediathekViewWeb API errors
funkarr_search_results_per_requestHistogramResult count distribution
funkarr_search_evaluations_totalCounterEvaluations run by the evaluation workers (tags: source, type, status)
funkarr_search_evaluation_duration_secondsHistogramEvaluation duration from ruleset resolution to releases (tags: source, type)
funkarr_search_mediathek_cache_hits_totalCounterMediathekViewWeb response cache hits
funkarr_search_mediathek_cache_misses_totalCounterMediathekViewWeb response cache misses

Feed (FunkArr.Feed) ​

MetricTypeDescription
funkarr_feed_crawls_totalCounterFeed ingest runs by outcome (tag: status)
funkarr_feed_probes_unchanged_totalCounterIngest runs that found no new Filmliste update
funkarr_feed_items_seen_totalCounterNew Mediathek entries collected by the ingest
funkarr_feed_unmatched_totalCounterNew entries without a matching ruleset
funkarr_feed_published_totalCounterReleases published to the feed
funkarr_feed_rejected_totalCounterReleases rejected by the feed gate (tag: reason; currently not populated)
funkarr_feed_gaps_totalCounterIngest runs that could not cover the whole window
funkarr_feed_crawl_duration_secondsHistogramIngest run duration
funkarr_feed_entriesGaugeReleases currently in the feed

Scoring (FunkArr.Scoring) ​

MetricTypeDescription
funkarr_scoring_accepted_totalCounterAccepted results (tag: ruleSetId)
funkarr_scoring_rejected_totalCounterRejected results (tag: ruleSetId)
funkarr_scoring_duration_secondsHistogramScoring duration
funkarr_scoring_runs_totalCounterScoring invocations
funkarr_scoring_regex_timeouts_totalCounterRegex match timeouts
funkarr_scoring_no_config_totalCounterRequests with no matching config

Enrichment (FunkArr.Enrichment) ​

MetricTypeDescription
funkarr_enrichment_requests_totalCounterEnrichment requests (tags: api = tmdb/tvdb, status = hit/miss)
funkarr_enrichment_failed_totalCounterEnrichment failures (tag: api)
funkarr_enrichment_duration_secondsHistogramAPI call duration (tag: api)
funkarr_enrichment_items_enriched_totalCounterItems enriched (tag: api)
funkarr_enrichment_cache_entriesGaugeCurrent cache entries
funkarr_enrichment_cache_hits_totalCounterCache hits
funkarr_enrichment_cache_misses_totalCounterCache misses

History (FunkArr.History) ​

MetricTypeDescription
funkarr_history_recordings_totalCounterScoring history recordings
funkarr_history_trimmed_totalCounterOld entries trimmed
funkarr_history_queries_totalCounterHistory queries served (tag: type)

RuleSet (FunkArr.RuleSet) ​

MetricTypeDescription
funkarr_ruleset_loaded_totalCounterRulesets loaded (tag: source)
funkarr_ruleset_removed_totalCounterRulesets removed
funkarr_ruleset_activeGaugeActive ruleset count
funkarr_ruleset_update_checks_totalCounterCommunity update checks
funkarr_ruleset_updates_applied_totalCounterCommunity updates applied
funkarr_ruleset_update_errors_totalCounterCommunity update errors
funkarr_ruleset_validation_errors_totalCounterRuleset validation errors
funkarr_ruleset_scans_totalCounterScan/rescan invocations
funkarr_ruleset_file_events_totalCounterFilesystem 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:

CheckFailure 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 ​

yaml
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])