aboutsummaryrefslogtreecommitdiff
path: root/crates/otlp-file-exporter/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'crates/otlp-file-exporter/README.md')
-rw-r--r--crates/otlp-file-exporter/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/crates/otlp-file-exporter/README.md b/crates/otlp-file-exporter/README.md
new file mode 100644
index 000000000..7e31609e8
--- /dev/null
+++ b/crates/otlp-file-exporter/README.md
@@ -0,0 +1,12 @@
+# otlp-file-exporter
+
+This crate implements an OpenTelemetry exporter for writing [OTLP] JSON files to disk.
+
+This at some point will be [implemented upstream],
+at which point this crate will be deprecated,
+but for now it's here.
+
+License: MIT OR Apache-2.0
+
+[OTLP]: https://opentelemetry.io/docs/specs/otel/protocol/file-exporter/
+[implemented upstream]: https://github.com/open-telemetry/opentelemetry-rust/issues/2602