Render a Markdown file for metrics into YAML

[jcatera-splunk]

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.}

[SylvainJuge]

The jmx-metrics module provides the "JMX Gatherer" component, which is being deprecated (#2095) and is being replaced with jmx-scraper which defines (and thus also documents) the metric definitions in YAML format.

In addition, the YAML for supported systems is also being moved to instrumentation and also changed to align better with semantic conventions (open-telemetry/opentelemetry-java-instrumentation#12158) which provides a single reference for both JMX Scraper and Java instrumentation.

When using the jmxreceiver on the otel collector side, it is now possible to switch to use jmx scraper instead of jmx gatherer (which is still the default for now).