Skip to content

Commit 16f2bf0

Browse files
[OTLP] Add details for offline storage (#5628)
Co-authored-by: Mikel Blanchard <[email protected]>
1 parent a9c32c9 commit 16f2bf0

File tree

1 file changed

+17
-4
lines changed
  • src/OpenTelemetry.Exporter.OpenTelemetryProtocol

1 file changed

+17
-4
lines changed

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -632,10 +632,23 @@ want to solicit feedback from the community.
632632

633633
Added in `1.8.0`.
634634

635-
* When set to `disk` along with setting
636-
`OTEL_DOTNET_EXPERIMENTAL_OTLP_DISK_RETRY_DIRECTORY_PATH` to the path on
637-
disk, it enables retries by storing telemetry on disk during transient
638-
errors.
635+
* When set to `disk`, it enables retries by storing telemetry on disk during
636+
transient errors. The default path where the telemetry is stored is
637+
obtained by calling
638+
[Path.GetTempPath()](https://learn.microsoft.com/dotnet/api/system.io.path.gettemppath)
639+
or can be customized by setting
640+
`OTEL_DOTNET_EXPERIMENTAL_OTLP_DISK_RETRY_DIRECTORY_PATH` environment
641+
variable.
642+
643+
The OTLP exporter utilizes a forked version of the
644+
[OpenTelemetry.PersistentStorage.FileSystem](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/tree/main/src/OpenTelemetry.PersistentStorage.FileSystem)
645+
library to store telemetry data on disk. When a transient failure occurs,
646+
a file is created at the specified directory path on disk containing the
647+
serialized request data that was attempted to be sent to the OTLP
648+
ingestion. A background thread attempts to resend any offline stored
649+
telemetry every 60 seconds. For more details on how these files are
650+
managed on disk, refer to the [File
651+
details](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/tree/main/src/OpenTelemetry.PersistentStorage.FileSystem#file-details).
639652

640653
Added in **TBD** (Unreleased).
641654

0 commit comments

Comments
 (0)