Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[V2]Add Script for metrics markdown table #5941

Merged
merged 5 commits into from
Nov 24, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 92 additions & 0 deletions cmd/jaeger/docs/migration/all-in-one-metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
### Common Metrics
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could we just have a single table with a format similar to ### Equivalent Metrics? When one side is missing, put n/a


| Metric Name | Inner Parameters |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inner Parameters

The official term in Prometheus is Labels

|-------------|------------------|
| jaeger_query_latency | operation, result |
| jaeger_query_responses | operation |
| jaeger_query_requests_total | operation, result |
### V1 Only Metrics

| Metric Name | Inner Parameters |
|-------------|------------------|
| go_gc_duration_seconds | |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Wise-Wizard we should investigate how these standard Go metrics are being generated in v1 and decide how we can enable them in v2.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, will look in that

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is what we might want: https://github.com/open-telemetry/opentelemetry-go-contrib/blob/main/instrumentation/runtime/runtime.go

ideally Collector would expose those automatically, but it's not implemented currently -- open-telemetry/opentelemetry-collector#2155

| go_goroutines | |
| go_info | version |
| go_memstats_alloc_bytes | |
| go_memstats_alloc_bytes_total | |
| go_memstats_buck_hash_sys_bytes | |
| go_memstats_frees_total | |
| go_memstats_gc_sys_bytes | |
| go_memstats_heap_alloc_bytes | |
| go_memstats_heap_idle_bytes | |
| go_memstats_heap_inuse_bytes | |
| go_memstats_heap_objects | |
| go_memstats_heap_released_bytes | |
| go_memstats_heap_sys_bytes | |
| go_memstats_last_gc_time_seconds | |
| go_memstats_lookups_total | |
| go_memstats_mallocs_total | |
| go_memstats_mcache_inuse_bytes | |
| go_memstats_mcache_sys_bytes | |
| go_memstats_mspan_inuse_bytes | |
| go_memstats_mspan_sys_bytes | |
| go_memstats_next_gc_bytes | |
| go_memstats_other_sys_bytes | |
| go_memstats_stack_inuse_bytes | |
| go_memstats_stack_sys_bytes | |
| go_memstats_sys_bytes | |
| go_threads | |
| jaeger_build_info | build_date, revision, version |
| jaeger_collector_batch_size | host |
| jaeger_collector_http_request_duration | method, path, status |
| jaeger_collector_http_server_errors_total | source, status |
| jaeger_collector_http_server_requests_total | type |
| jaeger_collector_in_queue_latency | host |
| jaeger_collector_queue_capacity | host |
| jaeger_collector_queue_length | host |
| jaeger_collector_save_latency | host |
| jaeger_collector_spans_bytes | host |
| jaeger_collector_spans_dropped_total | host |
| jaeger_collector_spans_received_total | debug, format, svc, transport |
| jaeger_collector_spans_rejected_total | debug, format, svc, transport |
| jaeger_collector_spans_saved_by_svc_total | debug, result, svc |
| jaeger_collector_spans_serviceNames | host |
| jaeger_collector_traces_received_total | debug, format, sampler_type, svc, transport |
| jaeger_collector_traces_rejected_total | debug, format, sampler_type, svc, transport |
| jaeger_collector_traces_saved_by_svc_total | debug, result, sampler_type, svc |
| process_cpu_seconds_total | |
| process_max_fds | |
| process_open_fds | |
| process_resident_memory_bytes | |
| process_start_time_seconds | |
| process_virtual_memory_bytes | |
| process_virtual_memory_max_bytes | |
### V2 Only Metrics

