Metrics
Metrics Introduction
Metrics in Taurus' system are provided with Prometheus, an open-source monitoring system with a dimensional data model, flexible query language, efficient time series database and modern alerting approach.
Taurus mainly uses Prometheus to collect and store metrics as time series data. This means that metrics information is stored with the timestamp at which it was recorded, alongside optional key-value pairs called labels.
In this page, we will explain the different metric families, with thorough explanations and detailed representations.
Metrics Family and Description
Go Metrics
| Metric Family | Metric Description |
|---|---|
| go_build_info | Build information about the main Go module. |
| go_gc_duration_seconds | A summary of the wall-time pause (stop-the-world) duration in garbage collection cycles. |
| go_gc_gogc_percent | Heap size target percentage configured by the user, otherwise 100. This value is set by the GOGC environment variable, and the runtime/debug.SetGCPercent function. Sourced from /gc/gogc:percent |
| go_gc_gomemlimit_bytes | Go runtime memory limit configured by the user, otherwise math.MaxInt64. This value is set by the GOMEMLIMIT environment variable, and the runtime/debug.SetMemoryLimit function. Sourced from /gc/gomemlimit:bytes |
| go_goroutines | Number of goroutines that currently exist. |
| go_info | Information about the Go environment. |
| go_memstats_alloc_bytes | Number of bytes allocated in heap and currently in use. Equals to /memory/classes/heap/objects:bytes. |
| go_memstats_alloc_bytes_total | Total number of bytes allocated in heap until now, even if released already. Equals to /gc/heap/allocs:bytes. |
| go_memstats_buck_hash_sys_bytes | Number of bytes used by the profiling bucket hash table. Equals to /memory/classes/profiling/buckets:bytes. |
| go_memstats_frees_total | Total number of heap objects frees. Equals to /gc/heap/frees:objects + /gc/heap/tiny/allocs:objects. |
| go_memstats_gc_sys_bytes | Number of bytes used for garbage collection system metadata. Equals to /memory/classes/metadata/other:bytes. |
| go_memstats_heap_alloc_bytes | Number of heap bytes allocated and currently in use, same as go_memstats_alloc_bytes. Equals to /memory/classes/heap/objects:bytes. |
| go_memstats_heap_idle_bytes | Number of heap bytes waiting to be used. Equals to /memory/classes/heap/released:bytes + /memory/classes/heap/free:bytes. |
| go_memstats_heap_inuse_bytes | Number of heap bytes that are in use. Equals to /memory/classes/heap/objects:bytes + /memory/classes/heap/unused:bytes. |
| go_memstats_heap_objects | Number of currently allocated objects. Equals to /gc/heap/objects:objects. |
| go_memstats_heap_released_bytes | Number of heap bytes released to OS. Equals to /memory/classes/heap/released:bytes. |
| go_memstats_heap_sys_bytes | Number of heap bytes obtained from system. Equals to /memory/classes/heap/objects:bytes + /memory/classes/heap/unused:bytes + /memory/classes/heap/released:bytes + /memory/classes/heap/free:bytes. |
| go_memstats_last_gc_time_seconds | Number of seconds since 1970 of last garbage collection. |
| go_memstats_mallocs_total | Total number of heap objects allocated, both live and gc-ed. Semantically a counter version for go_memstats_heap_objects gauge. Equals to /gc/heap/allocs:objects + /gc/heap/tiny/allocs:objects. |
| go_memstats_mcache_inuse_bytes | Number of bytes in use by mcache structures. Equals to /memory/classes/metadata/mcache/inuse:bytes. |
| go_memstats_mcache_sys_bytes | Number of bytes used for mcache structures obtained from system. Equals to /memory/classes/metadata/mcache/inuse:bytes + /memory/classes/metadata/mcache/free:bytes. |
| go_memstats_mspan_inuse_bytes | Number of bytes in use by mspan structures. Equals to /memory/classes/metadata/mspan/inuse:bytes. |
| go_memstats_mspan_sys_bytes | Number of bytes used for mspan structures obtained from system. Equals to /memory/classes/metadata/mspan/inuse:bytes + /memory/classes/metadata/mspan/free:bytes. |
| go_memstats_next_gc_bytes | Number of heap bytes when next garbage collection will take place. Equals to /gc/heap/goal:bytes. |
| go_memstats_other_sys_bytes | Number of bytes used for other system allocations. Equals to /memory/classes/other:bytes. |
| go_memstats_stack_inuse_bytes | Number of bytes obtained from system for stack allocator in non-CGO environments. Equals to /memory/classes/heap/stacks:bytes. |
| go_memstats_stack_sys_bytes | Number of bytes obtained from system for stack allocator. Equals to /memory/classes/heap/stacks:bytes + /memory/classes/os-stacks:bytes. |
| go_memstats_sys_bytes | Number of bytes obtained from system. Equals to /memory/classes/total:byte. |
| go_sched_gomaxprocs_threads | The current runtime.GOMAXPROCS setting, or the number of operating system threads that can execute user-level Go code simultaneously. Sourced from /sched/gomaxprocs:threads. |
| go_sql_idle_connections | The number of idle connections. |
| go_sql_in_use_connections | The number of connections currently in use. |
| go_sql_max_idle_closed_total | The total number of connections closed due to SetMaxIdleConns. |
| go_sql_max_idle_time_closed_total | The total number of connections closed due to SetConnMaxIdleTime. |
| go_sql_max_lifetime_closed_total | The total number of connections closed due to SetConnMaxLifetime. |
| go_sql_max_open_connections | Maximum number of open connections to the database. |
| go_sql_open_connections | The number of established connections both in use and idle. |
| go_sql_wait_count_total | The total number of connections waited for. |
| go_sql_wait_duration_seconds_total | The total time blocked waiting for a new connection. |
| go_threads | Number of OS threads created. |
GRPC Metrics
| Metric Family | Metric Description |
|---|---|
| grpc_server_handled_total | Total number of RPCs completed on the server, regardless of success or failure. |
| grpc_server_handling_seconds | Summary of response latency (seconds) of gRPC that had been application-level handled by the server. |
Taurus validatord metrics
| Metric Family | Metric Description |
|---|---|
| tg_validatord_cryptocompareClient_APICall_total | Total number of API calls by the cryptocompare client. |
| tg_validatord_database_request_timing_seconds | Time taken by database requests. |
| tg_validatord_info | Info about the particular instance. |
| tg_validatord_job_wallet_elapsed_time_ns | Elapsed time for job wallet operations in nanoseconds. |
| tg_validatord_log_event_counter | Counts the number of log events. |
| tg_validatord_pq_error_counter | Total number of database errors from pq. |
Taurus Job Metrics
| Metric Family | Metric Description |
|---|---|
| tg_job_job_execution_time_in_seconds | Summary of job execution time. An observation is created for each job execution. |
| tg_job_job_state | State of job: 0=unknown, 1=disabled, 2=enabled. |
| tg_job_job_status_counters | Count the status occurrences. |
| tgJob_controller_state | State of the controller: 0=unknown, 1=stopped, 2=started. |
| tgJob_info | Info about the job library. |
Metric Family and representation
| Metric Name | Metric Representation |
|---|---|
| go_build_info | gauge |
| go_gc_duration_seconds | summary |
| go_gc_gogc_percent | gauge |
| go_gc_gomemlimit_bytes | gauge |
| go_goroutines | gauge |
| go_info | gauge |
| go_memstats_alloc_bytes | gauge |
| go_memstats_alloc_bytes_total | counter |
| go_memstats_buck_hash_sys_bytes | gauge |
| go_memstats_frees_total | counter |
| go_memstats_gc_sys_bytes | gauge |
| go_memstats_heap_alloc_bytes | gauge |
| go_memstats_heap_idle_bytes | gauge |
| go_memstats_heap_inuse_bytes | gauge |
| go_memstats_heap_objects | gauge |
| go_memstats_heap_released_bytes | gauge |
| go_memstats_heap_sys_bytes | gauge |
| go_memstats_last_gc_time_seconds | gauge |
| go_memstats_mallocs_total | counter |
| go_memstats_mcache_inuse_bytes | gauge |
| go_memstats_mcache_sys_bytes | gauge |
| go_memstats_mspan_inuse_bytes | gauge |
| go_memstats_mspan_sys_bytes | gauge |
| go_memstats_next_gc_bytes | gauge |
| go_memstats_other_sys_bytes | gauge |
| go_memstats_stack_inuse_bytes | gauge |
| go_memstats_stack_sys_bytes | gauge |
| go_memstats_sys_bytes | gauge |
| go_sched_gomaxprocs_threads | gauge |
| go_sql_idle_connections | gauge |
| go_sql_in_use_connections | gauge |
| go_sql_max_idle_closed_total | counter |
| go_sql_max_idle_time_closed_total | counter |
| go_sql_max_lifetime_closed_total | counter |
| go_sql_max_open_connections | gauge |
| go_sql_open_connections | gauge |
| go_sql_wait_count_total | counter |
| go_sql_wait_duration_seconds_total | counter |
| go_threads | gauge |
| grpc_server_handled_total | counter |
| grpc_server_handling_seconds | summary |
| tg_job_job_execution_time_in_seconds | summary |
| tg_job_job_state | gauge |
| tg_job_job_status_counters | counter |
| tg_validatord_cryptocompareClient_APICall_total | counter |
| tg_validatord_database_request_timing_seconds | summary |
| tg_validatord_info | gauge |
| tg_validatord_job_wallet_elapsed_time_ns | gauge |
| tg_validatord_log_event_counter | counter |
| tg_validatord_pq_error_counter | counter |
| tgJob_controller_state | gauge |
| tgJob_info
Updated about 15 hours ago