Description: Gets the metrics for the PDN Server.
Since: 1.0.1
Security: Requires a valid Scoped Token, which contains the Scope “system:metrics:r”.
Usage: GET /api/v1/metrics
Authorization: N/A
Content-Type: application/x-www-form-urlencoded
Example: Here is an example of the PDN Server metrics; a full list can be obtained by accessing the endpoint.
# NAME go_memstats_heap_alloc_bytes # TYPE Gauge # HELP Process go heap allocated bytes # # NAME app_get_block_duration_secs # TYPE Histogram # HELP Time to retrieve a cache-block from Artifactory, in seconds
PDN Server Application Metrics
The following table details the Application metrics used in the PDN Server (available from release 1.6.2). For the full list, refer to the next section.
Name | Description | Type |
|---|---|---|
app_cache_hit | Counts the cache-hit | counter |
app_cache_miss | Counts the cache-miss | counter |
app_get_block_duration_secs | Time to retrieve a cache-block from Artifactory, in seconds | histogram |
app_get_block_errors | Counts errors while retrieving a cache-block from Artifactory | counter |
app_grpc_server_request_cnt | Counts the GRPC requests | counter |
app_grpc_server_request_duration_secs | Counts the GRPC request duration, in seconds | histogram |
app_grpc_server_request_errors | Counts the GRPC requests with errors | counter |
app_http_request_cnt | Counts the HTTP requests | counter |
app_http_request_duration_secs | The HTTP request duration, in seconds | histogram |
app_http_request_errors | Counts the HTTP requests with errors | counter |
app_peers_available | Number of available PDN Nodes (peers) | gauge |
Application Metrics (PDN Server)
# HELP app_peers_available Number of available peers # TYPE app_peers_available gauge # HELP go_gc_duration_seconds A summary of the pause duration of garbage collection cycles. # TYPE go_gc_duration_seconds summary # HELP go_goroutines Number of goroutines that currently exist. # TYPE go_goroutines gauge # HELP go_info Information about the Go environment. # TYPE go_info gauge # HELP go_memstats_alloc_bytes Number of bytes allocated and still in use. # TYPE go_memstats_alloc_bytes gauge # HELP go_memstats_alloc_bytes_total Total number of bytes allocated, even if freed. # TYPE go_memstats_alloc_bytes_total counter # HELP go_memstats_buck_hash_sys_bytes Number of bytes used by the profiling bucket hash table. # TYPE go_memstats_buck_hash_sys_bytes gauge # HELP go_memstats_frees_total Total number of frees. # TYPE go_memstats_frees_total counter # HELP go_memstats_gc_sys_bytes Number of bytes used for garbage collection system metadata. # TYPE go_memstats_gc_sys_bytes gauge # HELP go_memstats_heap_alloc_bytes Number of heap bytes allocated and still in use. # TYPE go_memstats_heap_alloc_bytes gauge # HELP go_memstats_heap_idle_bytes Number of heap bytes waiting to be used. # TYPE go_memstats_heap_idle_bytes gauge # HELP go_memstats_heap_inuse_bytes Number of heap bytes that are in use. # TYPE go_memstats_heap_inuse_bytes gauge # HELP go_memstats_heap_objects Number of allocated objects. # TYPE go_memstats_heap_objects gauge # HELP go_memstats_heap_released_bytes Number of heap bytes released to OS. # TYPE go_memstats_heap_released_bytes gauge # HELP go_memstats_heap_sys_bytes Number of heap bytes obtained from system. # TYPE go_memstats_heap_sys_bytes gauge # HELP go_memstats_last_gc_time_seconds Number of seconds since 1970 of last garbage collection. # TYPE go_memstats_last_gc_time_seconds gauge # HELP go_memstats_lookups_total Total number of pointer lookups. # TYPE go_memstats_lookups_total counter # HELP go_memstats_mallocs_total Total number of mallocs. # TYPE go_memstats_mallocs_total counter # HELP go_memstats_mcache_inuse_bytes Number of bytes in use by mcache structures. # TYPE go_memstats_mcache_inuse_bytes gauge # HELP go_memstats_mcache_sys_bytes Number of bytes used for mcache structures obtained from system. # TYPE go_memstats_mcache_sys_bytes gauge # HELP go_memstats_mspan_inuse_bytes Number of bytes in use by mspan structures. # TYPE go_memstats_mspan_inuse_bytes gauge # HELP go_memstats_mspan_sys_bytes Number of bytes used for mspan structures obtained from system. # TYPE go_memstats_mspan_sys_bytes gauge # HELP go_memstats_next_gc_bytes Number of heap bytes when next garbage collection will take place. # TYPE go_memstats_next_gc_bytes gauge # HELP go_memstats_other_sys_bytes Number of bytes used for other system allocations. # TYPE go_memstats_other_sys_bytes gauge # HELP go_memstats_stack_inuse_bytes Number of bytes in use by the stack allocator. # TYPE go_memstats_stack_inuse_bytes gauge # HELP go_memstats_stack_sys_bytes Number of bytes obtained from system for stack allocator. # TYPE go_memstats_stack_sys_bytes gauge # HELP go_memstats_sys_bytes Number of bytes obtained from system. # TYPE go_memstats_sys_bytes gauge # HELP go_threads Number of OS threads created. # TYPE go_threads gauge # HELP promhttp_metric_handler_errors_total Total number of internal errors encountered by the promhttp metric handler. # TYPE promhttp_metric_handler_errors_total counter