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

Add docs about the Hosts metrics tab to serverless #3955

Merged
merged 2 commits into from
Jun 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/en/serverless/images/anomalies-overlay.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/en/serverless/images/hosts-open-in-lens.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/en/serverless/images/logs-overlay.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/en/serverless/images/metadata-overlay.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/en/serverless/images/metrics-overlay.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 10 additions & 10 deletions docs/en/serverless/infra-monitoring/analyze-hosts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ Need help getting started? Follow the steps in
The **Hosts** page provides several ways to view host metrics:

* Overview tiles show the number of hosts returned by your search plus
averages of key metrics, including CPU usage, memory usage, and throughput.
averages of key metrics, including CPU usage, normalized load, and memory usage.
Max disk usage is also shown.

* The Host limit controls the maximum number of hosts shown on the page. The
default is 50, which means the page shows data for the top 50 hosts based on the
Expand All @@ -56,8 +57,7 @@ The **Hosts** page provides several ways to view host metrics:
or change the number of rows displayed on each page to see all of your hosts.

* Each host name is an active link to a <DocLink id="serverlessObservabilityAnalyzeHosts" section="view-host-details" text="host details" /> page,
which includes metrics, host metadata, alerts, processes, logs, and anomalies.
You can optionally open the host details in an overlay.
where you can explore enhanced metrics and other observability data related to the selected host.

* Table columns are sortable, but note that the sorting behavior is applied to
the already returned data set.
Expand Down Expand Up @@ -109,13 +109,14 @@ page:

## View metrics

On the **Metrics** tab of the **Hosts** page, view metrics trending over time, including normalized load,
CPU usage, memory usage, network inbound, network outbound, disk read IOPS, and
disk write IOPS. Place your cursor over a line to view metrics at a specific
point in time.
On the **Metrics** tab, view metrics trending over time, including CPU usage,
normalized load, memory usage, disk usage, and other metrics related to disk IOPs and throughput.
Place your cursor over a line to view metrics at a specific
point in time. From within each visualization, you can choose to open the visualization in Lens.

To see metrics for a specific host, refer to <DocLink id="serverlessObservabilityAnalyzeHosts" section="view-host-details" text="View host details"/>.

{/* TODO: Uncomment this section if/when the inspect option feature is added back in.
<div id="inspect-metrics"></div>

### Inspect and download metrics
Expand All @@ -134,7 +135,7 @@ file.

Click **View: Data** and notice that you can change the view to **Requests** to explore the request
used to fetch the data and the response returned from ((es)). On the **Request** tab, click links
to further inspect and analyze the request in the Dev Console or Search Profiler.
to further inspect and analyze the request in the Dev Console or Search Profiler. */}

<div id="analyze-hosts-open-in-lens"></div>

Expand Down Expand Up @@ -212,8 +213,7 @@ The host details overlay contains the following tabs:
<HostDetails />

<DocCallOut title="Note">
These metrics are also available when viewing hosts on the **Inventory**
page.
The metrics shown on the **Hosts** page are also available when viewing hosts on the **Inventory** page.
</DocCallOut>

<div id="analyze-hosts-why-dashed-lines"></div>
Expand Down
39 changes: 25 additions & 14 deletions docs/en/serverless/transclusion/host-details.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,43 @@

<DocAccordion buttonContent="Overview">

![Host metrics](../images/metrics-overlay.png)

The **Overview** tab displays metrics about the selected host, including CPU usage,
normalized load, memory usage, disk usage, network traffic, and the log rate.
The **Overview** tab displays key metrics about the selected host, such as CPU usage,
normalized load, memory usage, and max disk usage.

Change the time range to view metrics over a specific period of time.

Expand each section to view more detail related to the selected host, such as metadata,
active alerts, services detected on the host, and metrics.

Hover over a specific time period on a chart to compare the various metrics at that given time.

Expand the **Alerts** section to see alerts related to the selected host.
Click **Show all** to drill down into related data.

![Host overview](../images/overview-overlay.png)

</DocAccordion>

<DocAccordion buttonContent="Metadata">

![Host metadata](../images/metadata-overlay.png)

The **Metadata** tab lists all the meta information relating to the host,
including host, cloud, and agent information.

This information can help when investigating events—for example,
when filtering by operating system or architecture.

![Host metadata](../images/metadata-overlay.png)

</DocAccordion>

<DocAccordion buttonContent="Processes">
<DocAccordion buttonContent="Metrics">

![Host processes](../images/processes-overlay.png)
The **Metrics** tab shows host metrics organized by type and is more complete than the view available in the *Overview* tab.

![Metrics](../images/metrics-overlay.png)

</DocAccordion>

<DocAccordion buttonContent="Processes">

The **Processes** tab lists the total number of processes (`system.process.summary.total`) running on the host,
along with the total number of processes in these various states:
Expand All @@ -55,12 +64,12 @@ The number of top processes is controlled by `process.include_top_n.by_cpu` and
| **Memory** | The percentage of memory (`system.process.memory.rss.pct`) the process occupied in main memory (RAM). |
| **State** | The current state of the process and the total number of processes (`system.process.state`). Expected values are: `running`, `sleeping`, `dead`, `stopped`, `idle`, `zombie`, and `unknown`. |

![Host processes](../images/processes-overlay.png)

</DocAccordion>

<DocAccordion buttonContent="Logs">

![Host logs](../images/logs-overlay.png)

The **Logs** tab displays logs relating to the host that you have selected. By default, the logs tab displays the following columns.

| | |
Expand All @@ -70,13 +79,13 @@ The **Logs** tab displays logs relating to the host that you have selected. By d

To view the logs in the ((logs-app)) for a detailed analysis, click **Open in Logs**.

![Host logs](../images/logs-overlay.png)

</DocAccordion>

<DocAccordion buttonContent="Anomalies">

![Anomalies](../images/anomalies-overlay.png)

The **Anomalies** table displays a list of each single metric ((anomaly-detect)) job for the specific host. By default, anomaly
The **Anomalies** tab displays a list of each single metric ((anomaly-detect)) job for the specific host. By default, anomaly
jobs are sorted by time, showing the most recent jobs first.

Along with the name of each anomaly job, detected anomalies with a severity score equal to 50 or higher are listed. These
Expand All @@ -86,6 +95,8 @@ the actual value and the expected ("typical") value of the host metric in the an
To drill down and analyze the metric anomaly, select **Actions** → **Open in Anomaly Explorer**.
You can also select **Actions** → **Show in Inventory** to view the host Inventory page, filtered by the specific metric.

![Anomalies](../images/anomalies-overlay.png)

</DocAccordion>

{/* TODO: Find out if OSQuery tab will be included in serverless. It does not currently appear in serverless builds */}
Expand Down
Loading