Skip to content

[EDOT SDKs] Add a note about auto-instrumentation capabilities and limitations to supported technologies overview #4387

Description

@hegerchr

The supported technologies docs for EDOT SDKs (e.g. Java) are listing or linking pages on frameworks and libraries that are supported by auto-instrumentation packages. Auto-instrumentation can raise the expectation by users that it will generate telemetry data for any application. In case an application does not utilize popular frameworks and libraries that have auto-instrumentation packages available and does not have build-in native Open Telemetry instrumentation by the vendor, no telemetry data might be collected. This is because auto-instrumentation packages can only instrument what they know. If an application uses custom frameworks or libraries, maybe even closed-source, no auto-instrumentation packages will be available. In such cases, users have to manually instrument the parts of the application that are not covered by auto-instrumentation packages if telemetry data is wanted.

We should add a note to the supported technologies pages of the EDOT SDKs explaining this. This note should cover

  • Capabilities and limitations of auto-instrumentation
  • Manual instrumentation by a vendor of a framework or library
  • Manual instrumentation by an application developer

Metadata

Metadata

Assignees

Labels

Team:IngestIssues owned by the Ingest Docs Team

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions