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]: Update CPU and Network metrics in docs #4079

Closed
2 tasks done
Tracked by #188641 ...
roshan-elastic opened this issue Jul 18, 2024 · 0 comments · Fixed by #4386
Closed
2 tasks done
Tracked by #188641 ...

[Request]: Update CPU and Network metrics in docs #4079

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

Comments

@roshan-elastic
Copy link
Contributor

roshan-elastic commented Jul 18, 2024

Description

We are going to be updating the metric definitions for three existing metrics in Inventory and Hosts:

CPU Usage
Network Inbound
Network Outbound

These are defined as 'inventory' metrics for Hosts and is commonly leveraged by both Inventory and Inventory alerting rules:

In Inventory
image

In Inventory Rules
image

Additionally, the Hosts UI has these metrics definitions defined too (but they are not defined in the same place in the code):

image

To avoid affecting existing rules customers already have, instead of changing the actual metric definitions - we'll create new metrics and refer to the old ones as 'legacy':

For example, for the new 'CPU usage' metric definition we will:

  • Update the Hosts UI to use this new one instead of the old one (we'll change the tooltips as well)
  • Update the Inventory & inventory alerts to refer to the existing 'CPU usage' metrics as 'CPU Usage (legacy)'
  • Add a new metric to Inventory and Inventory alerts called 'CPU Usage' which uses the new definition

Note Do you think we could have a heading in there somewhere that talks about 'legacy' metrics that we can link to from the UI? We'd like to be able to refer to this from the UI

image

Resources

Related Issues:

Definitions:

"CPU Usage" (new)
"CPU Usage (legacy)"

"Network Inbound (RX)" (new)
"Network Inbound (RX) (Legacy)"

"Network Outbound (TX)" (new)
"Network Outbound (TX) (Legacy)"

Which documentation set does this change impact?

Stateful and Serverless

Feature differences

None

What release is this request related to?

8.16 (but sooner on serverless - TBC)

Collaboration model

The documentation team

Point of contact.

Main contact: @roshan-elastic

Stakeholders: @crespocarlos (coordinate with him on release dates)

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