diff options
author | S. Solomon Darnell | 2025-03-28 21:52:21 -0500 |
---|---|---|
committer | S. Solomon Darnell | 2025-03-28 21:52:21 -0500 |
commit | 4a52a71956a8d46fcb7294ac71734504bb09bcc2 (patch) | |
tree | ee3dc5af3b6313e921cd920906356f5d4febc4ed /.venv/lib/python3.12/site-packages/opentelemetry/semconv/_incubating/metrics/process_metrics.py | |
parent | cc961e04ba734dd72309fb548a2f97d67d578813 (diff) | |
download | gn-ai-master.tar.gz |
Diffstat (limited to '.venv/lib/python3.12/site-packages/opentelemetry/semconv/_incubating/metrics/process_metrics.py')
-rw-r--r-- | .venv/lib/python3.12/site-packages/opentelemetry/semconv/_incubating/metrics/process_metrics.py | 235 |
1 files changed, 235 insertions, 0 deletions
diff --git a/.venv/lib/python3.12/site-packages/opentelemetry/semconv/_incubating/metrics/process_metrics.py b/.venv/lib/python3.12/site-packages/opentelemetry/semconv/_incubating/metrics/process_metrics.py new file mode 100644 index 00000000..902d79de --- /dev/null +++ b/.venv/lib/python3.12/site-packages/opentelemetry/semconv/_incubating/metrics/process_metrics.py @@ -0,0 +1,235 @@ +# Copyright The OpenTelemetry Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from typing import ( + Callable, + Final, + Generator, + Iterable, + Optional, + Sequence, + Union, +) + +from opentelemetry.metrics import ( + CallbackOptions, + Counter, + Meter, + ObservableGauge, + Observation, + UpDownCounter, +) + +# pylint: disable=invalid-name +CallbackT = Union[ + Callable[[CallbackOptions], Iterable[Observation]], + Generator[Iterable[Observation], CallbackOptions, None], +] + +PROCESS_CONTEXT_SWITCHES: Final = "process.context_switches" +""" +Number of times the process has been context switched +Instrument: counter +Unit: {context_switch} +""" + + +def create_process_context_switches(meter: Meter) -> Counter: + """Number of times the process has been context switched""" + return meter.create_counter( + name=PROCESS_CONTEXT_SWITCHES, + description="Number of times the process has been context switched.", + unit="{context_switch}", + ) + + +PROCESS_CPU_TIME: Final = "process.cpu.time" +""" +Total CPU seconds broken down by different states +Instrument: counter +Unit: s +""" + + +def create_process_cpu_time(meter: Meter) -> Counter: + """Total CPU seconds broken down by different states""" + return meter.create_counter( + name=PROCESS_CPU_TIME, + description="Total CPU seconds broken down by different states.", + unit="s", + ) + + +PROCESS_CPU_UTILIZATION: Final = "process.cpu.utilization" +""" +Difference in process.cpu.time since the last measurement, divided by the elapsed time and number of CPUs available to the process +Instrument: gauge +Unit: 1 +""" + + +def create_process_cpu_utilization( + meter: Meter, callbacks: Optional[Sequence[CallbackT]] +) -> ObservableGauge: + """Difference in process.cpu.time since the last measurement, divided by the elapsed time and number of CPUs available to the process""" + return meter.create_observable_gauge( + name=PROCESS_CPU_UTILIZATION, + callbacks=callbacks, + description="Difference in process.cpu.time since the last measurement, divided by the elapsed time and number of CPUs available to the process.", + unit="1", + ) + + +PROCESS_DISK_IO: Final = "process.disk.io" +""" +Disk bytes transferred +Instrument: counter +Unit: By +""" + + +def create_process_disk_io(meter: Meter) -> Counter: + """Disk bytes transferred""" + return meter.create_counter( + name=PROCESS_DISK_IO, + description="Disk bytes transferred.", + unit="By", + ) + + +PROCESS_MEMORY_USAGE: Final = "process.memory.usage" +""" +The amount of physical memory in use +Instrument: updowncounter +Unit: By +""" + + +def create_process_memory_usage(meter: Meter) -> UpDownCounter: + """The amount of physical memory in use""" + return meter.create_up_down_counter( + name=PROCESS_MEMORY_USAGE, + description="The amount of physical memory in use.", + unit="By", + ) + + +PROCESS_MEMORY_VIRTUAL: Final = "process.memory.virtual" +""" +The amount of committed virtual memory +Instrument: updowncounter +Unit: By +""" + + +def create_process_memory_virtual(meter: Meter) -> UpDownCounter: + """The amount of committed virtual memory""" + return meter.create_up_down_counter( + name=PROCESS_MEMORY_VIRTUAL, + description="The amount of committed virtual memory.", + unit="By", + ) + + +PROCESS_NETWORK_IO: Final = "process.network.io" +""" +Network bytes transferred +Instrument: counter +Unit: By +""" + + +def create_process_network_io(meter: Meter) -> Counter: + """Network bytes transferred""" + return meter.create_counter( + name=PROCESS_NETWORK_IO, + description="Network bytes transferred.", + unit="By", + ) + + +PROCESS_OPEN_FILE_DESCRIPTOR_COUNT: Final = ( + "process.open_file_descriptor.count" +) +""" +Number of file descriptors in use by the process +Instrument: updowncounter +Unit: {file_descriptor} +""" + + +def create_process_open_file_descriptor_count(meter: Meter) -> UpDownCounter: + """Number of file descriptors in use by the process""" + return meter.create_up_down_counter( + name=PROCESS_OPEN_FILE_DESCRIPTOR_COUNT, + description="Number of file descriptors in use by the process.", + unit="{file_descriptor}", + ) + + +PROCESS_PAGING_FAULTS: Final = "process.paging.faults" +""" +Number of page faults the process has made +Instrument: counter +Unit: {fault} +""" + + +def create_process_paging_faults(meter: Meter) -> Counter: + """Number of page faults the process has made""" + return meter.create_counter( + name=PROCESS_PAGING_FAULTS, + description="Number of page faults the process has made.", + unit="{fault}", + ) + + +PROCESS_THREAD_COUNT: Final = "process.thread.count" +""" +Process threads count +Instrument: updowncounter +Unit: {thread} +""" + + +def create_process_thread_count(meter: Meter) -> UpDownCounter: + """Process threads count""" + return meter.create_up_down_counter( + name=PROCESS_THREAD_COUNT, + description="Process threads count.", + unit="{thread}", + ) + + +PROCESS_UPTIME: Final = "process.uptime" +""" +The time the process has been running +Instrument: gauge +Unit: s +Note: Instrumentations SHOULD use a gauge with type `double` and measure uptime in seconds as a floating point number with the highest precision available. +The actual accuracy would depend on the instrumentation and operating system. +""" + + +def create_process_uptime( + meter: Meter, callbacks: Optional[Sequence[CallbackT]] +) -> ObservableGauge: + """The time the process has been running""" + return meter.create_observable_gauge( + name=PROCESS_UPTIME, + callbacks=callbacks, + description="The time the process has been running.", + unit="s", + ) |