Skip to content

Add readme for spark instrumentation #14055

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

breedx-splk
Copy link
Contributor

People see "spark" and now think it means "Apache Spark". Adding this readme in hopes of clarifying that for some confused users.

@breedx-splk breedx-splk requested a review from a team as a code owner June 17, 2025 17:08
@otelbot-java-instrumentation
Copy link
Contributor

🔧 The result from spotlessApply was committed to the PR branch.

Copy link
Member

@jaydeluca jaydeluca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 we can add a metadata.yaml file with this description too, i can do that in one of my batches.

Copy link
Member

@trask trask left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Comment on lines +7 to +8

This instrumentation is NOT for Apache Spark.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems pretty well covered above already?

Suggested change
This instrumentation is NOT for Apache Spark.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted it to be very clear. :)


This instrumentation is NOT for Apache Spark.

The instrumentation here facilitates tracing by generating HTTP SERVER spans.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This instrumentation does not generate any spans.

Copy link
Member

@jaydeluca jaydeluca Jun 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah right, it looks similar to the Avaje-jex-3.0 instrumentation, so maybe the description could instead be

Suggested change
The instrumentation here facilitates tracing by generating HTTP SERVER spans.
This instrumentation does not emit telemetry on its own. Instead, it extracts the HTTP route and attaches it to SERVER spans and HTTP server metrics.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants