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] Fleet: APM Integration settings (fleet editor) redesign #91412

Closed
simitt opened this issue Feb 15, 2021 · 7 comments · Fixed by #106535
Closed

[APM] Fleet: APM Integration settings (fleet editor) redesign #91412

simitt opened this issue Feb 15, 2021 · 7 comments · Fixed by #106535
Assignees
Labels
apm:fleet enhancement New value added to drive a business result Team:APM All issues that need APM UI Team support v7.15.0

Comments

@simitt
Copy link
Contributor

simitt commented Feb 15, 2021

Design issue: https://github.com/elastic/observability-design/issues/29

Add an editor for configuring APM Server options when installed as Elastic Agent integration and configured in Fleet.

Only a handful of APM settings can be configured in the experimental APM Server package for Agent/Fleet Integration. elastic/apm-server#4690 introduces a few more options, where having dedicated setting groups would be more user friendly; e.g. grouping together RUM config options or security related config options. More options to follow throughout the journey of becoming an Elastic Agent Integration.

Also in scope (in alignment with the design issue):

  • APM Agent manual installation instructions
  • Java agent runtime attachment UI

Fleet UI allows for custom extensions. @kevinlog and @paul-tavares were working on a nice custom policy editor for the Elastic Endpoint Integration, which might be used as reference implementation.

More APM Server config options will follow; in case all options need to be known for the design, we can list the options here.

Screenshots

Current APM Server Integration UI Screenshot 2021-02-15 at 15 37 23
Elastic Endpoint Editor Screenshot 2021-02-15 at 15 53 37

Solution

As described in https://github.com/elastic/observability-design/issues/29, the redesign of the integrations settings page will consist of relevant groups for the configuration of the server. This design is meant as a display pattern rather than a 1-1 ordering of the fields and the content will need additional texts for certain group descriptions. This will come in a later iteration.

03b Fleet - APM integration - Settings (default)

  • Each group is displayed in a panel with a panel header including a title and description. The contents will be displayed as described forms. We'll determine the shown options vs. hiding the uncommon options in "Advanced options" accordion. This will make the default setup much easier to digest when adding the integration initially.

  • Options for enabling features such as RUM and TLS will determine the required/optional state of the inputs in the group form. E.g. enabling TLS will show invalid until the required fields are filled.

  • Frozen flags (read-only configurations due to Cloud-managed Fleet) will show a prepend label with a lock icon and the input itself as read-only.

View full unfolded page

03b Fleet - APM integration - Settings (all open)

@simitt simitt added Team:APM All issues that need APM UI Team support enhancement New value added to drive a business result needs design labels Feb 15, 2021
@elasticmachine
Copy link
Contributor

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

@simitt simitt changed the title [APM][Fleet] Add APM configuration editor [APM][Fleet] Add APM Server configuration editor Feb 15, 2021
@graphaelli graphaelli added v7.14.0 and removed v7.13.0 labels Mar 1, 2021
@graphaelli
Copy link
Member

This will be good to have but considering it an unlikely stretch goal for 7.13.

@graphaelli
Copy link
Member

@formgeist - @jalvz can provide requirements for design

@jalvz
Copy link
Contributor

jalvz commented Mar 4, 2021

We will also have some settings to configure the Java agent attacher (elastic/apm-server#4830, elastic/apm-server#4829), which will probably need a clear visual distinction, too.

@felixbarny
Copy link
Member

felixbarny commented Mar 5, 2021

For other agents, we'd also want to show manual installation instructions. See also #88822 and #93420 (comment) #89989.
I agree that a design phase makes a lot of sense. Do we already have a design issue for 7.13 for this? I'm happy to collaborate on that.

@sorenlouv sorenlouv changed the title [APM][Fleet] Add APM Server configuration editor [APM] Fleet: Add APM Server configuration editor Mar 5, 2021
@formgeist
Copy link
Contributor

@felixbarny and others; I've opened a separate design issue to track the design process for the new configuration view https://github.com/elastic/observability-design/issues/29 - feel free to add additional specifications in there.

@sorenlouv sorenlouv added v7.15.0 and removed v7.14.0 labels May 26, 2021
@formgeist formgeist changed the title [APM] Fleet: Add APM Server configuration editor [APM] Fleet: APM Integration settings redesign Jul 1, 2021
@formgeist formgeist assigned formgeist and unassigned formgeist Jul 1, 2021
@formgeist
Copy link
Contributor

Updated the description with the proposed settings redesign. This should give enough guidance for the initial implementation and we can iron out the details later on. cc @sqren @simitt

@sorenlouv sorenlouv changed the title [APM] Fleet: APM Integration settings redesign [APM] Fleet: APM Integration settings (fleet editor) redesign Jul 8, 2021
@cauemarcondes cauemarcondes self-assigned this Jul 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
apm:fleet enhancement New value added to drive a business result Team:APM All issues that need APM UI Team support v7.15.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

8 participants