diff --git a/docs/user_guide/metrics.md b/docs/user_guide/metrics.md index 7a272f1d3..33eb20f07 100644 --- a/docs/user_guide/metrics.md +++ b/docs/user_guide/metrics.md @@ -4,34 +4,40 @@ This doc contains all the metrics that Dragonfly components currently support. N ## Supernode -- dragonfly_supernode_build_info{version, revision, goversion, arch, os} - build and version information of supernode. -- dragonfly_supernode_http_requests_total{code, handler, method} - total number of http requests. -- dragonfly_supernode_http_request_duration_seconds{code, handler, method} - http request latency in seconds. -- dragonfly_supernode_http_request_size_bytes{code, handler, method} - http request size in bytes. -- dragonfly_supernode_http_response_size_bytes{code, handler, method} - http response size in bytes. -- dragonfly_supernode_peers{peer} - dragonfly peers, the label peer consists of the hostname and ip address of one peer. -- dragonfly_supernode_tasks{cdnstatus} - dragonfly tasks. -- dragonfly_supernode_tasks_registered_total{} - total times of registering new tasks. counter type. -- dragonfly_supernode_dfgettasks{callsystem, status} - dragonfly dfget tasks. -- dragonfly_supernode_dfgettasks_registered_total{callsystem} - total times of registering new dfgettasks. counter type. -- dragonfly_supernode_dfgettasks_failed_total{callsystem} - total times of failed dfgettasks. counter type. -- dragonfly_supernode_schedule_duration_milliseconds{peer} - duration for task scheduling in milliseconds. -- dragonfly_supernode_cdn_trigger_total{} - total times of triggering cdn. counter type. -- dragonfly_supernode_cdn_trigger_failed_total{} - total failed times of triggering cdn. counter type. -- dragonfly_supernode_cdn_cache_hit_total{} - total times of hitting cdn cache. counter type. -- dragonfly_supernode_cdn_download_total{} - total times of cdn downloading. counter type. -- dragonfly_supernode_cdn_download_failed_total{} - total failure times of cdn downloading. counter type. -- dragonfly_supernode_pieces_downloaded_size_bytes_total{} - total size of pieces downloaded from supernode in bytes. counter type. -- dragonfly_supernode_gc_peers_total{} - total number of peers that have been garbage collected. counter type. -- dragonfly_supernode_gc_tasks_total{} - total number of tasks that have been garbage collected. counter type. +Name | Labels | Type | Description +:----------------------------------------------------- | :--------------------------------------|:--------- | :---------- +dragonfly_supernode_build_info | version, revision, goversion, arch, os | gauge | Build and version information of supernode. +dragonfly_supernode_http_requests_total | code, handler, method | counter | Total number of http requests. +dragonfly_supernode_http_request_duration_seconds | code, handler, method | histogram | HTTP request latency in seconds. +dragonfly_supernode_http_request_size_bytes | code, handler, method | histogram | HTTP request size in bytes. +dragonfly_supernode_http_response_size_bytes | code, handler, method | histogram | HTTP response size in bytes. +dragonfly_supernode_peers | peer | gauge | Dragonfly peers, the label peer consists of the hostname and ip address of one peer. +dragonfly_supernode_tasks | cdnstatus | gauge | Dragonfly tasks. +dragonfly_supernode_tasks_registered_total | | counter | Total times of registering new tasks. +dragonfly_supernode_dfgettasks | callsystem, status | gauge | Dragonfly dfget tasks. +dragonfly_supernode_dfgettasks_registered_total | callsystem | counter | Total times of registering new dfgettasks. +dragonfly_supernode_dfgettasks_failed_total | callsystem | counter | Total times of failed dfgettasks. +dragonfly_supernode_schedule_duration_milliseconds | peer | histogram | Duration for task scheduling in milliseconds. +dragonfly_supernode_cdn_trigger_total | | counter | Total times of triggering cdn. +dragonfly_supernode_cdn_trigger_failed_total | | counter | Total failed times of triggering cdn. +dragonfly_supernode_cdn_cache_hit_total | | counter | Total times of hitting cdn cache. +dragonfly_supernode_cdn_download_total | | counter | Total times of cdn downloading. +dragonfly_supernode_cdn_download_failed_total | | counter | Total failure times of cdn downloading. +dragonfly_supernode_pieces_downloaded_size_bytes_total | | counter | Total size of pieces downloaded from supernode in bytes. +dragonfly_supernode_gc_peers_total | | counter | Total number of peers that have been garbage collected. +dragonfly_supernode_gc_tasks_total | | counter | Total number of tasks that have been garbage collected. ## Dfdaemon -- dragonfly_dfdaemon_build_info{version, revision, goversion, arch, os} - build and version information of dfdaemon. +Name | Labels | Type | Description +:---------------------------- | :------------------------------------- | :---- | :---------- +dragonfly_dfdaemon_build_info | version, revision, goversion, arch, os | gauge | Build and version information of dfdaemon. ## Dfget -- dragonfly_dfget_download_duration_seconds{callsystem, peer} - dfget download duration in seconds. -- dragonfly_dfget_download_size_bytes_total{callsystem, peer} - total size of files downloaded by dfget in bytes. counter type. -- dragonfly_dfget_download_total{callsystem, peer} - total times of dfget downloading. counter type. -- dragonfly_dfget_download_failed_total{callsystem, peer, reason} - total times of failed dfget downloading. counter type. +Name | Labels | Type | Description +:---------------------------------------- | :----------------------- | :-------- | :---------- +dragonfly_dfget_download_duration_seconds | callsystem, peer | histogram | Dfget download duration in seconds. +dragonfly_dfget_download_size_bytes_total | callsystem, peer | counter | Total size of files downloaded by dfget in bytes. +dragonfly_dfget_download_total | callsystem, peer | counter | Total times of dfget downloading. +dragonfly_dfget_download_failed_total | callsystem, peer, reason | counter | Total times of failed dfget downloading.