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

[Request]: 'Missing Field' explanation for Host documentation #4091

Closed
1 task done
roshan-elastic opened this issue Jul 24, 2024 · 0 comments · Fixed by #4183
Closed
1 task done

[Request]: 'Missing Field' explanation for Host documentation #4091

roshan-elastic opened this issue Jul 24, 2024 · 0 comments · Fixed by #4183
Assignees

Comments

@roshan-elastic
Copy link
Contributor

roshan-elastic commented Jul 24, 2024

Description

We're going to be update the 'missing field' UX that shows in lens when a field is missing from the index to be less 'harsh' ('error') and be softer ('information') due to complaints from users that the experience seems 'broken' when it's not:

'Scary' error message
image

Our solution will present something much softer like this:

Softer messages are more appropriate in the context of Hosts
image

As part of this, we're going to be linking through to Host-specific documentation to explain what missing fields means and why it could happen (via the 'learn more' link).

Resources

Here is the issue:

The documentation should explain the main use cases why fields may be missing:

1. The chart refers to a field which is not relevant to the hosts they are observing
This is probably the most common issue. Specifically, if you are only observing windows hosts, 'load' is not collected at all (because 'load' is not a windows concept at all). We should use the load metric not being collected for windows as being a common example of why the fields are missing.

2. They may not be collecting metrics as we recommend
This could be because either:

  • The system integration is not installed
  • They aren't collecting metrics through OpenTelemetry (OTel metrics are not automatically mapped to ECS so these should now work)

Note : By the time this documentation goes out, the infrastructure onboarding journey will be updated to include the simplest options for onboarding hosts - I'm not sure if you can allude to this or not in the docs...it might become to hard to maintain this

3. They have explicitly chosen not to send these metrics
Some customers choose to limit the metrics emitted to Elastic to save on space/improve cluster performance. For example, the systems integration has options to easily choose which metrics you wish to emit:

image

Which documentation set does this change impact?

Stateful and Serverless

Feature differences

Identical for stateful/serverless

What release is this request related to?

8.16 (but we aim to have this deployed in serverless by 26th August so would like this live for at least serverless by then)

Collaboration model

The documentation team

Point of contact.

Main contact: @roshan-elastic

Stakeholders: @crespocarlos

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants