Skip to content

Commit ec8a220

Browse files
committed
fix fmt
Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
1 parent 63ba927 commit ec8a220

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

internal/pkg/otel/templates/README.md.tmpl

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ To validate OTel configuration run `otel validate` subcommand:
1919
./elastic-agent otel validate --config otel.yml
2020
```
2121

22+
Use the components command to get the list of components included in the binary:
23+
24+
```bash
25+
./elastic-agent otel components
26+
```
27+
2228
[feature gates](https://github.com/open-telemetry/opentelemetry-collector/blob/main/featuregate/README.md#controlling-gates) are supported using `--feature-gates` flag.
2329

2430
## Components
@@ -78,9 +84,9 @@ This section provides a summary of components included in the Elastic Distributi
7884

7985
## Persistence in OpenTelemetry Collector
8086

81-
By default, the OpenTelemetry Collector is stateless, which means it doesn't store offsets on disk while reading files. As a result, if you restart the collector, it won't retain the last read offset, potentially leading to data duplication or loss. However, we have configured persistence in the settings provided with the Elastic Agent package.
87+
By default, the OpenTelemetry Collector is stateless, which means it doesn't store offsets on disk while reading files. As a result, if you restart the collector, it won't retain the last read offset, potentially leading to data duplication or loss. However, we have configured persistence in the settings provided with the Elastic Agent package.
8288

83-
To enable persistence for the `filelogreceiver`, we add the `file_storage` extension and activate it for `filelog`.
89+
To enable persistence for the `filelogreceiver`, we add the `file_storage` extension and activate it for `filelog`.
8490
Execute `export STATE_PATH=/path/to/store/otel/offsets` and use the following configuration to enable persistence:
8591

8692
```yaml
@@ -106,10 +112,10 @@ service:
106112
exporters: [...]
107113
```
108114

109-
> [!WARNING]
115+
> [!WARNING]
110116
Removing the storage key from the filelog section will disable persistence, which will lead to data duplication or loss when the collector restarts.
111117

112-
> [!IMPORTANT]
118+
> [!IMPORTANT]
113119
If you remove the `create_directory: true` option, you'll need to manually create a directory to store the data. You can ignore this option if the directory already exists.
114120

115121
### Persistence in standalone Docker mode

0 commit comments

Comments
 (0)