From 5d151671ff9ad5ecb20c507ddfe64684a46aa6c6 Mon Sep 17 00:00:00 2001 From: Liudmila Molkova Date: Sun, 9 Jun 2024 18:56:54 -0700 Subject: [PATCH] metrics cleanup --- .../_incubating/metrics/system_metrics.py | 48 +++++++++++++++++++ .../templates/registry/semantic_metrics.j2 | 4 +- 2 files changed, 51 insertions(+), 1 deletion(-) diff --git a/opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/metrics/system_metrics.py b/opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/metrics/system_metrics.py index 5a5e32b2650..640f010e994 100644 --- a/opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/metrics/system_metrics.py +++ b/opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/metrics/system_metrics.py @@ -114,6 +114,10 @@ def create_system_cpu_utilization( SYSTEM_DISK_IO = "system.disk.io" +""" +Instrument: counter +Unit: By +""" def create_system_disk_io(meter: Meter) -> Counter: @@ -148,6 +152,10 @@ def create_system_disk_io_time(meter: Meter) -> Counter: SYSTEM_DISK_MERGED = "system.disk.merged" +""" +Instrument: counter +Unit: {operation} +""" def create_system_disk_merged(meter: Meter) -> Counter: @@ -180,6 +188,10 @@ def create_system_disk_operation_time(meter: Meter) -> Counter: SYSTEM_DISK_OPERATIONS = "system.disk.operations" +""" +Instrument: counter +Unit: {operation} +""" def create_system_disk_operations(meter: Meter) -> Counter: @@ -191,6 +203,10 @@ def create_system_disk_operations(meter: Meter) -> Counter: SYSTEM_FILESYSTEM_USAGE = "system.filesystem.usage" +""" +Instrument: updowncounter +Unit: By +""" def create_system_filesystem_usage(meter: Meter) -> UpDownCounter: @@ -202,6 +218,10 @@ def create_system_filesystem_usage(meter: Meter) -> UpDownCounter: SYSTEM_FILESYSTEM_UTILIZATION = "system.filesystem.utilization" +""" +Instrument: gauge +Unit: 1 +""" def create_system_filesystem_utilization( @@ -294,6 +314,10 @@ def create_system_memory_usage(meter: Meter) -> UpDownCounter: SYSTEM_MEMORY_UTILIZATION = "system.memory.utilization" +""" +Instrument: gauge +Unit: 1 +""" def create_system_memory_utilization( @@ -308,6 +332,10 @@ def create_system_memory_utilization( SYSTEM_NETWORK_CONNECTIONS = "system.network.connections" +""" +Instrument: updowncounter +Unit: {connection} +""" def create_system_network_connections(meter: Meter) -> UpDownCounter: @@ -363,6 +391,10 @@ def create_system_network_errors(meter: Meter) -> Counter: SYSTEM_NETWORK_IO = "system.network.io" +""" +Instrument: counter +Unit: By +""" def create_system_network_io(meter: Meter) -> Counter: @@ -374,6 +406,10 @@ def create_system_network_io(meter: Meter) -> Counter: SYSTEM_NETWORK_PACKETS = "system.network.packets" +""" +Instrument: counter +Unit: {packet} +""" def create_system_network_packets(meter: Meter) -> Counter: @@ -385,6 +421,10 @@ def create_system_network_packets(meter: Meter) -> Counter: SYSTEM_PAGING_FAULTS = "system.paging.faults" +""" +Instrument: counter +Unit: {fault} +""" def create_system_paging_faults(meter: Meter) -> Counter: @@ -396,6 +436,10 @@ def create_system_paging_faults(meter: Meter) -> Counter: SYSTEM_PAGING_OPERATIONS = "system.paging.operations" +""" +Instrument: counter +Unit: {operation} +""" def create_system_paging_operations(meter: Meter) -> Counter: @@ -424,6 +468,10 @@ def create_system_paging_usage(meter: Meter) -> UpDownCounter: SYSTEM_PAGING_UTILIZATION = "system.paging.utilization" +""" +Instrument: gauge +Unit: 1 +""" def create_system_paging_utilization( diff --git a/scripts/semconv/templates/registry/semantic_metrics.j2 b/scripts/semconv/templates/registry/semantic_metrics.j2 index 68a9d475da1..2de58f6bddb 100644 --- a/scripts/semconv/templates/registry/semantic_metrics.j2 +++ b/scripts/semconv/templates/registry/semantic_metrics.j2 @@ -26,8 +26,10 @@ {{prefix}}Deprecated: {{c.to_docstring(metric.deprecated, prefix)}} {%- elif ctx.filter == "any" and metric.stability == "stable" %} {{prefix}}Deprecated in favor of stable :py:const:`{{stable_class_ref(metric.metric_name, '.')}}` - {%- elif c.str_or_empty(metric.brief)|length %} + {%- else -%} + {%- if c.str_or_empty(metric.brief)|length %} {{prefix}}{{c.to_docstring(metric.brief, prefix)}} + {%- endif %} {{prefix}}Instrument: {{ metric.instrument }} {{prefix}}Unit: {{ metric.unit }} {%- if c.str_or_empty(metric.note)|length %}