Add SDK Log health metrics (#1921)
Co-authored-by: Liudmila Molkova <limolkova@microsoft.com>
This commit is contained in:
Jonas Kunz
GitHub
parent
a18f2cafe1
commit
f69c711b69
|
|
@ -0,0 +1,22 @@
|
||||||
|
# Use this changelog template to create an entry for release notes.
|
||||||
|
#
|
||||||
|
# If your change doesn't affect end users you should instead start
|
||||||
|
# your pull request title with [chore] or use the "Skip Changelog" label.
|
||||||
|
|
||||||
|
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
|
||||||
|
change_type: 'enhancement'
|
||||||
|
|
||||||
|
# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
|
||||||
|
component: 'otel'
|
||||||
|
|
||||||
|
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
|
||||||
|
note: Adds SDK self-monitoring metrics for log processing
|
||||||
|
|
||||||
|
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
|
||||||
|
# The values here must be integers.
|
||||||
|
issues: [1921]
|
||||||
|
|
||||||
|
# (Optional) One or more lines of additional information to render under the primary note.
|
||||||
|
# These lines will be padded with 2 spaces and then inserted directly into the document.
|
||||||
|
# Use pipe (|) for multiline entries.
|
||||||
|
subtext:
|
||||||
|
|
@ -69,10 +69,15 @@ E.g. for Java the fully qualified classname SHOULD be used in this case.
|
||||||
|
|
||||||
| Value | Description | Stability |
|
| Value | Description | Stability |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
|
| `batching_log_processor` | The builtin SDK Batching LogRecord Processor |  |
|
||||||
| `batching_span_processor` | The builtin SDK Batching Span Processor |  |
|
| `batching_span_processor` | The builtin SDK Batching Span Processor |  |
|
||||||
|
| `otlp_grpc_log_exporter` | OTLP LogRecord exporter over gRPC with protobuf serialization |  |
|
||||||
| `otlp_grpc_span_exporter` | OTLP span exporter over gRPC with protobuf serialization |  |
|
| `otlp_grpc_span_exporter` | OTLP span exporter over gRPC with protobuf serialization |  |
|
||||||
|
| `otlp_http_json_log_exporter` | OTLP LogRecord exporter over HTTP with JSON serialization |  |
|
||||||
| `otlp_http_json_span_exporter` | OTLP span exporter over HTTP with JSON serialization |  |
|
| `otlp_http_json_span_exporter` | OTLP span exporter over HTTP with JSON serialization |  |
|
||||||
|
| `otlp_http_log_exporter` | OTLP LogRecord exporter over HTTP with protobuf serialization |  |
|
||||||
| `otlp_http_span_exporter` | OTLP span exporter over HTTP with protobuf serialization |  |
|
| `otlp_http_span_exporter` | OTLP span exporter over HTTP with protobuf serialization |  |
|
||||||
|
| `simple_log_processor` | The builtin SDK Simple LogRecord Processor |  |
|
||||||
| `simple_span_processor` | The builtin SDK Simple Span Processor |  |
|
| `simple_span_processor` | The builtin SDK Simple Span Processor |  |
|
||||||
|
|
||||||
## OTel Scope Attributes
|
## OTel Scope Attributes
|
||||||
|
|
|
||||||
|
|
@ -20,6 +20,12 @@ This document describes metrics emitted by the OpenTelemetry SDK components them
|
||||||
- [Metric: `otel.sdk.processor.span.processed.count`](#metric-otelsdkprocessorspanprocessedcount)
|
- [Metric: `otel.sdk.processor.span.processed.count`](#metric-otelsdkprocessorspanprocessedcount)
|
||||||
- [Metric: `otel.sdk.exporter.span.inflight.count`](#metric-otelsdkexporterspaninflightcount)
|
- [Metric: `otel.sdk.exporter.span.inflight.count`](#metric-otelsdkexporterspaninflightcount)
|
||||||
- [Metric: `otel.sdk.exporter.span.exported.count`](#metric-otelsdkexporterspanexportedcount)
|
- [Metric: `otel.sdk.exporter.span.exported.count`](#metric-otelsdkexporterspanexportedcount)
|
||||||
|
- [Metric: `otel.sdk.log.created`](#metric-otelsdklogcreated)
|
||||||
|
- [Metric: `otel.sdk.processor.log.queue.size`](#metric-otelsdkprocessorlogqueuesize)
|
||||||
|
- [Metric: `otel.sdk.processor.log.queue.capacity`](#metric-otelsdkprocessorlogqueuecapacity)
|
||||||
|
- [Metric: `otel.sdk.processor.log.processed`](#metric-otelsdkprocessorlogprocessed)
|
||||||
|
- [Metric: `otel.sdk.exporter.log.inflight`](#metric-otelsdkexporterloginflight)
|
||||||
|
- [Metric: `otel.sdk.exporter.log.exported`](#metric-otelsdkexporterlogexported)
|
||||||
|
|
||||||
<!-- tocstop -->
|
<!-- tocstop -->
|
||||||
|
|
||||||
|
|
@ -144,10 +150,15 @@ E.g. for Java the fully qualified classname SHOULD be used in this case.
|
||||||
|
|
||||||
| Value | Description | Stability |
|
| Value | Description | Stability |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
|
| `batching_log_processor` | The builtin SDK Batching LogRecord Processor |  |
|
||||||
| `batching_span_processor` | The builtin SDK Batching Span Processor |  |
|
| `batching_span_processor` | The builtin SDK Batching Span Processor |  |
|
||||||
|
| `otlp_grpc_log_exporter` | OTLP LogRecord exporter over gRPC with protobuf serialization |  |
|
||||||
| `otlp_grpc_span_exporter` | OTLP span exporter over gRPC with protobuf serialization |  |
|
| `otlp_grpc_span_exporter` | OTLP span exporter over gRPC with protobuf serialization |  |
|
||||||
|
| `otlp_http_json_log_exporter` | OTLP LogRecord exporter over HTTP with JSON serialization |  |
|
||||||
| `otlp_http_json_span_exporter` | OTLP span exporter over HTTP with JSON serialization |  |
|
| `otlp_http_json_span_exporter` | OTLP span exporter over HTTP with JSON serialization |  |
|
||||||
|
| `otlp_http_log_exporter` | OTLP LogRecord exporter over HTTP with protobuf serialization |  |
|
||||||
| `otlp_http_span_exporter` | OTLP span exporter over HTTP with protobuf serialization |  |
|
| `otlp_http_span_exporter` | OTLP span exporter over HTTP with protobuf serialization |  |
|
||||||
|
| `simple_log_processor` | The builtin SDK Simple LogRecord Processor |  |
|
||||||
| `simple_span_processor` | The builtin SDK Simple Span Processor |  |
|
| `simple_span_processor` | The builtin SDK Simple Span Processor |  |
|
||||||
|
|
||||||
<!-- markdownlint-restore -->
|
<!-- markdownlint-restore -->
|
||||||
|
|
@ -200,10 +211,15 @@ E.g. for Java the fully qualified classname SHOULD be used in this case.
|
||||||
|
|
||||||
| Value | Description | Stability |
|
| Value | Description | Stability |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
|
| `batching_log_processor` | The builtin SDK Batching LogRecord Processor |  |
|
||||||
| `batching_span_processor` | The builtin SDK Batching Span Processor |  |
|
| `batching_span_processor` | The builtin SDK Batching Span Processor |  |
|
||||||
|
| `otlp_grpc_log_exporter` | OTLP LogRecord exporter over gRPC with protobuf serialization |  |
|
||||||
| `otlp_grpc_span_exporter` | OTLP span exporter over gRPC with protobuf serialization |  |
|
| `otlp_grpc_span_exporter` | OTLP span exporter over gRPC with protobuf serialization |  |
|
||||||
|
| `otlp_http_json_log_exporter` | OTLP LogRecord exporter over HTTP with JSON serialization |  |
|
||||||
| `otlp_http_json_span_exporter` | OTLP span exporter over HTTP with JSON serialization |  |
|
| `otlp_http_json_span_exporter` | OTLP span exporter over HTTP with JSON serialization |  |
|
||||||
|
| `otlp_http_log_exporter` | OTLP LogRecord exporter over HTTP with protobuf serialization |  |
|
||||||
| `otlp_http_span_exporter` | OTLP span exporter over HTTP with protobuf serialization |  |
|
| `otlp_http_span_exporter` | OTLP span exporter over HTTP with protobuf serialization |  |
|
||||||
|
| `simple_log_processor` | The builtin SDK Simple LogRecord Processor |  |
|
||||||
| `simple_span_processor` | The builtin SDK Simple Span Processor |  |
|
| `simple_span_processor` | The builtin SDK Simple Span Processor |  |
|
||||||
|
|
||||||
<!-- markdownlint-restore -->
|
<!-- markdownlint-restore -->
|
||||||
|
|
@ -286,10 +302,15 @@ E.g. for Java the fully qualified classname SHOULD be used in this case.
|
||||||
|
|
||||||
| Value | Description | Stability |
|
| Value | Description | Stability |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
|
| `batching_log_processor` | The builtin SDK Batching LogRecord Processor |  |
|
||||||
| `batching_span_processor` | The builtin SDK Batching Span Processor |  |
|
| `batching_span_processor` | The builtin SDK Batching Span Processor |  |
|
||||||
|
| `otlp_grpc_log_exporter` | OTLP LogRecord exporter over gRPC with protobuf serialization |  |
|
||||||
| `otlp_grpc_span_exporter` | OTLP span exporter over gRPC with protobuf serialization |  |
|
| `otlp_grpc_span_exporter` | OTLP span exporter over gRPC with protobuf serialization |  |
|
||||||
|
| `otlp_http_json_log_exporter` | OTLP LogRecord exporter over HTTP with JSON serialization |  |
|
||||||
| `otlp_http_json_span_exporter` | OTLP span exporter over HTTP with JSON serialization |  |
|
| `otlp_http_json_span_exporter` | OTLP span exporter over HTTP with JSON serialization |  |
|
||||||
|
| `otlp_http_log_exporter` | OTLP LogRecord exporter over HTTP with protobuf serialization |  |
|
||||||
| `otlp_http_span_exporter` | OTLP span exporter over HTTP with protobuf serialization |  |
|
| `otlp_http_span_exporter` | OTLP span exporter over HTTP with protobuf serialization |  |
|
||||||
|
| `simple_log_processor` | The builtin SDK Simple LogRecord Processor |  |
|
||||||
| `simple_span_processor` | The builtin SDK Simple Span Processor |  |
|
| `simple_span_processor` | The builtin SDK Simple Span Processor |  |
|
||||||
|
|
||||||
<!-- markdownlint-restore -->
|
<!-- markdownlint-restore -->
|
||||||
|
|
@ -348,10 +369,15 @@ E.g. for Java the fully qualified classname SHOULD be used in this case.
|
||||||
|
|
||||||
| Value | Description | Stability |
|
| Value | Description | Stability |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
|
| `batching_log_processor` | The builtin SDK Batching LogRecord Processor |  |
|
||||||
| `batching_span_processor` | The builtin SDK Batching Span Processor |  |
|
| `batching_span_processor` | The builtin SDK Batching Span Processor |  |
|
||||||
|
| `otlp_grpc_log_exporter` | OTLP LogRecord exporter over gRPC with protobuf serialization |  |
|
||||||
| `otlp_grpc_span_exporter` | OTLP span exporter over gRPC with protobuf serialization |  |
|
| `otlp_grpc_span_exporter` | OTLP span exporter over gRPC with protobuf serialization |  |
|
||||||
|
| `otlp_http_json_log_exporter` | OTLP LogRecord exporter over HTTP with JSON serialization |  |
|
||||||
| `otlp_http_json_span_exporter` | OTLP span exporter over HTTP with JSON serialization |  |
|
| `otlp_http_json_span_exporter` | OTLP span exporter over HTTP with JSON serialization |  |
|
||||||
|
| `otlp_http_log_exporter` | OTLP LogRecord exporter over HTTP with protobuf serialization |  |
|
||||||
| `otlp_http_span_exporter` | OTLP span exporter over HTTP with protobuf serialization |  |
|
| `otlp_http_span_exporter` | OTLP span exporter over HTTP with protobuf serialization |  |
|
||||||
|
| `simple_log_processor` | The builtin SDK Simple LogRecord Processor |  |
|
||||||
| `simple_span_processor` | The builtin SDK Simple Span Processor |  |
|
| `simple_span_processor` | The builtin SDK Simple Span Processor |  |
|
||||||
|
|
||||||
<!-- markdownlint-restore -->
|
<!-- markdownlint-restore -->
|
||||||
|
|
@ -441,10 +467,414 @@ E.g. for Java the fully qualified classname SHOULD be used in this case.
|
||||||
|
|
||||||
| Value | Description | Stability |
|
| Value | Description | Stability |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
|
| `batching_log_processor` | The builtin SDK Batching LogRecord Processor |  |
|
||||||
| `batching_span_processor` | The builtin SDK Batching Span Processor |  |
|
| `batching_span_processor` | The builtin SDK Batching Span Processor |  |
|
||||||
|
| `otlp_grpc_log_exporter` | OTLP LogRecord exporter over gRPC with protobuf serialization |  |
|
||||||
| `otlp_grpc_span_exporter` | OTLP span exporter over gRPC with protobuf serialization |  |
|
| `otlp_grpc_span_exporter` | OTLP span exporter over gRPC with protobuf serialization |  |
|
||||||
|
| `otlp_http_json_log_exporter` | OTLP LogRecord exporter over HTTP with JSON serialization |  |
|
||||||
| `otlp_http_json_span_exporter` | OTLP span exporter over HTTP with JSON serialization |  |
|
| `otlp_http_json_span_exporter` | OTLP span exporter over HTTP with JSON serialization |  |
|
||||||
|
| `otlp_http_log_exporter` | OTLP LogRecord exporter over HTTP with protobuf serialization |  |
|
||||||
| `otlp_http_span_exporter` | OTLP span exporter over HTTP with protobuf serialization |  |
|
| `otlp_http_span_exporter` | OTLP span exporter over HTTP with protobuf serialization |  |
|
||||||
|
| `simple_log_processor` | The builtin SDK Simple LogRecord Processor |  |
|
||||||
|
| `simple_span_processor` | The builtin SDK Simple Span Processor |  |
|
||||||
|
|
||||||
|
<!-- markdownlint-restore -->
|
||||||
|
<!-- prettier-ignore-end -->
|
||||||
|
<!-- END AUTOGENERATED TEXT -->
|
||||||
|
<!-- endsemconv -->
|
||||||
|
|
||||||
|
### Metric: `otel.sdk.log.created`
|
||||||
|
|
||||||
|
This metric is [recommended][MetricRecommended].
|
||||||
|
|
||||||
|
<!-- semconv metric.otel.sdk.log.created -->
|
||||||
|
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
||||||
|
<!-- see templates/registry/markdown/snippet.md.j2 -->
|
||||||
|
<!-- prettier-ignore-start -->
|
||||||
|
<!-- markdownlint-capture -->
|
||||||
|
<!-- markdownlint-disable -->
|
||||||
|
|
||||||
|
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
|
||||||
|
| -------- | --------------- | ----------- | -------------- | --------- |
|
||||||
|
| `otel.sdk.log.created` | Counter | `{log_record}` | The number of logs submitted to enabled SDK Loggers |  |
|
||||||
|
|
||||||
|
<!-- markdownlint-restore -->
|
||||||
|
<!-- prettier-ignore-end -->
|
||||||
|
<!-- END AUTOGENERATED TEXT -->
|
||||||
|
<!-- endsemconv -->
|
||||||
|
|
||||||
|
### Metric: `otel.sdk.processor.log.queue.size`
|
||||||
|
|
||||||
|
This metric is [recommended][MetricRecommended].
|
||||||
|
|
||||||
|
<!-- semconv metric.otel.sdk.processor.log.queue.size -->
|
||||||
|
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
||||||
|
<!-- see templates/registry/markdown/snippet.md.j2 -->
|
||||||
|
<!-- prettier-ignore-start -->
|
||||||
|
<!-- markdownlint-capture -->
|
||||||
|
<!-- markdownlint-disable -->
|
||||||
|
|
||||||
|
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
|
||||||
|
| -------- | --------------- | ----------- | -------------- | --------- |
|
||||||
|
| `otel.sdk.processor.log.queue.size` | UpDownCounter | `{log_record}` | The number of log records in the queue of a given instance of an SDK log processor [1] |  |
|
||||||
|
|
||||||
|
**[1]:** Only applies to log record processors which use a queue, e.g. the SDK Batching Log Record Processor.
|
||||||
|
|
||||||
|
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||||
|
|---|---|---|---|---|---|
|
||||||
|
| [`otel.component.name`](/docs/attributes-registry/otel.md) | string | A name uniquely identifying the instance of the OpenTelemetry component within its containing SDK instance. [1] | `otlp_grpc_span_exporter/0`; `custom-name` | `Recommended` |  |
|
||||||
|
| [`otel.component.type`](/docs/attributes-registry/otel.md) | string | A name identifying the type of the OpenTelemetry component. [2] | `batching_span_processor`; `com.example.MySpanExporter` | `Recommended` |  |
|
||||||
|
|
||||||
|
**[1] `otel.component.name`:** Implementations SHOULD ensure a low cardinality for this attribute, even across application or SDK restarts.
|
||||||
|
E.g. implementations MUST NOT use UUIDs as values for this attribute.
|
||||||
|
|
||||||
|
Implementations MAY achieve these goals by following a `<otel.component.type>/<instance-counter>` pattern, e.g. `batching_span_processor/0`.
|
||||||
|
Hereby `otel.component.type` refers to the corresponding attribute value of the component.
|
||||||
|
|
||||||
|
The value of `instance-counter` MAY be automatically assigned by the component and uniqueness within the enclosing SDK instance MUST be guaranteed.
|
||||||
|
For example, `<instance-counter>` MAY be implemented by using a monotonically increasing counter (starting with `0`), which is incremented every time an
|
||||||
|
instance of the given component type is started.
|
||||||
|
|
||||||
|
With this implementation, for example the first Batching Span Processor would have `batching_span_processor/0`
|
||||||
|
as `otel.component.name`, the second one `batching_span_processor/1` and so on.
|
||||||
|
These values will therefore be reused in the case of an application restart.
|
||||||
|
|
||||||
|
**[2] `otel.component.type`:** If none of the standardized values apply, implementations SHOULD use the language-defined name of the type.
|
||||||
|
E.g. for Java the fully qualified classname SHOULD be used in this case.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
`otel.component.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
|
||||||
|
|
||||||
|
| Value | Description | Stability |
|
||||||
|
|---|---|---|
|
||||||
|
| `batching_log_processor` | The builtin SDK Batching LogRecord Processor |  |
|
||||||
|
| `batching_span_processor` | The builtin SDK Batching Span Processor |  |
|
||||||
|
| `otlp_grpc_log_exporter` | OTLP LogRecord exporter over gRPC with protobuf serialization |  |
|
||||||
|
| `otlp_grpc_span_exporter` | OTLP span exporter over gRPC with protobuf serialization |  |
|
||||||
|
| `otlp_http_json_log_exporter` | OTLP LogRecord exporter over HTTP with JSON serialization |  |
|
||||||
|
| `otlp_http_json_span_exporter` | OTLP span exporter over HTTP with JSON serialization |  |
|
||||||
|
| `otlp_http_log_exporter` | OTLP LogRecord exporter over HTTP with protobuf serialization |  |
|
||||||
|
| `otlp_http_span_exporter` | OTLP span exporter over HTTP with protobuf serialization |  |
|
||||||
|
| `simple_log_processor` | The builtin SDK Simple LogRecord Processor |  |
|
||||||
|
| `simple_span_processor` | The builtin SDK Simple Span Processor |  |
|
||||||
|
|
||||||
|
<!-- markdownlint-restore -->
|
||||||
|
<!-- prettier-ignore-end -->
|
||||||
|
<!-- END AUTOGENERATED TEXT -->
|
||||||
|
<!-- endsemconv -->
|
||||||
|
|
||||||
|
### Metric: `otel.sdk.processor.log.queue.capacity`
|
||||||
|
|
||||||
|
This metric is [recommended][MetricRecommended].
|
||||||
|
|
||||||
|
<!-- semconv metric.otel.sdk.processor.log.queue.capacity -->
|
||||||
|
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
||||||
|
<!-- see templates/registry/markdown/snippet.md.j2 -->
|
||||||
|
<!-- prettier-ignore-start -->
|
||||||
|
<!-- markdownlint-capture -->
|
||||||
|
<!-- markdownlint-disable -->
|
||||||
|
|
||||||
|
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
|
||||||
|
| -------- | --------------- | ----------- | -------------- | --------- |
|
||||||
|
| `otel.sdk.processor.log.queue.capacity` | UpDownCounter | `{log_record}` | The maximum number of log records the queue of a given instance of an SDK Log Record processor can hold [1] |  |
|
||||||
|
|
||||||
|
**[1]:** Only applies to Log Record processors which use a queue, e.g. the SDK Batching Log Record Processor.
|
||||||
|
|
||||||
|
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||||
|
|---|---|---|---|---|---|
|
||||||
|
| [`otel.component.name`](/docs/attributes-registry/otel.md) | string | A name uniquely identifying the instance of the OpenTelemetry component within its containing SDK instance. [1] | `otlp_grpc_span_exporter/0`; `custom-name` | `Recommended` |  |
|
||||||
|
| [`otel.component.type`](/docs/attributes-registry/otel.md) | string | A name identifying the type of the OpenTelemetry component. [2] | `batching_span_processor`; `com.example.MySpanExporter` | `Recommended` |  |
|
||||||
|
|
||||||
|
**[1] `otel.component.name`:** Implementations SHOULD ensure a low cardinality for this attribute, even across application or SDK restarts.
|
||||||
|
E.g. implementations MUST NOT use UUIDs as values for this attribute.
|
||||||
|
|
||||||
|
Implementations MAY achieve these goals by following a `<otel.component.type>/<instance-counter>` pattern, e.g. `batching_span_processor/0`.
|
||||||
|
Hereby `otel.component.type` refers to the corresponding attribute value of the component.
|
||||||
|
|
||||||
|
The value of `instance-counter` MAY be automatically assigned by the component and uniqueness within the enclosing SDK instance MUST be guaranteed.
|
||||||
|
For example, `<instance-counter>` MAY be implemented by using a monotonically increasing counter (starting with `0`), which is incremented every time an
|
||||||
|
instance of the given component type is started.
|
||||||
|
|
||||||
|
With this implementation, for example the first Batching Span Processor would have `batching_span_processor/0`
|
||||||
|
as `otel.component.name`, the second one `batching_span_processor/1` and so on.
|
||||||
|
These values will therefore be reused in the case of an application restart.
|
||||||
|
|
||||||
|
**[2] `otel.component.type`:** If none of the standardized values apply, implementations SHOULD use the language-defined name of the type.
|
||||||
|
E.g. for Java the fully qualified classname SHOULD be used in this case.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
`otel.component.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
|
||||||
|
|
||||||
|
| Value | Description | Stability |
|
||||||
|
|---|---|---|
|
||||||
|
| `batching_log_processor` | The builtin SDK Batching LogRecord Processor |  |
|
||||||
|
| `batching_span_processor` | The builtin SDK Batching Span Processor |  |
|
||||||
|
| `otlp_grpc_log_exporter` | OTLP LogRecord exporter over gRPC with protobuf serialization |  |
|
||||||
|
| `otlp_grpc_span_exporter` | OTLP span exporter over gRPC with protobuf serialization |  |
|
||||||
|
| `otlp_http_json_log_exporter` | OTLP LogRecord exporter over HTTP with JSON serialization |  |
|
||||||
|
| `otlp_http_json_span_exporter` | OTLP span exporter over HTTP with JSON serialization |  |
|
||||||
|
| `otlp_http_log_exporter` | OTLP LogRecord exporter over HTTP with protobuf serialization |  |
|
||||||
|
| `otlp_http_span_exporter` | OTLP span exporter over HTTP with protobuf serialization |  |
|
||||||
|
| `simple_log_processor` | The builtin SDK Simple LogRecord Processor |  |
|
||||||
|
| `simple_span_processor` | The builtin SDK Simple Span Processor |  |
|
||||||
|
|
||||||
|
<!-- markdownlint-restore -->
|
||||||
|
<!-- prettier-ignore-end -->
|
||||||
|
<!-- END AUTOGENERATED TEXT -->
|
||||||
|
<!-- endsemconv -->
|
||||||
|
|
||||||
|
### Metric: `otel.sdk.processor.log.processed`
|
||||||
|
|
||||||
|
This metric is [recommended][MetricRecommended].
|
||||||
|
|
||||||
|
<!-- semconv metric.otel.sdk.processor.log.processed -->
|
||||||
|
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
||||||
|
<!-- see templates/registry/markdown/snippet.md.j2 -->
|
||||||
|
<!-- prettier-ignore-start -->
|
||||||
|
<!-- markdownlint-capture -->
|
||||||
|
<!-- markdownlint-disable -->
|
||||||
|
|
||||||
|
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
|
||||||
|
| -------- | --------------- | ----------- | -------------- | --------- |
|
||||||
|
| `otel.sdk.processor.log.processed` | Counter | `{log_record}` | The number of log records for which the processing has finished, either successful or failed [1] |  |
|
||||||
|
|
||||||
|
**[1]:** For successful processing, `error.type` MUST NOT be set. For failed processing, `error.type` must contain the failure cause.
|
||||||
|
For the SDK Simple and Batching Log Record Processor a log record is considered to be processed already when it has been submitted to the exporter,
|
||||||
|
not when the corresponding export call has finished.
|
||||||
|
|
||||||
|
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||||
|
|---|---|---|---|---|---|
|
||||||
|
| [`error.type`](/docs/attributes-registry/error.md) | string | A low-cardinality description of the failure reason. SDK Batching Log Record Processors MUST use `queue_full` for log records dropped due to a full queue. [1] | `queue_full` | `Recommended` |  |
|
||||||
|
| [`otel.component.name`](/docs/attributes-registry/otel.md) | string | A name uniquely identifying the instance of the OpenTelemetry component within its containing SDK instance. [2] | `otlp_grpc_span_exporter/0`; `custom-name` | `Recommended` |  |
|
||||||
|
| [`otel.component.type`](/docs/attributes-registry/otel.md) | string | A name identifying the type of the OpenTelemetry component. [3] | `batching_span_processor`; `com.example.MySpanExporter` | `Recommended` |  |
|
||||||
|
|
||||||
|
**[1] `error.type`:** The `error.type` SHOULD be predictable, and SHOULD have low cardinality.
|
||||||
|
|
||||||
|
When `error.type` is set to a type (e.g., an exception type), its
|
||||||
|
canonical class name identifying the type within the artifact SHOULD be used.
|
||||||
|
|
||||||
|
Instrumentations SHOULD document the list of errors they report.
|
||||||
|
|
||||||
|
The cardinality of `error.type` within one instrumentation library SHOULD be low.
|
||||||
|
Telemetry consumers that aggregate data from multiple instrumentation libraries and applications
|
||||||
|
should be prepared for `error.type` to have high cardinality at query time when no
|
||||||
|
additional filters are applied.
|
||||||
|
|
||||||
|
If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`.
|
||||||
|
|
||||||
|
If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes),
|
||||||
|
it's RECOMMENDED to:
|
||||||
|
|
||||||
|
- Use a domain-specific attribute
|
||||||
|
- Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not.
|
||||||
|
|
||||||
|
**[2] `otel.component.name`:** Implementations SHOULD ensure a low cardinality for this attribute, even across application or SDK restarts.
|
||||||
|
E.g. implementations MUST NOT use UUIDs as values for this attribute.
|
||||||
|
|
||||||
|
Implementations MAY achieve these goals by following a `<otel.component.type>/<instance-counter>` pattern, e.g. `batching_span_processor/0`.
|
||||||
|
Hereby `otel.component.type` refers to the corresponding attribute value of the component.
|
||||||
|
|
||||||
|
The value of `instance-counter` MAY be automatically assigned by the component and uniqueness within the enclosing SDK instance MUST be guaranteed.
|
||||||
|
For example, `<instance-counter>` MAY be implemented by using a monotonically increasing counter (starting with `0`), which is incremented every time an
|
||||||
|
instance of the given component type is started.
|
||||||
|
|
||||||
|
With this implementation, for example the first Batching Span Processor would have `batching_span_processor/0`
|
||||||
|
as `otel.component.name`, the second one `batching_span_processor/1` and so on.
|
||||||
|
These values will therefore be reused in the case of an application restart.
|
||||||
|
|
||||||
|
**[3] `otel.component.type`:** If none of the standardized values apply, implementations SHOULD use the language-defined name of the type.
|
||||||
|
E.g. for Java the fully qualified classname SHOULD be used in this case.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
`error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
|
||||||
|
|
||||||
|
| Value | Description | Stability |
|
||||||
|
|---|---|---|
|
||||||
|
| `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. |  |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
`otel.component.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
|
||||||
|
|
||||||
|
| Value | Description | Stability |
|
||||||
|
|---|---|---|
|
||||||
|
| `batching_log_processor` | The builtin SDK Batching LogRecord Processor |  |
|
||||||
|
| `batching_span_processor` | The builtin SDK Batching Span Processor |  |
|
||||||
|
| `otlp_grpc_log_exporter` | OTLP LogRecord exporter over gRPC with protobuf serialization |  |
|
||||||
|
| `otlp_grpc_span_exporter` | OTLP span exporter over gRPC with protobuf serialization |  |
|
||||||
|
| `otlp_http_json_log_exporter` | OTLP LogRecord exporter over HTTP with JSON serialization |  |
|
||||||
|
| `otlp_http_json_span_exporter` | OTLP span exporter over HTTP with JSON serialization |  |
|
||||||
|
| `otlp_http_log_exporter` | OTLP LogRecord exporter over HTTP with protobuf serialization |  |
|
||||||
|
| `otlp_http_span_exporter` | OTLP span exporter over HTTP with protobuf serialization |  |
|
||||||
|
| `simple_log_processor` | The builtin SDK Simple LogRecord Processor |  |
|
||||||
|
| `simple_span_processor` | The builtin SDK Simple Span Processor |  |
|
||||||
|
|
||||||
|
<!-- markdownlint-restore -->
|
||||||
|
<!-- prettier-ignore-end -->
|
||||||
|
<!-- END AUTOGENERATED TEXT -->
|
||||||
|
<!-- endsemconv -->
|
||||||
|
|
||||||
|
### Metric: `otel.sdk.exporter.log.inflight`
|
||||||
|
|
||||||
|
This metric is [recommended][MetricRecommended].
|
||||||
|
|
||||||
|
<!-- semconv metric.otel.sdk.exporter.log.inflight -->
|
||||||
|
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
||||||
|
<!-- see templates/registry/markdown/snippet.md.j2 -->
|
||||||
|
<!-- prettier-ignore-start -->
|
||||||
|
<!-- markdownlint-capture -->
|
||||||
|
<!-- markdownlint-disable -->
|
||||||
|
|
||||||
|
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
|
||||||
|
| -------- | --------------- | ----------- | -------------- | --------- |
|
||||||
|
| `otel.sdk.exporter.log.inflight` | UpDownCounter | `{log_record}` | The number of log records which were passed to the exporter, but that have not been exported yet (neither successful, nor failed) [1] |  |
|
||||||
|
|
||||||
|
**[1]:** For successful exports, `error.type` MUST NOT be set. For failed exports, `error.type` must contain the failure cause.
|
||||||
|
|
||||||
|
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||||
|
|---|---|---|---|---|---|
|
||||||
|
| [`otel.component.name`](/docs/attributes-registry/otel.md) | string | A name uniquely identifying the instance of the OpenTelemetry component within its containing SDK instance. [1] | `otlp_grpc_span_exporter/0`; `custom-name` | `Recommended` |  |
|
||||||
|
| [`otel.component.type`](/docs/attributes-registry/otel.md) | string | A name identifying the type of the OpenTelemetry component. [2] | `batching_span_processor`; `com.example.MySpanExporter` | `Recommended` |  |
|
||||||
|
| [`server.address`](/docs/attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [3] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Recommended` when applicable |  |
|
||||||
|
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [4] | `80`; `8080`; `443` | `Recommended` when applicable |  |
|
||||||
|
|
||||||
|
**[1] `otel.component.name`:** Implementations SHOULD ensure a low cardinality for this attribute, even across application or SDK restarts.
|
||||||
|
E.g. implementations MUST NOT use UUIDs as values for this attribute.
|
||||||
|
|
||||||
|
Implementations MAY achieve these goals by following a `<otel.component.type>/<instance-counter>` pattern, e.g. `batching_span_processor/0`.
|
||||||
|
Hereby `otel.component.type` refers to the corresponding attribute value of the component.
|
||||||
|
|
||||||
|
The value of `instance-counter` MAY be automatically assigned by the component and uniqueness within the enclosing SDK instance MUST be guaranteed.
|
||||||
|
For example, `<instance-counter>` MAY be implemented by using a monotonically increasing counter (starting with `0`), which is incremented every time an
|
||||||
|
instance of the given component type is started.
|
||||||
|
|
||||||
|
With this implementation, for example the first Batching Span Processor would have `batching_span_processor/0`
|
||||||
|
as `otel.component.name`, the second one `batching_span_processor/1` and so on.
|
||||||
|
These values will therefore be reused in the case of an application restart.
|
||||||
|
|
||||||
|
**[2] `otel.component.type`:** If none of the standardized values apply, implementations SHOULD use the language-defined name of the type.
|
||||||
|
E.g. for Java the fully qualified classname SHOULD be used in this case.
|
||||||
|
|
||||||
|
**[3] `server.address`:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available.
|
||||||
|
|
||||||
|
**[4] `server.port`:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
`otel.component.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
|
||||||
|
|
||||||
|
| Value | Description | Stability |
|
||||||
|
|---|---|---|
|
||||||
|
| `batching_log_processor` | The builtin SDK Batching LogRecord Processor |  |
|
||||||
|
| `batching_span_processor` | The builtin SDK Batching Span Processor |  |
|
||||||
|
| `otlp_grpc_log_exporter` | OTLP LogRecord exporter over gRPC with protobuf serialization |  |
|
||||||
|
| `otlp_grpc_span_exporter` | OTLP span exporter over gRPC with protobuf serialization |  |
|
||||||
|
| `otlp_http_json_log_exporter` | OTLP LogRecord exporter over HTTP with JSON serialization |  |
|
||||||
|
| `otlp_http_json_span_exporter` | OTLP span exporter over HTTP with JSON serialization |  |
|
||||||
|
| `otlp_http_log_exporter` | OTLP LogRecord exporter over HTTP with protobuf serialization |  |
|
||||||
|
| `otlp_http_span_exporter` | OTLP span exporter over HTTP with protobuf serialization |  |
|
||||||
|
| `simple_log_processor` | The builtin SDK Simple LogRecord Processor |  |
|
||||||
|
| `simple_span_processor` | The builtin SDK Simple Span Processor |  |
|
||||||
|
|
||||||
|
<!-- markdownlint-restore -->
|
||||||
|
<!-- prettier-ignore-end -->
|
||||||
|
<!-- END AUTOGENERATED TEXT -->
|
||||||
|
<!-- endsemconv -->
|
||||||
|
|
||||||
|
### Metric: `otel.sdk.exporter.log.exported`
|
||||||
|
|
||||||
|
This metric is [recommended][MetricRecommended].
|
||||||
|
|
||||||
|
<!-- semconv metric.otel.sdk.exporter.log.exported -->
|
||||||
|
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
||||||
|
<!-- see templates/registry/markdown/snippet.md.j2 -->
|
||||||
|
<!-- prettier-ignore-start -->
|
||||||
|
<!-- markdownlint-capture -->
|
||||||
|
<!-- markdownlint-disable -->
|
||||||
|
|
||||||
|
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
|
||||||
|
| -------- | --------------- | ----------- | -------------- | --------- |
|
||||||
|
| `otel.sdk.exporter.log.exported` | Counter | `{log_record}` | The number of log records for which the export has finished, either successful or failed [1] |  |
|
||||||
|
|
||||||
|
**[1]:** For successful exports, `error.type` MUST NOT be set. For failed exports, `error.type` must contain the failure cause.
|
||||||
|
For exporters with partial success semantics (e.g. OTLP with `rejected_log_records`), rejected log records must count as failed and only non-rejected log records count as success.
|
||||||
|
If no rejection reason is available, `rejected` SHOULD be used as value for `error.type`.
|
||||||
|
|
||||||
|
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||||
|
|---|---|---|---|---|---|
|
||||||
|
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [1] | `rejected`; `timeout`; `500`; `java.net.UnknownHostException` | `Recommended` |  |
|
||||||
|
| [`otel.component.name`](/docs/attributes-registry/otel.md) | string | A name uniquely identifying the instance of the OpenTelemetry component within its containing SDK instance. [2] | `otlp_grpc_span_exporter/0`; `custom-name` | `Recommended` |  |
|
||||||
|
| [`otel.component.type`](/docs/attributes-registry/otel.md) | string | A name identifying the type of the OpenTelemetry component. [3] | `batching_span_processor`; `com.example.MySpanExporter` | `Recommended` |  |
|
||||||
|
| [`server.address`](/docs/attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [4] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Recommended` when applicable |  |
|
||||||
|
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [5] | `80`; `8080`; `443` | `Recommended` when applicable |  |
|
||||||
|
|
||||||
|
**[1] `error.type`:** The `error.type` SHOULD be predictable, and SHOULD have low cardinality.
|
||||||
|
|
||||||
|
When `error.type` is set to a type (e.g., an exception type), its
|
||||||
|
canonical class name identifying the type within the artifact SHOULD be used.
|
||||||
|
|
||||||
|
Instrumentations SHOULD document the list of errors they report.
|
||||||
|
|
||||||
|
The cardinality of `error.type` within one instrumentation library SHOULD be low.
|
||||||
|
Telemetry consumers that aggregate data from multiple instrumentation libraries and applications
|
||||||
|
should be prepared for `error.type` to have high cardinality at query time when no
|
||||||
|
additional filters are applied.
|
||||||
|
|
||||||
|
If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`.
|
||||||
|
|
||||||
|
If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes),
|
||||||
|
it's RECOMMENDED to:
|
||||||
|
|
||||||
|
- Use a domain-specific attribute
|
||||||
|
- Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not.
|
||||||
|
|
||||||
|
**[2] `otel.component.name`:** Implementations SHOULD ensure a low cardinality for this attribute, even across application or SDK restarts.
|
||||||
|
E.g. implementations MUST NOT use UUIDs as values for this attribute.
|
||||||
|
|
||||||
|
Implementations MAY achieve these goals by following a `<otel.component.type>/<instance-counter>` pattern, e.g. `batching_span_processor/0`.
|
||||||
|
Hereby `otel.component.type` refers to the corresponding attribute value of the component.
|
||||||
|
|
||||||
|
The value of `instance-counter` MAY be automatically assigned by the component and uniqueness within the enclosing SDK instance MUST be guaranteed.
|
||||||
|
For example, `<instance-counter>` MAY be implemented by using a monotonically increasing counter (starting with `0`), which is incremented every time an
|
||||||
|
instance of the given component type is started.
|
||||||
|
|
||||||
|
With this implementation, for example the first Batching Span Processor would have `batching_span_processor/0`
|
||||||
|
as `otel.component.name`, the second one `batching_span_processor/1` and so on.
|
||||||
|
These values will therefore be reused in the case of an application restart.
|
||||||
|
|
||||||
|
**[3] `otel.component.type`:** If none of the standardized values apply, implementations SHOULD use the language-defined name of the type.
|
||||||
|
E.g. for Java the fully qualified classname SHOULD be used in this case.
|
||||||
|
|
||||||
|
**[4] `server.address`:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available.
|
||||||
|
|
||||||
|
**[5] `server.port`:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
`error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
|
||||||
|
|
||||||
|
| Value | Description | Stability |
|
||||||
|
|---|---|---|
|
||||||
|
| `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. |  |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
`otel.component.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
|
||||||
|
|
||||||
|
| Value | Description | Stability |
|
||||||
|
|---|---|---|
|
||||||
|
| `batching_log_processor` | The builtin SDK Batching LogRecord Processor |  |
|
||||||
|
| `batching_span_processor` | The builtin SDK Batching Span Processor |  |
|
||||||
|
| `otlp_grpc_log_exporter` | OTLP LogRecord exporter over gRPC with protobuf serialization |  |
|
||||||
|
| `otlp_grpc_span_exporter` | OTLP span exporter over gRPC with protobuf serialization |  |
|
||||||
|
| `otlp_http_json_log_exporter` | OTLP LogRecord exporter over HTTP with JSON serialization |  |
|
||||||
|
| `otlp_http_json_span_exporter` | OTLP span exporter over HTTP with JSON serialization |  |
|
||||||
|
| `otlp_http_log_exporter` | OTLP LogRecord exporter over HTTP with protobuf serialization |  |
|
||||||
|
| `otlp_http_span_exporter` | OTLP span exporter over HTTP with protobuf serialization |  |
|
||||||
|
| `simple_log_processor` | The builtin SDK Simple LogRecord Processor |  |
|
||||||
| `simple_span_processor` | The builtin SDK Simple Span Processor |  |
|
| `simple_span_processor` | The builtin SDK Simple Span Processor |  |
|
||||||
|
|
||||||
<!-- markdownlint-restore -->
|
<!-- markdownlint-restore -->
|
||||||
|
|
|
||||||
|
|
@ -110,3 +110,98 @@ groups:
|
||||||
recommended: when applicable
|
recommended: when applicable
|
||||||
- ref: error.type
|
- ref: error.type
|
||||||
examples: ["rejected", "timeout", "500", "java.net.UnknownHostException"]
|
examples: ["rejected", "timeout", "500", "java.net.UnknownHostException"]
|
||||||
|
|
||||||
|
- id: metric.otel.sdk.log.created
|
||||||
|
type: metric
|
||||||
|
metric_name: otel.sdk.log.created
|
||||||
|
stability: development
|
||||||
|
brief: "The number of logs submitted to enabled SDK Loggers"
|
||||||
|
instrument: counter
|
||||||
|
unit: "{log_record}"
|
||||||
|
|
||||||
|
- id: metric.otel.sdk.processor.log.queue.size
|
||||||
|
type: metric
|
||||||
|
metric_name: otel.sdk.processor.log.queue.size
|
||||||
|
stability: development
|
||||||
|
brief: "The number of log records in the queue of a given instance of an SDK log processor"
|
||||||
|
note: |
|
||||||
|
Only applies to log record processors which use a queue, e.g. the SDK Batching Log Record Processor.
|
||||||
|
instrument: updowncounter
|
||||||
|
unit: "{log_record}"
|
||||||
|
attributes:
|
||||||
|
- ref: otel.component.type
|
||||||
|
- ref: otel.component.name
|
||||||
|
|
||||||
|
- id: metric.otel.sdk.processor.log.queue.capacity
|
||||||
|
type: metric
|
||||||
|
metric_name: otel.sdk.processor.log.queue.capacity
|
||||||
|
stability: development
|
||||||
|
brief: "The maximum number of log records the queue of a given instance of an SDK Log Record processor can hold"
|
||||||
|
note: |
|
||||||
|
Only applies to Log Record processors which use a queue, e.g. the SDK Batching Log Record Processor.
|
||||||
|
instrument: updowncounter
|
||||||
|
unit: "{log_record}"
|
||||||
|
attributes:
|
||||||
|
- ref: otel.component.type
|
||||||
|
- ref: otel.component.name
|
||||||
|
|
||||||
|
- id: metric.otel.sdk.processor.log.processed
|
||||||
|
type: metric
|
||||||
|
metric_name: otel.sdk.processor.log.processed
|
||||||
|
stability: development
|
||||||
|
brief: "The number of log records for which the processing has finished, either successful or failed"
|
||||||
|
note: |
|
||||||
|
For successful processing, `error.type` MUST NOT be set. For failed processing, `error.type` must contain the failure cause.
|
||||||
|
For the SDK Simple and Batching Log Record Processor a log record is considered to be processed already when it has been submitted to the exporter,
|
||||||
|
not when the corresponding export call has finished.
|
||||||
|
instrument: counter
|
||||||
|
unit: "{log_record}"
|
||||||
|
attributes:
|
||||||
|
- ref: otel.component.type
|
||||||
|
- ref: otel.component.name
|
||||||
|
- ref: error.type
|
||||||
|
brief: >
|
||||||
|
A low-cardinality description of the failure reason. SDK Batching Log Record Processors MUST use `queue_full` for log records dropped due to a full queue.
|
||||||
|
examples: ["queue_full"]
|
||||||
|
|
||||||
|
- id: metric.otel.sdk.exporter.log.inflight
|
||||||
|
type: metric
|
||||||
|
metric_name: otel.sdk.exporter.log.inflight
|
||||||
|
stability: development
|
||||||
|
brief: "The number of log records which were passed to the exporter, but that have not been exported yet (neither successful, nor failed)"
|
||||||
|
note: |
|
||||||
|
For successful exports, `error.type` MUST NOT be set. For failed exports, `error.type` must contain the failure cause.
|
||||||
|
instrument: updowncounter
|
||||||
|
unit: "{log_record}"
|
||||||
|
attributes:
|
||||||
|
- ref: otel.component.type
|
||||||
|
- ref: otel.component.name
|
||||||
|
- ref: server.address
|
||||||
|
requirement_level:
|
||||||
|
recommended: when applicable
|
||||||
|
- ref: server.port
|
||||||
|
requirement_level:
|
||||||
|
recommended: when applicable
|
||||||
|
|
||||||
|
- id: metric.otel.sdk.exporter.log.exported
|
||||||
|
type: metric
|
||||||
|
metric_name: otel.sdk.exporter.log.exported
|
||||||
|
stability: development
|
||||||
|
brief: "The number of log records for which the export has finished, either successful or failed"
|
||||||
|
note: |
|
||||||
|
For successful exports, `error.type` MUST NOT be set. For failed exports, `error.type` must contain the failure cause.
|
||||||
|
For exporters with partial success semantics (e.g. OTLP with `rejected_log_records`), rejected log records must count as failed and only non-rejected log records count as success.
|
||||||
|
If no rejection reason is available, `rejected` SHOULD be used as value for `error.type`.
|
||||||
|
instrument: counter
|
||||||
|
unit: "{log_record}"
|
||||||
|
attributes:
|
||||||
|
- ref: otel.component.type
|
||||||
|
- ref: otel.component.name
|
||||||
|
- ref: server.address
|
||||||
|
requirement_level:
|
||||||
|
recommended: when applicable
|
||||||
|
- ref: server.port
|
||||||
|
requirement_level:
|
||||||
|
recommended: when applicable
|
||||||
|
- ref: error.type
|
||||||
|
examples: ["rejected", "timeout", "500", "java.net.UnknownHostException"]
|
||||||
|
|
|
||||||
|
|
@ -72,6 +72,16 @@ groups:
|
||||||
brief: >
|
brief: >
|
||||||
The builtin SDK Simple Span Processor
|
The builtin SDK Simple Span Processor
|
||||||
stability: development
|
stability: development
|
||||||
|
- id: batching_log_processor
|
||||||
|
value: "batching_log_processor"
|
||||||
|
brief: >
|
||||||
|
The builtin SDK Batching LogRecord Processor
|
||||||
|
stability: development
|
||||||
|
- id: simple_log_processor
|
||||||
|
value: "simple_log_processor"
|
||||||
|
brief: >
|
||||||
|
The builtin SDK Simple LogRecord Processor
|
||||||
|
stability: development
|
||||||
- id: otlp_grpc_span_exporter
|
- id: otlp_grpc_span_exporter
|
||||||
value: "otlp_grpc_span_exporter"
|
value: "otlp_grpc_span_exporter"
|
||||||
brief: >
|
brief: >
|
||||||
|
|
@ -87,6 +97,21 @@ groups:
|
||||||
brief: >
|
brief: >
|
||||||
OTLP span exporter over HTTP with JSON serialization
|
OTLP span exporter over HTTP with JSON serialization
|
||||||
stability: development
|
stability: development
|
||||||
|
- id: otlp_grpc_log_exporter
|
||||||
|
value: "otlp_grpc_log_exporter"
|
||||||
|
brief: >
|
||||||
|
OTLP LogRecord exporter over gRPC with protobuf serialization
|
||||||
|
stability: development
|
||||||
|
- id: otlp_http_log_exporter
|
||||||
|
value: "otlp_http_log_exporter"
|
||||||
|
brief: >
|
||||||
|
OTLP LogRecord exporter over HTTP with protobuf serialization
|
||||||
|
stability: development
|
||||||
|
- id: otlp_http_json_log_exporter
|
||||||
|
value: "otlp_http_json_log_exporter"
|
||||||
|
brief: >
|
||||||
|
OTLP LogRecord exporter over HTTP with JSON serialization
|
||||||
|
stability: development
|
||||||
stability: development
|
stability: development
|
||||||
brief: >
|
brief: >
|
||||||
A name identifying the type of the OpenTelemetry component.
|
A name identifying the type of the OpenTelemetry component.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue