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

[Integrations] Improve message re: viewing all Elastic Agent Ingegrations #115436

Closed
gchaps opened this issue Oct 18, 2021 · 6 comments
Closed

[Integrations] Improve message re: viewing all Elastic Agent Ingegrations #115436

gchaps opened this issue Oct 18, 2021 · 6 comments
Assignees
Labels
bug Fixes for quality problems that affect the customer experience Feature:Unified Integrations Unified Integrations view feature Team:Fleet Team label for Observability Data Collection Fleet team v7.16.0 v8.0.0

Comments

@gchaps
Copy link
Contributor

gchaps commented Oct 18, 2021

This message has a typo and capitalization errors.

Screen Shot 2021-10-15 at 11 14 19 AM

Edits:

  • Elastic Agent integrations > Elastic Agent integrations (lower case i)
  • Not all integrations are displayed > suggest removing this sentence because it repeats the title
  • Or add and > or add an
  • To see full list > to view the complete list
  • Add ending period after the second sentence

The text will then look like this

Update your package registry to view all Elastic Agent integrations
Update your package registry to set the EPR proxy, or add an on-prem offline EPR to view the full list of integrations.

cc @dedemorton to review the context of the message. Should EPR be spelled out?

@gchaps gchaps added bug Fixes for quality problems that affect the customer experience v8.0.0 Team:Fleet Team label for Observability Data Collection Fleet team v7.16.0 Feature:Unified Integrations Unified Integrations view feature labels Oct 18, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/fleet (Team:Fleet)

@thomasneirynck thomasneirynck self-assigned this Oct 18, 2021
@snide snide self-assigned this Oct 18, 2021
@thomasneirynck thomasneirynck removed their assignment Oct 18, 2021
@dedemorton
Copy link
Contributor

I mentioned to Gail that I'm missing some context here. When and why does this message appear? Does it appear when Kibana is unable to access the package registry? When that happens, does Kibana only show integrations that are installed by default? Are there other reasons why this message might be displayed?

I think more context would be useful to users so they know which link to follow.

I assume you're describing problems users might encounter when using a proxy server or running the stack in an air gapped environment (as described here).

If that's the case, the language in the message should match the documentation (or vice versa). I'm also wondering whether the docs for air gapped environments need to be moved to the main guide (rather than the dev guide) because they seem a little buried there.

One other thing..."update your package registry" seems a little vague and could be misinterpreted to mean update the packages. It sounds like you have two options, set the proxy URL in the Kibana config, or host your own Elastic Package Registry. Neither of those tasks seems to fall under "updating the package registry" in my mind.

Sorry for all the speculation but it's really hard to see a message out of context and provide meaningful feedback. If feels to me like this message needs more than a simple copy edit. If you can provide a revision, I'll be happy to review it.

@mostlyjason
Copy link
Contributor

This message is displayed when Kibana is unable to access the Elastic Package Registry, most commonly at epr.elastic.co. When that happens it only shows the integrations that are bundled with Kibana. The most common time this happens is when users run Kibana in an environment without public internet access or in an air gapped environment. The package registry may not contain the complete list if the user has chosen to remove some. Also, some Elastic Agent integrations may be bundled with Kibana in the future.

Here is an updated version:

Update your package registry setting to view more integrations
Kibana cannot reach the Elastic Package Registry (EPR), which provides Elastic Agent integrations. To see them, please set the URL for a registry proxy or an on-prem registry.

@akshay-saraswat can you confirm we are naming these components correctly? Also CCing you on Dede's comment to relocate the docs.

@gchaps
Copy link
Contributor Author

gchaps commented Oct 19, 2021

Thanks, Jason. @dedemorton and I chatted and really like this new version. I've edited the text to follow EUI writing guidelines and remove EPR since it doesn't appear elsewhere in the message:

Update your package registry setting to view more integrations
Kibana cannot reach the Elastic Package Registry, which provides Elastic Agent integrations. To view these integrations, set the URL for a registry proxy or an on-prem registry.

@thomasneirynck thomasneirynck self-assigned this Oct 19, 2021
@thomasneirynck
Copy link
Contributor

To close the loop: this is blocked until a fix for #115564 is merged. I am working on this now.

@thomasneirynck thomasneirynck removed their assignment Nov 4, 2021
@thomasneirynck
Copy link
Contributor

Closing, dupe of #115564

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixes for quality problems that affect the customer experience Feature:Unified Integrations Unified Integrations view feature Team:Fleet Team label for Observability Data Collection Fleet team v7.16.0 v8.0.0
Projects
None yet
Development

No branches or pull requests

6 participants