| Metric Name | Inner Parameters |
|-------------|------------------|
| exporter_send_failed_spans | exporter, service_instance_id, service_name, service_version |
| exporter_sent_spans | exporter, service_instance_id, service_name, service_version |
| process_cpu_seconds | service_instance_id, service_name, service_version |
| process_memory_rss | service_instance_id, service_name, service_version |
| process_runtime_heap_alloc_bytes | service_instance_id, service_name, service_version |
| process_runtime_total_alloc_bytes | service_instance_id, service_name, service_version |
| process_runtime_total_sys_memory_bytes | service_instance_id, service_name, service_version |
| process_uptime | service_instance_id, service_name, service_version |
| processor_batch_batch_send_size | processor, service_instance_id, service_name, service_version |
| processor_batch_batch_send_size_bytes | processor, service_instance_id, service_name, service_version |
| processor_batch_metadata_cardinality | processor, service_instance_id, service_name, service_version |
| processor_batch_timeout_trigger_send | processor, service_instance_id, service_name, service_version |
| receiver_accepted_spans | receiver, service_instance_id, service_name, service_version, transport |
| receiver_refused_spans | receiver, service_instance_id, service_name, service_version, transport |
| rpc_server_duration | rpc_grpc_status_code, rpc_method, rpc_service, rpc_system, service_instance_id, service_name, service_version |
| rpc_server_request_size | rpc_method, rpc_service, rpc_system, service_instance_id, service_name, service_version |
| rpc_server_requests_per_rpc | rpc_grpc_status_code, rpc_method, rpc_service, rpc_system, service_instance_id, service_name, service_version |
| rpc_server_response_size | rpc_method, rpc_service, rpc_system, service_instance_id, service_name, service_version |
| rpc_server_responses_per_rpc | rpc_grpc_status_code, rpc_method, rpc_service, rpc_system, service_instance_id, service_name, service_version |
| target_info | service_instance_id, service_name, service_version |
### Equivalent Metrics

| V1 Metric | V1 Parameters | V2 Metric | V2 Parameters |
|-----------|---------------|-----------|---------------|
| jaeger_collector_spans_rejected_total | debug, format, svc, transport | receiver_refused_spans | receiver, service_instance_id, service_name, service_version, transport |
106 changes: 106 additions & 0 deletions cmd/jaeger/docs/migration/badger-metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
### Common Metrics

| Metric Name | Inner Parameters |
|-------------|------------------|
| jaeger_badger_compaction_current_num_lsm | |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the storage-specific files will have large overlap with all-in-one, I recommend filtering out only the storage-related metrics.

| jaeger_badger_get_num_memtable | |
| jaeger_badger_get_num_user | |
| jaeger_badger_get_with_result_num_user | |
| jaeger_badger_iterator_num_user | |
| jaeger_badger_put_num_user | |
| jaeger_badger_read_bytes_lsm | |
| jaeger_badger_read_bytes_vlog | |
| jaeger_badger_read_num_vlog | |
| jaeger_badger_size_bytes_lsm | |
| jaeger_badger_size_bytes_vlog | |
| jaeger_badger_write_bytes_l0 | |
| jaeger_badger_write_bytes_user | |
| jaeger_badger_write_bytes_vlog | |
| jaeger_badger_write_num_vlog | |
| jaeger_badger_write_pending_num_memtable | |
| jaeger_query_latency | operation, result |
| jaeger_query_requests_total | operation, result |
| jaeger_query_responses | operation |
### V1 Only Metrics

| Metric Name | Inner Parameters |
|-------------|------------------|
| go_gc_duration_seconds | |
| go_goroutines | |
| go_info | version |
| go_memstats_alloc_bytes | |
| go_memstats_alloc_bytes_total | |
| go_memstats_buck_hash_sys_bytes | |
| go_memstats_frees_total | |
| go_memstats_gc_sys_bytes | |
| go_memstats_heap_alloc_bytes | |
| go_memstats_heap_idle_bytes | |
| go_memstats_heap_inuse_bytes | |
| go_memstats_heap_objects | |
| go_memstats_heap_released_bytes | |
| go_memstats_heap_sys_bytes | |
| go_memstats_last_gc_time_seconds | |
| go_memstats_lookups_total | |
| go_memstats_mallocs_total | |
| go_memstats_mcache_inuse_bytes | |
| go_memstats_mcache_sys_bytes | |
| go_memstats_mspan_inuse_bytes | |
| go_memstats_mspan_sys_bytes | |
| go_memstats_next_gc_bytes | |
| go_memstats_other_sys_bytes | |
| go_memstats_stack_inuse_bytes | |
| go_memstats_stack_sys_bytes | |
| go_memstats_sys_bytes | |
| go_threads | |
| jaeger_badger_key_log_bytes_available | |
| jaeger_badger_storage_maintenance_last_run | |
| jaeger_badger_storage_valueloggc_last_run | |
| jaeger_badger_value_log_bytes_available | |
| jaeger_build_info | build_date, revision, version |
| jaeger_collector_batch_size | host |
| jaeger_collector_http_request_duration | method, path, status |
| jaeger_collector_http_server_errors_total | source, status |
| jaeger_collector_http_server_requests_total | type |
| jaeger_collector_in_queue_latency | host |
| jaeger_collector_queue_capacity | host |
| jaeger_collector_queue_length | host |
| jaeger_collector_save_latency | host |
| jaeger_collector_spans_bytes | host |
| jaeger_collector_spans_dropped_total | host |
| jaeger_collector_spans_received_total | debug, format, svc, transport |
| jaeger_collector_spans_rejected_total | debug, format, svc, transport |
| jaeger_collector_spans_saved_by_svc_total | debug, result, svc |
| jaeger_collector_spans_serviceNames | host |
| jaeger_collector_traces_received_total | debug, format, sampler_type, svc, transport |
| jaeger_collector_traces_rejected_total | debug, format, sampler_type, svc, transport |
| jaeger_collector_traces_saved_by_svc_total | debug, result, sampler_type, svc |
| process_cpu_seconds_total | |
| process_max_fds | |
| process_open_fds | |
| process_resident_memory_bytes | |
| process_start_time_seconds | |
| process_virtual_memory_bytes | |
| process_virtual_memory_max_bytes | |
### V2 Only Metrics

| Metric Name | Inner Parameters |
|-------------|------------------|
| exporter_send_failed_spans | exporter, service_instance_id, service_name, service_version |
| exporter_sent_spans | exporter, service_instance_id, service_name, service_version |
| process_cpu_seconds | service_instance_id, service_name, service_version |
| process_memory_rss | service_instance_id, service_name, service_version |
| process_runtime_heap_alloc_bytes | service_instance_id, service_name, service_version |
| process_runtime_total_alloc_bytes | service_instance_id, service_name, service_version |
| process_runtime_total_sys_memory_bytes | service_instance_id, service_name, service_version |
| process_uptime | service_instance_id, service_name, service_version |
| processor_batch_batch_send_size | processor, service_instance_id, service_name, service_version |
| processor_batch_metadata_cardinality | processor, service_instance_id, service_name, service_version |
| processor_batch_timeout_trigger_send | processor, service_instance_id, service_name, service_version |
| receiver_accepted_spans | receiver, service_instance_id, service_name, service_version, transport |
| receiver_refused_spans | receiver, service_instance_id, service_name, service_version, transport |
| target_info | service_instance_id, service_name, service_version |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

arguably this is equivalent to jaeger_build_info

### Equivalent Metrics

| V1 Metric | V1 Parameters | V2 Metric | V2 Parameters |
|-----------|---------------|-----------|---------------|
| jaeger_collector_spans_rejected_total | debug, format, svc, transport | receiver_refused_spans | receiver, service_instance_id, service_name, service_version, transport |
97 changes: 97 additions & 0 deletions cmd/jaeger/docs/migration/cassandra-metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
### Common Metrics

| Metric Name | Inner Parameters |
|-------------|------------------|
| jaeger_cassandra_attempts_total | table |
| jaeger_cassandra_errors_total | table |
| jaeger_cassandra_inserts_total | table |
| jaeger_cassandra_latency_err | table |
| jaeger_cassandra_latency_ok | table |
| jaeger_cassandra_read_attempts_total | table |
| jaeger_cassandra_read_errors_total | table |
| jaeger_cassandra_read_inserts_total | table |
| jaeger_cassandra_read_latency_err | table |
| jaeger_cassandra_read_latency_ok | table |
| jaeger_cassandra_tag_index_skipped_total | |
| jaeger_query_latency | operation, result |
| jaeger_query_requests_total | operation, result |
| jaeger_query_responses | operation |
### V1 Only Metrics

| Metric Name | Inner Parameters |
|-------------|------------------|
| go_gc_duration_seconds | |
| go_goroutines | |
| go_info | version |
| go_memstats_alloc_bytes | |
| go_memstats_alloc_bytes_total | |
| go_memstats_buck_hash_sys_bytes | |
| go_memstats_frees_total | |
| go_memstats_gc_sys_bytes | |
| go_memstats_heap_alloc_bytes | |
| go_memstats_heap_idle_bytes | |
| go_memstats_heap_inuse_bytes | |
| go_memstats_heap_objects | |
| go_memstats_heap_released_bytes | |
| go_memstats_heap_sys_bytes | |
| go_memstats_last_gc_time_seconds | |
| go_memstats_lookups_total | |
| go_memstats_mallocs_total | |
| go_memstats_mcache_inuse_bytes | |
| go_memstats_mcache_sys_bytes | |
| go_memstats_mspan_inuse_bytes | |
| go_memstats_mspan_sys_bytes | |
| go_memstats_next_gc_bytes | |
| go_memstats_other_sys_bytes | |
| go_memstats_stack_inuse_bytes | |
| go_memstats_stack_sys_bytes | |
| go_memstats_sys_bytes | |
| go_threads | |
| jaeger_build_info | build_date, revision, version |
| jaeger_collector_batch_size | host |
| jaeger_collector_http_request_duration | method, path, status |
| jaeger_collector_http_server_errors_total | source, status |
| jaeger_collector_http_server_requests_total | type |
| jaeger_collector_in_queue_latency | host |
| jaeger_collector_queue_capacity | host |
| jaeger_collector_queue_length | host |
| jaeger_collector_save_latency | host |
| jaeger_collector_spans_bytes | host |
| jaeger_collector_spans_dropped_total | host |
| jaeger_collector_spans_received_total | debug, format, svc, transport |
| jaeger_collector_spans_rejected_total | debug, format, svc, transport |
| jaeger_collector_spans_saved_by_svc_total | debug, result, svc |
| jaeger_collector_spans_serviceNames | host |
| jaeger_collector_traces_received_total | debug, format, sampler_type, svc, transport |
| jaeger_collector_traces_rejected_total | debug, format, sampler_type, svc, transport |
| jaeger_collector_traces_saved_by_svc_total | debug, result, sampler_type, svc |
| process_cpu_seconds_total | |
| process_max_fds | |
| process_open_fds | |
| process_resident_memory_bytes | |
| process_start_time_seconds | |
| process_virtual_memory_bytes | |
| process_virtual_memory_max_bytes | |
### V2 Only Metrics

| Metric Name | Inner Parameters |
|-------------|------------------|
| exporter_send_failed_spans | exporter, service_instance_id, service_name, service_version |
| exporter_sent_spans | exporter, service_instance_id, service_name, service_version |
| process_cpu_seconds | service_instance_id, service_name, service_version |
| process_memory_rss | service_instance_id, service_name, service_version |
| process_runtime_heap_alloc_bytes | service_instance_id, service_name, service_version |
| process_runtime_total_alloc_bytes | service_instance_id, service_name, service_version |
| process_runtime_total_sys_memory_bytes | service_instance_id, service_name, service_version |
| process_uptime | service_instance_id, service_name, service_version |
| processor_batch_batch_send_size | processor, service_instance_id, service_name, service_version |
| processor_batch_metadata_cardinality | processor, service_instance_id, service_name, service_version |
| processor_batch_timeout_trigger_send | processor, service_instance_id, service_name, service_version |
| receiver_accepted_spans | receiver, service_instance_id, service_name, service_version, transport |
| receiver_refused_spans | receiver, service_instance_id, service_name, service_version, transport |
| target_info | service_instance_id, service_name, service_version |
### Equivalent Metrics

| V1 Metric | V1 Parameters | V2 Metric | V2 Parameters |
|-----------|---------------|-----------|---------------|
| jaeger_collector_spans_rejected_total | debug, format, svc, transport | receiver_refused_spans | receiver, service_instance_id, service_name, service_version, transport |
96 changes: 96 additions & 0 deletions cmd/jaeger/docs/migration/elasticsearch-metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
### Common Metrics

| Metric Name | Inner Parameters |
|-------------|------------------|
| jaeger_bulk_index_attempts_total | |
| jaeger_bulk_index_errors_total | |
| jaeger_bulk_index_inserts_total | |
| jaeger_bulk_index_latency_err | |
| jaeger_bulk_index_latency_ok | |
| jaeger_index_create_attempts_total | |
| jaeger_index_create_errors_total | |
| jaeger_index_create_inserts_total | |
| jaeger_index_create_latency_err | |
| jaeger_index_create_latency_ok | |
| jaeger_query_latency | operation, result |
| jaeger_query_requests_total | operation, result |
| jaeger_query_responses | operation |
### V1 Only Metrics

