-
Notifications
You must be signed in to change notification settings - Fork 999
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
Conversation
|
@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"? |
Would it be more precise to say "The observed system" or "the instrumented application"?
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:
If this all seems too pedantic, I won't feel bad if the PR gets closed :-) |
I see what you mean. I think it makes sense, @chalin, @cartermp, @austinlparker: wdyt? |
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? |
@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>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
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!