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

[APM] Getting started: Change logic to check whether APM Server was setup when running under fleet #86462

Closed
simitt opened this issue Dec 18, 2020 · 8 comments
Labels
apm:fleet Team:APM All issues that need APM UI Team support v7.14.0

Comments

@simitt
Copy link
Contributor

simitt commented Dec 18, 2020

Description
When APM Server is started with the new indexing strategy (apm-server.data_streams.enabled=true) it does not write an onboarding document. The whole APM Setup process moves to Kibana and Fleet and therefore Fleet Status should be used to check whether the APM Integration (including the APM Server) is properly setup.

Required Action
Remove the button to check whether APM Server was setup in the Fleet install section (described in #88659), but explain to users how to check if the APM Server is running under Fleet.
We should give a short desription and link to the Quick Start guide, which will include the APM quickstart.
Details in #86462 (comment)

@simitt simitt added the Team:APM All issues that need APM UI Team support label Dec 18, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/apm-ui (Team:apm)

@ruflin
Copy link
Contributor

ruflin commented Dec 18, 2020

If I remember correctly, the apm-server doc was written as soon as the first time the apm-server was set up. It was basically to indicate to the user, that he has a working apm-server. So in the new scenario, this means having at least 1 policy with an apm integration inside that was successfully deployed. @nchaulet Do we have an API endpoint for this?

If we check for the above, the behaviour will slightly change. So if the user did the setup and then stops apm-server again, it will show in the APM UI again that there is no apm-server and tells him to go to Fleet UI to set it up. We can go even further to tell users, he doesn't have an Elastic Agent enrolled yet and should go fleet.

For some time, there is a hybrid approach needed, because it might be that the standalone apm-server is used.

An, there is also the option, that Elastic Agent with apm-server is standalone and does not have the permission to write the doc. What are we doing in this scenario?

@simitt
Copy link
Contributor Author

simitt commented Dec 18, 2020

Elastic Agent with apm-server is standalone

We only plan to support APM Server via Elastic Agent in fleet modus, so we don't have to take precautions for that.

@simitt
Copy link
Contributor Author

simitt commented Dec 21, 2020

My comment from above was not quite right, rephrasing with a cite from the APM Server 8.0 vision doc:

As with any Elastic Agent integration, it is technically possible to run with Fleet or standalone. Fleet mode is required in order to install APM-specific templates and other package artifacts, as well as to support features such as central configuration and server status.

@sorenlouv
Copy link
Member

Moving this to 7.13

@sorenlouv sorenlouv changed the title [APM][Elastic Agent] Change logic to check whether APM Server was setup [APM] Getting started: Change logic to check whether APM Server was setup when running under fleet Feb 23, 2021
@sorenlouv
Copy link
Member

This might not be needed. @simitt will close or clarify if it's still needed.

@simitt
Copy link
Contributor Author

simitt commented Mar 9, 2021

Remove the button to check whether APM Server was setup in the Fleet install section (described in #88659), but explain to users how to check if the APM Server is running under Fleet.
We should give a short desription and link to the Quick Start guide, which will include the APM quickstart.

Here is how you can familiarize yourself with the steps involved:

(1) Navigate to Fleet UI and check for the policy that should be used (if user has not yet set up an Elastic Agent, they will only see the default policies)
Screenshot 2021-03-09 at 16 54 09

(2) Check whether APM integration is added to the desired policy, if not add it

Screenshot 2021-03-09 at 16 54 14

Screenshot 2021-03-09 at 16 54 20

(3) Enroll an Elastic Agent to the desired policy, which will then run the APM Server
Screenshot 2021-03-09 at 16 54 29

@simitt simitt removed their assignment Mar 9, 2021
@sorenlouv
Copy link
Member

Replaced by #100672

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
apm:fleet Team:APM All issues that need APM UI Team support v7.14.0
Projects
None yet
Development

No branches or pull requests

6 participants