Auth0 API metrics
The API Metrics page shows how much API traffic an Auth0 tenant handles, how much of it succeeds and how close the tenant runs to its rate limits. The data comes from an Auth0 Metric Stream, which is separate from the log stream that carries events.
What you need
Section titled “What you need”- An Auth0 tenant connected to Identiguard. See Connect Auth0.
- An Auth0 plan that supports Metric Streams. This is typically an Enterprise plan. Confirm it with the client before you start.
- The admin role in the workspace to set up the stream. Every role, including viewer, can open the page and read the charts.
- Access to the Auth0 dashboard, to create the stream under Monitoring → Streams.
The metric stream has its own endpoint and its own secret. It does not use the log stream token. Auth0’s Terraform provider does not support metric streams, so you always create this stream by hand in Auth0.
Open the page
Section titled “Open the page”- Open Tenants.
- In Tenant overview, find the Auth0 tenant.
- Choose the line-chart icon (tooltip API Metrics) on its row. Only Auth0 rows have this icon.
The page title is API Metrics, with the tenant name and “Auth0 API request volume and response type from the OTLP metric stream.”
If the tenant has no metric stream yet, the page shows the card Enable the Auth0 Metric Stream in place of the charts.
Set up a metric stream on a new tenant
Section titled “Set up a metric stream on a new tenant”- On the Add New Auth0 Tenant form, tick Set up a metric stream now in the Metric stream section.
- Choose Create Auth0 Tenant.
- On the setup screen, find the Metric stream panel. Copy the OTLP endpoint URL and the Bearer token (shown once).
- In Auth0, go to Monitoring → Streams → Create Stream and choose Metric Stream of type HTTP.
- Paste the OTLP endpoint URL.
- Choose Bearer Token as the authentication method and paste the token.
- Save the stream.
Set up a metric stream on an existing tenant
Section titled “Set up a metric stream on an existing tenant”The setup is on the API Metrics page. It is not on the tenant’s Edit page.
- Open Tenants and choose the line-chart icon (API Metrics) on the Auth0 row.
- On the card Enable the Auth0 Metric Stream, choose Generate endpoint. Only admins can do this. Other roles see the button disabled, with the tooltip “Admin access required to generate a metric-stream endpoint”.
- The card shows the warning “Shown once - copy these now. The header secret cannot be retrieved again after you leave this page.”
- Copy the Endpoint URL and the Header secret with their Copy buttons. Header name is shown for reference.
- In Auth0, follow the steps under Manual setup in Auth0:
- Go to Monitoring → Streams → New Metric Stream.
- Choose type HTTP.
- Paste the endpoint URL as the OTLP endpoint.
- Choose Bearer Token as the authentication method and paste the header secret as the token. Paste the secret only.
- Back in Identiguard, choose Continue to metrics. The secret is now gone from the screen for good.
- Watch the Stream status tile. It changes from “nothing received yet” to Active when Auth0 delivers the first metrics.
The controls
Section titled “The controls”| Control | What it does |
|---|---|
| Range buttons 5m, 15m, 1h, 24h, 7d, 30d, 90d | Set the time window for every card. The default is 24h. |
| Seven filter menus: API, Operation, Failure code, Client ID, Connection ID, Country code, Grant type | Narrow every card to one value. Each starts at All. |
| Updated Ns ago or Updated <time> | When the data was last loaded |
| Refresh icon (Refresh metrics) | Loads the data again now |
The range menu
Section titled “The range menu”The range also sets how fine the charts are.
| Range | One point on the chart is | Notes |
|---|---|---|
| 5m, 15m | One second | Live view. The page refreshes by itself every 10 seconds while the browser tab is visible. Filters are not available. |
| 1h, 24h | One minute | |
| 7d, 30d | One hour | |
| 90d | One day |
On 5m and 15m the filter menus are disabled, with the note “Dimension filters aren’t available on 5m/15m - per-second data can’t be filtered by dimension. Switch to 1h or a longer range to filter.”
When some older data cannot be read with the filters you chose, the page says: “Some older history in this range could not be read with the current filters and was omitted from the charts below (never fabricated).” The charts then show less history than the range. Clear the filters or choose a shorter range.
The cards
Section titled “The cards”The cards appear in this order.
Summary tiles
Section titled “Summary tiles”| Tile | What it shows |
|---|---|
| Requests (<range>) | Total API requests in the range. The hint shows “N not succeeded”. |
| Success rate | The share of requests that succeeded, “across the selected range and filters”. It turns red below 90%. It reads No traffic when there were no requests. |
| Max RPS | The “busiest single second in range”, in requests per second |
| Avg RPS | The “average across the range”, in requests per second |
| Rate limited | The number of requests Auth0 refused with a 429 response in the range |
| Stream status | Active, or Stale in red. The hint shows “last received <time>” or “nothing received yet”. |
Stale means the metric stream is enabled but Identiguard has received nothing for more than 15 minutes, or has never received anything.
Max RPS and Avg RPS depend on per-second data, which Identiguard keeps from the moment the stream first delivers. Before that, they read Not available with “per-second history begins at the point of capture”. When per-second data covers only part of the range, the hint reads “measured over the last X of this Y range”.
Sustained request rate
Section titled “Sustained request rate”“How long traffic in the last <range> ran above each rate threshold, second-accurate.”
Four tiles: >100 rps, >300 rps, >400 rps and >500 rps. Each shows a length of time. For example, 2 minutes under >300 rps means that for 120 separate seconds in the range the tenant handled more than 300 requests per second.
Use this card to compare real traffic with the tenant’s Auth0 rate limit. It answers “how long were we above the limit”, which an average hides.
API requests
Section titled “API requests”Stacked bars, one bar per time step. Each bar is split by response type:
- Succeeded
- Rate limited
- Client or server error
- Anomaly detection
- Any other failure code
On 5m and 15m the split is simpler: Succeeded, Rate limited and Failed. Per-second data does not keep the difference between error types.
Requests per second
Section titled “Requests per second”A line chart: “Bucket-average request rate, same window as the chart above - not the true instantaneous peak (see the sustained-rate card for that).”
Each point is the average rate over one time step. On 24h, one point is the average over a minute, so a short burst looks smaller here than it was. For the true peak, read Max RPS and Sustained request rate.
Response type
Section titled “Response type”A ring chart beside the line chart: “Share of requests by response type across the selected range and filters.” The centre shows Total requests.
Per-stream request rate
Section titled “Per-stream request rate”A table: “Requests, success rate and sustained rate for every Auth0 stream in the last <range>.”
Columns: Stream, Requests, Success %, Max RPS, Avg RPS, >100, >300, >400, >500 and Trend (a small line chart). On a single tenant’s page the table has one row.
Traffic by
Section titled “Traffic by”A chart with a switch: App, Path, Country or Grant type. The title follows the switch, for example Traffic by App. It shows “Succeeded, rate-limited and failed requests by <dimension> in the last <range>, top 10 shown”.
- App groups by the Auth0 client ID. Use it to find which application causes the traffic.
- Path groups by API operation.
- Country groups by country code.
- Grant type groups by OAuth grant type. Only token requests carry a grant type, so most traffic has none.
Top rate-limited operations
Section titled “Top rate-limited operations”“Which Auth0 API operations were throttled (429) the most in the last <range>.” Columns: Operation, % rate limited, Events, Rate limited. Top 10.
Busiest API operations
Section titled “Busiest API operations”“The 10 Auth0 API operations that carried the most requests in the last <range>.” Columns: Operation, Requests, % of range, Failed, % failed.
Failures by API operation
Section titled “Failures by API operation”“Which Auth0 API operations carried failure codes in the last <range>.” Columns: Operation, % failed, Events, Failed.
Read the page in five steps
Section titled “Read the page in five steps”- Choose a range. Use 24h for a daily check, and 5m or 15m to watch an incident live.
- Read Success rate and Rate limited. A red success rate or a rate-limited count above zero needs a closer look.
- Read Sustained request rate and compare it with the tenant’s Auth0 rate limit.
- Use Top rate-limited operations and Failures by API operation to find the operation.
- Switch Traffic by to App to find the client. Then narrow every card with the filter menus, on 1h or a longer range.
Empty states
Section titled “Empty states”| What you see | Meaning |
|---|---|
| Card Enable the Auth0 Metric Stream | The tenant has no metric stream yet |
| No traffic in range | A card has no requests in the window |
| No traffic on Success rate | No requests, so no rate can be worked out |
| No Auth0 streams configured | No stream to measure |
| Not available | No per-second data for the range yet |
| “Metrics unavailable - the metrics query did not answer.” | The data could not be loaded |
On the dashboard
Section titled “On the dashboard”The Dashboard has a card Auth0 API metrics: “API request volume and response type from every Auth0 tenant’s metric stream, combined”. It appears when the workspace has at least one Auth0 tenant, even when none has a metric stream.
It is the same panel for all Auth0 tenants together, with two differences:
- The last tile is Streams reporting, shown as N of M. The hint reads “all streams receiving data”, “stale: <names>” or “not enabled: <names>”.
- An extra card Response type by stream shows “Succeeded, rate-limited and failed requests per Auth0 stream in the selected range”.
With more than one stream, Max RPS is the peak of the busiest single stream. It is not a peak across all streams added together.
Troubleshooting
Section titled “Troubleshooting”Setting up
Section titled “Setting up”| What you see | Why | What to do |
|---|---|---|
| Card Enable the Auth0 Metric Stream in place of charts | The metric stream is not enabled for this tenant | An admin chooses Generate endpoint and creates the stream in Auth0. |
| Generate endpoint is disabled, with “Admin access required to generate a metric-stream endpoint” | Your role is member or viewer | Ask a workspace admin. |
| “Failed to enable the metric stream (<status>).” or “Network error while generating the endpoint.” | The request failed | Try again. |
| “Metric stream is already enabled for this tenant. Pass {“rotate”:true} to generate a new secret.” | The endpoint was already generated, for example in another browser tab | Reload the page. The secret cannot be shown again and there is no button to issue a new one. If the secret is lost, contact the product team. |
| You cannot find Metric Streams in the Auth0 dashboard | The client’s Auth0 plan does not include them | Confirm the plan with the client. Without it this feature cannot be used. |
Reading the page
Section titled “Reading the page”| What you see | Why | What to do |
|---|---|---|
| Stream status is Stale, or reads “nothing received yet” | Auth0 is not delivering. The stream was not created, the endpoint is wrong, the secret is wrong, or the word Bearer was typed in front of the secret. |
In Auth0, open the metric stream. Check the type is HTTP, the authentication is Bearer Token, and the token is the secret only. |
| Not available with “per-second history begins at the point of capture” | No per-second data exists for this range yet | Wait. Data starts when the stream first delivers. |
| “measured over the last X of this Y range” | Per-second data covers only part of the range | For information. Choose a shorter range for full coverage. |
| “Dimension filters aren’t available on 5m/15m - per-second data can’t be filtered by dimension. Switch to 1h or a longer range to filter.” | Per-second data cannot be filtered | Choose 1h or longer. |
| “Some older history in this range could not be read with the current filters and was omitted from the charts below (never fabricated).” | Older stored data does not hold that filter’s detail | Clear the filters, or choose a shorter range. |
| “Metrics unavailable - the metrics query did not answer.” | The data could not be loaded | Choose the refresh icon. Escalate if it continues. |
| No traffic in range, No traffic or No Auth0 streams configured | Nothing was received in the window | Choose a longer range. Check Stream status. |
| Most rows show no grant type | Only token requests carry a grant type | Nothing. This is normal. |
| Dashboard tile Streams reporting shows 0 of N with “not enabled: <names>” | Those Auth0 tenants have no metric stream | Set one up, or ignore the card. |
| Dashboard tile Streams reporting shows “stale: <names>” | Those streams have delivered nothing for more than 15 minutes | Open that tenant’s API Metrics page and check the stream in Auth0. |