Skip to content

Commit b38b6f9

Browse files
Add TLS notes and settings (#913)
* Add TLS notes and settings * Update docs/reference/edot-java/configuration.md Co-authored-by: SylvainJuge <[email protected]> * Add config based option --------- Co-authored-by: SylvainJuge <[email protected]>
1 parent 79486da commit b38b6f9

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

docs/reference/edot-java/configuration.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,22 @@ One solution is to add the certificate or certificate authority to the JVM trust
244244

245245
If trust store modification is not possible or not practical, for example when troubleshooting or working with a local deployment, certificate verification can be disabled by setting `ELASTIC_OTEL_VERIFY_SERVER_CERT` to `false`. This however need to be evaluated carefully as it lowers the communication security and could allow for man-in-the-middle attacks where the data could be intercepted between the agent and the collector endpoint.
246246

247+
### TLS configuration for OTLP endpoint
248+
249+
To secure the connection to the OTLP endpoint using TLS, you can configure the following environment variables as documented in the [OpenTelemetry OTLP Exporter specification](https://opentelemetry.io/docs/specs/otel/protocol/exporter/):
250+
251+
| Option | Description |
252+
|---|---|
253+
| `OTEL_EXPORTER_OTLP_CERTIFICATE` | Path to a PEM-encoded file containing the trusted certificate(s) to verify the server's TLS credentials. |
254+
| `OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE` | Path to a PEM-encoded file containing the client certificate for mTLS. |
255+
| `OTEL_EXPORTER_OTLP_CLIENT_KEY` | Path to a PEM-encoded file containing the client's private key for mTLS. |
256+
257+
Signal-specific variants are also supported: `OTEL_EXPORTER_OTLP_{signal}_CERTIFICATE`, `OTEL_EXPORTER_OTLP_{signal}_CLIENT_CERTIFICATE`, and `OTEL_EXPORTER_OTLP_{signal}_CLIENT_KEY` where `{signal}` is one of `TRACES`, `METRICS` or `LOGS`.
258+
259+
:::{note}
260+
TLS configuration for OpAMP endpoint (central configuration) is not yet supported in EDOT Java.
261+
:::
262+
247263
## Prevent logs export
248264

249265
To prevent logs from being exported, set `OTEL_LOGS_EXPORTER` to `none`. However, application logs might still be gathered and exported by the Collector through the `filelog` receiver.

docs/reference/edot-java/supported-technologies.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,23 @@ products:
1717

1818
The EDOT Java agent is a [distribution](https://opentelemetry.io/docs/concepts/distributions/) of [OpenTelemetry Java Instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation) agent. It inherits all the [supported](opentelemetry://reference/compatibility/nomenclature.md) technologies of the OpenTelemetry Java Instrumentation.
1919

20+
:::{note}
21+
**Understanding auto-instrumentation scope**
22+
23+
Auto-instrumentation automatically captures telemetry for the frameworks and libraries listed on this page. However, it cannot instrument:
24+
25+
- Custom or proprietary frameworks and libraries
26+
- Closed-source components without instrumentation support
27+
- Application-specific business logic
28+
29+
If your application uses technologies not covered by auto-instrumentation, you have two options:
30+
31+
1. **Native OpenTelemetry support** — Some frameworks and libraries include built-in OpenTelemetry instrumentation provided by the vendor.
32+
2. **Manual instrumentation** — Use the [OpenTelemetry API](https://opentelemetry.io/docs/languages/java/instrumentation/) to add custom spans, metrics, and logs for unsupported components.
33+
3. **Configuration-based instrumentation** — Use the [`otel.instrumentation.methods.include`](https://opentelemetry.io/docs/zero-code/java/agent/annotations/#creating-spans-around-methods-with-otelinstrumentationmethodsinclude) option to create spans around specific methods without modifying application code or dependencies.
34+
:::
35+
36+
2037
## EDOT Collector and Elastic Stack versions
2138

2239
The EDOT Java agent sends data through the OpenTelemetry protocol (OTLP). While OTLP ingest works with later 8.16+ versions of the EDOT Collector, for full support use either [EDOT Collector](elastic-agent://reference/edot-collector/index.md) versions 9.x or [{{serverless-full}}](docs-content://deploy-manage/deploy/elastic-cloud/serverless.md) for OTLP ingest.

0 commit comments

Comments
 (0)