| Metric Name | Inner Parameters |
|-------------|------------------|
| go_gc_duration_seconds | |
| go_goroutines | |
| go_info | version |
| go_memstats_alloc_bytes | |
| go_memstats_alloc_bytes_total | |
| go_memstats_buck_hash_sys_bytes | |
| go_memstats_frees_total | |
| go_memstats_gc_sys_bytes | |
| go_memstats_heap_alloc_bytes | |
| go_memstats_heap_idle_bytes | |
| go_memstats_heap_inuse_bytes | |
| go_memstats_heap_objects | |
| go_memstats_heap_released_bytes | |
| go_memstats_heap_sys_bytes | |
| go_memstats_last_gc_time_seconds | |
| go_memstats_lookups_total | |
| go_memstats_mallocs_total | |
| go_memstats_mcache_inuse_bytes | |
| go_memstats_mcache_sys_bytes | |
| go_memstats_mspan_inuse_bytes | |
| go_memstats_mspan_sys_bytes | |
| go_memstats_next_gc_bytes | |
| go_memstats_other_sys_bytes | |
| go_memstats_stack_inuse_bytes | |
| go_memstats_stack_sys_bytes | |
| go_memstats_sys_bytes | |
| go_threads | |
| jaeger_build_info | build_date, revision, version |
| jaeger_collector_batch_size | host |
| jaeger_collector_http_request_duration | method, path, status |
| jaeger_collector_http_server_errors_total | source, status |
| jaeger_collector_http_server_requests_total | type |
| jaeger_collector_in_queue_latency | host |
| jaeger_collector_queue_capacity | host |
| jaeger_collector_queue_length | host |
| jaeger_collector_save_latency | host |
| jaeger_collector_spans_bytes | host |
| jaeger_collector_spans_dropped_total | host |
| jaeger_collector_spans_received_total | debug, format, svc, transport |
| jaeger_collector_spans_rejected_total | debug, format, svc, transport |
| jaeger_collector_spans_saved_by_svc_total | debug, result, svc |
| jaeger_collector_spans_serviceNames | host |
| jaeger_collector_traces_received_total | debug, format, sampler_type, svc, transport |
| jaeger_collector_traces_rejected_total | debug, format, sampler_type, svc, transport |
| jaeger_collector_traces_saved_by_svc_total | debug, result, sampler_type, svc |
| process_cpu_seconds_total | |
| process_max_fds | |
| process_open_fds | |
| process_resident_memory_bytes | |
| process_start_time_seconds | |
| process_virtual_memory_bytes | |
| process_virtual_memory_max_bytes | |
### V2 Only Metrics

| Metric Name | Inner Parameters |
|-------------|------------------|
| exporter_send_failed_spans | exporter, service_instance_id, service_name, service_version |
| exporter_sent_spans | exporter, service_instance_id, service_name, service_version |
| process_cpu_seconds | service_instance_id, service_name, service_version |
| process_memory_rss | service_instance_id, service_name, service_version |
| process_runtime_heap_alloc_bytes | service_instance_id, service_name, service_version |
| process_runtime_total_alloc_bytes | service_instance_id, service_name, service_version |
| process_runtime_total_sys_memory_bytes | service_instance_id, service_name, service_version |
| process_uptime | service_instance_id, service_name, service_version |
| processor_batch_batch_send_size | processor, service_instance_id, service_name, service_version |
| processor_batch_metadata_cardinality | processor, service_instance_id, service_name, service_version |
| processor_batch_timeout_trigger_send | processor, service_instance_id, service_name, service_version |
| receiver_accepted_spans | receiver, service_instance_id, service_name, service_version, transport |
| receiver_refused_spans | receiver, service_instance_id, service_name, service_version, transport |
| target_info | service_instance_id, service_name, service_version |
### Equivalent Metrics

| V1 Metric | V1 Parameters | V2 Metric | V2 Parameters |
|-----------|---------------|-----------|---------------|
| jaeger_collector_spans_rejected_total | debug, format, svc, transport | receiver_refused_spans | receiver, service_instance_id, service_name, service_version, transport |
Loading
Loading