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

Few changes to the metricbeat exported fields #2101

Merged
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
4 changes: 4 additions & 0 deletions CHANGELOG.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ https://github.com/elastic/beats/compare/v5.0.0-alpha4...master[Check the HEAD d
- The undocumented file output `index` setting was removed. Use `filename` instead. {pull}2077[2077]

*Metricbeat*
- Create a separate metricSet for load under the system module and remove load information from CPU stats. {pull}2101[2101]
- Rename `system.memory.actual.free` with `system.memory.available` and remove `system.memory.actual.used`.
{pull}2101[2101]
- Add `system.load.norm.1`, `system.load.norm.5` and `system.load.norm.15`. {pull}2101[2101]

*Packetbeat*
- Set `enabled` ` in `packetbeat.protocols.icmp` configuration to `true` by default. {pull}1988[1988]
Expand Down
107 changes: 54 additions & 53 deletions metricbeat/docs/fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2159,37 +2159,6 @@ type: long
The amount of CPU time spent in involuntary wait by the virtual CPU while the hypervisor was servicing another processor. Available only on Unix.


[float]
== load Fields

Load averages.



[float]
=== system.cpu.load.1

type: half_float

Load average for the last minute.


[float]
=== system.cpu.load.5

type: half_float

Load average for the last 5 minutes.


[float]
=== system.cpu.load.15

type: half_float

Load average for the last 15 minutes.


[float]
== diskio Fields

Expand Down Expand Up @@ -2279,7 +2248,7 @@ The total number of of milliseconds spent doing I/Os.


[float]
=== system.filesystem.avail
=== system.filesystem.available

type: long

Expand Down Expand Up @@ -2402,73 +2371,105 @@ Total space (used plus free).


[float]
== memory Fields
== load Fields

`memory` contains local memory stats.
Load averages.



[float]
=== system.memory.total
=== system.load.1

type: long
type: half_float

Total memory.
Load average for the last minute.


[float]
=== system.memory.used.bytes
=== system.load.5

type: long
type: half_float

Used memory.
Load average for the last 5 minutes.


[float]
=== system.memory.free
=== system.load.15

type: long
type: half_float

Available memory.
Load average for the last 15 minutes.


[float]
=== system.memory.used.pct
=== system.load.norm.1

type: half_float

The percentage of used memory.
Load divided by the number of cores for the last minute.


[float]
=== system.load.norm.5

type: half_float

Load divided by the number of cores for the last 5 minutes.


[float]
=== system.load.norm.15

type: half_float

Load divided by the number of cores for the last 15 minutes.


[float]
== memory Fields

`memory` contains local memory stats.



[float]
== actual Fields
=== system.memory.total

Actual memory fields.
type: long

Total memory.


[float]
=== system.memory.actual.used.bytes
=== system.memory.used.bytes

type: long

Actual used memory. This value is the "used" memory minus the memory used for disk caches and buffers. Available only on Unix.
Used memory.


[float]
=== system.memory.actual.free
=== system.memory.free

type: long

Actual available memory. This value is the "free" memory plus the memory used for disk caches and buffers. Available only on Unix.
The total amount of free memory in bytes. This value does not include memory consumed by system caches and buffers (see system.memory.available).


[float]
=== system.memory.actual.used.pct
=== system.memory.used.pct

type: half_float

The percentage of actual used memory.
The percentage of used memory.


[float]
=== system.memory.available

type: long

Available memory in bytes. It is calculated based on the OS. On Linux it consists of the free memory plus caches and buffers. On OSX it is a sum of free memory and the inactive memory.


[float]
Expand Down
7 changes: 7 additions & 0 deletions metricbeat/docs/modules/system.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@ metricbeat.modules:
# CPU stats
- cpu

# System Load stats
- load

# Per CPU core stats
#- core

Expand Down Expand Up @@ -101,6 +104,8 @@ The following metricsets are available:

* <<metricbeat-metricset-system-fsstat,fsstat>>

* <<metricbeat-metricset-system-load,load>>

* <<metricbeat-metricset-system-memory,memory>>

* <<metricbeat-metricset-system-network,network>>
Expand All @@ -117,6 +122,8 @@ include::system/filesystem.asciidoc[]

include::system/fsstat.asciidoc[]

include::system/load.asciidoc[]

include::system/memory.asciidoc[]

include::system/network.asciidoc[]
Expand Down
19 changes: 19 additions & 0 deletions metricbeat/docs/modules/system/load.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
////
This file is generated! See scripts/docs_collector.py
////

[[metricbeat-metricset-system-load]]
include::../../../module/system/load/_meta/docs.asciidoc[]


==== Fields

For a description of each field in the metricset, see the
<<exported-fields-system,exported fields>> section.

Here is an example document generated by this metricset:

[source,json]
----
include::../../../module/system/load/_meta/data.json[]
----
3 changes: 3 additions & 0 deletions metricbeat/etc/beat.full.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ metricbeat.modules:
# CPU stats
- cpu

# System Load stats
- load

# Per CPU core stats
#- core

Expand Down
3 changes: 3 additions & 0 deletions metricbeat/etc/beat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ metricbeat.modules:
# CPU stats
- cpu

# System Load stats
- load

# Per CPU core stats
#- core

Expand Down
78 changes: 38 additions & 40 deletions metricbeat/etc/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1289,24 +1289,6 @@
The amount of CPU time spent in involuntary wait by the virtual CPU while the hypervisor
was servicing another processor.
Available only on Unix.

- name: load
type: group
description: >
Load averages.
fields:
- name: "1"
type: half_float
description: >
Load average for the last minute.
- name: "5"
type: half_float
description: >
Load average for the last 5 minutes.
- name: "15"
type: half_float
description: >
Load average for the last 15 minutes.
- name: diskio
type: group
description: >
Expand Down Expand Up @@ -1366,7 +1348,7 @@
description: >
`filesystem` contains local filesystem stats.
fields:
- name: avail
- name: available
type: long
description: >
The disk space available to an unprivileged user in bytes.
Expand Down Expand Up @@ -1432,6 +1414,38 @@
type: long
description: >
Total space (used plus free).
- name: load
type: group
description: >
Load averages.
fields:
- name: "1"
type: half_float
description: >
Load average for the last minute.
- name: "5"
type: half_float
description: >
Load average for the last 5 minutes.
- name: "15"
type: half_float
description: >
Load average for the last 15 minutes.

- name: "norm.1"
type: half_float
description: >
Load divided by the number of cores for the last minute.

- name: "norm.5"
type: half_float
description: >
Load divided by the number of cores for the last 5 minutes.

- name: "norm.15"
type: half_float
description: >
Load divided by the number of cores for the last 15 minutes.
- name: memory
type: group
description: >
Expand All @@ -1450,34 +1464,18 @@
- name: free
type: long
description: >
Available memory.
The total amount of free memory in bytes. This value does not include memory consumed by system caches and buffers (see system.memory.available).

- name: used.pct
type: half_float
description: >
The percentage of used memory.

- name: actual
type: group
- name: available
type: long
description: >
Actual memory fields.
fields:
- name: used.bytes
type: long
description: >
Actual used memory. This value is the "used" memory minus the memory used for disk caches and buffers.
Available only on Unix.

- name: free
type: long
description: >
Actual available memory. This value is the "free" memory plus the memory used for disk caches and
buffers. Available only on Unix.

- name: used.pct
type: half_float
description: >
The percentage of actual used memory.
Available memory in bytes. It is calculated based on the OS. On Linux it consists of the free memory
plus caches and buffers. On OSX it is a sum of free memory and the inactive memory.

- name: swap
type: group
Expand Down
1 change: 1 addition & 0 deletions metricbeat/include/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import (
_ "github.com/elastic/beats/metricbeat/module/system/diskio"
_ "github.com/elastic/beats/metricbeat/module/system/filesystem"
_ "github.com/elastic/beats/metricbeat/module/system/fsstat"
_ "github.com/elastic/beats/metricbeat/module/system/load"
_ "github.com/elastic/beats/metricbeat/module/system/memory"
_ "github.com/elastic/beats/metricbeat/module/system/network"
_ "github.com/elastic/beats/metricbeat/module/system/process"
Expand Down
3 changes: 3 additions & 0 deletions metricbeat/metricbeat.full.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ metricbeat.modules:
# CPU stats
- cpu

# System Load stats
- load

# Per CPU core stats
#- core

Expand Down
Loading