open-telemetry / open-telemetry/opentelemetry-java-contrib

Contrib component metadata

Open
#2,586 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
269
Forks
196
Avg merge
2d 7h
Merged PRs (30d)
38

Description

As a user exploring the java ecosystem, I would like to know what types of extensions and tools are available to me, aside from the standard java agent instrumentations.

As part of the Ecosystem Explorer Project, we would like to inventory the extensions produced by this repo so that we can expose them as part of our registry. (https://github.com/open-telemetry/opentelemetry-ecosystem-explorer/issues/22)

In order to do that, we would like to introduce a metadata file for each component in this project that contains some basic information, similar to how components are documented in the collector (example), and in the java instrumentation project (example).

References:

Requirements:

  • Review all contrib components and identify metadata fields to create a proposed schema
  • Create and document schema definition
  • Populate metadata files for all components

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

Start by reviewing the referenced Collector and Java instrumentation metadata schemas, then inspect all components in this repository to identify the fields they need. Document the proposed schema and populate a metadata file for every contrib component; completion means the schema is defined and all components are represented.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.