opentelemetry.io
opentelemetry.io copied to clipboard
Java docs: consider generating table from data
Consider generating, from data, the table in the section on Suppressing specific agent instrumentation of the Agent conf page.
This is a script that was (manually) used to cross-check the table entries:
https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/5133f99cca30b5b0db1352da3b80668f8a487297/buildscripts/check-suppressing-instrumentation-docs.sh
Here is some context for this issue:
https://github.com/open-telemetry/opentelemetry.io/issues/1229#issuecomment-1078122455:
@trask, I'm looking at migrating suppressing-instrumentation.md next (possibly embedding it in the Agent config page).
I'm thinking that it might make sense to use Hugo to generate the "Suppressing specific agent instrumentation" table from data -- possibly using the command you wrote here: https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/14372adb6872624b89022e2531073752ff095ce8/buildscripts/check-suppressing-instrumentation-docs.sh#L18-L21. WDYT? How do you propose deriving the Library/Framework name?
I haven't fully thought this out, but wanted to gather at least some initial feedback about possible data-driven approach to generating the table. Thanks.
Or another thought would be to use a manually-curated data file to generate the table, and a separate script (like the one you wrote) to simply cross-check if any new matching
*Module.java
files are missing. I'll let this simmer and try out a few things tomorrow.
Yet another idea might be to add the Library/Framework* name to the source files so that it can be extracted along with the argument to super
.
cc @open-telemetry/java-instrumentation-approvers in case anyone has good idea how to generate this table more reliably than the script at https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/v1.12.1/buildscripts/check-suppressing-instrumentation-docs.sh (maybe with some code restructuring?)
https://opentelemetry.io/docs/instrumentation/java/automatic/agent-config/#suppressing-specific-agent-instrumentation
looks like this is resolved now? cc @trask @chalin
I think this issue is about keeping that table up-to-date with the source code somehow(?)