View metrics Stay organized with collections Save and categorize content based on your preferences.
This topic explains how to view Apigee hybrid metrics in aStackdriver dashboard.
About Stackdriver
For more information about metrics, dashboards, andStackdriver see:
Enabling hybrid metrics
Before hybrid metrics can be sent toStackdriver,you must first enable metrics collection. SeeConfigure metrics collectionfor this procedure.
About hybrid metric names and labels
When enabled, hybrid automatically populates Stackdriver metrics. The domain name prefixof the metrics created by hybrid is:
apigee.googleapis.com/
For example, the/proxy/request_count metric contains the total number of requests receivedby an API proxy. The metric name in Stackdriver is therefore:
apigee.googleapis.com/proxy/request_count
Stackdriver lets youfilterandgroupmetrics data based on labels. Some labels are predefined, and others are added explicitly by hybrid.TheAvailable metrics section below lists all of the available hybridmetrics and any labels added specifically for a metric that you can use for filtering and grouping.
Viewing metrics
The following example shows how to view metrics in Stackdriver:- Open theMonitoring Metrics Explorer in a browser. Alternatively, if you're already in the Stackdriver console, selectMetrics explorer.
InFind resource type and metric, locate and select the metric you want to examine. Choose a specific metric listed inAvailable metrics, or search for a metric. For example, search for
proxy/latencies:
- Select the desired metric.
- Apply filters. Filter choices for each metric are listed inAvailable metrics. For example, for the
proxy_latenciesmetric, filter choices are:org=org_name. - Stackdriver displays the chart for the selected metric.
- ClickSave.
Creating a dashboard
Dashboardsare one way for you to view and analyze metric data that is important to you.Stackdriver provides predefined dashboards for the resources and services that you use,and you can also create custom dashboards.
You use achartto display an Apigee metric in your custom dashboard. With custom dashboards, you have complete controlover the charts that are displayed and their configuration. For more information on creating charts, seeCreating charts.
The following example shows how to create a dashboard in Stackdriver and then to add charts to view metrics data:
- Open theMonitoring Metrics Explorer in a browser and then selectDashboards.
- Select+ Create Dashboard.
- Give the dashboard a name. For example:Hybrid Proxy Request Traffic
- ClickConfirm.
For each chart that you want to add to your dashboard, follow these steps:
- In the dashboard, selectAdd chart.
- Select the desired metric as described above inViewing metrics.
- Complete the dialog to define your chart.
- ClickSave. Stackdriver displays data for the selected metric.
Available metrics
The following tables list metrics for analyzing proxy traffic.
Proxy, target, and server traffic metrics
ThePrometheus service collectsand processes metrics (as described inMetrics collection) forproxy, target, and server traffic.
The following table describes the metrics and labels that Prometheus uses.These labels are used in the metrics log entries.
| Metric name | Label | Use |
|---|---|---|
/proxy/request_count | method | The total number of API proxy requests received. |
/proxy/response_count | methodresponse_code | The total number of API proxy responses received. |
/proxy/latencies | method | Total number of milliseconds it took to respond to a call. This time includes the Apigee API proxy overhead and your target server time. |
/target/request_count | method
| The total number of requests sent to the proxy's target. |
/target/response_count | method
| The total number of responses received from the proxy's target. |
/target/latencies | method
| Total number of milliseconds it took to respond to a call. This time does not include the Apigee API proxy overhead. |
/policy/latencies | policy_name | The total number of milliseconds that this named policy took to execute. |
/server/fault_count | source | The total number of faults for the server application. For example, the application could be |
/server/nio | state | The number of open sockets. |
/server/num_threads | The number of active non-daemon threads in the server. | |
/server/request_count | method
| The total number of requests received by the server application. For example, the application could be |
/server/response_count | method
| Total number of responses sent by the server application. For example, the application could be |
/server/latencies | method
| Latency is the latency in millisecs introduced by the server application. For example, the application could be |
/upstream/request_count | method
| The number of requests sent by the server application to its upstream application. For example, for the |
/upstream/response_count | method
| The number of responses received by the server application from its upstream application. For example, for the |
/upstream/latencies | method
| The latency incurred at the upstream server application in milliseconds. For example, for the |
UDCA metrics
ThePrometheus service collectsand processes metrics (as described inMetrics collection) for theUDCA service just as it does for other hybrid services.
The following table describes the metrics and labels that Prometheus uses in theUDCA metrics data. These labels are used in the metrics log entries.
| Metric name | Label | Use |
|---|---|---|
/udca/server/local_file_oldest_ts | dataset
| The timestamp, in milliseconds since the start of the Unix Epoch, for the oldest file in the dataset. This is computed every 60 seconds and does not reflect the state in real time. If the UDCA is up to date and there are no files waiting to be uploaded when this metric is computed, then this value will be 0. If this value keeps increasing, then old files are still on disk. |
/udca/server/local_file_latest_ts | dataset
| The timestamp, in milliseconds since the start of the Unix Epoch, for the latest file on disk by state. This is computed every 60 seconds and does not reflect the state in real time. If the UDCA is up to date and there are no files waiting to be uploaded when this metric is computed, then this value will be 0. |
/udca/server/local_file_count | dataset
| A count of the number of files on disk in the data collection pod. Ideally, the value will be close to 0. A consistent high value indicates that files are not being uploaded or that the UDCA is not able to upload them fast enough. This value is computed every 60 seconds and does not reflect the state of the UDCA in real time. |
/udca/server/total_latencies | dataset | The time interval, in seconds, between the data file being created and the data file being successfully uploaded. Buckets will be 100ms, 250ms, 500ms, 1s, 2s, 4s, 8s, 16s, 32s, and 64s. Histogram for total latency from file creation time to successful upload time. |
/udca/server/upload_latencies | dataset | The total time, in seconds, that UDCA spent uploading a data file. Buckets will be 100ms, 250ms, 500ms, 1s, 2s, 4s, 8s, 16s, 32s, and 64s. The metrics will display a histogram for total upload latency, including all upstream calls. |
/udca/upstream/http_error_count | service
| The total count of HTTP errors that UDCA encountered. This metric is useful to help determine which part of the UDCA external dependencies are failing and for what reason. These errors can arise for various services ( |
/udca/upstream/http_latencies | service
| The upstream latency of services, in seconds. Buckets will be 100ms, 250ms, 500ms, 1s, 2s, 4s, 8s, 16s, 32s, and 64s. Histogram for latency from upstream services. |
/udca/upstream/uploaded_file_sizes | dataset | The size of the file being uploaded to the Apigee services, in bytes. Buckets will be 1KB, 10KB, 100KB, 1MB, 10MB, 100MB, and 1GB. Histogram for file size by dataset, organization and environment. |
/udca/upstream/uploaded_file_count | dataset | A count of the files that UDCA uploaded to the Apigee services. Note that:
|
/udca/disk/used_bytes | dataset
| The space occupied by the data files on the data collection pod's disk, in bytes. An increase in this value over time:
|
/udca/server/pruned_file_count | dataset
| Count of files which have been deleted because their Time To Life (TTL) was beyond a set threshold. The dataset can include API, trace, and others, and state can beUPLOADED,FAILED, orDISCARDED. |
/udca/server/retry_cache_size | dataset | A count of the number of files, by dataset, that UDCA is retrying to upload. After 3 retries for each file, UDCA moves the file to the |
Cassandra metrics
ThePrometheus service collectsand processes metrics (as described inMetrics collection) forCassandra just as it does for other hybrid services.
The following table describes the metrics and labels that Prometheus uses in theCassandra metrics data. These labels are used in the metrics log entries.
| Metric name (excluding domain) | Label | Use |
|---|---|---|
/cassandra/process_max_fds | Maximum number of open file descriptors. | |
/cassandra/process_open_fds | Open file descriptors. | |
/cassandra/jvm_memory_pool_bytes_max | pool | JVM maximum memory usage for the pool. |
/cassandra/jvm_memory_pool_bytes_init | pol | JVM initial memory usage for the pool. |
/cassandra/jvm_memory_bytes_max | area | JVM heap maximum memory usage. |
/cassandra/process_cpu_seconds_total | User and system CPU time spent in seconds. | |
/cassandra/jvm_memory_bytes_used | area | JVM heap memory usage. |
/cassandra/compaction_pendingtasks | unit | Outstanding compactions for Cassandra sstables. SeeCompaction for more. |
/cassandra/jvm_memory_bytes_init | area | JVM heap initial memory usage. |
/cassandra/jvm_memory_pool_bytes_used | pool | JVM pool memory usage. |
/cassandra/jvm_memory_pool_bytes_committed | pool | JVM pool committed memory usage. |
/cassandra/clientrequest_latency | scope
| Read request latency in the 75th percentile range in microseconds. |
/cassandra/jvm_memory_bytes_committed | area | JVM heap committed memory usage. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-02-18 UTC.