Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor auto-instrumentation docs and examples for multiple instrumentation libraries #962

Merged
merged 4 commits into from
Oct 13, 2023
Merged

Refactor auto-instrumentation docs and examples for multiple instrumentation libraries #962

merged 4 commits into from
Oct 13, 2023

Conversation

jvoravong
Copy link
Contributor

@jvoravong jvoravong commented Oct 12, 2023 •
edited
Loading

Description:
This PR enhances and refactors our operator auto-instrumentation example documentation:

  • Revise the existing Java example for consistency for soon to be added instrumentation libraries
  • Move the example operator auto-instrumentation README.md to spring-petclinic-java.md. Will add a new broader example operator auto-instrumentation README.md in a follow up PR.

Testing:

  • Validated the Java demo manually.

Documentation:

  • Initiated the development of Go template code to sustainably manage documentation across various instrumentation libraries for auto-instrumentation.
  • Opting to withhold the go template code for now and anticipate introducing it after documenting 3-4 instrumentation libraries to ensure relevancy and refined usage.

@jvoravong jvoravong changed the title Add support materials for NodeJS auto-instrumentation Refactor auto-instrumentation docs and examples for multiple instrumentation libraries Oct 12, 2023
@jvoravong
Update example deploying operator auto-instrumentation for java to be…
00b109e 
…tter match a nodejs version about to be added
@jvoravong jvoravong marked this pull request as ready for review October 12, 2023 17:48
@jvoravong jvoravong requested review from a team as code owners October 12, 2023 17:48
@jvoravong jvoravong force-pushed the otl-1406 branch 2 times, most recently from a163e53 to b638cd9 Compare October 12, 2023 21:11
jvoravong added a commit to jvoravong/splunk-otel-collector-chart that referenced this pull request Oct 13, 2023
@jvoravong
Add placeholder README_NEW.md until signalfx#962 is merged
a38c381
@jvoravong jvoravong mentioned this pull request Oct 13, 2023
Merged
jvoravong added a commit to jvoravong/splunk-otel-collector-chart that referenced this pull request Oct 13, 2023
@jvoravong
Add placeholder README_NEW.md until signalfx#962 is merged
f97cdc3
@jvoravong jvoravong merged commit 3f84423 into signalfx:main Oct 13, 2023
23 of 24 checks passed
@jvoravong jvoravong deleted the otl-1406 branch October 13, 2023 21:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@atoulme atoulme atoulme approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jvoravong @atoulme