Skip to content

Commit 8fff6ec

Browse files
authored
Merge pull request #75425 from max-cx/OBSDOCS-869
OBSDOCS-869/TRACING-3977: Documentation for filestorage extension
2 parents fb5056d + 38b9e4c commit 8fff6ec

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

modules/otel-collector-components.adoc

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1149,6 +1149,46 @@ This extension supports traces, metrics, and logs.
11491149
<11> Sets a timeout for the token client's request.
11501150
<12> You can assign the authenticator configuration to an OTLP exporter.
11511151

1152+
[id="filestorage-extension_{context}"]
1153+
=== File Storage Extension
1154+
1155+
:FeatureName: The File Storage Extension
1156+
include::snippets/technology-preview.adoc[]
1157+
1158+
The File Storage Extension supports traces, metrics, and logs. This extension can persist the state to the local file system. This extension persists the sending queue for the OTLP exporters that are based on the HTTP and the gRPC protocols. This extension requires the read and write access to a directory. This extension can use a default directory, but the default directory must already exist.
1159+
1160+
.OpenTelemetry Collector custom resource with a configured File Storage Extension that persists an OTLP sending queue
1161+
[source,yaml]
1162+
----
1163+
config: |
1164+
extensions:
1165+
file_storage/all_settings:
1166+
directory: /var/lib/otelcol/mydir # <1>
1167+
timeout: 1s # <2>
1168+
compaction:
1169+
on_start: true # <3>
1170+
directory: /tmp/ # <4>
1171+
max_transaction_size: 65_536 # <5>
1172+
fsync: false # <6>
1173+
1174+
exporters:
1175+
otlp:
1176+
sending_queue:
1177+
storage: file_storage/all_settings
1178+
1179+
service:
1180+
extensions: [file_storage/all_settings]
1181+
pipelines:
1182+
traces:
1183+
receivers: [otlp]
1184+
exporters: [otlp]
1185+
----
1186+
<1> Specifies the directory in which the telemetry data is stored.
1187+
<2> Specifies the timeout time interval for opening the stored files.
1188+
<3> Starts compaction when the Collector starts. If omitted, the default is `+false+`.
1189+
<4> Specifies the directory in which the compactor stores the telemetry data.
1190+
<5> Defines the maximum size of the compaction transaction. To ignore the transaction size, set to zero. If omitted, the default is `+65536+` bytes.
1191+
<6> When set, forces the database to perform an `fsync` call after each write operation. This helps to ensure database integrity if there is an interruption to the database process, but at the cost of performance.
11521192

11531193
[id="jaegerremotesampling-extension_{context}"]
11541194
=== Jaeger Remote Sampling extension

0 commit comments

Comments
 (0)