diff --git a/extension/encoding/avrologencodingextension/README.md b/extension/encoding/avrologencodingextension/README.md index e20855e9c3d44..ccd1c6ad90545 100644 --- a/extension/encoding/avrologencodingextension/README.md +++ b/extension/encoding/avrologencodingextension/README.md @@ -1,6 +1,9 @@ -# AVRO Log encoding extension - +# AVRO Log Encoding Extension + +The `avrolog` encoding extension is used to unmarshal AVRO and insert it into the body of a log record. Marshalling is not supported. + + | Status | | | ------------- |-----------| | Stability | [development] | @@ -11,8 +14,6 @@ [development]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#development -The `avrolog` encoding extension is used to unmarshal AVRO and insert it into the body of a log record. Marshalling is not supported. - The extension accepts a configuration option to specify the Avro schema to use to read the log record body. Example: diff --git a/extension/encoding/avrologencodingextension/metadata.yaml b/extension/encoding/avrologencodingextension/metadata.yaml index 9fb33479d5f01..3a41d737d4404 100644 --- a/extension/encoding/avrologencodingextension/metadata.yaml +++ b/extension/encoding/avrologencodingextension/metadata.yaml @@ -1,5 +1,10 @@ +display_name: AVRO Log Encoding Extension type: avro_log_encoding +description: > + The `avrolog` encoding extension is used to unmarshal AVRO and insert it into the body of a log record. Marshalling + is not supported. + status: disable_codecov_badge: true class: extension diff --git a/extension/encoding/awscloudwatchmetricstreamsencodingextension/README.md b/extension/encoding/awscloudwatchmetricstreamsencodingextension/README.md index bbebc7160988f..e88ae02485024 100644 --- a/extension/encoding/awscloudwatchmetricstreamsencodingextension/README.md +++ b/extension/encoding/awscloudwatchmetricstreamsencodingextension/README.md @@ -1,6 +1,9 @@ -# AWS CloudWatch Metric streams encoding extension - +# AWS CloudWatch Metric Streams Encoding Extension + +This extension unmarshalls metrics encoded in formats produced by [Amazon CloudWatch Metric Streams](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html). + + | Status | | | ------------- |-----------| | Stability | [alpha] | @@ -12,9 +15,6 @@ [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib -This extension unmarshals metrics encoded in formats produced by -[Amazon CloudWatch Metric Streams](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html). - The extension can be configured to unmarshal metrics in either the JSON or OpenTelemetry 1.0.0 output formats. At this time the OpenTelemetry 0.7.0 output format is unsupported, there are no plans to add support for it. diff --git a/extension/encoding/awscloudwatchmetricstreamsencodingextension/metadata.yaml b/extension/encoding/awscloudwatchmetricstreamsencodingextension/metadata.yaml index 43fbe4cb26391..81582a624dd23 100644 --- a/extension/encoding/awscloudwatchmetricstreamsencodingextension/metadata.yaml +++ b/extension/encoding/awscloudwatchmetricstreamsencodingextension/metadata.yaml @@ -1,5 +1,10 @@ +display_name: AWS CloudWatch Metric Streams Encoding Extension type: awscloudwatchmetricstreams_encoding +description: > + This extension unmarshalls metrics encoded in formats produced by + [Amazon CloudWatch Metric Streams](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html). + status: disable_codecov_badge: true class: extension diff --git a/extension/encoding/awslogsencodingextension/README.md b/extension/encoding/awslogsencodingextension/README.md index 22b37a98de2a8..46ab2fe99c493 100644 --- a/extension/encoding/awslogsencodingextension/README.md +++ b/extension/encoding/awslogsencodingextension/README.md @@ -1,6 +1,8 @@ -# AWS Logs encoding extension - +# AWS Logs Encoding Extension + +This extension unmarshalls logs encoded in formats produced by AWS services. + | Status | | | ------------- |-----------| | Stability | [alpha] | diff --git a/extension/encoding/awslogsencodingextension/metadata.yaml b/extension/encoding/awslogsencodingextension/metadata.yaml index 3b347ee19b7ca..7aafb45702ea0 100644 --- a/extension/encoding/awslogsencodingextension/metadata.yaml +++ b/extension/encoding/awslogsencodingextension/metadata.yaml @@ -1,5 +1,8 @@ +display_name: AWS Logs Encoding Extension type: awslogs_encoding +description: This extension unmarshalls logs encoded in formats produced by AWS services. + status: disable_codecov_badge: true class: extension diff --git a/extension/encoding/azureencodingextension/README.md b/extension/encoding/azureencodingextension/README.md index 7902a7b54741f..1ef63132c8748 100644 --- a/extension/encoding/azureencodingextension/README.md +++ b/extension/encoding/azureencodingextension/README.md @@ -1,5 +1,9 @@ -# Azure Logs/Traces/Metrics encoding extension +# Azure Logs/Traces/Metrics Encoding Extension + +This extension is designed for unmarshaling logs/traces/metrics encoded in specific format produced by [Azure Diagnostic Settings Export](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/diagnostic-settings) or [Azure Data Collection Rules (DCRs)](https://learn.microsoft.com/en-us/azure/azure-monitor/data-collection/data-collection-rule-overview) + + | Status | | | ------------- |-----------| | Stability | [development] | @@ -10,12 +14,6 @@ [development]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#development -## Overview - -This extension is designed for unmarshaling logs/traces/metrics encoded in specific format -produced by [Azure Diagnostic Settings Export](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/diagnostic-settings) or -[Azure Data Collection Rules (DCRs)](https://learn.microsoft.com/en-us/azure/azure-monitor/data-collection/data-collection-rule-overview) - ### Configuration This Encoding extension has set of configuration options for each type of telemetry signals, @@ -36,7 +34,7 @@ This extension supports auto-detection and parsing of the following formats: Currently supported following Azure Metrics export formats: * export via Diagnostic Settings ([multi-dimensional metrics are not supported](https://learn.microsoft.com/en-us/azure/azure-monitor/platform/diagnostic-settings?tabs=portal#metrics-limitations)) -* export via Data Collection Rules (DCRs) ([dimensions and metric filtering are supported](https://learn.microsoft.com/en-us/azure/azure-monitor/data-collection/data-collection-metrics)) +* export via Data Collection Rules (DCRs) ([dimensions and metric filtering are supported](https://learn.microsoft.com/en-us/azure/azure-monitor/data-collection/data-collection-rule-overview)) ***time_formats (Optional)*** diff --git a/extension/encoding/azureencodingextension/metadata.yaml b/extension/encoding/azureencodingextension/metadata.yaml index 0473a77b36547..e5b57b6062064 100644 --- a/extension/encoding/azureencodingextension/metadata.yaml +++ b/extension/encoding/azureencodingextension/metadata.yaml @@ -1,5 +1,11 @@ +display_name: Azure Logs/Traces/Metrics Encoding Extension type: azure_encoding +description: > + This extension is designed for unmarshaling logs/traces/metrics encoded in specific format + produced by [Azure Diagnostic Settings Export](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/diagnostic-settings) or + [Azure Data Collection Rules (DCRs)](https://learn.microsoft.com/en-us/azure/azure-monitor/data-collection/data-collection-rule-overview) + status: disable_codecov_badge: true class: extension diff --git a/extension/encoding/googlecloudlogentryencodingextension/README.md b/extension/encoding/googlecloudlogentryencodingextension/README.md index 4b98545d2dfa0..865c387ad2f4e 100644 --- a/extension/encoding/googlecloudlogentryencodingextension/README.md +++ b/extension/encoding/googlecloudlogentryencodingextension/README.md @@ -1,6 +1,9 @@ -# Google Cloud LogEntry encoding extension - +# Google Cloud LogEntry Encoding Extension + +This extension can be used to unmarshall a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) message type. + + | Status | | | ------------- |-----------| | Stability | [alpha] | @@ -13,7 +16,7 @@ [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib -This extension can be used to unmarshall a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) message type. The extension expects each log to take up 1 line, and it will decode as many logs as log lines received. +The extension expects each log to take up 1 line, and it will decode as many logs as log lines received. Currently, this extension [can parse the following logs](#supported-log-types) into log record attributes: diff --git a/extension/encoding/googlecloudlogentryencodingextension/metadata.yaml b/extension/encoding/googlecloudlogentryencodingextension/metadata.yaml index ac7c9d13c3cb8..ccd1601c89a0b 100644 --- a/extension/encoding/googlecloudlogentryencodingextension/metadata.yaml +++ b/extension/encoding/googlecloudlogentryencodingextension/metadata.yaml @@ -1,5 +1,10 @@ +display_name: Google Cloud LogEntry Encoding Extension type: googlecloudlogentry_encoding +description: > + This extension can be used to unmarshall a + [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) message type. + status: disable_codecov_badge: true class: extension diff --git a/extension/encoding/jaegerencodingextension/README.md b/extension/encoding/jaegerencodingextension/README.md index a862e363fdde7..855aaae0a1fc7 100644 --- a/extension/encoding/jaegerencodingextension/README.md +++ b/extension/encoding/jaegerencodingextension/README.md @@ -1,6 +1,5 @@ -# Jaeger encoding extension - +# Jaeger Encoding Extension | Status | | | ------------- |-----------| | Stability | [alpha] | diff --git a/extension/encoding/jaegerencodingextension/metadata.yaml b/extension/encoding/jaegerencodingextension/metadata.yaml index e8615d89219c7..b8bf12ff5d5d4 100644 --- a/extension/encoding/jaegerencodingextension/metadata.yaml +++ b/extension/encoding/jaegerencodingextension/metadata.yaml @@ -1,3 +1,4 @@ +display_name: Jaeger Encoding Extension type: jaeger_encoding status: diff --git a/extension/encoding/jsonlogencodingextension/README.md b/extension/encoding/jsonlogencodingextension/README.md index ce6ef8478b24f..ff46071070fef 100644 --- a/extension/encoding/jsonlogencodingextension/README.md +++ b/extension/encoding/jsonlogencodingextension/README.md @@ -1,6 +1,5 @@ -# JSON Log encoding extension - +# JSON Log Encoding Extension | Status | | | ------------- |-----------| | Stability | [alpha] | diff --git a/extension/encoding/jsonlogencodingextension/metadata.yaml b/extension/encoding/jsonlogencodingextension/metadata.yaml index 9908dbdd59aa1..07cd04c9c6ee4 100644 --- a/extension/encoding/jsonlogencodingextension/metadata.yaml +++ b/extension/encoding/jsonlogencodingextension/metadata.yaml @@ -1,3 +1,4 @@ +display_name: JSON Log Encoding Extension type: json_log_encoding status: diff --git a/extension/encoding/otlpencodingextension/README.md b/extension/encoding/otlpencodingextension/README.md index 51735f6800b68..8096c71479a47 100644 --- a/extension/encoding/otlpencodingextension/README.md +++ b/extension/encoding/otlpencodingextension/README.md @@ -1,6 +1,9 @@ -# OTLP encoding extension - +# OTLP Encoding Extension + +This extension unmarshals and marshals data encoded according to the [OTLP specification](https://opentelemetry.io/docs/specs/otlp/). + + | Status | | | ------------- |-----------| | Stability | [beta] | @@ -12,9 +15,7 @@ [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib -This extension unmarshals and marshals data encoded according to the [OTLP specification](https://opentelemetry.io/docs/specs/otlp/). - -It accepts OTLP data encoded using Protobuf or JSON protocols. +This extension accepts OTLP data encoded using Protobuf or JSON protocols. Example using Protobuf protocol: ```yaml diff --git a/extension/encoding/otlpencodingextension/metadata.yaml b/extension/encoding/otlpencodingextension/metadata.yaml index a710086b6d48a..384d80652e3b1 100644 --- a/extension/encoding/otlpencodingextension/metadata.yaml +++ b/extension/encoding/otlpencodingextension/metadata.yaml @@ -1,5 +1,10 @@ +display_name: OTLP Encoding Extension type: otlp_encoding +description: > + This extension unmarshals and marshals data encoded according to the + [OTLP specification](https://opentelemetry.io/docs/specs/otlp/). + status: disable_codecov_badge: true class: extension diff --git a/extension/encoding/textencodingextension/README.md b/extension/encoding/textencodingextension/README.md index e2d72eebd472a..8a261c2e8669e 100644 --- a/extension/encoding/textencodingextension/README.md +++ b/extension/encoding/textencodingextension/README.md @@ -1,6 +1,8 @@ -# Text encoding extension - +# Text Encoding Extension + +The `text_encoding` extension is an encoding extension that can unmarshal and marshal logs. + | Status | | | ------------- |-----------| | Stability | [beta] | @@ -13,8 +15,6 @@ [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib -The `text_encoding` extension is an encoding extension that can unmarshal and marshal logs. - The extension accepts an encoding and separator to unmarshal data as the body of one or more log records. The separator accepts regular expressions. diff --git a/extension/encoding/textencodingextension/metadata.yaml b/extension/encoding/textencodingextension/metadata.yaml index 428cc46e7fa64..a0196e9af2d8e 100644 --- a/extension/encoding/textencodingextension/metadata.yaml +++ b/extension/encoding/textencodingextension/metadata.yaml @@ -1,5 +1,8 @@ +display_name: Text Encoding Extension type: text_encoding +description: The `text_encoding` extension is an encoding extension that can unmarshal and marshal logs. + status: class: extension stability: diff --git a/extension/encoding/zipkinencodingextension/README.md b/extension/encoding/zipkinencodingextension/README.md index cb37347a17d1c..560f993e31ffd 100644 --- a/extension/encoding/zipkinencodingextension/README.md +++ b/extension/encoding/zipkinencodingextension/README.md @@ -1,6 +1,8 @@ -# Zipkin encoding extension - +# Zipkin Encoding Extension + +This extension supports marshaling and unmarshalling Zipkin data representing traces. + | Status | | | ------------- |-----------| | Stability | [alpha] | @@ -12,8 +14,6 @@ [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib -This extension supports marshaling and unmarshaling Zipkin data representing traces. - The extension supports the following configuration options: * `protocol`: either `zipkin_proto`, `zipkin_json` or `zipkin_thrift` * `version`: `v1` or `v2` diff --git a/extension/encoding/zipkinencodingextension/metadata.yaml b/extension/encoding/zipkinencodingextension/metadata.yaml index fb035b15f584a..b426b0c951458 100644 --- a/extension/encoding/zipkinencodingextension/metadata.yaml +++ b/extension/encoding/zipkinencodingextension/metadata.yaml @@ -1,5 +1,8 @@ +display_name: Zipkin Encoding Extension type: zipkin_encoding +description: This extension supports marshaling and unmarshalling Zipkin data representing traces. + status: disable_codecov_badge: true class: extension