-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(OTEL): Collector feedback from SME
- Loading branch information
1 parent
f25ef4d
commit 6f4e824
Showing
5 changed files
with
66 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 54 additions & 0 deletions
54
...try-integrations/opentelemetry/collector/opentelemetry-general-coll-configs.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
title: "General OpenTelemetry collector configurations" | ||
tags: | ||
- Integrations | ||
- Open source telemetry integrations | ||
- OpenTelemetry | ||
metaDescription: Here are some general configurations for your collector. | ||
--- | ||
|
||
A variety of general configurations are available for your collector setup. | ||
|
||
### Health Check [#health-check] | ||
|
||
The health check is an extension to the primary functionality of the collector and ensures the collector is working. | ||
|
||
For setup details, see [health_check (GitHub)](https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/troubleshooting.md#health-check) | ||
|
||
When enabled, the local endpoint using localhost:13133 returns the following response: | ||
|
||
``` | ||
{ | ||
"status": "Server available", | ||
"upSince": "2015-10-21T12:00:00.6847174Z", | ||
"uptime": "50.0123456s" | ||
} | ||
``` | ||
|
||
### Environment variables [#env-variables] | ||
|
||
The collector configuration supports the use and expansion of environment variables. For example: | ||
|
||
``` | ||
processors: | ||
attributes/example: | ||
actions: | ||
- key: "${DB_KEY}" | ||
action: "${OPERATION}" | ||
``` | ||
|
||
### Proxy support [#proxy-support] | ||
|
||
Exporters that leverage the net/http package respect the following proxy environment variables: | ||
|
||
* HTTP_PROXY | ||
* HTTPS_PROXY | ||
* NO_PROXY | ||
|
||
If these environment variables are set when the collector starts, then exporters, regardless of protocol, will or will not proxy traffic. | ||
|
||
### Authentication [#authentication] | ||
|
||
Most `receivers` exposing an HTTP or gRPC port can be protected using the collector’s [authentication mechanism](https://opentelemetry.io/docs/collector/configuration/#authentication), and most `exporters` using HTTP or gRPC clients can add authentication data to the outgoing requests. | ||
|
||
For a list of known authenticators, use the [Registry](https://opentelemetry.io/registry/?s=authenticator&component=extension&language=) available in the OpenTelemetry website. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters