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.

Sign up for GitHub

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

Jump to bottom

Update metrics and add legacy section #4386

Merged
merged 1 commit into from
Oct 18, 2024
Merged

Update metrics and add legacy section #4386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 38 additions & 6 deletions docs/en/observability/monitor-infra/host-metrics.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Learn about key host metrics displayed in the {infrastructure-app}:
* <<key-metrics-log,Log>>
* <<key-metrics-network,Network>>
* <<key-metrics-network,Disk>>
* <<legacy-metrics,Legacy metrics>>


[discrete]
Expand All @@ -34,11 +35,11 @@ Learn about key host metrics displayed in the {infrastructure-app}:
|===
| Metric | Description

| **CPU Usage (%)** | Percentage of CPU time spent in states other than Idle and IOWait, normalized by the number of CPU cores. This includes both time spent on user space and kernel space.
| **CPU Usage (%)** | Average of percentage of CPU time spent in states other than Idle and IOWait, normalized by the number of CPU cores. Includes both time spent on user space and kernel space. 100% means all CPUs of the host are busy.

100% means all CPUs of the host are busy.
**Field Calculation**: `average(system.cpu.total.norm.pct)`

**Field Calculation:** `(average(system.cpu.user.pct) + average(system.cpu.system.pct)) / max(system.cpu.cores)`
For legacy metric calculations, refer to <<legacy-metrics>>.

| **CPU Usage - iowait (%)** | The percentage of CPU time spent in wait (on disk).

Expand Down Expand Up @@ -159,12 +160,15 @@ A high level indicates a situation of memory saturation for the host. For exampl

| **Network Inbound (RX)** | Number of bytes that have been received per second on the public interfaces of the hosts.

**Field Calculation:** `average(host.network.ingress.bytes) * 8 / (max(metricset.period, kql='host.network.ingress.bytes: *') / 1000)`
**Field Calculation**: `sum(host.network.ingress.bytes) * 8 / 1000`

| **Network Inbound (TX)** | Number of bytes that have been sent per second on the public interfaces of the hosts.
For legacy metric calculations, refer to <<legacy-metrics>>.

**Field Calculation:** `average(host.network.egress.bytes) * 8 / (max(metricset.period, kql='host.network.egress.bytes: *') / 1000)`
| **Network Outbound (TX)** | Number of bytes that have been sent per second on the public interfaces of the hosts.

**Field Calculation**: `sum(host.network.egress.bytes) * 8 / 1000`

For legacy metric calculations, refer to <<legacy-metrics>>.
|===

[discrete]
Expand Down Expand Up @@ -204,3 +208,31 @@ A high level indicates a situation of memory saturation for the host. For exampl
**Field Calculation:** `counter_rate(max(system.diskio.write.bytes), kql='system.diskio.write.bytes: *')`

|===

[discrete]
[[legacy-metrics]]
== Legacy metrics

Over time, we may change the formula used to calculate a specific metric.
To avoid affecting your existing rules, instead of changing the actual metric definition,
we create a new metric and refer to the old one as "legacy."

The UI and any new rules you create will use the new metric definition.
However, any alerts that use the old definition will refer to the metric as "legacy."

[options="header"]
|===
| Metric | Description

| **CPU Usage (legacy)** | Percentage of CPU time spent in states other than Idle and IOWait, normalized by the number of CPU cores. This includes both time spent on user space and kernel space. 100% means all CPUs of the host are busy.

**Field Calculation:** `(average(system.cpu.user.pct) + average(system.cpu.system.pct)) / max(system.cpu.cores)`

| **Network Inbound (RX) (legacy)** | Number of bytes that have been received per second on the public interfaces of the hosts.

**Field Calculation:** `average(host.network.ingress.bytes) * 8 / (max(metricset.period, kql='host.network.ingress.bytes: *') / 1000)`

| **Network Outbound (TX) (legacy)** | Number of bytes that have been sent per second on the public interfaces of the hosts.

