-
Notifications
You must be signed in to change notification settings - Fork 159
[Observability] Add docs on schema selection for host data #2707
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
Conversation
@roshan-elastic I've started a draft here for the schema selector docs so we can iterate on what we need. Previews are in the comment above titled Preview links for changed docs. Let me know what you think about the updates, and if we need to change anything or add additional information anywhere. I still need to update the metrics reference page, is there a PR or documentation I can look at that has the metric definitions that need to be added? |
solutions/observability/incident-management/create-an-inventory-rule.md
Outdated
Show resolved
Hide resolved
solutions/observability/infra-and-hosts/detect-metric-anomalies.md
Outdated
Show resolved
Hide resolved
@mdbirnstiehl - One thing we're doing is rendering the host view based on it schema. For example, if it's an OTel host:
In short, I'm thinking we should update the docs to reflect this: Thoughts
*We'll need to be able to refer to an 'OpenTelemetry' #heading within the Hosts section of the metrics reference so that we can point users here directly from the UI (I have a short-link of https://ela.st/docs-infra-host-metrics-otel that I can point towards the docs) |
Hosts in Infra Inventory FYI it uses the same schema selector and behaves in the same way as hosts. We'll be adding a link from this selector to the docs to explain how it works (if we wanted to simplify the docs we could possibly just refer to the schema selector in the host docs from the inventory docs for more info?) FYI - there's a possibility we remove schema selection from the infra inventory in a follow up issue but we haven't decided yet. Any work we do in these infra inventory docs should probably be minimal. |
FYI - @mdbirnstiehl - I have a build available that you can test - I'll DM you |
@roshan-elastic I've added the following:
|
Hey @mdbirnstiehl
Looks perfect for Hosts. I think we just need to update the inventory one too but it might be worth just removing that and linking through to the same content in the hosts (your call).
Looks good!
Yeah, that looks good.
Looks good!
Yeah I think something like should work. I think OpenTelemetry should probably be a higher-level heading as there will be all the same kinds of metrics underneath it (e.g. CPU, disk, memory etc).
I've updated the doc so you can make the changes now - thanks! |
Got it, makes sense after seeing the updated doc. I'll work on that today. |
@roshan-elastic I've update the host metrics page, and added the notes to the Infrastructure Inventory regard anomalies and processes. One last thing to verify, the OTel formulas are only relevant for stack from 9.2 forward, correct? |
Awesome @mdbirnstiehl.
That will be the next major release they go into yes. They will likely go out in serverless before then though - I can let you know when it's merged into |
Hey @mdbirnstiehl, FYI we'll be imminently merging the Hosts schema work into Feel free to merge in your work any time. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a few minor comments. Otherwise, lgtm!
reference/data-analysis/observability/observability-host-metrics.md
Outdated
Show resolved
Hide resolved
If you haven’t added data yet, click **Add data** to search for and install an Elastic integration. | ||
|
||
Need help getting started? Follow the steps in [Get started with system metrics](/solutions/observability/infra-and-hosts/get-started-with-system-metrics.md). | ||
If you haven’t added data yet, click **Add data → Host** and select how you want to monitor your host—OpenTelemetry or Elastic Agent. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if you need to add the {applies_to}
tag here. Flagging in case you do.
If you haven’t added data yet, click **Add data → Host** and select how you want to monitor your host—OpenTelemetry or Elastic Agent. | |
`{applies_to}`{stack: "ga 9.2", serverless: "ga"}` | |
If you haven’t added data yet, click **Add data → Host** and select how you want to monitor your host—OpenTelemetry or Elastic Agent. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Add data steps and OTel option did exist in 9.0, but this integration language was out of date. OTel data has been available, it's just the schema selection that is new.
solutions/observability/infra-and-hosts/view-infrastructure-metrics-by-resource-type.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
This PR closes #2084