[Docs] Adds docs on how to run Kibana with the APM agent locally #84700
Conversation
TinaHeiligers
added
v8.0.0
release_note:skip
|
@vigneshshanmugam I was asked to ping you for a review from the APM team. |
|
@elasticmachine merge upstream |
TinaHeiligers
force-pushed
the
running-kibana-with-apm
branch
from
96a995a
to
61f04ee
Compare
| [[running-kibana-with-apm]] | ||
| == Running Kibana with the APM Agent Locally | ||
|
|
||
| The easiest and recommended way of running Kibana with the APM agent locally is to use the solution provided by the https://github.com/elastic/apm-integration-testing[apm-integration-testing] repo. You’ll need https://www.docker.com/community-edition[Docker] and https://docs.docker.com/compose/install/[Docker Compose] to use the tool. |
There was a problem hiding this comment.
I think it would be worth adding a paragraph here about why a developer would want to do this with examples of the types of information that can be captured with the APM agent currently.
There was a problem hiding this comment.
@TinaHeiligers Looks good to me, But do you think its worth merging this section with already available debugging doc
Co-authored-by: Vignesh Shanmugam <vignesh.shanmugam22@gmail.com>
| UI in {kib}. | ||
|
|
||
| If you want to run kibana with a local instance of the APM agent, refer to <<running-kibana-with-apm>>. |
There was a problem hiding this comment.
Comment to reviewers: I've linked to the documentation on how to run Kibana with a local APM agent here.
| ---- | ||
| module.exports = { | ||
| active: true, | ||
| serverUrl: 'http://127.0.0.1:8200', // use `http://localhost:8200` as an alternative |
There was a problem hiding this comment.
Comment to reviewers: using http://127.0.0.1:8200 doesn't work for me, but localhost does. The apm-agent-node team is aware of this and working to find the cause.
Co-authored-by: Vignesh Shanmugam <vignesh.shanmugam22@gmail.com>
| All config options can be set by | ||
| creating an appropriate config file under `config/apm.dev.js`. |
There was a problem hiding this comment.
Should we document that it is also possible to configure the agent via kibana.yml?
There was a problem hiding this comment.
@pgayvallet we can add that later, once we're ok with enabling in prod.
There was a problem hiding this comment.
Bump: did we ever document this (and is it possible)? Asking because I want to add the apm settings to the allow list on cloud, to make it possible for anyone to enable apm instrumentation without involving cloud folks.
Resolves #83045
Summary
Adds a section to the CONTRIBUTING docs on how to run Kibana locally with the APM agent.
Checklist
Delete any items that are not applicable to this PR.
For maintainers