Merge pull request #88391 from max-cx/OBSDOCS-1619

OBSDOCS-1619: Docs for TP File Exporter

Author: skopacz1

observability/otel/otel-collector/otel-collector-exporters.adoc

@@ -20,13 +20,14 @@ Currently, the following General Availability and Technology Preview exporters a
 - xref:../../../observability/otel/otel-collector/otel-collector-exporters.adoc#aws-cloudwatch-exporter_otel-collector-exporters[AWS CloudWatch Exporter]
 - xref:../../../observability/otel/otel-collector/otel-collector-exporters.adoc#aws-emf-exporter_otel-collector-exporters[AWS EMF Exporter]
 - xref:../../../observability/otel/otel-collector/otel-collector-exporters.adoc#aws-xray-exporter_otel-collector-exporters[AWS X-Ray Exporter]
+- xref:../../../observability/otel/otel-collector/otel-collector-exporters.adoc#file-exporter_otel-collector-exporters[File Exporter]
 
 [id="otlp-exporter_{context}"]
 == OTLP Exporter
 
 The OTLP gRPC Exporter exports traces and metrics by using the OpenTelemetry protocol (OTLP).
 
-.OpenTelemetry Collector custom resource with an enabled OTLP Exporter
+.OpenTelemetry Collector custom resource with the enabled OTLP Exporter
 [source,yaml]
 ----
 # ...
@@ -65,7 +66,7 @@ The OTLP gRPC Exporter exports traces and metrics by using the OpenTelemetry pro
 
 The OTLP HTTP Exporter exports traces and metrics by using the OpenTelemetry protocol (OTLP).
 
-.OpenTelemetry Collector custom resource with an enabled OTLP Exporter
+.OpenTelemetry Collector custom resource with the enabled OTLP Exporter
 [source,yaml]
 ----
 # ...
@@ -96,7 +97,7 @@ The OTLP HTTP Exporter exports traces and metrics by using the OpenTelemetry pro
 
 The Debug Exporter prints traces and metrics to the standard output.
 
-.OpenTelemetry Collector custom resource with an enabled Debug Exporter
+.OpenTelemetry Collector custom resource with the enabled Debug Exporter
 [source,yaml]
 ----
 # ...
@@ -128,7 +129,7 @@ The Load Balancing Exporter consistently exports spans, metrics, and logs accord
 :FeatureName: The Load Balancing Exporter
 include::snippets/technology-preview.adoc[leveloffset=+1]
 
-.OpenTelemetry Collector custom resource with an enabled Load Balancing Exporter
+.OpenTelemetry Collector custom resource with the enabled Load Balancing Exporter
 [source,yaml]
 ----
 # ...
@@ -168,7 +169,7 @@ The Prometheus Exporter exports metrics in the Prometheus or OpenMetrics formats
 :FeatureName: The Prometheus Exporter
 include::snippets/technology-preview.adoc[]
 
-.OpenTelemetry Collector custom resource with an enabled Prometheus Exporter
+.OpenTelemetry Collector custom resource with the enabled Prometheus Exporter
 [source,yaml]
 ----
 # ...
@@ -217,7 +218,7 @@ The Prometheus Remote Write Exporter exports metrics to compatible back ends.
 :FeatureName: The Prometheus Remote Write Exporter
 include::snippets/technology-preview.adoc[]
 
-.OpenTelemetry Collector custom resource with an enabled Prometheus Remote Write Exporter
+.OpenTelemetry Collector custom resource with the enabled Prometheus Remote Write Exporter
 [source,yaml]
 ----
 # ...
@@ -259,7 +260,7 @@ The Kafka Exporter exports logs, metrics, and traces to Kafka. This exporter use
 :FeatureName: The Kafka Exporter
 include::snippets/technology-preview.adoc[]
 
-.OpenTelemetry Collector custom resource with an enabled Kafka Exporter
+.OpenTelemetry Collector custom resource with the enabled Kafka Exporter
 [source,yaml]
 ----
 # ...
@@ -447,7 +448,43 @@ include::snippets/technology-preview.adoc[]
 // * link:https://docs.aws.amazon.com/sdk-for-go/v2/developer-guide/configure-auth.html[Configure Authentication] (AWS SDK for Go v2 Developer Guide)
 * link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html[IAM roles] (AWS Identity and Access Management User Guide)
 
+[id="file-exporter_{context}"]
+== File Exporter
+
+The File Exporter writes telemetry data to files in persistent storage and supports file operations such as rotation, compression, and writing to multiple files. With this exporter, you can also use a resource attribute to control file naming. The only required setting is `path`, which specifies the destination path for telemetry files in the persistent-volume file system.
+
+:FeatureName: The File Exporter
+include::snippets/technology-preview.adoc[]
+
+.OpenTelemetry Collector custom resource with the enabled File Exporter
+[source,yaml]
+----
+# ...
+  config: |
+    exporters:
+      file:
+        path: /data/metrics.json # <1>
+        rotation: # <2>
+          max_megabytes: 10 # <3>
+          max_days: 3 # <4>
+          max_backups: 3 # <5>
+          localtime: true # <6>
+        format: proto # <7>
+        compression: zstd # <8>
+        flush_interval: 5 # <9>
+# ...
+----
+<1> The file-system path where the data is to be written. There is no default.
+<2> File rotation is an optional feature of this exporter. By default, telemetry data is exported to a single file. Add the `rotation` setting to enable file rotation.
+<3> The `max_megabytes` setting is the maximum size a file is allowed to reach until it is rotated. The default is `100`.
+<4> The `max_days` setting is for how many days a file is to be retained, counting from the timestamp in the file name. There is no default.
+<5> The `max_backups` setting is for retaining several older files. The defalt is `100`.
+<6> The `localtime` setting specifies the local-time format for the timestamp, which is appended to the file name in front of any extension, when the file is rotated. The default is the Coordinated Universal Time (UTC).
+<7> The format for encoding the telemetry data before writing it to a file. The default format is `json`. The `proto` format is also supported.
+<8> File compression is optional and not set by default. This setting defines the compression algorithm for the data that is exported to a file. Currently, only the `zstd` compression algorithm is supported. There is no default.
+<9> The time interval between flushes. A value without a unit is set in nanoseconds. This setting is ignored when file rotation is enabled through the `rotation` settings.
+
 [role="_additional-resources"]
 [id="additional-resources_otel-collector-exporters_{context}"]
 == Additional resources
-* link:https://opentelemetry.io/docs/specs/otlp/[OpenTelemetry Protocol (OTLP) documentation]
+* link:https://opentelemetry.io/docs/specs/otlp/[OpenTelemetry Protocol (OTLP) documentation]