Skip to content

docs: Add histogram latency metrics documentation and test patterns #8675

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zbennett10 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add histogram latency metrics documentation and test patterns #8675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions docs/user_guide/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
# Copyright 2018-2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# Copyright 2018-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
Expand Down Expand Up @@ -218,6 +218,11 @@ metrics are used for latencies:
|Category |Metric |Metric Name |Description |Granularity|Frequency |
|--------------|----------------|------------|---------------------------|-----------|-------------|
|Latency |Request to First Response Time |`nv_inference_first_response_histogram_ms` |Histogram of end-to-end inference request to the first response time |Per model |Per request |
| |Request Time |`nv_inference_request_duration_histogram_us` |Histogram of end-to-end inference request duration (includes cached requests) |Per model |Per request |
| |Queue Time |`nv_inference_queue_duration_histogram_us` |Histogram of time requests spend waiting in the scheduling queue |Per model |Per request |
| |Compute Input Time|`nv_inference_compute_input_duration_histogram_us` |Histogram of time requests spend processing inference inputs |Per model |Per request |
| |Compute Time |`nv_inference_compute_infer_duration_histogram_us` |Histogram of time requests spend executing the inference model |Per model |Per request |
| |Compute Output Time|`nv_inference_compute_output_duration_histogram_us` |Histogram of time requests spend processing inference outputs |Per model |Per request |

To enable these metrics specifically, you can set `--metrics-config histogram_latencies=true`

Expand Down Expand Up @@ -265,7 +270,12 @@ model_metrics {

Currently, the following histogram families support custom buckets.
```
nv_inference_first_response_histogram_ms // Time to First Response
nv_inference_first_response_histogram_ms // Time to First Response (ms)
nv_inference_request_duration_histogram_us // Request Duration (us)
nv_inference_queue_duration_histogram_us // Queue Duration (us)
nv_inference_compute_input_duration_histogram_us // Compute Input Duration (us)
nv_inference_compute_infer_duration_histogram_us // Compute Infer Duration (us)
nv_inference_compute_output_duration_histogram_us // Compute Output Duration (us)
```

#### Summaries
Expand Down
11 changes: 9 additions & 2 deletions qa/L0_metrics/metrics_config_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/usr/bin/python
# Copyright 2023-2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# Copyright 2023-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
Expand Down Expand Up @@ -44,7 +44,14 @@
"nv_inference_compute_infer_duration",
"nv_inference_compute_output_duration",
]
INF_HISTOGRAM_PATTERNS = ["nv_inference_first_response_histogram_ms"]
INF_HISTOGRAM_PATTERNS = [
"nv_inference_first_response_histogram_ms",
"nv_inference_request_duration_histogram_us",
"nv_inference_queue_duration_histogram_us",
"nv_inference_compute_input_duration_histogram_us",
"nv_inference_compute_infer_duration_histogram_us",
"nv_inference_compute_output_duration_histogram_us",
]
INF_SUMMARY_PATTERNS = [
"nv_inference_request_summary",
"nv_inference_queue_summary",
Expand Down