Skip to content

Java docs: consider generating table from data #1236

Open
@chalin

Description

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:

#1229 (comment):

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions