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

Render a Markdown file for metrics into YAML

Open
#2,238 1 comment 1 reaction 2 assignees View on GitHub

@SylvainJuge is already working on this.

Since Sep 9, 2025.

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

Description

Component(s)

jmx-metrics

Is your feature request related to a problem? Please describe.

File: https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/jmx-metrics/docs/target-systems/tomcat.md

The public documentation fetches and renders YAML files into HTML tables for our customers. The metrics given in this file are in Markdown. We don't have a way to render Markdown files in our docs right now, and per @atoulme , it doesn't make sense to use Markdown.

For the time being, I'm going to create a DITA table with the information given in this file, but it will not be dynamic, so any changes will not be reflected in the docs.

We're currently pointing to an old version of the Tomcat monitor YAML docs for the metrics at https://github.com/bxtp4p/splunk-otel-collector/blob/dc9b2605da67a966bc29176b86b5e6208ce0b06d/internal/signalfx-agent/pkg/monitors/collectd/tomcat/metadata.yaml#L4.

Describe the solution you'd like

We'd like the file to be converted to YAML.

Describe alternatives you've considered

We're going to manually include the info in the doc until this issue has been addressed and the Markdown has been converted to YAML.

Additional context

No response

Tip

React with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding +1 or me too, to help us triage it. Learn more here.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.