openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-06 15:46:57 +01:00
Code Issues Releases Activity
Files
eb21424e97d48118fd1ff8c8b4dff94de2dd3b1c
openshift-docs/modules/cluster-logging-exported-fields-default.adoc
Andrea Hoffer 3af9a23ca2 Fixing backticks that were rendering
2020-03-17 18:48:18 +00:00

1097 lines
22 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
// Module included in the following assemblies:
//
// * logging/cluster-logging-exported-fields.adoc
[id="cluster-logging-exported-fields-default_{context}"]
= Default exported fields
These are the default fields exported by the logging system and available for searching
from Elasticsearch and Kibana. The default fields are Top Level and `collectd*`
[discrete]
=== Top Level Fields
The top level fields are common to every application, and may be present in
every record. For the Elasticsearch template, top level fields populate the actual
mappings of `default` in the template's mapping section.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `@timestamp`
| The UTC value marking when the log payload was created, or when the log payload
was first collected if the creation time is not known. This is the log
processing pipeline’s best effort determination of when the log payload was
generated. Add the `@` prefix convention to note a field as being reserved for a
particular use. With Elasticsearch, most tools look for `@timestamp` by default.
For example, the format would be 2015-01-24 14:06:05.071000.
| `geoip`
|This is geo-ip of the machine.
| `hostname`
|The `hostname` is the fully qualified domain name (FQDN) of the entity
generating the original payload. This field is an attempt to derive this
context. Sometimes the entity generating it knows the context. While other times
that entity has a restricted namespace itself, which is known by the collector
or normalizer.
| `ipaddr4`
|The IP address V4 of the source server, which can be an array.
| `ipaddr6`
|The IP address V6 of the source server, if available.
| `level`
|The logging level as provided by rsyslog (severitytext property), python's
logging module. Possible values are as listed at
link:http://sourceware.org/git/?p=glibc.git;a=blob;f=misc/sys/syslog.h;h=ee01478c4b19a954426a96448577c5a76e6647c0;hb=HEAD#l74[`misc/sys/syslog.h`]
plus `trace` and `unknown`. For example, "alert crit debug emerg err info notice
trace unknown warning". Note that `trace` is not in the `syslog.h` list but many
applications use it.
. You should only use `unknown` when the logging system gets a value it does not
understand, and note that it is the highest level.
. Consider `trace` as higher or more verbose, than `debug`.
. `error` is deprecated, use `err`.
. Convert `panic` to `emerg`.
. Convert `warn` to `warning`.
Numeric values from `syslog/journal PRIORITY` can usually be mapped using the
priority values as listed at
link:http://sourceware.org/git/?p=glibc.git;a=blob;f=misc/sys/syslog.h;h=ee01478c4b19a954426a96448577c5a76e6647c0;hb=HEAD#l51[misc/sys/syslog.h].
Log levels and priorities from other logging systems should be mapped to the
nearest match. See
link:https://docs.python.org/2.7/library/logging.html#logging-levels[python
logging] for an example.
| `message`
|A typical log entry message, or payload. It can be stripped of metadata pulled
out of it by the collector or normalizer, that is UTF-8 encoded.
| `pid`
|This is the process ID of the logging entity, if available.
| `service`
|The name of the service associated with the logging entity, if available. For
example, the `syslog APP-NAME` property is mapped to
the service field.
| `tags`
|Optionally provided operator defined list of tags placed on each log by the
collector or normalizer. The payload can be a string with whitespace-delimited
string tokens, or a JSON list of string tokens.
| `file`
|Optional path to the file containing the log entry local to the collector `TODO`
analyzer for file paths.
| `offset`
|The offset value can represent bytes to the start of the log line in the file
(zero or one based), or log line numbers (zero or one based), as long as the
values are strictly monotonically increasing in the context of a single log
file. The values are allowed to wrap, representing a new version of the log file
(rotation).
| `namespace_name`
|Associate this record with the `namespace` that shares it's name. This value
will not be stored, but it is used to associate the record with the appropriate
`namespace` for access control and visualization. Normally this value will be
given in the tag, but if the protocol does not support sending a tag, this field
can be used. If this field is present, it will override the `namespace` given in
the tag or in `kubernetes.namespace_name`.
| `namespace_uuid`
|This is the `uuid` associated with the `namespace_name`. This value will not be
stored, but is used to associate the record with the appropriate namespace for
access control and visualization. If this field is present, it will override the
`uuid` given in `kubernetes.namespace_uuid`. This will also cause the Kubernetes
metadata lookup to be skipped for this log record.
|===
[discrete]
=== `collectd` Fields
The following fields represent namespace metrics metadata.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.interval`
|type: float
The `collectd` interval.
| `collectd.plugin`
|type: string
The `collectd` plug-in.
| `collectd.plugin_instance`
|type: string
The `collectd` plugin_instance.
| `collectd.type_instance`
|type: string
The `collectd` `type_instance`.
| `collectd.type`
|type: string
The `collectd` type.
| `collectd.dstypes`
|type: string
The `collectd` dstypes.
|===
[discrete]
[id="exported-fields-collectd.processes_{context}"]
=== `collectd.processes` Fields
The following field corresponds to the `collectd` processes plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.processes.ps_state`
|type: integer
The `collectd ps_state` type of processes plug-in.
|===
[discrete]
[id="exported-fields-collectd.processes.ps_disk_ops_{context}"]
=== `collectd.processes.ps_disk_ops` Fields
The `collectd` `ps_disk_ops` type of processes plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.processes.ps_disk_ops.read`
|type: float
`TODO`
| `collectd.processes.ps_disk_ops.write`
|type: float
`TODO`
| `collectd.processes.ps_vm`
|type: integer
The `collectd` `ps_vm` type of processes plug-in.
| `collectd.processes.ps_rss`
|type: integer
The `collectd` `ps_rss` type of processes plug-in.
| `collectd.processes.ps_data`
|type: integer
The `collectd` `ps_data` type of processes plug-in.
| `collectd.processes.ps_code`
|type: integer
The `collectd` `ps_code` type of processes plug-in.
| `collectd.processes.ps_stacksize`
| type: integer
The `collectd` `ps_stacksize` type of processes plug-in.
|===
[discrete]
[id="exported-fields-collectd.processes.ps_cputime_{context}"]
=== `collectd.processes.ps_cputime` Fields
The `collectd` `ps_cputime` type of processes plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.processes.ps_cputime.user`
|type: float
`TODO`
| `collectd.processes.ps_cputime.syst`
|type: float
`TODO`
|===
[discrete]
[id="exported-fields-collectd.processes.ps_count_{context}"]
=== `collectd.processes.ps_count` Fields
The `collectd` `ps_count` type of processes plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.processes.ps_count.processes`
|type: integer
`TODO`
| `collectd.processes.ps_count.threads`
|type: integer
`TODO`
|===
[discrete]
[id="exported-fields-collectd.processes.ps_pagefaults_{context}"]
=== `collectd.processes.ps_pagefaults` Fields
The `collectd` `ps_pagefaults` type of processes plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.processes.ps_pagefaults.majflt`
|type: float
`TODO`
| `collectd.processes.ps_pagefaults.minflt`
|type: float
`TODO`
|===
[discrete]
[id="exported-fields-collectd.processes.ps_disk_octets_{context}"]
=== `collectd.processes.ps_disk_octets` Fields
The `collectd ps_disk_octets` type of processes plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.processes.ps_disk_octets.read`
|type: float
`TODO`
| `collectd.processes.ps_disk_octets.write`
|type: float
`TODO`
| `collectd.processes.fork_rate`
|type: float
The `collectd` `fork_rate` type of processes plug-in.
|===
[discrete]
[id="exported-fields-collectd.disk_{context}"]
=== `collectd.disk` Fields
Corresponds to `collectd` disk plug-in.
[discrete]
[id="exported-fields-collectd.disk.disk_merged_{context}"]
=== `collectd.disk.disk_merged` Fields
The `collectd` `disk_merged` type of disk plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.disk.disk_merged.read`
|type: float
`TODO`
| `collectd.disk.disk_merged.write`
|type: float
`TODO`
|===
[discrete]
[id="exported-fields-collectd.disk.disk_octets_{context}"]
=== `collectd.disk.disk_octets` Fields
The `collectd` `disk_octets` type of disk plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.disk.disk_octets.read`
|type: float
`TODO`
| `collectd.disk.disk_octets.write`
|type: float
`TODO`
|===
[discrete]
[id="exported-fields-collectd.disk.disk_time_{context}"]
=== `collectd.disk.disk_time` Fields
The `collectd` `disk_time` type of disk plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.disk.disk_time.read`
|type: float
`TODO`
| `collectd.disk.disk_time.write`
|type: float
`TODO`
|===
[discrete]
[id="exported-fields-collectd.disk.disk_ops_{context}"]
=== `collectd.disk.disk_ops` Fields
The `collectd` `disk_ops` type of disk plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.disk.disk_ops.read`
|type: float
`TODO`
| `collectd.disk.disk_ops.write`
|type: float
`TODO`
| `collectd.disk.pending_operations`
|type: integer
The `collectd` `pending_operations` type of disk plug-in.
|===
[discrete]
[id="exported-fields-collectd.disk.disk_io_time_{context}"]
=== `collectd.disk.disk_io_time` Fields
The `collectd disk_io_time` type of disk plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.disk.disk_io_time.io_time`
|type: float
`TODO`
| `collectd.disk.disk_io_time.weighted_io_time`
|type: float
`TODO`
|===
[discrete]
[id="exported-fields-collectd.interface_{context}"]
=== `collectd.interface` Fields
Corresponds to the `collectd` interface plug-in.
[discrete]
[id="exported-fields-collectd.interface.if_octets_{context}"]
=== `collectd.interface.if_octets` Fields
The `collectd` `if_octets` type of interface plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.interface.if_octets.rx`
|type: float
`TODO`
| `collectd.interface.if_octets.tx`
|type: float
`TODO`
|===
[discrete]
[id="exported-fields-collectd.interface.if_packets_{context}"]
=== `collectd.interface.if_packets` Fields
The `collectd` `if_packets` type of interface plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.interface.if_packets.rx`
|type: float
`TODO`
| `collectd.interface.if_packets.tx`
|type: float
`TODO`
|===
[discrete]
[id="exported-fields-collectd.interface.if_errors_{context}"]
=== `collectd.interface.if_errors` Fields
The `collectd` `if_errors` type of interface plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.interface.if_errors.rx`
|type: float
`TODO`
| `collectd.interface.if_errors.tx`
|type: float
`TODO`
|===
[discrete]
[id="exported-fields-collectd.interface.if_dropped_{context}"]
=== collectd.interface.if_dropped Fields
The `collectd` `if_dropped` type of interface plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.interface.if_dropped.rx`
|type: float
`TODO`
| `collectd.interface.if_dropped.tx`
|type: float
`TODO`
|===
[discrete]
[id="exported-fields-collectd.virt_{context}"]
=== `collectd.virt` Fields
Corresponds to `collectd` virt plug-in.
[discrete]
[id="exported-fields-collectd.virt.if_octets_{context}"]
=== `collectd.virt.if_octets` Fields
The `collectd if_octets` type of virt plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.virt.if_octets.rx`
|type: float
`TODO`
| `collectd.virt.if_octets.tx`
|type: float
`TODO`
|===
[discrete]
[id="exported-fields-collectd.virt.if_packets_{context}"]
=== `collectd.virt.if_packets` Fields
The `collectd` `if_packets` type of virt plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.virt.if_packets.rx`
|type: float
`TODO`
| `collectd.virt.if_packets.tx`
|type: float
`TODO`
|===
[discrete]
[id="exported-fields-collectd.virt.if_errors_{context}"]
=== `collectd.virt.if_errors` Fields
The `collectd` `if_errors` type of virt plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.virt.if_errors.rx`
|type: float
`TODO`
| `collectd.virt.if_errors.tx`
|type: float
`TODO`
|===
[discrete]
[id="exported-fields-collectd.virt.if_dropped_{context}"]
=== `collectd.virt.if_dropped` Fields
The `collectd` `if_dropped` type of virt plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.virt.if_dropped.rx`
|type: float
`TODO`
| `collectd.virt.if_dropped.tx`
|type: float
`TODO`
|===
[discrete]
[id="exported-fields-collectd.virt.disk_ops_{context}"]
=== `collectd.virt.disk_ops` Fields
The `collectd` `disk_ops` type of virt plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.virt.disk_ops.read`
|type: float
`TODO`
| `collectd.virt.disk_ops.write`
|type: float
`TODO`
|===
[discrete]
[id="exported-fields-collectd.virt.disk_octets_{context}"]
=== `collectd.virt.disk_octets` Fields
The `collectd` `disk_octets` type of virt plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.virt.disk_octets.read`
|type: float
`TODO`
| `collectd.virt.disk_octets.write`
|type: float
`TODO`
| `collectd.virt.memory`
|type: float
The `collectd` memory type of virt plug-in.
| `collectd.virt.virt_vcpu`
|type: float
The `collectd` `virt_vcpu` type of virt plug-in.
| `collectd.virt.virt_cpu_total`
|type: float
The `collectd` `virt_cpu_total` type of virt plug-in.
|===
[discrete]
[id="exported-fields-collectd.CPU_{context}"]
=== `collectd.CPU` Fields
Corresponds to the `collectd` CPU plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.CPU.percent`
|type: float
The `collectd` type percent of plug-in CPU.
|===
[discrete]
[id="exported-fields-collectd.df_{context}"]
=== collectd.df Fields
Corresponds to the `collectd` `df` plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.df.df_complex`
|type: float
The `collectd` type `df_complex` of plug-in `df`.
| `collectd.df.percent_bytes`
|type: float
The `collectd` type `percent_bytes` of plug-in `df`.
|===
[discrete]
[id="exported-fields-collectd.entropy_{context}"]
=== `collectd.entropy` Fields
Corresponds to the `collectd` entropy plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.entropy.entropy`
|type: integer
The `collectd` entropy type of entropy plug-in.
|===
////
[discrete]
[id="exported-fields-collectd.nfs_{context}"]
=== `collectd.nfs` Fields
Corresponds to the `collectd` NFS plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.nfs.nfs_procedure`
|type: integer
The `collectd` `nfs_procedure` type of nfs plug-in.
|===
////
[discrete]
[id="exported-fields-collectd.memory_{context}"]
=== `collectd.memory` Fields
Corresponds to the `collectd` memory plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.memory.memory`
|type: float
The `collectd` memory type of memory plug-in.
| `collectd.memory.percent`
|type: float
The `collectd` percent type of memory plug-in.
|===
[discrete]
[id="exported-fields-collectd.swap_{context}"]
=== `collectd.swap` Fields
Corresponds to the `collectd` swap plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.swap.swap`
|type: integer
The `collectd` swap type of swap plug-in.
| `collectd.swap.swap_io`
|type: integer
The `collectd swap_io` type of swap plug-in.
|===
[discrete]
[id="exported-fields-collectd.load_{context}"]
=== `collectd.load` Fields
Corresponds to the `collectd` load plug-in.
[discrete]
[id="exported-fields-collectd.load.load_{context}"]
=== `collectd.load.load` Fields
The `collectd` load type of load plug-in
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.load.load.shortterm`
|type: float
`TODO`
| `collectd.load.load.midterm`
|type: float
`TODO`
| `collectd.load.load.longterm`
|type: float
`TODO`
|===
[discrete]
[id="exported-fields-collectd.aggregation_{context}"]
=== `collectd.aggregation` Fields
Corresponds to `collectd` aggregation plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.aggregation.percent`
|type: float
`TODO`
|===
[discrete]
[id="exported-fields-collectd.statsd_{context}"]
=== `collectd.statsd` Fields
Corresponds to `collectd` `statsd` plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.statsd.host_cpu`
|type: integer
The `collectd` CPU type of `statsd` plug-in.
| `collectd.statsd.host_elapsed_time`
|type: integer
The `collectd` `elapsed_time` type of `statsd` plug-in.
| `collectd.statsd.host_memory`
|type: integer
The `collectd` memory type of `statsd` plug-in.
| `collectd.statsd.host_nic_speed`
|type: integer
The `collectd` `nic_speed` type of `statsd` plug-in.
| `collectd.statsd.host_nic_rx`
|type: integer
The `collectd` `nic_rx` type of `statsd` plug-in.
| `collectd.statsd.host_nic_tx`
|type: integer
The `collectd` `nic_tx` type of `statsd` plug-in.
| `collectd.statsd.host_nic_rx_dropped`
|type: integer
The `collectd` `nic_rx_dropped` type of `statsd` plug-in.
| `collectd.statsd.host_nic_tx_dropped`
|type: integer
The `collectd` `nic_tx_dropped` type of `statsd` plug-in.
| `collectd.statsd.host_nic_rx_errors`
|type: integer
The `collectd` `nic_rx_errors` type of `statsd` plug-in.
| `collectd.statsd.host_nic_tx_errors`
|type: integer
The `collectd` `nic_tx_errors` type of `statsd` plug-in.
| `collectd.statsd.host_storage`
|type: integer
The `collectd` storage type of `statsd` plug-in.
| `collectd.statsd.host_swap`
|type: integer
The `collectd` swap type of `statsd` plug-in.
| `collectd.statsd.host_vdsm`
|type: integer
The `collectd` VDSM type of `statsd` plug-in.
| `collectd.statsd.host_vms`
|type: integer
The `collectd` VMS type of `statsd` plug-in.
| `collectd.statsd.vm_nic_tx_dropped`
|type: integer
The `collectd` `nic_tx_dropped` type of `statsd` plug-in.
| `collectd.statsd.vm_nic_rx_bytes`
|type: integer
The `collectd` `nic_rx_bytes` type of `statsd` plug-in.
| `collectd.statsd.vm_nic_tx_bytes`
|type: integer
The `collectd` `nic_tx_bytes` type of `statsd` plug-in.
| `collectd.statsd.vm_balloon_min`
|type: integer
The `collectd` `balloon_min` type of `statsd` plug-in.
| `collectd.statsd.vm_balloon_max`
|type: integer
The `collectd` `balloon_max` type of `statsd` plug-in.
| `collectd.statsd.vm_balloon_target`
|type: integer
The `collectd` `balloon_target` type of `statsd` plug-in.
| `collectd.statsd.vm_balloon_cur`
| type: integer
The `collectd` `balloon_cur` type of `statsd` plug-in.
| `collectd.statsd.vm_cpu_sys`
|type: integer
The `collectd` `cpu_sys` type of `statsd` plug-in.
| `collectd.statsd.vm_cpu_usage`
|type: integer
The `collectd` `cpu_usage` type of `statsd` plug-in.
| `collectd.statsd.vm_disk_read_ops`
|type: integer
The `collectd` `disk_read_ops` type of `statsd` plug-in.
| `collectd.statsd.vm_disk_write_ops`
|type: integer
The `collectd` `disk_write_ops` type of `statsd` plug-in.
| `collectd.statsd.vm_disk_flush_latency`
|type: integer
The `collectd` `disk_flush_latency` type of `statsd` plug-in.
| `collectd.statsd.vm_disk_apparent_size`
|type: integer
The `collectd` `disk_apparent_size` type of `statsd` plug-in.
| `collectd.statsd.vm_disk_write_bytes`
|type: integer
The `collectd` `disk_write_bytes` type of `statsd` plug-in.
| `collectd.statsd.vm_disk_write_rate`
|type: integer
The `collectd` `disk_write_rate` type of `statsd` plug-in.
| `collectd.statsd.vm_disk_true_size`
|type: integer
The `collectd` `disk_true_size` type of `statsd` plug-in.
| `collectd.statsd.vm_disk_read_rate`
|type: integer
The `collectd` `disk_read_rate` type of `statsd` plug-in.
| `collectd.statsd.vm_disk_write_latency`
|type: integer
The `collectd` `disk_write_latency` type of `statsd` plug-in.
| `collectd.statsd.vm_disk_read_latency`
|type: integer
The `collectd` `disk_read_latency` type of `statsd` plug-in.
| `collectd.statsd.vm_disk_read_bytes`
|type: integer
The `collectd` `disk_read_bytes` type of `statsd` plug-in.
| `collectd.statsd.vm_nic_rx_dropped`
|type: integer
The `collectd` `nic_rx_dropped` type of `statsd` plug-in.
| `collectd.statsd.vm_cpu_user`
|type: integer
The `collectd` `cpu_user` type of `statsd` plug-in.
| `collectd.statsd.vm_nic_rx_errors`
|type: integer
The `collectd` `nic_rx_errors` type of `statsd` plug-in.
| `collectd.statsd.vm_nic_tx_errors`
|type: integer
The `collectd` `nic_tx_errors` type of `statsd` plug-in.
| `collectd.statsd.vm_nic_speed`
|type: integer
The `collectd` `nic_speed` type of `statsd` plug-in.
|===
[discrete]
[id="exported-fields-collectd.postgresql_{context}"]
=== `collectd.postgresql Fields`
Corresponds to `collectd` `postgresql` plug-in.
[cols="3,7",options="header"]
|===
|Parameter
|Description
| `collectd.postgresql.pg_n_tup_g`
|type: integer
The `collectd` type `pg_n_tup_g` of plug-in postgresql.
| `collectd.postgresql.pg_n_tup_c`
|type: integer
The `collectd` type `pg_n_tup_c` of plug-in postgresql.
| `collectd.postgresql.pg_numbackends`
|type: integer
The `collectd` type `pg_numbackends` of plug-in postgresql.
| `collectd.postgresql.pg_xact`
|type: integer
The `collectd` type `pg_xact` of plug-in postgresql.
| `collectd.postgresql.pg_db_size`
|type: integer
The `collectd` type `pg_db_size` of plug-in postgresql.
| `collectd.postgresql.pg_blks`
|type: integer
The `collectd` type `pg_blks` of plug-in postgresql.
|===
View Git Blame Copy Permalink