open-telemetry / open-telemetry/opentelemetry-java-instrumentation

Configuration documentation and metadata

Open
#15,084 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
2.6k
Forks
1.2k
Avg merge
2d 18h
Merged PRs (30d)
228

Description

In the SIG meeting last week there was a discussion related to configurations, how we track them, and how they are then made available and documented to users.

A few key points:

  • The current metadata approach duplicates all the "common" configurations and adds them to each metadata file. This could prove a bit tedious if they are to change in the future and would require updating all the individual metadata files
    • We need to ensure this is scalable/maintainable. We could potentially use references or some other approach for "common" configs
  • There is no centralized catalog / reference of all configurations that cover the SDK, agent, contrib etc, that allows for searching/filtering. We have some prototypes with the new explorer, but should look into proper ways to expose this.
    • Some ideas to explore:
      • Add to opentelemetry.io pages/ registry
      • Add to ecosystem explorer
      • Render another yaml file similar to instrumentation-list.yaml
  • How to handle documenting for declarative config? do we need something separate for that?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the current metadata files, the ecosystem explorer prototypes, and instrumentation-list.yaml to understand how configurations are represented and exposed. The work is not yet scoped to a specific change; done would require a decided, maintainable approach for shared metadata, a searchable catalog, and declarative-configuration documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.