From ee5feba0e1bf6d114ec528c551bc88873e940bc7 Mon Sep 17 00:00:00 2001 From: Evgenii Stratonikov Date: Wed, 31 Jan 2024 10:29:42 +0300 Subject: [PATCH] Makefile: Add target to regenerate metrics description Signed-off-by: Evgenii Stratonikov --- Makefile | 6 ++++- docs/ir-metrics.md | 8 ++++++ docs/node-metrics.md | 59 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 72 insertions(+), 1 deletion(-) create mode 100644 docs/ir-metrics.md create mode 100644 docs/node-metrics.md diff --git a/Makefile b/Makefile index 84653a03a..9ee331238 100755 --- a/Makefile +++ b/Makefile @@ -94,6 +94,10 @@ export-metrics: dep CGO_ENABLED=0 \ go build -v -trimpath -o bin/export-metrics ./scripts/export-metrics +docs: export-metrics + @./bin/export-metrics -node ./docs/node-metrics.md -format md + @./bin/export-metrics -ir ./docs/ir-metrics.md -format md + # Regenerate proto files: protoc: @if [ ! -d "$(PROTOC_DIR)" ] || [ ! -d "$(PROTOC_GEN_GO_DIR)" ] || [ ! -d "$(PROTOGEN_FROSTFS_DIR)" ]; then \ @@ -259,4 +263,4 @@ env-down: docker volume rm -f frostfs-node_neo-go rm -f ./.cache/.frostfs-ir-state rm -f ./.cache/.frostfs-node-state - rm -rf ./.cache/storage \ No newline at end of file + rm -rf ./.cache/storage diff --git a/docs/ir-metrics.md b/docs/ir-metrics.md new file mode 100644 index 000000000..48947f488 --- /dev/null +++ b/docs/ir-metrics.md @@ -0,0 +1,8 @@ +# FrostFS Node prometheus metrics +Name | Description | Constant labels | Variable labels +-- | -- | -- | -- +frostfs_ir_ir_epoch | Current epoch as seen by inner-ring node. | | +frostfs_ir_ir_event_duration_seconds | Duration of processing of inner-ring events | | type; success +frostfs_ir_ir_health | Current inner-ring node state. | | +frostfs_ir_logger_entry_count | Total log entries emitted or dropped by severity level | | level; dropped +frostfs_ir_morphcache_request_duration_seconds | Morph cache request process duration | | success; method diff --git a/docs/node-metrics.md b/docs/node-metrics.md new file mode 100644 index 000000000..f4f2543aa --- /dev/null +++ b/docs/node-metrics.md @@ -0,0 +1,59 @@ +# FrostFS Node prometheus metrics +Name | Description | Constant labels | Variable labels +-- | -- | -- | -- +frostfs_node_blobovnicza_tree_get_bytes | Accumulated payload size read from Blobovnicza tree | | shard_id; path +frostfs_node_blobovnicza_tree_mode | Blobovnicza tree mode | | shard_id; path; mode +frostfs_node_blobovnicza_tree_object_move_duration_seconds | Accumulated Blobovnicza tree object move duration | | shard_id; path +frostfs_node_blobovnicza_tree_open_blobovnicza_count | Count of opened blobovniczas of Blobovnicza tree | | shard_id; path +frostfs_node_blobovnicza_tree_open_blobovnicza_items_total | Count of items in opened blobovniczas of Blobovnicza tree | | shard_id; path +frostfs_node_blobovnicza_tree_open_blobovnicza_size_bytes | Size of opened blobovniczas of Blobovnicza tree | | shard_id; path +frostfs_node_blobovnicza_tree_put_bytes | Accumulated payload size written to Blobovnicza tree | | shard_id; path +frostfs_node_blobovnicza_tree_rebuild_complete_percent | Percent of rebuild completeness | | shard_id; path +frostfs_node_blobovnicza_tree_rebuild_status | Blobovnicza tree rebuild status | | shard_id; path; mode +frostfs_node_blobovnicza_tree_request_duration_seconds | Accumulated Blobovnicza tree request process duration | | shard_id; path; success; method; with_storage_id +frostfs_node_blobstore_get_bytes | Accumulated payload size read from Blobstore | | shard_id +frostfs_node_blobstore_mode | Blobstore mode value | | shard_id; mode +frostfs_node_blobstore_put_bytes | Accumulated payload size written to Blobstore | | shard_id +frostfs_node_blobstore_request_duration_seconds | Accumulated Blobstore request process duration | | shard_id; success; method; with_storage_id +frostfs_node_engine_container_objects_total | Count of objects for each container | | shard_id; cid; type +frostfs_node_engine_container_size_bytes | Accumulated size of all objects in a container | | cid +frostfs_node_engine_errors_total | Shard's error counter | | shard_id +frostfs_node_engine_mode_info | Shard mode | | shard_id; mode +frostfs_node_engine_objects_total | Objects counters per shards. DEPRECATED: Will be deleted in next releasese, use frostfs_node_engine_container_objects_total metric. | | shard_id; type +frostfs_node_engine_payload_size_bytes | Accumulated size of all objects in a shard | | shard_id +frostfs_node_engine_request_duration_seconds | Duration of Engine requests | | method +frostfs_node_fstree_get_bytes | Accumulated payload size read from FSTree | | shard_id; path +frostfs_node_fstree_mode | FSTree mode value | | shard_id; path; mode +frostfs_node_fstree_put_bytes | Accumulated payload size written to FSTree | | shard_id; path +frostfs_node_fstree_request_duration_seconds | Accumulated FSTree request process duration | | shard_id; success; path; method +frostfs_node_garbage_collector_delete_duration_seconds | The total time of GC runs to delete objects from disk | | shard_id; success +frostfs_node_garbage_collector_deleted_objects_total | Total count of objects GC deleted or failed to delete from disk | | shard_id; status +frostfs_node_garbage_collector_marked_for_removal_objects_total | Total count of expired objects GC marked to remove | | shard_id; object_type +frostfs_node_garbage_collector_marking_duration_seconds | The total time of GC runs to mark expired objects as removed | | shard_id; success; object_type +frostfs_node_grpc_server_health | GRPC Server Endpoint health | | endpoint +frostfs_node_ir_epoch | Current epoch as seen by inner-ring node. | | +frostfs_node_logger_entry_count | Total log entries emitted or dropped by severity level | | level; dropped +frostfs_node_metabase_mode | Metabase mode | | shard_id; path; mode +frostfs_node_metabase_request_duration_seconds | Accumulated Metabase request process duration | | shard_id; success; path; method +frostfs_node_morph_invoke_duration_seconds | Cummulative duration of contract invocations | | invoke_type; contract; method; success +frostfs_node_morph_last_block | Index of the last received block | | +frostfs_node_morph_notifications_total | Number of notifications received by notification type | | notification_type +frostfs_node_morph_switches_total | Number of endpoint switches | | +frostfs_node_morphcache_request_duration_seconds | Morph cache request process duration | | success; method +frostfs_node_object_request_duration_seconds | Object Service request process duration | | method; success +frostfs_node_object_request_payload_bytes | Object Service request payload | | method +frostfs_node_pilorama_mode | Pilorama mode | | shard_id; mode +frostfs_node_pilorama_request_duration_seconds | Accumulated Pilorama request process duration | | shard_id; success; method +frostfs_node_policer_processed_objects_total | Total number of objects processed by policer | | +frostfs_node_replicator_in_flight_requests_total | Number of in-flight requests | | +frostfs_node_replicator_processed_objects_total | Number of objects processed since the node startup | | +frostfs_node_replicator_total_replicated_payload_size_bytes | Total size of payloads replicated | | +frostfs_node_state_health | Current Node state | | +frostfs_node_treeservice_replicate_task_duration_seconds | Duration of individual replication tasks executed as part of replication loops | | success +frostfs_node_treeservice_replicate_wait_duration_seconds | Duration of overall waiting time for replication loops | | success +frostfs_node_treeservice_sync_duration_seconds | Duration of synchronization operations | | success +frostfs_node_writecache_actual_objects_total | Actual objects count in writecache | | shard_id; storage +frostfs_node_writecache_estimated_size_bytes | Estimated writecache size | | shard_id; storage +frostfs_node_writecache_mode_info | Writecache mode value | | shard_id; mode +frostfs_node_writecache_operations_total | The number of writecache operations processed | | shard_id; storage; success; operation +frostfs_node_writecache_request_duration_seconds | Writecache request process duration | | shard_id; success; storage; method