Skip to content

Commit f6899b0

Browse files
vvs-personalstashyurishkuro
vvs-personalstash
and
yurishkuro
authored
[V2]Add Script for metrics markdown table (#5941)
## Description of the changes - Added a script for creating a markdown table to view and compare v1 and v2 metrics using json generated by compare metrics ## Checklist - *[x] I have read https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md - *[x] I have signed all commits - [ ] I have added unit tests for the new functionality - *[x] I have run lint and test steps successfully - for `jaeger`: `make lint test` - for `jaeger-ui`: `yarn lint` and `yarn test` --------- Signed-off-by: vvs-personalstash <[email protected]> Co-authored-by: Yuri Shkuro <[email protected]>
1 parent 49f33a4 commit f6899b0

File tree

8 files changed

+430
-59
lines changed

8 files changed

+430
-59
lines changed

‎cmd/jaeger/docs/migration/all-in-one-metrics.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# ALL-IN-ONE METRICS
2+
### Combined Metrics
3+
4+
| V1 Metric | V1 Labels | V2 Metric | V2 Labels |
5+
|-----------|---------------|-----------|---------------|
6+
| jaeger_query_latency | operation, result | jaeger_query_latency | operation, result |
7+
| jaeger_query_responses | operation | jaeger_query_responses | operation |
8+
| jaeger_query_requests_total | operation, result | jaeger_query_requests_total | operation, result |
9+
| go_gc_duration_seconds | N/A | N/A | N/A |
10+
| go_goroutines | N/A | N/A | N/A |
11+
| go_info | version | N/A | N/A |
12+
| go_memstats_alloc_bytes | N/A | N/A | N/A |
13+
| go_memstats_alloc_bytes_total | N/A | N/A | N/A |
14+
| go_memstats_buck_hash_sys_bytes | N/A | N/A | N/A |
15+
| go_memstats_frees_total | N/A | N/A | N/A |
16+
| go_memstats_gc_sys_bytes | N/A | N/A | N/A |
17+
| go_memstats_heap_alloc_bytes | N/A | N/A | N/A |
18+
| go_memstats_heap_idle_bytes | N/A | N/A | N/A |
19+
| go_memstats_heap_inuse_bytes | N/A | N/A | N/A |
20+
| go_memstats_heap_objects | N/A | N/A | N/A |
21+
| go_memstats_heap_released_bytes | N/A | N/A | N/A |
22+
| go_memstats_heap_sys_bytes | N/A | N/A | N/A |
23+
| go_memstats_last_gc_time_seconds | N/A | N/A | N/A |
24+
| go_memstats_lookups_total | N/A | N/A | N/A |
25+
| go_memstats_mallocs_total | N/A | N/A | N/A |
26+
| go_memstats_mcache_inuse_bytes | N/A | N/A | N/A |
27+
| go_memstats_mcache_sys_bytes | N/A | N/A | N/A |
28+
| go_memstats_mspan_inuse_bytes | N/A | N/A | N/A |
29+
| go_memstats_mspan_sys_bytes | N/A | N/A | N/A |
30+
| go_memstats_next_gc_bytes | N/A | N/A | N/A |
31+
| go_memstats_other_sys_bytes | N/A | N/A | N/A |
32+
| go_memstats_stack_inuse_bytes | N/A | N/A | N/A |
33+
| go_memstats_stack_sys_bytes | N/A | N/A | N/A |
34+
| go_memstats_sys_bytes | N/A | N/A | N/A |
35+
| go_threads | N/A | N/A | N/A |
36+
| jaeger_build_info | build_date, revision, version | N/A | N/A |
37+
| jaeger_collector_batch_size | host | N/A | N/A |
38+
| jaeger_collector_http_request_duration | method, path, status | N/A | N/A |
39+
| jaeger_collector_http_server_errors_total | source, status | N/A | N/A |
40+
| jaeger_collector_http_server_requests_total | type | N/A | N/A |
41+
| jaeger_collector_in_queue_latency | host | N/A | N/A |
42+
| jaeger_collector_queue_capacity | host | N/A | N/A |
43+
| jaeger_collector_queue_length | host | N/A | N/A |
44+
| jaeger_collector_save_latency | host | N/A | N/A |
45+
| jaeger_collector_spans_bytes | host | N/A | N/A |
46+
| jaeger_collector_spans_dropped_total | host | N/A | N/A |
47+
| jaeger_collector_spans_received_total | debug, format, svc, transport | N/A | N/A |
48+
| jaeger_collector_spans_rejected_total | debug, format, svc, transport | N/A | N/A |
49+
| jaeger_collector_spans_saved_by_svc_total | debug, result, svc | N/A | N/A |
50+
| jaeger_collector_spans_serviceNames | host | N/A | N/A |
51+
| jaeger_collector_traces_received_total | debug, format, sampler_type, svc, transport | N/A | N/A |
52+
| jaeger_collector_traces_rejected_total | debug, format, sampler_type, svc, transport | N/A | N/A |
53+
| jaeger_collector_traces_saved_by_svc_total | debug, result, sampler_type, svc | N/A | N/A |
54+
| process_cpu_seconds_total | N/A | N/A | N/A |
55+
| process_max_fds | N/A | N/A | N/A |
56+
| process_open_fds | N/A | N/A | N/A |
57+
| process_resident_memory_bytes | N/A | N/A | N/A |
58+
| process_start_time_seconds | N/A | N/A | N/A |
59+
| process_virtual_memory_bytes | N/A | N/A | N/A |
60+
| process_virtual_memory_max_bytes | N/A | N/A | N/A |
61+
| N/A | N/A | exporter_send_failed_spans | exporter, service_instance_id, service_name, service_version |
62+
| N/A | N/A | exporter_sent_spans | exporter, service_instance_id, service_name, service_version |
63+
| N/A | N/A | process_cpu_seconds | service_instance_id, service_name, service_version |
64+
| N/A | N/A | process_memory_rss | service_instance_id, service_name, service_version |
65+
| N/A | N/A | process_runtime_heap_alloc_bytes | service_instance_id, service_name, service_version |
66+
| N/A | N/A | process_runtime_total_alloc_bytes | service_instance_id, service_name, service_version |
67+
| N/A | N/A | process_runtime_total_sys_memory_bytes | service_instance_id, service_name, service_version |
68+
| N/A | N/A | process_uptime | service_instance_id, service_name, service_version |
69+
| N/A | N/A | processor_batch_batch_send_size | processor, service_instance_id, service_name, service_version |
70+
| N/A | N/A | processor_batch_batch_send_size_bytes | processor, service_instance_id, service_name, service_version |
71+
| N/A | N/A | processor_batch_metadata_cardinality | processor, service_instance_id, service_name, service_version |
72+
| N/A | N/A | processor_batch_timeout_trigger_send | processor, service_instance_id, service_name, service_version |
73+
| N/A | N/A | receiver_accepted_spans | receiver, service_instance_id, service_name, service_version, transport |
74+
| N/A | N/A | receiver_refused_spans | receiver, service_instance_id, service_name, service_version, transport |
75+
| N/A | N/A | rpc_server_duration | rpc_grpc_status_code, rpc_method, rpc_service, rpc_system, service_instance_id, service_name, service_version |
76+
| N/A | N/A | rpc_server_request_size | rpc_method, rpc_service, rpc_system, service_instance_id, service_name, service_version |
77+
| N/A | N/A | rpc_server_requests_per_rpc | rpc_grpc_status_code, rpc_method, rpc_service, rpc_system, service_instance_id, service_name, service_version |
78+
| N/A | N/A | rpc_server_response_size | rpc_method, rpc_service, rpc_system, service_instance_id, service_name, service_version |
79+
| N/A | N/A | rpc_server_responses_per_rpc | rpc_grpc_status_code, rpc_method, rpc_service, rpc_system, service_instance_id, service_name, service_version |
80+
| N/A | N/A | target_info | service_instance_id, service_name, service_version |
81+
### Equivalent Metrics
82+
83+
| V1 Metric | V1 Labels | V2 Metric | V2 Labels |
84+
|-----------|---------------|-----------|---------------|
85+
| jaeger_collector_spans_rejected_total | debug, format, svc, transport | receiver_refused_spans | receiver, service_instance_id, service_name, service_version, transport |
86+
| jaeger_build_info | build_date, revision, version | target_info | service_instance_id, service_name, service_version |

‎cmd/jaeger/docs/migration/badger-metrics.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# BADGER METRICS
2+
3+
### Combined Metrics
4+
5+
| V1 Metric | V1 Parameters | V2 Metric | V2 Parameters |
6+
| ------------------------------------------ | ------------- | ---------------------------------------- | ------------- |
7+
| jaeger_badger_compaction_current_num_lsm | N/A | jaeger_badger_compaction_current_num_lsm | N/A |
8+
| jaeger_badger_get_num_memtable | N/A | jaeger_badger_get_num_memtable | N/A |
9+
| jaeger_badger_get_num_user | N/A | jaeger_badger_get_num_user | N/A |
10+
| jaeger_badger_get_with_result_num_user | N/A | jaeger_badger_get_with_result_num_user | N/A |
11+
| jaeger_badger_iterator_num_user | N/A | jaeger_badger_iterator_num_user | N/A |
12+
| jaeger_badger_put_num_user | N/A | jaeger_badger_put_num_user | N/A |
13+
| jaeger_badger_read_bytes_lsm | N/A | jaeger_badger_read_bytes_lsm | N/A |
14+
| jaeger_badger_read_bytes_vlog | N/A | jaeger_badger_read_bytes_vlog | N/A |
15+
| jaeger_badger_read_num_vlog | N/A | jaeger_badger_read_num_vlog | N/A |
16+
| jaeger_badger_size_bytes_lsm | N/A | jaeger_badger_size_bytes_lsm | N/A |
17+
| jaeger_badger_size_bytes_vlog | N/A | jaeger_badger_size_bytes_vlog | N/A |
18+
| jaeger_badger_write_bytes_l0 | N/A | jaeger_badger_write_bytes_l0 | N/A |
19+
| jaeger_badger_write_bytes_user | N/A | jaeger_badger_write_bytes_user | N/A |
20+
| jaeger_badger_write_bytes_vlog | N/A | jaeger_badger_write_bytes_vlog | N/A |
21+
| jaeger_badger_write_num_vlog | N/A | jaeger_badger_write_num_vlog | N/A |
22+
| jaeger_badger_write_pending_num_memtable | N/A | jaeger_badger_write_pending_num_memtable | N/A |
23+
| jaeger_badger_key_log_bytes_available | N/A | N/A | N/A |
24+
| jaeger_badger_storage_maintenance_last_run | N/A | N/A | N/A |
25+
| jaeger_badger_storage_valueloggc_last_run | N/A | N/A | N/A |
26+
| jaeger_badger_value_log_bytes_available | N/A | N/A | N/A |
27+
28+
### Equivalent Metrics
29+
30+
| V1 Metric | V1 Parameters | V2 Metric | V2 Parameters |
31+
| ------------------------------------- | ------------------------------ | ---------------------- | ----------------------------------------------------------------------- |
32+
| jaeger_collector_spans_rejected_total | debug, format, svc, transport | receiver_refused_spans | receiver, service_instance_id, service_name, service_version, transport |
33+
| jaeger_build_info | build_date, revision, version | target_info | service_instance_id, service_name, service_version |

‎cmd/jaeger/docs/migration/cassandra-metrics.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# CASSANDRA METRICS
2+
### Combined Metrics
3+
4+
| V1 Metric | V1 Parameters | V2 Metric | V2 Parameters |
5+
|-----------|---------------|-----------|---------------|
6+
| jaeger_cassandra_attempts_total | table | jaeger_cassandra_attempts_total | table |
7+
| jaeger_cassandra_errors_total | table | jaeger_cassandra_errors_total | table |
8+
| jaeger_cassandra_inserts_total | table | jaeger_cassandra_inserts_total | table |
9+
| jaeger_cassandra_latency_err | table | jaeger_cassandra_latency_err | table |
10+
| jaeger_cassandra_latency_ok | table | jaeger_cassandra_latency_ok | table |
11+
| jaeger_cassandra_read_attempts_total | table | jaeger_cassandra_read_attempts_total | table |
12+
| jaeger_cassandra_read_errors_total | table | jaeger_cassandra_read_errors_total | table |
13+
| jaeger_cassandra_read_inserts_total | table | jaeger_cassandra_read_inserts_total | table |
14+
| jaeger_cassandra_read_latency_err | table | jaeger_cassandra_read_latency_err | table |
15+
| jaeger_cassandra_read_latency_ok | table | jaeger_cassandra_read_latency_ok | table |
16+
| jaeger_cassandra_tag_index_skipped_total | N/A | jaeger_cassandra_tag_index_skipped_total | N/A |
17+
### Equivalent Metrics
18+
19+
| V1 Metric | V1 Parameters | V2 Metric | V2 Parameters |
20+
|-----------|---------------|-----------|---------------|
21+
| jaeger_collector_spans_rejected_total | debug, format, svc, transport | receiver_refused_spans | receiver, service_instance_id, service_name, service_version, transport |
22+
| jaeger_build_info | build_date, revision, version | target_info | service_instance_id, service_name, service_version |

‎cmd/jaeger/docs/migration/elasticsearch-metrics.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# ELASTICSEARCH METRICS
2+
### Combined Metrics
3+
4+
| V1 Metric | V1 Parameters | V2 Metric | V2 Parameters |
5+
|-----------|---------------|-----------|---------------|
6+
| jaeger_bulk_index_attempts_total | N/A | jaeger_bulk_index_attempts_total | N/A |
7+
| jaeger_bulk_index_errors_total | N/A | jaeger_bulk_index_errors_total | N/A |
8+
| jaeger_bulk_index_inserts_total | N/A | jaeger_bulk_index_inserts_total | N/A |
9+
| jaeger_bulk_index_latency_err | N/A | jaeger_bulk_index_latency_err | N/A |
10+
| jaeger_bulk_index_latency_ok | N/A | jaeger_bulk_index_latency_ok | N/A |
11+
| jaeger_index_create_attempts_total | N/A | jaeger_index_create_attempts_total | N/A |
12+
| jaeger_index_create_errors_total | N/A | jaeger_index_create_errors_total | N/A |
13+
| jaeger_index_create_inserts_total | N/A | jaeger_index_create_inserts_total | N/A |
14+
| jaeger_index_create_latency_err | N/A | jaeger_index_create_latency_err | N/A |
15+
| jaeger_index_create_latency_ok | N/A | jaeger_index_create_latency_ok | N/A |
16+
### Equivalent Metrics
17+
18+
| V1 Metric | V1 Parameters | V2 Metric | V2 Parameters |
19+
|-----------|---------------|-----------|---------------|
20+
| jaeger_collector_spans_rejected_total | debug, format, svc, transport | receiver_refused_spans | receiver, service_instance_id, service_name, service_version, transport |
21+
| jaeger_build_info | build_date, revision, version | target_info | service_instance_id, service_name, service_version |

‎cmd/jaeger/docs/migration/opensearch-metrics.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# OPENSEARCH METRICS
2+
### Combined Metrics
3+
4+
| V1 Metric | V1 Parameters | V2 Metric | V2 Parameters |
5+
|-----------|---------------|-----------|---------------|
6+
| jaeger_bulk_index_attempts_total | N/A | jaeger_bulk_index_attempts_total | N/A |
7+
| jaeger_bulk_index_errors_total | N/A | jaeger_bulk_index_errors_total | N/A |
8+
| jaeger_bulk_index_inserts_total | N/A | jaeger_bulk_index_inserts_total | N/A |
9+
| jaeger_bulk_index_latency_err | N/A | jaeger_bulk_index_latency_err | N/A |
10+
| jaeger_bulk_index_latency_ok | N/A | jaeger_bulk_index_latency_ok | N/A |
11+
| jaeger_index_create_attempts_total | N/A | jaeger_index_create_attempts_total | N/A |
12+
| jaeger_index_create_errors_total | N/A | jaeger_index_create_errors_total | N/A |
13+
| jaeger_index_create_inserts_total | N/A | jaeger_index_create_inserts_total | N/A |
14+
| jaeger_index_create_latency_err | N/A | jaeger_index_create_latency_err | N/A |
15+
| jaeger_index_create_latency_ok | N/A | jaeger_index_create_latency_ok | N/A |
16+
### Equivalent Metrics
17+
18+
| V1 Metric | V1 Parameters | V2 Metric | V2 Parameters |
19+
|-----------|---------------|-----------|---------------|
20+
| jaeger_collector_spans_rejected_total | debug, format, svc, transport | receiver_refused_spans | receiver, service_instance_id, service_name, service_version, transport |
21+
| jaeger_build_info | build_date, revision, version | target_info | service_instance_id, service_name, service_version |

‎scripts/compare_metrics.py

Lines changed: 0 additions & 59 deletions
This file was deleted.

0 commit comments

Comments
 (0)