From 16f2bf0fb904e5d7a5e9bbf914dec539610d0a62 Mon Sep 17 00:00:00 2001 From: Vishwesh Bankwar Date: Fri, 17 May 2024 15:49:39 -0700 Subject: [PATCH] [OTLP] Add details for offline storage (#5628) Co-authored-by: Mikel Blanchard --- .../README.md | 21 +++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md index adff6d6c7f2..79b0cfdefb8 100644 --- a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md +++ b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md @@ -632,10 +632,23 @@ want to solicit feedback from the community. Added in `1.8.0`. - * When set to `disk` along with setting - `OTEL_DOTNET_EXPERIMENTAL_OTLP_DISK_RETRY_DIRECTORY_PATH` to the path on - disk, it enables retries by storing telemetry on disk during transient - errors. + * When set to `disk`, it enables retries by storing telemetry on disk during + transient errors. The default path where the telemetry is stored is + obtained by calling + [Path.GetTempPath()](https://learn.microsoft.com/dotnet/api/system.io.path.gettemppath) + or can be customized by setting + `OTEL_DOTNET_EXPERIMENTAL_OTLP_DISK_RETRY_DIRECTORY_PATH` environment + variable. + + The OTLP exporter utilizes a forked version of the + [OpenTelemetry.PersistentStorage.FileSystem](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/tree/main/src/OpenTelemetry.PersistentStorage.FileSystem) + library to store telemetry data on disk. When a transient failure occurs, + a file is created at the specified directory path on disk containing the + serialized request data that was attempted to be sent to the OTLP + ingestion. A background thread attempts to resend any offline stored + telemetry every 60 seconds. For more details on how these files are + managed on disk, refer to the [File + details](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/tree/main/src/OpenTelemetry.PersistentStorage.FileSystem#file-details). Added in **TBD** (Unreleased).