Skip to content

Commit fb0b901

Browse files
Updated otel readme (#4674) (#4681)
* updated otel readme * Update internal/pkg/otel/README.md Co-authored-by: Pierre HILBERT <pierre.hilbert@elastic.co> * Update internal/pkg/otel/templates/README.md.tmpl Co-authored-by: Pierre HILBERT <pierre.hilbert@elastic.co> * Update internal/pkg/otel/templates/README.md.tmpl Co-authored-by: Pierre HILBERT <pierre.hilbert@elastic.co> * Update internal/pkg/otel/README.md Co-authored-by: Pierre HILBERT <pierre.hilbert@elastic.co> --------- Co-authored-by: Pierre HILBERT <pierre.hilbert@elastic.co> (cherry picked from commit eaf3c43) Co-authored-by: Michal Pristas <michal.pristas@gmail.com>
1 parent 9aea3c8 commit fb0b901

File tree

2 files changed

+18
-10
lines changed

2 files changed

+18
-10
lines changed

internal/pkg/otel/README.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,19 @@ To run the Elastic Distribution for OpenTelemetry Collector you can use Elastic-
88
Running command
99

1010
```bash
11-
./elastic-agent -c otel.yml run
11+
./elastic-agent otel --config otel.yml
1212
```
1313

14-
from unpacked Elastic Agent package will run Elastic-Agent as an OpenTelemetry Collector. The `-c` flag needs to point to [OpenTelemetry Collector Configuration file](https://opentelemetry.io/docs/collector/configuration/) named `otel`, `otlp` or `otelcol`.
15-
Both `yaml` and `yml` suffixes are supported.
14+
from unpacked Elastic Agent package will run Elastic-Agent as an OpenTelemetry Collector. The `--config` flag needs to point to [OpenTelemetry Collector Configuration file](https://opentelemetry.io/docs/collector/configuration/). OTel mode is available only using `otel` subcommand. Elastic Agent will not do any autodetection of configuration file passed when used without `otel` subcommand and will try to run normally.
1615

17-
> In case this condition is not met, Elastic Agent will run in its default mode and will not behave as OpenTelemetry Collector.
1816

19-
Note that `validate` subcommand and [feature gates](https://github.com/open-telemetry/opentelemetry-collector/blob/main/featuregate/README.md#controlling-gates) are not supported yet.
17+
To validate OTel configuration run `otel validate` subcommand:
18+
19+
```bash
20+
./elastic-agent otel validate --config otel.yml
21+
```
22+
23+
[feature gates](https://github.com/open-telemetry/opentelemetry-collector/blob/main/featuregate/README.md#controlling-gates) are supported using `--feature-gates` flag.
2024

2125
## Components
2226

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

+9-5
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,19 @@ To run the Elastic Distribution for OpenTelemetry Collector you can use Elastic-
88
Running command
99

1010
```bash
11-
./elastic-agent -c otel.yml run
11+
./elastic-agent otel --config otel.yml
1212
```
1313

14-
from unpacked Elastic Agent package will run Elastic-Agent as an OpenTelemetry Collector. The `-c` flag needs to point to [OpenTelemetry Collector Configuration file](https://opentelemetry.io/docs/collector/configuration/) named `otel`, `otlp` or `otelcol`.
15-
Both `yaml` and `yml` suffixes are supported.
14+
from unpacked Elastic Agent package will run Elastic-Agent as an OpenTelemetry Collector. The `--config` flag needs to point to [OpenTelemetry Collector Configuration file](https://opentelemetry.io/docs/collector/configuration/). OTel mode is available only using `otel` subcommand. Elastic Agent will not do any autodetection of configuration file passed when used without `otel` subcommand and will try to run normally.
1615

17-
> In case this condition is not met, Elastic Agent will run in its default mode and will not behave as OpenTelemetry Collector.
1816

19-
Note that `validate` subcommand and [feature gates](https://github.com/open-telemetry/opentelemetry-collector/blob/main/featuregate/README.md#controlling-gates) are not supported yet.
17+
To validate OTel configuration run `otel validate` subcommand:
18+
19+
```bash
20+
./elastic-agent otel validate --config otel.yml
21+
```
22+
23+
[feature gates](https://github.com/open-telemetry/opentelemetry-collector/blob/main/featuregate/README.md#controlling-gates) are supported using `--feature-gates` flag.
2024

2125
## Components
2226

0 commit comments

Comments
 (0)