Skip to content
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

Fix Collector configuration issues #3443

Merged
Merged
Changes from 4 commits
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
3f22c75
Redo URLs
theletterf Oct 26, 2023
778d19d
Format fixes
theletterf Oct 26, 2023
90fc621
Update lint
theletterf Oct 26, 2023
f4dfacb
Merge branch 'main' into theletterf-fix-config-collector-issues
theletterf Oct 27, 2023
e42180c
Further edits
theletterf Oct 31, 2023
1e790d8
Add refs
theletterf Oct 31, 2023
5162477
Linting issues
theletterf Oct 31, 2023
fa3c1ac
Redo URLs
theletterf Oct 26, 2023
ba21733
Format fixes
theletterf Oct 26, 2023
8e8673c
Update lint
theletterf Oct 26, 2023
4aac692
Further edits
theletterf Oct 31, 2023
66a3fe8
Add refs
theletterf Oct 31, 2023
fd81f8b
Linting issues
theletterf Oct 31, 2023
21f7883
Update content/en/docs/collector/configuration.md
theletterf Oct 31, 2023
e986fbc
Update content/en/docs/collector/configuration.md
theletterf Oct 31, 2023
23616d8
Update content/en/docs/collector/configuration.md
theletterf Oct 31, 2023
f830907
Update content/en/docs/collector/configuration.md
theletterf Oct 31, 2023
619dcaa
Update configuration.md
theletterf Oct 31, 2023
69bfe97
Merge branch 'main' into theletterf-fix-config-collector-issues
theletterf Oct 31, 2023
588b852
Merge branch 'theletterf-fix-config-collector-issues' of github.com:t…
theletterf Oct 31, 2023
597cd8f
Fix format
theletterf Oct 31, 2023
9904c66
Merge branch 'main' into theletterf-fix-config-collector-issues
theletterf Nov 6, 2023
e579d0b
Update content/en/docs/collector/configuration.md
theletterf Nov 6, 2023
ccc08a1
Update content/en/docs/collector/configuration.md
theletterf Nov 6, 2023
c8de7f7
Update content/en/docs/collector/configuration.md
theletterf Nov 6, 2023
7a623e6
Update content/en/docs/collector/configuration.md
theletterf Nov 6, 2023
ffe0f72
Update content/en/docs/collector/configuration.md
theletterf Nov 6, 2023
7bd1989
Update content/en/docs/collector/configuration.md
theletterf Nov 6, 2023
0c3c657
Update content/en/docs/collector/configuration.md
theletterf Nov 6, 2023
0422884
Update content/en/docs/collector/configuration.md
theletterf Nov 6, 2023
50d4020
Update content/en/docs/collector/configuration.md
theletterf Nov 6, 2023
c08e79c
Update content/en/docs/collector/configuration.md
theletterf Nov 6, 2023
c63b67d
Update content/en/docs/collector/configuration.md
theletterf Nov 6, 2023
b9406d0
Formatting
theletterf Nov 6, 2023
af354ff
Merge branch 'main' into theletterf-fix-config-collector-issues
theletterf Nov 6, 2023
f06c5dd
Merge branch 'main' into theletterf-fix-config-collector-issues
theletterf Nov 7, 2023
d4d1970
Merge branch 'main' into theletterf-fix-config-collector-issues
theletterf Nov 7, 2023
3dc10dd
Merge branch 'main' into theletterf-fix-config-collector-issues
theletterf Nov 7, 2023
ee43d57
Update content/en/docs/collector/configuration.md
theletterf Nov 8, 2023
8c569df
Update content/en/docs/collector/configuration.md
theletterf Nov 8, 2023
fc4bc91
Update content/en/docs/collector/configuration.md
theletterf Nov 8, 2023
acef656
Update content/en/docs/collector/configuration.md
theletterf Nov 8, 2023
117502a
Merge branch 'main' into theletterf-fix-config-collector-issues
theletterf Nov 8, 2023
9c85b18
Additional fixes
theletterf Nov 8, 2023
935db71
Fixes
theletterf Nov 8, 2023
26f4fba
Merge branch 'main' into theletterf-fix-config-collector-issues
theletterf Nov 8, 2023
de1939d
Merge branch 'main' into theletterf-fix-config-collector-issues
theletterf Nov 9, 2023
a535489
Merge branch 'main' into theletterf-fix-config-collector-issues
theletterf Nov 22, 2023
fa5c7d6
Edits
theletterf Nov 22, 2023
a5d2ee9
Merge branch 'theletterf-fix-config-collector-issues' of github.com:t…
theletterf Nov 22, 2023
8aa7b54
Merge branch 'main' into theletterf-fix-config-collector-issues
theletterf Nov 23, 2023
af29957
Merge branch 'main' into theletterf-fix-config-collector-issues
Nov 24, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 25 additions & 25 deletions content/en/docs/collector/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Configuration
weight: 20
description: Learn how to configure the Collector to suit your needs
# prettier-ignore
cSpell:ignore: cfssl cfssljson fluentforward gencert genkey hostmetrics initca loglevel OIDC oidc otlphttp pprof prodevent prometheusremotewrite servicegraph spanevents spanmetrics upsert zpages
---
Expand Down Expand Up @@ -330,25 +331,24 @@ processors:

