Add basic configuration for the APM tracer #18861
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jalvz
added
enhancement
Team:Integrations
|
Pinging @elastic/integrations (Team:Integrations) |
botelastic
bot
added
needs_team
💔 Tests Failed
Expand to view the summary
Build stats
Test stats 🧪
Test errorsExpand to view the tests failures
--------------------- >> end captured stdout << ----------------------
Steps errorsExpand to view the steps failures
Log outputExpand to view the last 100 lines of log output
|
axw
reviewed
Jun 4, 2020
Co-authored-by: Andrew Wilkins <[email protected]>
Co-authored-by: Andrew Wilkins <[email protected]>
Co-authored-by: Andrew Wilkins <[email protected]>
Co-authored-by: Andrew Wilkins <[email protected]>
axw
reviewed
Jun 5, 2020
|
@urso / @ycombinator can any of you have a look at this, or assign it to someone else? Thanks. |
urso
reviewed
Jun 10, 2020
libbeat/beat/instrumentation.go
Outdated
| // Listener is only relevant for APM Server sending tracing data to itself | ||
| // APM Server needs this Listener to create an ad-hoc tracing server | ||
| Listener net.Listener | ||
| } |
There was a problem hiding this comment.
The 'libbeat/beat' package should be the minimal package with public API that is required to implement a custom Beat. It should provide mostly interfaces only. Can we move this functionality into a separate package and turn 'Instrumentation' into an interface? Do we even need Instrumentation or would it be enough to have a Tracer within the Beat structure?
There was a problem hiding this comment.
Done. Just the Tracer is not enough, thou - we need the Listener
urso
reviewed
Jun 12, 2020
libbeat/cmd/instance/beat.go
Outdated
| Logging *common.Config `config:"logging"` | ||
| MetricLogging *common.Config `config:"logging.metrics"` | ||
| Keystore *common.Config `config:"keystore"` | ||
| Instrumentation *common.Config `config:"instrumentation"` |
There was a problem hiding this comment.
I know there are no clear rules, but I'd prefer to use concrete types and only use common.Config if we really need it (e.g. capture a configuration without interpreting it yet). You might consider to change this line to Instrumentation instrumentation.Config).
urso
reviewed
Jun 12, 2020
| // Instrumentation is an interface that can return an APM tracer a net.listener | ||
| type Instrumentation interface { | ||
| Tracer() *apm.Tracer | ||
| Listener() net.Listener |
There was a problem hiding this comment.
I'm curious, but why do we need the Listener here? Is it still for apm-server itself, or is it some general requirement? I didn't see the listener used.
There was a problem hiding this comment.
Yes, it is for apm-server: we need to create an adhoc tracing server so it doesn't send traces to itself infinitely. Possibly this can be useful for the Elastic Agent too.
urso
approved these changes
Jun 15, 2020
jalvz
added a commit
to jalvz/beats
that referenced
this pull request
Jun 25, 2020
This includes an instrumentation namespace at the top of all beat config files. The tracer is exposed trough the Beat object.
jalvz
added a commit
that referenced
this pull request
Jun 26, 2020
melchiormoulin
pushed a commit
to melchiormoulin/beats
that referenced
this pull request
Oct 14, 2020
This includes an instrumentation namespace at the top of all beat config files. The tracer is exposed trough the Beat object.
leweafan
pushed a commit
to leweafan/beats
that referenced
this pull request
Apr 28, 2023
This includes an instrumentation namespace at the top of all beat config files. The tracer is exposed trough the Beat object.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This adds configuration for the APM tracer, and sets it on the
Beatobject so that every Beat can use it.Libbeat is responsible for correct initialization and closing.
A top level
instrumentationconfig option is added tolibbeat.yml/reference.ymlto set it up, disabled by default.Why is it important?
Dogfooding!
Checklist
CHANGELOG.next.asciidocorCHANGELOG-developer.next.asciidoc.How to test this PR locally
Run any beat with configuration enabled and disabled, alongside with APM Server, Elasticsearch and Kibana. Observe
outputtransactions (or lack thereof when disabled) in the Kibana APM tab, coming from the libbeat publisher.Related issues
Closes #18360
An APM Server PR showing how to use the tracer from the Beat is coming up soon.