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.

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

Clarify instrumentation definition #2245

Merged
merged 3 commits into from
Feb 7, 2023

Conversation

MattDodsonEnglish
Copy link
Contributor

The original version implied that the code itself emits metrics, which I don't think is precisely true. Isn't it the system that emits?

Great docs, by the way!

@MattDodsonEnglish MattDodsonEnglish requested a review from a team as a code owner February 1, 2023 15:57
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Feb 1, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: MattDodsonEnglish / name: Matt Dodson (440220d)

@svrnm
Copy link
Member

svrnm commented Feb 1, 2023

@MattDodsonEnglish I am not sure if I understand your concern: Instrumentation is added into the code (either manually or by means to inject it) so that the application (code) is able to emit telemetry. What are you referring to when you say "system"?

@MattDodsonEnglish
Copy link
Contributor Author

MattDodsonEnglish commented Feb 1, 2023

What are you referring to when you say "system"?

Would it be more precise to say "The observed system" or "the instrumented application"?

the application (code) is able to emit telemetry.

This is my essential confusion: I don't think that application is equivalent to code, since an application also has hardware that runs the code. Code itself can't emit anything; it's just lines of text.

For a little more context, I'm about to review a docs PR for another OSS tool, k6 (developed by Grafana). These docs use the word "instrument" often, and I see "Instrument" and "instrumentation" all over text about observability and observability tools. But, it was hard to find definitions. Someone pointed me here, and I really like the simplicity and economy of it. However it still gives me a slight pause to read "code emits". I suppose it's not so easy to come up with a "perfect" and concise definition. Another attempt:

When the application runs, the components with instrumented code emit metrics...

If this all seems too pedantic, I won't feel bad if the PR gets closed :-)

@svrnm
Copy link
Member

svrnm commented Feb 2, 2023

I see what you mean. I think it makes sense, @chalin, @cartermp, @austinlparker: wdyt?

@chalin
Copy link
Contributor

chalin commented Feb 2, 2023

I think that there is room for improvement, though I'd be in favor of the suggested change I proposed earlier: which refers to "code from the system's components". Any comment on that?

@svrnm
Copy link
Member

svrnm commented Feb 6, 2023

@MattDodsonEnglish please apply @chalin's suggestion and then I think we should be good to go

Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Copy link
Contributor

@cartermp cartermp left a comment

Choose a reason for hiding this comment

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

Thanks!

@cartermp cartermp merged commit 83635e0 into open-telemetry:main Feb 7, 2023
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.

None yet

4 participants