Skip to main content
Rime services expose several endpoints for monitoring the health of a self-hosted deployment. Use them to inform scaling and performance decisions.

API container

The API container serves a /health route on port 8000 that reports overall status:
A typical response looks like this:
The response confirms that both the API and model services are up and responding.

Arcana container

Arcana’s cloud service is retiring on August 15, 2026. On-prem Arcana images stay available to pull and run, but stop receiving updates and support after that date, including vulnerability patches. See Migrate from Arcana to Coda for what changes if you move.

Healthcheck

To check if the model is running properly, you can perform a liveness probe using the /readyz endpoint:
A typical response looks like this:

Metrics

The model can emit OpenTelemetry metrics. The internal vLLM process also exposes a Prometheus /metrics endpoint. You can use either as a data source for metrics collection, tuning, and debugging.

OpenTelemetry metrics

The Rime engine exposes the following OpenTelemetry metrics:
  • rime.engine.concurrent_pipeline
  • rime.engine.generated_audio_duration
  • rime.engine.gpu_load
  • rime.engine.initial_latency
  • rime.engine.invocation_request
To have the model emit OpenTelemetry metrics, set two environment variables …
  • … set OTEL_COLLECTOR_PROTOCOL to grpc (recommended), http/protobuf, or http/json.
  • … provide a valid OpenTelemetry Collector endpoint (through OTEL_COLLECTOR_ENDPOINT).
e.g.;
The model does not set any resource attributes for these metrics. OTEL_RESOURCE_ATTRIBUTES may be used to define them. The model does not implement OpenTelemetry authentication. If you need authentication, run an OpenTelemetry Collector sidecar to forward the metrics.

Prometheus metrics

To retrieve vLLM Prometheus metrics, issue an HTTP request to http://localhost:${GENERATOR_VLLM_PORT:?}/metrics. By default, a random port is assigned to the vLLM server. To choose a fixed port (which would be convenient for forwarding these metrics, if desired), set the environment variable GENERATOR_VLLM_PORT to an available port number.

OpenTelemetry Collector sidecar

If you need authentication or other OpenTelemetry Collector extensions, use the contrib distribution that includes them.
You can run an OpenTelemetry Collector to forward both the OpenTelemetry and Prometheus metrics, or to retrieve the OpenTelemetry metrics locally. For example, Docker Compose can be used to run the model and an OpenTelemetry Collector …
… where otelcol/config.yaml would be the configuration file for the OpenTelemetry Collector.

Histogram tuning

Metrics that emit histogram data use pre-configured bucket boundaries. The Rime engine prescribes its own defaults for some metrics. These may also be configurable/tunable through the use of HISTOGRAM_BUCKETS_* environment variables. To separate differently-tuned sets of data across individual metrics, a suffix may be attached to the original metric name using HISTOGRAM_SUFFIX_* environment variables.
  • rime.engine.initial_latency
    • Measured in milliseconds.
    • Default bounds:
    • Set alternative bounds:
    • Set alternative metric name suffix:
      • HISTOGRAM_SUFFIX_INITIAL_LATENCY='tuned_120ms' produces a metric named rime.engine.initial_latency.tuned_120ms
  • rime.engine.generated_audio_duration
    • Measured in seconds.
    • Default bounds:
    • Set alternative bounds:
    • Set alternative metric name suffix:
      • HISTOGRAM_SUFFIX_GENERATED_AUDIO_DURATION='tuned_3s' produces a metric named rime.engine.generated_audio_duration.tuned_3s

Mist container

Healthcheck

To check if the model is running properly, use the /livez and /readyz probes on the engine HTTP port:
Current Mist images do not serve /ping. Use /livez for liveness and /readyz for readiness.

Metrics

Prometheus-compatible metrics are served by the generator, not on the engine HTTP port. Pin the port with GENERATOR_SERVICE_PORT on the model container and scrape it there:
See Prometheus for a complete scrape configuration. This endpoint provides telemetry data, including:
  • HTTP request counters: requests broken down by endpoint, status code, and HTTP method
  • Error tracking: counts of HTTP errors by type and status code
Example metrics include:
Scrape these metrics with Prometheus to build dashboards and alerts for your deployment.