Files
scylladb/scripts/metrics-config.yml
Amnon Heiman 55b21b01ee alternator/stats.cc, metrics-config.yml: docs fix per-table metrics
This patch updates alternator/stats.cc and the get_description.py
configuration (metrics-config.yml) to restore compatibility with
per-table alternator metrics in the documentation generation process.

Previously, the group name for metrics was selected using an inline
expression like (has_table)? "alternator_table" : "alternator", which
made it difficult to maintain a straightforward mapping in the
configuration file.  With this change, the group name is now assigned to
a variable in alternator/stats.cc, allowing metrics-config.yml to map
group names directly. This makes the configuration easier to maintain
and enables get_description.py to document both global and per-table
metrics correctly.

This is a minimal, targeted fix to get the documentation working again
with the new per-table metrics format.

Signed-off-by: Amnon Heiman <amnon@scylladb.com>

Closes scylladb/scylladb#24509
2025-06-15 18:06:36 +03:00

72 lines
3.0 KiB
YAML

"cdc/log.cc":
params:
cdc_group_name: cdc
part_name;suffix: [["static_row", "total"],["clustering_row", "total"], ["map", "total"], ["set", "total"], ["list", "total"], ["udt", "total"], ["range_tombstone", "total"],["partition_delete", "total"],["row_delete", "total"], ["static_row", "failed"],["clustering_row", "failed"], ["map", "failed"], ["set", "failed"], ["list", "failed"], ["udt", "failed"], ["range_tombstone", "failed"],["partition_delete", "failed"],["row_delete", "failed"]]
kind: ["total", "failed"]
"db/commitlog/commitlog.cc":
params:
metrics_category_name: ["commitlog", "schema_commitlog"]
cfg.max_active_flushes: "cfg.max_active_flushes"
"cql3/query_processor.cc":
groups:
"80": query_processor
allowmismatch: true
"raft/server.cc":
allowmismatch: true
"replica/dirty_memory_manager.cc":
params:
namestr: ["regular", "system"]
"replica/table.cc":
params:
stat_name: ["exclusive_row", "shared_row", "exclusive_partition", "shared_partition"]
"replica/database.cc":
allowmismatch: true
params:
"_dirty_memory_manager.throttle_threshold()": "throttle threshold"
"seastar/apps/metrics_tester/metrics_tester.cc": skip
"seastar/tests/unit/metrics_test.cc": skip
"seastar/tests/unit/metrics_tester.cc": skip
"seastar/tests/unit/prometheus_http_test.cc": skip
"service/storage_proxy.cc":
params:
COORDINATOR_STATS_CATEGORY: "storage_proxy_coordinator"
"storage_proxy_stats::COORDINATOR_STATS_CATEGORY": "storage_proxy_coordinator"
REPLICA_STATS_CATEGORY: "storage_proxy_replica"
_short_description_prefix: ["total_write_attempts", "write_errors", "background_replica_writes_failed", "read_repair_write_attempts"]
_long_description_prefix: ["total number of write requests", "number of write requests that failed", "background_replica_writes_failed", "number of write operations in a read repair context"]
_category: "storage_proxy_coordinator"
allowmismatch: true
"thrift/server.cc": skip
"tracing/tracing.cc":
params:
"max_pending_trace_records + write_event_records_threshold": "max_pending_trace_records + write_event_records_threshold"
"transport/server.cc":
groups:
"200": transport
params:
_max_request_size: "max_request_size"
"seastar/src/net/dpdk.cc": skip
"db/hints/manager.cc":
params:
"group_name": ["hints_for_views_manager", "hints_manager"]
"seastar/src/core/execution_stage.cc":
groups:
"100": execution_stages
"seastar/src/core/fair_queue.cc":
groups:
"300": io_queue
"seastar/src/net/net.cc":
params:
_stats_plugin_name: ["stats_plugin_name"]
_queue_name: ["queue"]
"_queue_name + \"_tx_packet_queue\"": ["queue"]
"_queue_name + \"_tx_packets\"": ["queue"]
"_queue_name + \"_rx_packets\"": ["queue"]
"_queue_name + \"_tx_bytes\"": ["queue"]
"_queue_name + \"_rx_bytes\"": ["queue"]
"_queue_name + \"_tx_frags\"": ["queue"]
"_queue_name + \"_rx_frags\"": ["queue"]
"alternator/stats.cc":
params:
group_name: "alternator"