Skip to content

Add new troubleshooting page - Collector not starting #2255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

alexandra5000
Copy link
Contributor

This PR adds a new troubleshooting topic that helps users resolve issues where the EDOT Collector fails to start or crashes on launch.

Run the following to validate your configuration without starting the Collector:

```bash
edot-collector --config=/path/to/otel-collector-config.yaml --dry-run
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you try if this works, too?

edot-collector validate --config=customconfig.yaml

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't work for me

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be otelcol validate --config=/path/to/otel-collector-config.yaml. Based on https://www.elastic.co/docs/reference/opentelemetry/edot-collector/download binary name.

The shared command works in my environment.

Copy link
Contributor

@theletterf theletterf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some comments, LGMT pending tech review

Copy link

🔍 Preview links for changed docs

Run the following to validate your configuration without starting the Collector:

```bash
edot-collector --config=/path/to/otel-collector-config.yaml --dry-run

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be otelcol validate --config=/path/to/otel-collector-config.yaml. Based on https://www.elastic.co/docs/reference/opentelemetry/edot-collector/download binary name.

The shared command works in my environment.


This checks for syntax errors and missing components.

EDOT fully supports `--dry-run`, just like the upstream Collector.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The dry-run flag is not needed with the validate subcommand:

$ ./otelcol validate --config otel.yml --dry-run
unknown flag: --dry-run

Comment on lines +65 to +69
To increase verbosity, run the Collector with:

```bash
--log-level=debug
```

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not available in the EDOT collector (nor in the upstream collector):

$ ./otelcol --log-level=debug
unknown flag: --log-level

To change the log level there's two main methods:

  1. Extend the telemetry section configuration file of the collector (/path/to/otel-collector-config.yaml) with:
service:
  telemetry:
    logs:
      level: debug
  1. (Recommended for troubleshooting) Via CLI flags:
./otelcol --set=service.telemetry.logs.level=debug

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

EDOT Collector won't start - troubleshooting
3 participants