Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] add header for file exporter. #10175

Merged
merged 4 commits into from
May 31, 2022
Merged

[docs] add header for file exporter. #10175

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
68d4471
add header for file exporter.
Frapschen May 20, 2022
a9d2da7
Apply suggestions from code review
Frapschen May 31, 2022
d9957a2
Update exporter/fileexporter/README.md
codeboten May 31, 2022
fadb58b
Apply suggestions from code review
codeboten May 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions exporter/fileexporter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# File Exporter

This exporter will write pipeline data to a JSON file. The data is written in
| 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
encoding](https://developers.google.com/protocol-buffers/docs/proto3#json)
using [OpenTelemetry
Expand All @@ -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:
Expand All @@ -24,3 +28,8 @@ exporters:
file:
path: ./filename.json
```


[alpha]:https://github.com/open-telemetry/opentelemetry-collector#alpha
[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
codeboten marked this conversation as resolved.
Show resolved Hide resolved
[core]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol