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 edits for load and socket metricset docs #3495

Merged
merged 2 commits into from
Feb 1, 2017
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
2 changes: 1 addition & 1 deletion metricbeat/docs/fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6811,7 +6811,7 @@ type: ip

example: 192.0.2.1 or 2001:0DB8:ABED:8536::1

Remote IP address. This can be an IPv4 or IPv6 address
Remote IP address. This can be an IPv4 or IPv6 address.


[float]
Expand Down
2 changes: 1 addition & 1 deletion metricbeat/module/system/load/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
=== system load MetricSet
=== System Load Metricset

The System `load` metricset provides load statistics.

Expand Down
38 changes: 20 additions & 18 deletions metricbeat/module/system/socket/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,37 +1,39 @@
=== system socket MetricSet
=== System Socket Metricset

WARNING: This functionality is in beta and is subject to change. It should be
deployed in production at your own risk.
beta[]

This metricset is available on Linux only and requires kernel 2.6.14 or newer.

The system socket metricset reports an event for each new TCP socket that it
sees. It does this by polling the kernel to get a dump of all sockets. So using
a short polling interval with this metricset is important to not miss short
lived connections. You can configure a period specifically for this module by
declaring it separately from other system metricsets.
The system `socket` metricset reports an event for each new TCP socket that it
sees. It does this by polling the kernel periodically to get a dump of all
sockets. You set the polling interval by configuring the `period` option.
Specifying a short polling interval with this metricset is important to avoid
missing short-lived connections. For example:

[source,yaml]
---
metricbeat.modules:
- module: system
metricsets: [cpu, memory]
- module: system
metricsets: [socket]
- module: system
metricsets: [socket] <1>
period: 1s
---

<1> You can configure the `socket` metricset separately to specify a different
`period` value than the other metricsets.

The metricset reports the process that has the socket open. In order to provide
this information Metricbeat must be running as root. It needs to be root to read
the file descriptor information of other processes.
this information, Metricbeat must be running as root. Root access is also
required to read the file descriptor information of other processes.

A reverse lookup can be performed by the metricset on the remote IP and the
returned hostname will be added to the event and cached. The is disabled by
default and can be enabled through the configuration. If a hostname is found
then the eTLD+1 (effective top-level domain plus one level) value will also be
added to the event.
You can configure the metricset to perform a reverse lookup on the remote IP,
and the returned hostname will be added to the event and cached. If a hostname
is found, then the eTLD+1 (effective top-level domain plus one level) value will
also be added to the event. Reverse lookups are disabled by default.

The full configuration for the metricset is shown below with its defaults.
The following example shows the full configuration for the metricset along with
the defaults.

[source,yaml]
---
Expand Down
2 changes: 1 addition & 1 deletion metricbeat/module/system/socket/_meta/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
type: ip
example: 192.0.2.1 or 2001:0DB8:ABED:8536::1
description: >
Remote IP address. This can be an IPv4 or IPv6 address
Remote IP address. This can be an IPv4 or IPv6 address.

- name: remote.port
type: long
Expand Down