add note about components command in README

Signed-off-by: ChrsMark <[email protected]>
elastic · Jan 22, 2025 · 63ba927 · 63ba927
1 parent 952baf2
commit 63ba927
Showing 1 changed file with 10 additions and 4 deletions.
diff --git a/internal/pkg/otel/README.md b/internal/pkg/otel/README.md
@@ -19,6 +19,12 @@ To validate OTel configuration run `otel validate` subcommand:
 ./elastic-agent otel validate --config otel.yml
 ```
 
+Use the components command to get the list of components included in the binary:
+
+```bash
+./elastic-agent otel components
+```
+
 [feature gates](https://github.com/open-telemetry/opentelemetry-collector/blob/main/featuregate/README.md#controlling-gates) are supported using `--feature-gates` flag.
 
 ## Components
@@ -85,9 +91,9 @@ This section provides a summary of components included in the Elastic Distributi
 | [spanmetricsconnector](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/connector/spanmetricsconnector/v0.117.0/connector/spanmetricsconnector/README.md) | v0.117.0 |
 ## Persistence in OpenTelemetry Collector
 
-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. 
+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.
 
-To enable persistence for the `filelogreceiver`, we add the `file_storage` extension and activate it for `filelog`. 
+To enable persistence for the `filelogreceiver`, we add the `file_storage` extension and activate it for `filelog`.
 Execute `export STATE_PATH=/path/to/store/otel/offsets` and use the following configuration to enable persistence:
 
 ```yaml
@@ -113,10 +119,10 @@ service:
       exporters: [...]
 ```
 
-> [!WARNING]  
+> [!WARNING]
 Removing the storage key from the filelog section will disable persistence, which will lead to data duplication or loss when the collector restarts.
 
-> [!IMPORTANT]  
+> [!IMPORTANT]
 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.
 
 ### Persistence in standalone Docker mode