Skip to content

Commit 9281486

Browse files
authored
Update documentation guide (#14673)
1 parent 98b177e commit 9281486

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

docs/contributing/documenting-instrumentation.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -220,8 +220,22 @@ within 24 hours.
220220

221221
## opentelemetry.io
222222

223-
All of our instrumentation modules are listed on the opentelemetry.io website in the context of how
224-
to [suppress specific instrumentation](https://opentelemetry.io/docs/zero-code/java/agent/disable/#suppressing-specific-agent-instrumentation).
223+
All of our instrumentation modules are listed on the opentelemetry.io website in two places:
224+
225+
### Supported Libraries
226+
227+
The [Supported Libraries](https://opentelemetry.io/docs/zero-code/java/agent/supported-libraries/)
228+
page lists all the library instrumentations that are included in the OpenTelemetry Java agent. It
229+
mostly mirrors the information from the [supported libraries](../supported-libraries.md) page in
230+
this repo, and should be updated when adding or removing library instrumentations.
231+
232+
This page may be automatically generated in the future, but for now it is manually maintained.
233+
234+
### Suppressing Instrumentation
235+
236+
The [Suppressing instrumentation](https://opentelemetry.io/docs/zero-code/java/agent/disable/#suppressing-specific-agent-instrumentation)
237+
page lists the instrumentations in the context of the keys needed for using
238+
the `otel.instrumentation.[name].enabled` configuration.
225239

226240
All new instrumentations should be added to this list. There is a
227241
[Github action](../../.github/workflows/documentation-disable-list-audit.yml) that runs nightly to check

0 commit comments

Comments
 (0)