-
Notifications
You must be signed in to change notification settings - Fork 175
[apm] Improve instructions for monitoring APM on premise #4749
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
base: 8.x
Are you sure you want to change the base?
Conversation
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
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.
✨
IMO the title The title should be: What do you think @lucabelluccini and @colleenmcginnis ? @colleenmcginnis , I hope this comment doesn't feel off-topic (I tend to add too many off-topic comments :-D ), as I think it's related with the original issue. |
*Only use this option if you have _not_ yet enrolled {agent}.* | ||
If you edit and re-enroll {agent}, you will likely lose the state of the agent. | ||
|
||
If you have already enrolled the {agent}, consider using the Fleet UI to change the agent's HTTP monitoring endpoint |
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.
Ideally we would have:
- For versions pre 8.15 we have to say:
*This procedure works only if you've _not_ yet enrolled {agent}.*
If you've already enrolled {agent}, you'll need to re-enroll {agent} and you'll lose the state of the agent.
- For version 8.15 and more recent
Use the Fleet UI to change the agent's HTTP monitoring endpoint using {fleet-guide}/agent-policy.html#advanced-agent-monitoring-settings[Advanced agent monitoring settings].
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.
Also, I would invite a developer / engineer to test this flow if possible.
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.
@simitt is someone from your team available to take a look at this recommendation?
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.
@raultorrecilla know better about the team's availability.
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.
Hello, I've taken the time to test this and it works. I'm leaving a comment below for a catch...
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.
I've left a comment.
This comment was marked as outdated.
This comment was marked as outdated.
85d485a
to
8f2485b
Compare
@@ -86,8 +95,6 @@ When complete, your `modules.d/beat-xpack.yml` file should look similar to this: | |||
period: 10s | |||
hosts: ["http://localhost:6791"] | |||
basepath: "/processes/apm-server-default" |
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.
This is actually not true...
The basepath
has to match the component
ID of the APM Integration.
For example, if ones creates an APM Integration policy and its ID is 7b12d130-018d-4fa8-908b-80a677e7cfce
, then the basepath
has to be set to basepath: "/processes/apm-7b12d130-018d-4fa8-908b-80a677e7cfce
.
How to tell a user how to get the component ID? I do not know the fastest solution, but it might be:
- Go to Fleet UI
- Go to the Elastic Agent policy which contains the APM Package Integration policy
- Go in Actions / View Policy
- Search for the
id
of the integrationapm
- Use the
id
, prefixing it withapm-
Or... from command line...
elastic-agent status --output full | grep apm
Will show up:
├─ apm-7b12d130-018d-4fa8-908b-80a677e7cfce <------ this one
│ ├─ apm-7b12d130-018d-4fa8-908b-80a677e7cfce
│ └─ apm-7b12d130-018d-4fa8-908b-80a677e7cfce-1720f832-262b-43fa-a3fd-0629bcb3d530
The only situation the APM Integration has apm-server-default
is when the integration is created via kibana.yml
and the ID is provided by the user, which is quite rare.
I've reserved some time to work on this and try it out. I've left some comments.... |
Description
@lucabelluccini shared a few ways we could improve the instructions for monitoring APM on premise:
username
andpassword
from the samplemodules.d/beat-xpack.yml
.Documentation sets edited in this PR
Check all that apply.
docs/en/observability/*
)docs/en/serverless/*
)docs/en/integrations/*
)Related issue
Closes #4726
Checklist
Follow-up tasks
Select one.