PDN Node Metrics

JFrog REST APIs

ft:sourceType
Paligo

Description: Gets the metrics for the PDN Node.

Since: 1.0.1

Security: Basic authorization (credentials are retrieved from the system.yaml).

Usage: GET /api/v1/metrics

Authorization: N/A

Content-Type: application/x-www-form-urlencoded

Example: Here is an example of the PDN Node metrics; a full list can be obtained by accessing the endpoint.

# NAME app_files_served 
# TYPE Gauge
# HELP Total number of files served by the download service
#
# NAME app_download_speed
# TYPE Histogram
# HELP Download speed of each file, in MB/s
PDN Node Application Metrics

The following table details the Application metrics used in the PDN Node (available from release 1.6.2). For the full Application list, refer to the next section.

Name

Description

Type

app_bytes_fetched

Total number of bytes fetched by the PDN Node

counter

app_bytes_served

Total number of bytes served by the PDN Node

counter

app_cache_hit

Cache-hit for downloaded file

counter

app_cache_max_bytes

Maximum size of PDN Node cache, in bytes

gauge

app_cache_miss

Cache-miss for downloaded file

counter

app_cache_used_bytes

Total number of bytes stored in the PDN Node cache

gauge

app_cache_used_files

Number of files stored in the PDN Node cache

gauge

app_download_errors

Total number of downloads that finished with an error

counter

app_download_speed

Download speed of each file, in MB/s

histogram

app_files_fetched

Total number of files fetched by the PDN Node

counter

app_files_served

Total number of files served by the PDN Node

counter

app_grpc_client_request_cnt

Counts the GRPC requests

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_http_request_cnt Counts HTTP requests

Counts the HTTP requests

counter

app_http_request_duration_secs

Counts the HTTP request duration, in seconds

histogram

app_http_request_errors

Counts the HTTP requests with errors

counter

app_receive_piece_from_peer_duration_secs

Time elapsed receiving a piece of a file from a PDN Server or another PDN Node (peer)

histogram

app_request_duration_secs

Counts the GRPC request duration, in seconds

histogram

app_save_piece_to_file_duration_secs

Time elapsed saving a single piece of a file to PDN Node disk cache

histogram

app_save_piece_to_state_file_duration_secs

Time elapsed saving a single piece of a file to the state file

histogram

app_send_piece_to_client_duration_secs

Time elapsed sending a single piece of a file to the downloading client

histogram

Application Metrics (PDN Node)
# HELP app_bytes_fetched Total number of bytes fetched by the download service
# TYPE app_bytes_fetched counter
# HELP app_bytes_served Total number of bytes served by the download service
# TYPE app_bytes_served counter
# HELP app_cache_hit Cache-hit for downloaded file
# TYPE app_cache_hit counter
# HELP app_cache_max_bytes Maximum size of PDN Node cache, in bytes
# TYPE app_cache_max_bytes gauge
# HELP app_cache_max_files Maximum number of files in PDN Node cache
# TYPE app_cache_max_files gauge
# HELP app_cache_miss Cache-miss for downloaded file
# TYPE app_cache_miss counter
# HELP app_cache_used_bytes Total number of bytes stored in PDN Node cache
# TYPE app_cache_used_bytes gauge
# HELP app_cache_used_files Number of files stored in PDN Node cache
# TYPE app_cache_used_files gauge
# HELP app_download_errors Total number of downloads that finished with an error
# TYPE app_download_errors counter
# HELP app_download_speed Download speed of each file, in MB/s
# TYPE app_download_speed histogram
# HELP app_files_fetched Total number of files fetched by the download service
# TYPE app_files_fetched counter
# HELP app_files_served Total number of files served by the download service
# TYPE app_files_served counter
# HELP app_grpc_client_request_cnt Counts GRPC requests
# TYPE app_grpc_client_request_cnt counter
# HELP app_grpc_server_request_cnt Counts GRPC requests
# TYPE app_grpc_server_request_cnt counter
# HELP app_grpc_server_request_duration_secs Counts GRPC request duration, in seconds
# TYPE app_grpc_server_request_duration_secs histogram
# HELP app_http_request_cnt Counts HTTP requests
# TYPE app_http_request_cnt counter
# HELP app_http_request_duration_secs Counts HTTP request duration, in seconds
# TYPE app_http_request_duration_secs histogram
# HELP app_http_request_errors Counts HTTP requests with errors
# TYPE app_http_request_errors counter
# HELP app_receive_piece_from_peer_duration_secs Time elapsed receiving piece from peer
# TYPE app_receive_piece_from_peer_duration_secs histogram
# HELP app_request_duration_secs Counts GRPC request duration, in seconds
# TYPE app_request_duration_secs histogram
# HELP app_save_piece_to_file_duration_secs Time elapsed saving single piece to disk
# TYPE app_save_piece_to_file_duration_secs histogram
# HELP app_save_piece_to_state_file_duration_secs Time elapsed saving single piece to the state file
# TYPE app_save_piece_to_state_file_duration_secs histogram
# HELP app_send_piece_to_client_duration_secs Time elapsed sending a single piece to downloading client
# TYPE app_send_piece_to_client_duration_secs histogram
GO Metrics (PDN Node)
# 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