**Field Calculation:** `average(host.network.egress.bytes) * 8 / (max(metricset.period, kql='host.network.egress.bytes: *') / 1000)`
|===
97 changes: 75 additions & 22 deletions docs/en/serverless/infra-monitoring/host-metrics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Learn about key host metrics displayed in the Infrastructure UI:
* <DocLink slug="/serverless/observability/host-metrics" section="log-metrics">Log</DocLink>
* <DocLink slug="/serverless/observability/host-metrics" section="network-metrics">Network</DocLink>
* <DocLink slug="/serverless/observability/host-metrics" section="network-metrics">Disk</DocLink>
* <DocLink slug="/serverless/observability/host-metrics" section="legacy-metrics">Legacy</DocLink>

<div id="key-metrics-hosts"></div>

Expand Down Expand Up @@ -57,68 +58,68 @@ Learn about key host metrics displayed in the Infrastructure UI:
}
]}>
<DocRow>
<DocCell>**CPU Usage (%)** </DocCell>
<DocCell>**CPU Usage (%)**</DocCell>
<DocCell>
Percentage of CPU time spent in states other than Idle and IOWait, normalized by the number of CPU cores. This includes both time spent on user space and kernel space.
Average of percentage of CPU time spent in states other than Idle and IOWait, normalized by the number of CPU cores. Includes both time spent on user space and kernel space. 100% means all CPUs of the host are busy.

100% means all CPUs of the host are busy.
**Field Calculation**: `(average(system.cpu.user.pct) + average(system.cpu.system.pct)) / max(system.cpu.cores)`
**Field Calculation**: `average(system.cpu.total.norm.pct)`

For legacy metric calculations, refer to <DocLink slug="/serverless/observability/host-metrics" section="legacy-metrics">Legacy metrics</DocLink>.
</DocCell>
</DocRow>
<DocRow>
<DocCell>**CPU Usage - iowait (%)**</DocCell>
<DocCell>
The percentage of CPU time spent in wait (on disk).

**Field Calculation**: `average(system.cpu.iowait.pct) / max(system.cpu.cores)`
</DocCell>
</DocRow>
<DocRow>
<DocCell>**CPU Usage - irq (%)** </DocCell>
<DocCell>
The percentage of CPU time spent servicing and handling hardware interrupts.

**Field Calculation**: `average(system.cpu.irq.pct) / max(system.cpu.cores)`
</DocCell>
</DocRow>
<DocRow>
<DocCell>**CPU Usage - nice (%)** </DocCell>
<DocCell>
The percentage of CPU time spent on low-priority processes.

**Field Calculation**: `average(system.cpu.nice.pct) / max(system.cpu.cores)`
</DocCell>
</DocRow>
<DocRow>
<DocCell>**CPU Usage - softirq (%)**</DocCell>
<DocCell>
The percentage of CPU time spent servicing and handling software interrupts.

**Field Calculation**: `average(system.cpu.softirq.pct) / max(system.cpu.cores)`
</DocCell>
</DocRow>
<DocRow>
<DocCell>**CPU Usage - steal (%)** </DocCell>
<DocCell>
The percentage of CPU time spent in involuntary wait by the virtual CPU while the hypervisor was servicing another processor. Available only on Unix.

**Field Calculation**: `average(system.cpu.steal.pct) / max(system.cpu.cores)`
</DocCell>
</DocRow>
<DocRow>
<DocCell>**CPU Usage - system (%)** </DocCell>
<DocCell>
The percentage of CPU time spent in kernel space.

**Field Calculation**: `average(system.cpu.system.pct) / max(system.cpu.cores)`
</DocCell>
</DocRow>
<DocRow>
<DocCell>**CPU Usage - user (%)** </DocCell>
<DocCell>
The percentage of CPU time spent in user space. On multi-core systems, you can have percentages that are greater than 100%. For example, if 3 cores are at 60% use, then the system.cpu.user.pct will be 180%.

**Field Calculation**: `average(system.cpu.user.pct) / max(system.cpu.cores)`
</DocCell>
</DocRow>
Expand Down Expand Up @@ -202,18 +203,18 @@ Learn about key host metrics displayed in the Infrastructure UI:
<DocCell>**Memory Free (excluding cache)**</DocCell>
<DocCell>
Total available memory excluding the page cache.

**Field Calculation**: `system.memory.free`
</DocCell>
</DocRow>
</DocRow>
<DocRow>
<DocCell>**Memory Total** </DocCell>
<DocCell>
Total memory capacity.

**Field Calculation**: `avg(system.memory.total)`
</DocCell>
</DocRow>
</DocRow>
<DocRow>
<DocCell>**Memory Usage (%)** </DocCell>
<DocCell>
Expand All @@ -225,12 +226,12 @@ Learn about key host metrics displayed in the Infrastructure UI:

**Field Calculation**: `average(system.memory.actual.used.pct)`
</DocCell>
</DocRow>
</DocRow>
<DocRow>
<DocCell>**Memory Used** </DocCell>
<DocCell>
Main memory usage excluding page cache.

**Field Calculation**: `average(system.memory.actual.used.bytes)`
</DocCell>
</DocRow>
Expand Down Expand Up @@ -279,15 +280,19 @@ Learn about key host metrics displayed in the Infrastructure UI:
<DocCell>
Number of bytes that have been received per second on the public interfaces of the hosts.

**Field Calculation**: `average(host.network.ingress.bytes) * 8 / (max(metricset.period, kql='host.network.ingress.bytes: *') / 1000)`
**Field Calculation**: `sum(host.network.ingress.bytes) * 8 / 1000`

For legacy metric calculations, refer to <DocLink slug="/serverless/observability/host-metrics" section="legacy-metrics">Legacy metrics</DocLink>.
</DocCell>
</DocRow>
<DocRow>
<DocCell>**Network Inbound (TX)** </DocCell>
<DocCell>**Network Outbound (TX)** </DocCell>
<DocCell>
Number of bytes that have been sent per second on the public interfaces of the hosts.

**Field Calculation**: `average(host.network.egress.bytes) * 8 / (max(metricset.period, kql='host.network.egress.bytes: *') / 1000)`
**Field Calculation**: `sum(host.network.egress.bytes) * 8 / 1000`

For legacy metric calculations, refer to <DocLink slug="/serverless/observability/host-metrics" section="legacy-metrics">Legacy metrics</DocLink>.
</DocCell>
</DocRow>
</DocTable>
Expand Down Expand Up @@ -360,4 +365,52 @@ Learn about key host metrics displayed in the Infrastructure UI:
**Field Calculation**: `counter_rate(max(system.diskio.write.bytes), kql='system.diskio.write.bytes: *')`
</DocCell>
</DocRow>
</DocTable>
</DocTable>

<div id="legacy-metrics"></div>

## Legacy metrics

Over time, we may change the formula used to calculate a specific metric.
To avoid affecting your existing rules, instead of changing the actual metric definition,
we create a new metric and refer to the old one as "legacy."

The UI and any new rules you create will use the new metric definition.
However, any alerts that use the old definition will refer to the metric as "legacy."

<DocTable columns={[
{
"title": "Metric",
"width": "30%"
},
{
"title": "Description",
"width": "70%"
}
]}>
<DocRow>
<DocCell>**CPU Usage (legacy)**</DocCell>
<DocCell>
Percentage of CPU time spent in states other than Idle and IOWait, normalized by the number of CPU cores. This includes both time spent on user space and kernel space.
100% means all CPUs of the host are busy.

**Field Calculation**: `(average(system.cpu.user.pct) + average(system.cpu.system.pct)) / max(system.cpu.cores)`
</DocCell>
</DocRow>
<DocRow>
<DocCell>**Network Inbound (RX) (legacy)** </DocCell>
<DocCell>
Number of bytes that have been received per second on the public interfaces of the hosts.

**Field Calculation**: `average(host.network.ingress.bytes) * 8 / (max(metricset.period, kql='host.network.ingress.bytes: *') / 1000)`
</DocCell>
</DocRow>
<DocRow>
<DocCell>**Network Outbound (TX) (legacy)** </DocCell>
<DocCell>
Number of bytes that have been sent per second on the public interfaces of the hosts.

**Field Calculation**: `average(host.network.egress.bytes) * 8 / (max(metricset.period, kql='host.network.egress.bytes: *') / 1000)`
</DocCell>
</DocRow>
</DocTable>
Loading