## Exporters <img width="35" class="img-initial" src="/img/logos/32x32/Exporters.svg"> {#exporters}

An exporter, which can be push or pull based, is how you send data to one or
more backends/destinations. Exporters may support one or more
Exporters send data to one or more backends or destinations. Exporters can be
pull or push based, and may support one or more
[data sources](/docs/concepts/signals/).

The `exporters:` section is how exporters are configured. Exporters may come
with default settings, but many require configuration to specify at least the
destination and security settings. Any configuration for an exporter must be
done in this section. Configuration parameters specified for which the exporter
provides a default configuration are overridden.
The `exporters:` section contains exporters configuration. Most exporters
theletterf marked this conversation as resolved.
Show resolved Hide resolved
require configuration to specify at least the destination, as well as security
settings, like authentication tokens or TLS certificates. Any setting you
specify overrides the default values, if present.

> Configuring an exporter does not enable it. Exporters are enabled via
> pipelines within the [service](#service) section.
> Configuring an exporter does not enable it. Exporters are enabled by adding
> them to the appropriate pipelines within the [service](#service) section.

One or more exporters must be configured. By default, no exporters are
configured. A basic example of exporters is provided below. Certain exporter
configurations require x.509 certificates to be created in order to be secure,
as described in [setting up certificates](#setting-up-certificates).
The Collector requires one or more exporters. The following example shows
various exporters. Notice that some exporters require x.509 certificates in
order to establish secure connections, as described in
[setting up certificates](#setting-up-certificates).

> For detailed exporter configuration, see the
> For more information on exporter configuration, see the
> [exporter README.md](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/README.md).

```yaml
Expand All @@ -359,7 +359,7 @@ exporters:

# Data sources: traces
otlp/jaeger:
endpoint: jaeger-all-in-one:4317
endpoint: jaeger.example.com:4317
theletterf marked this conversation as resolved.
Show resolved Hide resolved
tls:
cert_file: cert.pem
key_file: cert-key.pem
Expand All @@ -386,24 +386,24 @@ exporters:

# Data sources: traces, metrics
otlphttp:
endpoint: https://example.com:4318
endpoint: https://otlp.example.com:4318

# Data sources: metrics
prometheus:
endpoint: prometheus:8889
endpoint: localhost:8889
namespace: default

# Data sources: metrics
prometheusremotewrite:
endpoint: http://some.url:9411/api/prom/push
# For official Prometheus (e.g. running via Docker)
# endpoint: 'http://prometheus:9090/api/v1/write'
endpoint: http://prometheus.example.com:9411/api/prom/push
# When using the official Prometheus (running via Docker)
# endpoint: 'http://prometheus:9090/api/v1/write', add:
# tls:
# insecure: true

# Data sources: traces
zipkin:
endpoint: http://localhost:9411/api/v2/spans
endpoint: http://zipkin.example.com:9411/api/v2/spans
```

## Connectors <img width="32" class="img-initial" src="/img/logos/32x32/Load_Balancer.svg"> {#connectors}
Expand Down Expand Up @@ -602,15 +602,15 @@ exporters:

### Proxy Support

Exporters that leverage the `net/http` package (all do today) respect the
following proxy environment variables:
Exporters that leverage the [`net/http`](https://pkg.go.dev/net/http) package
respect the following proxy environment variables:

- HTTP_PROXY
- HTTPS_PROXY
- NO_PROXY

If set at Collector start time then exporters, regardless of protocol, will or
will not proxy traffic as defined by these environment variables.
If set at Collector start time, exporters, regardless of protocol, will proxy
traffic or bypass proxy traffic as defined by these environment variables.

### Authentication

Expand Down