You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: extension/apmconfigextension/README.md
+23-8Lines changed: 23 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,15 +34,19 @@ extensions:
34
34
protocols:
35
35
http:
36
36
endpoint: ":4320"
37
+
38
+
service:
39
+
extensions: [bearertokenauth, apmconfig]
37
40
```
38
41
39
42
The previous snippet configures the `bearertokenauth` authenticator as client authenticator to be used with the Elasticsearch endpoint.
40
43
41
44
- An Elasticsearch API key is used as secret token.
42
45
- The `apmconfig` section defines the Elasticsearch `endpoint` for reading the EDOT SDK configuration and the `authenticator` that should be used with the endpoint.
43
-
- The `opamp` section configures the OpAMP endpoint to provide an HTTP endpoint on port 4320. The EDOT SDKs are connecting to this endpoint to fetch configuration messages.
46
+
- The `opamp` section configures the OpAMP endpoint to provide an HTTP endpoint on port 4320. The EDOT SDKs are connecting to this endpoint to fetch configuration messages.
47
+
- The `service` section enables the `bearertokenauth` and `apmconfig` extension.
44
48
45
-
Authentication between the OpAMP endpoint and the EDOT SDKs is not configured in the snippet. More information on securing the communication between the apmconfig extension and the EDOT SDKs are given in [Secure the OpAMP endpoint](#secure-the-opamp-endpoint).
49
+
Authentication between the OpAMP endpoint and the EDOT SDKs is not configured in the snippet. More information on securing the communication between the `apmconfig` extension and the EDOT SDKs are given in [Secure the OpAMP endpoint](#secure-the-opamp-endpoint).
46
50
47
51
## Advanced configuration
48
52
@@ -56,7 +60,7 @@ All available Elasticsearch client configuration options can be found [here](htt
56
60
57
61
### Secure the OpAMP endpoint
58
62
59
-
The apmconfig extension embeds the [confighttp.ServerConfig](https://github.com/open-telemetry/opentelemetry-collector/blob/v0.125.0/config/confighttp/README.md), which means it supports standard HTTP server configuration, including TLS/mTLS and authentication.
63
+
The `apmconfig` extension embeds the [confighttp.ServerConfig](https://github.com/open-telemetry/opentelemetry-collector/blob/v0.125.0/config/confighttp/README.md), which means it supports standard HTTP server configuration, including TLS/mTLS and authentication.
60
64
61
65
#### Enable TLS and mTLS for the OpAMP endpoint
62
66
@@ -76,7 +80,6 @@ extensions:
76
80
tls:
77
81
cert_file: your/path/to/server.crt
78
82
key_file: your/path/to/server.key
79
-
...
80
83
```
81
84
82
85
More information is available in the [OpenTelemetry TLS server configuration documentation](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md#server-configuration).
An API key with the minimum required application permissions (as verified with the configuration above) can be created via Kibana by navigating to: `Observability → Applications → Settings → Agent Keys`, or by using the Elasticsearch Security API:
The configuration snippet configures the `bearertokenauth` authenticator for the authentication of the Elasticsearch client, the `apikeyauth` authenticator for the OpAMP server, the Elasticsearch endpoint, and TLS for securing the connection between the OpAMP server and EDOT SDKs being the OpAMP client.
@@ -232,7 +247,7 @@ contain only one entry—and in this case, the key may be an empty string.
232
247
field in the `AgentRemoteConfig` is set to `application/json`.
233
248
- Each `AgentRemoteConfig` message should contain a [hash
0 commit comments