From ac0ca624c435945abe61aaf37da218557a4a7610 Mon Sep 17 00:00:00 2001 From: harish-berri Date: Thu, 30 Apr 2026 22:54:57 +0000 Subject: [PATCH] docs(proxy): add Grafana Cloud Pyroscope user and API token configuration options --- docs/proxy/config_settings.md | 2 ++ docs/proxy/pyroscope_profiling.md | 14 ++++++++++++++ 2 files changed, 16 insertions(+) diff --git a/docs/proxy/config_settings.md b/docs/proxy/config_settings.md index e80c40ac4..565ba4991 100644 --- a/docs/proxy/config_settings.md +++ b/docs/proxy/config_settings.md @@ -863,6 +863,8 @@ router_settings: | PYROSCOPE_APP_NAME | Application name reported to Pyroscope. Required when LITELLM_ENABLE_PYROSCOPE is true. No default. | PYROSCOPE_SERVER_ADDRESS | Pyroscope server URL to send profiles to. Required when LITELLM_ENABLE_PYROSCOPE is true. No default. | PYROSCOPE_SAMPLE_RATE | Optional. Sample rate for Pyroscope profiling (integer). No default; when unset, the pyroscope-io library default is used. +| PYROSCOPE_GRAFANA_USER | Optional. Grafana Cloud Pyroscope user/tenant ID for basic auth. Required when PYROSCOPE_GRAFANA_API_TOKEN is set. +| PYROSCOPE_GRAFANA_API_TOKEN | Optional. Grafana Cloud API/access policy token for Pyroscope basic auth. Required when PYROSCOPE_GRAFANA_USER is set. | LITELLM_MASTER_KEY | Master key for proxy authentication | LITELLM_MAX_BUDGET_PER_SESSION_TTL | TTL in seconds for session budget counters used by the max-budget-per-session limiter. Default is 3600 (1 hour) | LITELLM_MAX_ITERATIONS_TTL | TTL in seconds for session iteration counters used by the max-iterations limiter. Default is 3600 (1 hour) diff --git a/docs/proxy/pyroscope_profiling.md b/docs/proxy/pyroscope_profiling.md index 19d12ba24..ab6367903 100644 --- a/docs/proxy/pyroscope_profiling.md +++ b/docs/proxy/pyroscope_profiling.md @@ -24,6 +24,8 @@ LiteLLM proxy can send continuous CPU profiles to [Grafana Pyroscope](https://gr | `PYROSCOPE_APP_NAME` | Yes (when enabled) | Application name shown in the Pyroscope UI. | | `PYROSCOPE_SERVER_ADDRESS` | Yes (when enabled) | Pyroscope server URL (e.g. `http://localhost:4040`). | | `PYROSCOPE_SAMPLE_RATE` | No | Sample rate (integer). If unset, the pyroscope-io library default is used. | + | `PYROSCOPE_GRAFANA_USER` | No | Grafana Cloud Pyroscope user/tenant ID. Required when `PYROSCOPE_GRAFANA_API_TOKEN` is set. | + | `PYROSCOPE_GRAFANA_API_TOKEN` | No | Grafana Cloud API/access policy token. Used as the Pyroscope basic auth password. | 3. **Start the proxy**; profiling will begin automatically when the proxy starts. @@ -34,6 +36,18 @@ LiteLLM proxy can send continuous CPU profiles to [Grafana Pyroscope](https://gr litellm --config config.yaml ``` + For Grafana Cloud Pyroscope, use the Profiles endpoint as `PYROSCOPE_SERVER_ADDRESS` + and set the Grafana Cloud credentials: + + ```bash + export LITELLM_ENABLE_PYROSCOPE=true + export PYROSCOPE_APP_NAME=litellm-proxy + export PYROSCOPE_SERVER_ADDRESS=https://profiles-prod-.grafana.net + export PYROSCOPE_GRAFANA_USER= + export PYROSCOPE_GRAFANA_API_TOKEN= + litellm --config config.yaml + ``` + 4. **View profiles** in the Pyroscope (or Grafana) UI and select your `PYROSCOPE_APP_NAME`. ## Notes