From 68d447199e17b5a84fc1a9cf926253952e3c4183 Mon Sep 17 00:00:00 2001 From: "minquan.chen" Date: Fri, 20 May 2022 08:09:39 +0800 Subject: [PATCH 1/4] add header for file exporter. --- exporter/fileexporter/README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/exporter/fileexporter/README.md b/exporter/fileexporter/README.md index 0ae26b4d1280..513222475997 100644 --- a/exporter/fileexporter/README.md +++ b/exporter/fileexporter/README.md @@ -1,6 +1,12 @@ # File Exporter -This exporter will write pipeline data to a JSON file. The data is written in +| Status | | +| ------------------------ |------------------------| +| Stability | [beta] | +| Supported pipeline types | traces, metrics, logs | +| Distributions | [contrib] | + +This exporter will write pipeline data to a JSON file. The data is written in. [Protobuf JSON encoding](https://developers.google.com/protocol-buffers/docs/proto3#json) using [OpenTelemetry @@ -9,8 +15,6 @@ protocol](https://github.com/open-telemetry/opentelemetry-proto). Please note that there is no guarantee that exact field names will remain stable. This intended for primarily for debugging Collector without setting up backends. -Supported pipeline types: traces, metrics, logs - ## Getting Started The following settings are required: @@ -24,3 +28,7 @@ exporters: file: path: ./filename.json ``` + + +[beta]:https://github.com/open-telemetry/opentelemetry-collector#beta +[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib From a9d2da7e57f08fb2f72daaee17c06268fcb1f434 Mon Sep 17 00:00:00 2001 From: minquan chen Date: Tue, 31 May 2022 15:43:16 +0800 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: Przemek Maciolek <58699843+pmm-sumo@users.noreply.github.com> --- exporter/fileexporter/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exporter/fileexporter/README.md b/exporter/fileexporter/README.md index 513222475997..527aedc8bfc5 100644 --- a/exporter/fileexporter/README.md +++ b/exporter/fileexporter/README.md @@ -2,7 +2,7 @@ | Status | | | ------------------------ |------------------------| -| Stability | [beta] | +| Stability | [alpha] | | Supported pipeline types | traces, metrics, logs | | Distributions | [contrib] | @@ -30,5 +30,5 @@ exporters: ``` -[beta]:https://github.com/open-telemetry/opentelemetry-collector#beta +[alpha]:https://github.com/open-telemetry/opentelemetry-collector#alpha [contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib From d9957a2a8db6c2475e9ddcb677eac10a1284bd27 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Tue, 31 May 2022 12:16:22 -0700 Subject: [PATCH 3/4] Update exporter/fileexporter/README.md --- exporter/fileexporter/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/exporter/fileexporter/README.md b/exporter/fileexporter/README.md index 527aedc8bfc5..2b1427a66c6d 100644 --- a/exporter/fileexporter/README.md +++ b/exporter/fileexporter/README.md @@ -2,7 +2,7 @@ | Status | | | ------------------------ |------------------------| -| Stability | [alpha] | +| Stability | [alpha] | | Supported pipeline types | traces, metrics, logs | | Distributions | [contrib] | From fadb58b7ad90970f98a5a9bc2b516bcc21c3948f Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Tue, 31 May 2022 12:19:04 -0700 Subject: [PATCH 4/4] Apply suggestions from code review --- exporter/fileexporter/README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/exporter/fileexporter/README.md b/exporter/fileexporter/README.md index 2b1427a66c6d..8ddeff4c65f2 100644 --- a/exporter/fileexporter/README.md +++ b/exporter/fileexporter/README.md @@ -1,10 +1,10 @@ # File Exporter -| Status | | -| ------------------------ |------------------------| -| Stability | [alpha] | -| Supported pipeline types | traces, metrics, logs | -| Distributions | [contrib] | +| Status | | +| ------------------------ |-----------------------| +| Stability | [alpha] | +| Supported pipeline types | traces, metrics, logs | +| Distributions | [core], [contrib] | This exporter will write pipeline data to a JSON file. The data is written in. [Protobuf JSON @@ -32,3 +32,4 @@ exporters: [alpha]:https://github.com/open-telemetry/opentelemetry-collector#alpha [contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib +[core]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol