Skip to content

Commit

Permalink
[OTLP] Add details for offline storage (#5628)
Browse files Browse the repository at this point in the history
Co-authored-by: Mikel Blanchard <mblanchard@macrosssoftware.com>
  • Loading branch information
vishweshbankwar and CodeBlanch authored May 17, 2024
1 parent a9c32c9 commit 16f2bf0
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down

0 comments on commit 16f2bf0

Please sign in to comment.