@opentelemetry/semantic-conventions
Version:
OpenTelemetry semantic conventions
949 lines • 117 kB
JavaScript
/*
* 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
*
* https://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.
*/
//----------------------------------------------------------------------------------------------------------
// DO NOT EDIT, this is an Auto-generated file from scripts/semconv/templates/register/stable/metrics.ts.j2
//----------------------------------------------------------------------------------------------------------
/**
* Number of active client instances
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_AZURE_COSMOSDB_CLIENT_ACTIVE_INSTANCE_COUNT = 'azure.cosmosdb.client.active_instance.count';
/**
* [Request units](https://learn.microsoft.com/azure/cosmos-db/request-units) consumed by the operation
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_AZURE_COSMOSDB_CLIENT_OPERATION_REQUEST_CHARGE = 'azure.cosmosdb.client.operation.request_charge';
/**
* The number of pipeline runs currently active in the system by state.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_CICD_PIPELINE_RUN_ACTIVE = 'cicd.pipeline.run.active';
/**
* Duration of a pipeline run grouped by pipeline, state and result.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_CICD_PIPELINE_RUN_DURATION = 'cicd.pipeline.run.duration';
/**
* The number of errors encountered in pipeline runs (eg. compile, test failures).
*
* @note There might be errors in a pipeline run that are non fatal (eg. they are suppressed) or in a parallel stage multiple stages could have a fatal error.
* This means that this error count might not be the same as the count of metric `cicd.pipeline.run.duration` with run result `failure`.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_CICD_PIPELINE_RUN_ERRORS = 'cicd.pipeline.run.errors';
/**
* The number of errors in a component of the CICD system (eg. controller, scheduler, agent).
*
* @note Errors in pipeline run execution are explicitly excluded. Ie a test failure is not counted in this metric.
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_CICD_SYSTEM_ERRORS = 'cicd.system.errors';
/**
* The number of workers on the CICD system by state.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_CICD_WORKER_COUNT = 'cicd.worker.count';
/**
* Total CPU time consumed
*
* @note Total CPU time consumed by the specific container on all available CPU cores
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_CONTAINER_CPU_TIME = 'container.cpu.time';
/**
* Container's CPU usage, measured in cpus. Range from 0 to the number of allocatable CPUs
*
* @note CPU usage of the specific container on all available CPU cores, averaged over the sample window
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_CONTAINER_CPU_USAGE = 'container.cpu.usage';
/**
* Disk bytes for the container.
*
* @note The total number of bytes read/written successfully (aggregated from all disks).
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_CONTAINER_DISK_IO = 'container.disk.io';
/**
* Memory usage of the container.
*
* @note Memory usage of the container.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_CONTAINER_MEMORY_USAGE = 'container.memory.usage';
/**
* Network bytes for the container.
*
* @note The number of bytes sent/received on all network interfaces by the container.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_CONTAINER_NETWORK_IO = 'container.network.io';
/**
* The time the container has been running
*
* @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.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_CONTAINER_UPTIME = 'container.uptime';
/**
* Deprecated. Use `system.cpu.frequency` instead.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `system.cpu.frequency`.
*/
export const METRIC_CPU_FREQUENCY = 'cpu.frequency';
/**
* Deprecated. Use `system.cpu.time` instead.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `system.cpu.time`.
*/
export const METRIC_CPU_TIME = 'cpu.time';
/**
* Deprecated. Use `system.cpu.utilization` instead.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `system.cpu.utilization`.
*/
export const METRIC_CPU_UTILIZATION = 'cpu.utilization';
/**
* The total number of objects collected inside a generation since interpreter start.
*
* @note This metric reports data from [`gc.stats()`](https://docs.python.org/3/library/gc.html#gc.get_stats).
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_CPYTHON_GC_COLLECTED_OBJECTS = 'cpython.gc.collected_objects';
/**
* The number of times a generation was collected since interpreter start.
*
* @note This metric reports data from [`gc.stats()`](https://docs.python.org/3/library/gc.html#gc.get_stats).
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_CPYTHON_GC_COLLECTIONS = 'cpython.gc.collections';
/**
* The total number of objects which were found to be uncollectable inside a generation since interpreter start.
*
* @note This metric reports data from [`gc.stats()`](https://docs.python.org/3/library/gc.html#gc.get_stats).
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_CPYTHON_GC_UNCOLLECTABLE_OBJECTS = 'cpython.gc.uncollectable_objects';
/**
* The number of connections that are currently in state described by the `state` attribute
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_DB_CLIENT_CONNECTION_COUNT = 'db.client.connection.count';
/**
* The time it took to create a new connection
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_DB_CLIENT_CONNECTION_CREATE_TIME = 'db.client.connection.create_time';
/**
* The maximum number of idle open connections allowed
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_DB_CLIENT_CONNECTION_IDLE_MAX = 'db.client.connection.idle.max';
/**
* The minimum number of idle open connections allowed
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_DB_CLIENT_CONNECTION_IDLE_MIN = 'db.client.connection.idle.min';
/**
* The maximum number of open connections allowed
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_DB_CLIENT_CONNECTION_MAX = 'db.client.connection.max';
/**
* The number of current pending requests for an open connection
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_DB_CLIENT_CONNECTION_PENDING_REQUESTS = 'db.client.connection.pending_requests';
/**
* The number of connection timeouts that have occurred trying to obtain a connection from the pool
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_DB_CLIENT_CONNECTION_TIMEOUTS = 'db.client.connection.timeouts';
/**
* The time between borrowing a connection and returning it to the pool
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_DB_CLIENT_CONNECTION_USE_TIME = 'db.client.connection.use_time';
/**
* The time it took to obtain an open connection from the pool
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_DB_CLIENT_CONNECTION_WAIT_TIME = 'db.client.connection.wait_time';
/**
* Deprecated, use `db.client.connection.create_time` instead. Note: the unit also changed from `ms` to `s`.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `db.client.connection.create_time` with unit `s`.
*/
export const METRIC_DB_CLIENT_CONNECTIONS_CREATE_TIME = 'db.client.connections.create_time';
/**
* Deprecated, use `db.client.connection.idle.max` instead.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `db.client.connection.idle.max`.
*/
export const METRIC_DB_CLIENT_CONNECTIONS_IDLE_MAX = 'db.client.connections.idle.max';
/**
* Deprecated, use `db.client.connection.idle.min` instead.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `db.client.connection.idle.min`.
*/
export const METRIC_DB_CLIENT_CONNECTIONS_IDLE_MIN = 'db.client.connections.idle.min';
/**
* Deprecated, use `db.client.connection.max` instead.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `db.client.connection.max`.
*/
export const METRIC_DB_CLIENT_CONNECTIONS_MAX = 'db.client.connections.max';
/**
* Deprecated, use `db.client.connection.pending_requests` instead.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `db.client.connection.pending_requests`.
*/
export const METRIC_DB_CLIENT_CONNECTIONS_PENDING_REQUESTS = 'db.client.connections.pending_requests';
/**
* Deprecated, use `db.client.connection.timeouts` instead.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `db.client.connection.timeouts`.
*/
export const METRIC_DB_CLIENT_CONNECTIONS_TIMEOUTS = 'db.client.connections.timeouts';
/**
* Deprecated, use `db.client.connection.count` instead.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `db.client.connection.count`.
*/
export const METRIC_DB_CLIENT_CONNECTIONS_USAGE = 'db.client.connections.usage';
/**
* Deprecated, use `db.client.connection.use_time` instead. Note: the unit also changed from `ms` to `s`.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `db.client.connection.use_time` with unit `s`.
*/
export const METRIC_DB_CLIENT_CONNECTIONS_USE_TIME = 'db.client.connections.use_time';
/**
* Deprecated, use `db.client.connection.wait_time` instead. Note: the unit also changed from `ms` to `s`.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `db.client.connection.wait_time` with unit `s`.
*/
export const METRIC_DB_CLIENT_CONNECTIONS_WAIT_TIME = 'db.client.connections.wait_time';
/**
* Deprecated, use `azure.cosmosdb.client.active_instance.count` instead.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `azure.cosmosdb.client.active_instance.count`.
*/
export const METRIC_DB_CLIENT_COSMOSDB_ACTIVE_INSTANCE_COUNT = 'db.client.cosmosdb.active_instance.count';
/**
* Deprecated, use `azure.cosmosdb.client.operation.request_charge` instead.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `azure.cosmosdb.client.operation.request_charge`.
*/
export const METRIC_DB_CLIENT_COSMOSDB_OPERATION_REQUEST_CHARGE = 'db.client.cosmosdb.operation.request_charge';
/**
* The actual number of records returned by the database operation.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_DB_CLIENT_RESPONSE_RETURNED_ROWS = 'db.client.response.returned_rows';
/**
* Measures the time taken to perform a DNS lookup.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_DNS_LOOKUP_DURATION = 'dns.lookup.duration';
/**
* Number of invocation cold starts
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_FAAS_COLDSTARTS = 'faas.coldstarts';
/**
* Distribution of CPU usage per invocation
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_FAAS_CPU_USAGE = 'faas.cpu_usage';
/**
* Number of invocation errors
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_FAAS_ERRORS = 'faas.errors';
/**
* Measures the duration of the function's initialization, such as a cold start
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_FAAS_INIT_DURATION = 'faas.init_duration';
/**
* Number of successful invocations
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_FAAS_INVOCATIONS = 'faas.invocations';
/**
* Measures the duration of the function's logic execution
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_FAAS_INVOKE_DURATION = 'faas.invoke_duration';
/**
* Distribution of max memory usage per invocation
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_FAAS_MEM_USAGE = 'faas.mem_usage';
/**
* Distribution of net I/O usage per invocation
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_FAAS_NET_IO = 'faas.net_io';
/**
* Number of invocation timeouts
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_FAAS_TIMEOUTS = 'faas.timeouts';
/**
* GenAI operation duration
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_GEN_AI_CLIENT_OPERATION_DURATION = 'gen_ai.client.operation.duration';
/**
* Measures number of input and output tokens used
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_GEN_AI_CLIENT_TOKEN_USAGE = 'gen_ai.client.token.usage';
/**
* Generative AI server request duration such as time-to-last byte or last output token
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_GEN_AI_SERVER_REQUEST_DURATION = 'gen_ai.server.request.duration';
/**
* Time per output token generated after the first token for successful responses
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_GEN_AI_SERVER_TIME_PER_OUTPUT_TOKEN = 'gen_ai.server.time_per_output_token';
/**
* Time to generate first token for successful responses
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_GEN_AI_SERVER_TIME_TO_FIRST_TOKEN = 'gen_ai.server.time_to_first_token';
/**
* Heap size target percentage configured by the user, otherwise 100.
*
* @note The value range is [0.0,100.0]. Computed from `/gc/gogc:percent`.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_GO_CONFIG_GOGC = 'go.config.gogc';
/**
* Count of live goroutines.
*
* @note Computed from `/sched/goroutines:goroutines`.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_GO_GOROUTINE_COUNT = 'go.goroutine.count';
/**
* Memory allocated to the heap by the application.
*
* @note Computed from `/gc/heap/allocs:bytes`.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_GO_MEMORY_ALLOCATED = 'go.memory.allocated';
/**
* Count of allocations to the heap by the application.
*
* @note Computed from `/gc/heap/allocs:objects`.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_GO_MEMORY_ALLOCATIONS = 'go.memory.allocations';
/**
* Heap size target for the end of the GC cycle.
*
* @note Computed from `/gc/heap/goal:bytes`.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_GO_MEMORY_GC_GOAL = 'go.memory.gc.goal';
/**
* Go runtime memory limit configured by the user, if a limit exists.
*
* @note Computed from `/gc/gomemlimit:bytes`. This metric is excluded if the limit obtained from the Go runtime is math.MaxInt64.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_GO_MEMORY_LIMIT = 'go.memory.limit';
/**
* Memory used by the Go runtime.
*
* @note Computed from `(/memory/classes/total:bytes - /memory/classes/heap/released:bytes)`.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_GO_MEMORY_USED = 'go.memory.used';
/**
* The number of OS threads that can execute user-level Go code simultaneously.
*
* @note Computed from `/sched/gomaxprocs:threads`.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_GO_PROCESSOR_LIMIT = 'go.processor.limit';
/**
* The time goroutines have spent in the scheduler in a runnable state before actually running.
*
* @note Computed from `/sched/latencies:seconds`. Bucket boundaries are provided by the runtime, and are subject to change.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_GO_SCHEDULE_DURATION = 'go.schedule.duration';
/**
* Number of active HTTP requests.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_HTTP_CLIENT_ACTIVE_REQUESTS = 'http.client.active_requests';
/**
* The duration of the successfully established outbound HTTP connections.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_HTTP_CLIENT_CONNECTION_DURATION = 'http.client.connection.duration';
/**
* Number of outbound HTTP connections that are currently active or idle on the client.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_HTTP_CLIENT_OPEN_CONNECTIONS = 'http.client.open_connections';
/**
* Size of HTTP client request bodies.
*
* @note The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_HTTP_CLIENT_REQUEST_BODY_SIZE = 'http.client.request.body.size';
/**
* Size of HTTP client response bodies.
*
* @note The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_HTTP_CLIENT_RESPONSE_BODY_SIZE = 'http.client.response.body.size';
/**
* Number of active HTTP server requests.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_HTTP_SERVER_ACTIVE_REQUESTS = 'http.server.active_requests';
/**
* Size of HTTP server request bodies.
*
* @note The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_HTTP_SERVER_REQUEST_BODY_SIZE = 'http.server.request.body.size';
/**
* Size of HTTP server response bodies.
*
* @note The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_HTTP_SERVER_RESPONSE_BODY_SIZE = 'http.server.response.body.size';
/**
* Energy consumed by the component
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_HW_ENERGY = 'hw.energy';
/**
* Number of errors encountered by the component
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_HW_ERRORS = 'hw.errors';
/**
* Ambient (external) temperature of the physical host
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_HW_HOST_AMBIENT_TEMPERATURE = 'hw.host.ambient_temperature';
/**
* Total energy consumed by the entire physical host, in joules
*
* @note The overall energy usage of a host **MUST** be reported using the specific `hw.host.energy` and `hw.host.power` metrics **only**, instead of the generic `hw.energy` and `hw.power` described in the previous section, to prevent summing up overlapping values.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_HW_HOST_ENERGY = 'hw.host.energy';
/**
* By how many degrees Celsius the temperature of the physical host can be increased, before reaching a warning threshold on one of the internal sensors
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_HW_HOST_HEATING_MARGIN = 'hw.host.heating_margin';
/**
* Instantaneous power consumed by the entire physical host in Watts (`hw.host.energy` is preferred)
*
* @note The overall energy usage of a host **MUST** be reported using the specific `hw.host.energy` and `hw.host.power` metrics **only**, instead of the generic `hw.energy` and `hw.power` described in the previous section, to prevent summing up overlapping values.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_HW_HOST_POWER = 'hw.host.power';
/**
* Instantaneous power consumed by the component
*
* @note It is recommended to report `hw.energy` instead of `hw.power` when possible.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_HW_POWER = 'hw.power';
/**
* Operational status: `1` (true) or `0` (false) for each of the possible states
*
* @note `hw.status` is currently specified as an *UpDownCounter* but would ideally be represented using a [*StateSet* as defined in OpenMetrics](https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#stateset). This semantic convention will be updated once *StateSet* is specified in OpenTelemetry. This planned change is not expected to have any consequence on the way users query their timeseries backend to retrieve the values of `hw.status` over time.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_HW_STATUS = 'hw.status';
/**
* Number of buffers in the pool.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_JVM_BUFFER_COUNT = 'jvm.buffer.count';
/**
* Measure of total memory capacity of buffers.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_JVM_BUFFER_MEMORY_LIMIT = 'jvm.buffer.memory.limit';
/**
* Deprecated, use `jvm.buffer.memory.used` instead.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*
* @deprecated Replaced by `jvm.buffer.memory.used`.
*/
export const METRIC_JVM_BUFFER_MEMORY_USAGE = 'jvm.buffer.memory.usage';
/**
* Measure of memory used by buffers.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_JVM_BUFFER_MEMORY_USED = 'jvm.buffer.memory.used';
/**
* Number of open file descriptors as reported by the JVM.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_JVM_FILE_DESCRIPTOR_COUNT = 'jvm.file_descriptor.count';
/**
* Measure of initial memory requested.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_JVM_MEMORY_INIT = 'jvm.memory.init';
/**
* Average CPU load of the whole system for the last minute as reported by the JVM.
*
* @note The value range is [0,n], where n is the number of CPU cores - or a negative number if the value is not available. This utilization is not defined as being for the specific interval since last measurement (unlike `system.cpu.utilization`). [Reference](https://docs.oracle.com/en/java/javase/17/docs/api/java.management/java/lang/management/OperatingSystemMXBean.html#getSystemLoadAverage()).
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_JVM_SYSTEM_CPU_LOAD_1M = 'jvm.system.cpu.load_1m';
/**
* Recent CPU utilization for the whole system as reported by the JVM.
*
* @note The value range is [0.0,1.0]. This utilization is not defined as being for the specific interval since last measurement (unlike `system.cpu.utilization`). [Reference](https://docs.oracle.com/en/java/javase/17/docs/api/jdk.management/com/sun/management/OperatingSystemMXBean.html#getCpuLoad()).
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_JVM_SYSTEM_CPU_UTILIZATION = 'jvm.system.cpu.utilization';
/**
* Maximum CPU resource limit set for the container
*
* @note See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core for details.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_CONTAINER_CPU_LIMIT = 'k8s.container.cpu.limit';
/**
* CPU resource requested for the container
*
* @note See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core for details.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_CONTAINER_CPU_REQUEST = 'k8s.container.cpu.request';
/**
* Maximum ephemeral storage resource limit set for the container
*
* @note See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core for details.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_CONTAINER_EPHEMERAL_STORAGE_LIMIT = 'k8s.container.ephemeral_storage.limit';
/**
* Ephemeral storage resource requested for the container
*
* @note See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core for details.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_CONTAINER_EPHEMERAL_STORAGE_REQUEST = 'k8s.container.ephemeral_storage.request';
/**
* Maximum memory resource limit set for the container
*
* @note See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core for details.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_CONTAINER_MEMORY_LIMIT = 'k8s.container.memory.limit';
/**
* Memory resource requested for the container
*
* @note See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core for details.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_CONTAINER_MEMORY_REQUEST = 'k8s.container.memory.request';
/**
* Indicates whether the container is currently marked as ready to accept traffic, based on its readiness probe (1 = ready, 0 = not ready)
*
* @note This metric **SHOULD** reflect the value of the `ready` field in the
* [K8s ContainerStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#containerstatus-v1-core).
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_CONTAINER_READY = 'k8s.container.ready';
/**
* Describes how many times the container has restarted (since the last counter reset)
*
* @note This value is pulled directly from the K8s API and the value can go indefinitely high and be reset to 0
* at any time depending on how your kubelet is configured to prune dead containers.
* It is best to not depend too much on the exact value but rather look at it as
* either == 0, in which case you can conclude there were no restarts in the recent past, or > 0, in which case
* you can conclude there were restarts in the recent past, and not try and analyze the value beyond that.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_CONTAINER_RESTART_COUNT = 'k8s.container.restart.count';
/**
* Describes the number of K8s containers that are currently in a state for a given reason
*
* @note All possible container state reasons will be reported at each time interval to avoid missing metrics.
* Only the value corresponding to the current state reason will be non-zero.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_CONTAINER_STATUS_REASON = 'k8s.container.status.reason';
/**
* Describes the number of K8s containers that are currently in a given state
*
* @note All possible container states will be reported at each time interval to avoid missing metrics.
* Only the value corresponding to the current state will be non-zero.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_CONTAINER_STATUS_STATE = 'k8s.container.status.state';
/**
* Maximum storage resource limit set for the container
*
* @note See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core for details.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_CONTAINER_STORAGE_LIMIT = 'k8s.container.storage.limit';
/**
* Storage resource requested for the container
*
* @note See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#resourcerequirements-v1-core for details.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_CONTAINER_STORAGE_REQUEST = 'k8s.container.storage.request';
/**
* The number of actively running jobs for a cronjob
*
* @note This metric aligns with the `active` field of the
* [K8s CronJobStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#cronjobstatus-v1-batch).
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_CRONJOB_ACTIVE_JOBS = 'k8s.cronjob.active_jobs';
/**
* Number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod
*
* @note This metric aligns with the `currentNumberScheduled` field of the
* [K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps).
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_DAEMONSET_CURRENT_SCHEDULED_NODES = 'k8s.daemonset.current_scheduled_nodes';
/**
* Number of nodes that should be running the daemon pod (including nodes currently running the daemon pod)
*
* @note This metric aligns with the `desiredNumberScheduled` field of the
* [K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps).
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_DAEMONSET_DESIRED_SCHEDULED_NODES = 'k8s.daemonset.desired_scheduled_nodes';
/**
* Number of nodes that are running the daemon pod, but are not supposed to run the daemon pod
*
* @note This metric aligns with the `numberMisscheduled` field of the
* [K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps).
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_DAEMONSET_MISSCHEDULED_NODES = 'k8s.daemonset.misscheduled_nodes';
/**
* Number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready
*
* @note This metric aligns with the `numberReady` field of the
* [K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps).
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_DAEMONSET_READY_NODES = 'k8s.daemonset.ready_nodes';
/**
* Total number of available replica pods (ready for at least minReadySeconds) targeted by this deployment
*
* @note This metric aligns with the `availableReplicas` field of the
* [K8s DeploymentStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#deploymentstatus-v1-apps).
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_DEPLOYMENT_AVAILABLE_PODS = 'k8s.deployment.available_pods';
/**
* Number of desired replica pods in this deployment
*
* @note This metric aligns with the `replicas` field of the
* [K8s DeploymentSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#deploymentspec-v1-apps).
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_DEPLOYMENT_DESIRED_PODS = 'k8s.deployment.desired_pods';
/**
* Current number of replica pods managed by this horizontal pod autoscaler, as last seen by the autoscaler
*
* @note This metric aligns with the `currentReplicas` field of the
* [K8s HorizontalPodAutoscalerStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#horizontalpodautoscalerstatus-v2-autoscaling)
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_HPA_CURRENT_PODS = 'k8s.hpa.current_pods';
/**
* Desired number of replica pods managed by this horizontal pod autoscaler, as last calculated by the autoscaler
*
* @note This metric aligns with the `desiredReplicas` field of the
* [K8s HorizontalPodAutoscalerStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#horizontalpodautoscalerstatus-v2-autoscaling)
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_HPA_DESIRED_PODS = 'k8s.hpa.desired_pods';
/**
* The upper limit for the number of replica pods to which the autoscaler can scale up
*
* @note This metric aligns with the `maxReplicas` field of the
* [K8s HorizontalPodAutoscalerSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#horizontalpodautoscalerspec-v2-autoscaling)
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_HPA_MAX_PODS = 'k8s.hpa.max_pods';
/**
* Target average utilization, in percentage, for CPU resource in HPA config.
*
* @note This metric aligns with the `averageUtilization` field of the
* [K8s HPA MetricTarget](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#metrictarget-v2-autoscaling).
* If the type of the metric is [`ContainerResource`](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#support-for-metrics-apis),
* the `k8s.container.name` attribute **MUST** be set to identify the specific container within the pod to which the metric applies.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_HPA_METRIC_TARGET_CPU_AVERAGE_UTILIZATION = 'k8s.hpa.metric.target.cpu.average_utilization';
/**
* Target average value for CPU resource in HPA config.
*
* @note This metric aligns with the `averageValue` field of the
* [K8s HPA MetricTarget](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#metrictarget-v2-autoscaling).
* If the type of the metric is [`ContainerResource`](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#support-for-metrics-apis),
* the `k8s.container.name` attribute **MUST** be set to identify the specific container within the pod to which the metric applies.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_HPA_METRIC_TARGET_CPU_AVERAGE_VALUE = 'k8s.hpa.metric.target.cpu.average_value';
/**
* Target value for CPU resource in HPA config.
*
* @note This metric aligns with the `value` field of the
* [K8s HPA MetricTarget](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#metrictarget-v2-autoscaling).
* If the type of the metric is [`ContainerResource`](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#support-for-metrics-apis),
* the `k8s.container.name` attribute **MUST** be set to identify the specific container within the pod to which the metric applies.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_HPA_METRIC_TARGET_CPU_VALUE = 'k8s.hpa.metric.target.cpu.value';
/**
* The lower limit for the number of replica pods to which the autoscaler can scale down
*
* @note This metric aligns with the `minReplicas` field of the
* [K8s HorizontalPodAutoscalerSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#horizontalpodautoscalerspec-v2-autoscaling)
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_HPA_MIN_PODS = 'k8s.hpa.min_pods';
/**
* The number of pending and actively running pods for a job
*
* @note This metric aligns with the `active` field of the
* [K8s JobStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#jobstatus-v1-batch).
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_JOB_ACTIVE_PODS = 'k8s.job.active_pods';
/**
* The desired number of successfully finished pods the job should be run with
*
* @note This metric aligns with the `completions` field of the
* [K8s JobSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#jobspec-v1-batch)..
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_JOB_DESIRED_SUCCESSFUL_PODS = 'k8s.job.desired_successful_pods';
/**
* The number of pods which reached phase Failed for a job
*
* @note This metric aligns with the `failed` field of the
* [K8s JobStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#jobstatus-v1-batch).
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_JOB_FAILED_PODS = 'k8s.job.failed_pods';
/**
* The max desired number of pods the job should run at any given time
*
* @note This metric aligns with the `parallelism` field of the
* [K8s JobSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#jobspec-v1-batch).
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_JOB_MAX_PARALLEL_PODS = 'k8s.job.max_parallel_pods';
/**
* The number of pods which reached phase Succeeded for a job
*
* @note This metric aligns with the `succeeded` field of the
* [K8s JobStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#jobstatus-v1-batch).
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_JOB_SUCCESSFUL_PODS = 'k8s.job.successful_pods';
/**
* Describes number of K8s namespaces that are currently in a given phase.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_NAMESPACE_PHASE = 'k8s.namespace.phase';
/**
* Amount of cpu allocatable on the node
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_NODE_ALLOCATABLE_CPU = 'k8s.node.allocatable.cpu';
/**
* Amount of ephemeral-storage allocatable on the node
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_NODE_ALLOCATABLE_EPHEMERAL_STORAGE = 'k8s.node.allocatable.ephemeral_storage';
/**
* Amount of memory allocatable on the node
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_NODE_ALLOCATABLE_MEMORY = 'k8s.node.allocatable.memory';
/**
* Amount of pods allocatable on the node
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export const METRIC_K8S_NODE_ALLOCATABLE_PODS = 'k8s.node.allocatable.pods';
/**
* Descr