icingabeat/docs/fields.asciidoc

1785 lines
16 KiB
Plaintext

////
This file is generated! See _meta/fields.yml and scripts/generate_field_docs.py
////
[[exported-fields]]
= Exported fields
[partintro]
--
This document describes the fields that are exported by icingabeat. They are
grouped in the following categories:
* <<exported-fields-beat>>
* <<exported-fields-cloud>>
* <<exported-fields-docker-processor>>
* <<exported-fields-host-processor>>
* <<exported-fields-icingabeat>>
* <<exported-fields-kubernetes-processor>>
--
[[exported-fields-beat]]
== Beat fields
Contains common beat fields available in all event types.
*`beat.name`*::
+
--
The name of the Beat sending the log messages. If the Beat name is set in the configuration file, then that value is used. If it is not set, the hostname is used. To set the Beat name, use the `name` option in the configuration file.
--
*`beat.hostname`*::
+
--
The hostname as returned by the operating system on which the Beat is running.
--
*`beat.timezone`*::
+
--
The timezone as returned by the operating system on which the Beat is running.
--
*`beat.version`*::
+
--
The version of the beat that generated this event.
--
*`@timestamp`*::
+
--
type: date
example: August 26th 2016, 12:35:53.332
format: date
required: True
The timestamp when the event log record was generated.
--
*`tags`*::
+
--
Arbitrary tags that can be set per Beat and per transaction type.
--
*`fields`*::
+
--
type: object
Contains user configurable fields.
--
[float]
== error fields
Error fields containing additional info in case of errors.
*`error.message`*::
+
--
type: text
Error message.
--
*`error.code`*::
+
--
type: long
Error code.
--
*`error.type`*::
+
--
type: keyword
Error type.
--
[[exported-fields-cloud]]
== Cloud provider metadata fields
Metadata from cloud providers added by the add_cloud_metadata processor.
*`meta.cloud.provider`*::
+
--
example: ec2
Name of the cloud provider. Possible values are ec2, gce, or digitalocean.
--
*`meta.cloud.instance_id`*::
+
--
Instance ID of the host machine.
--
*`meta.cloud.instance_name`*::
+
--
Instance name of the host machine.
--
*`meta.cloud.machine_type`*::
+
--
example: t2.medium
Machine type of the host machine.
--
*`meta.cloud.availability_zone`*::
+
--
example: us-east-1c
Availability zone in which this host is running.
--
*`meta.cloud.project_id`*::
+
--
example: project-x
Name of the project in Google Cloud.
--
*`meta.cloud.region`*::
+
--
Region in which this host is running.
--
[[exported-fields-docker-processor]]
== Docker fields
Docker stats collected from Docker.
*`docker.container.id`*::
+
--
type: keyword
Unique container id.
--
*`docker.container.image`*::
+
--
type: keyword
Name of the image the container was built on.
--
*`docker.container.name`*::
+
--
type: keyword
Container name.
--
*`docker.container.labels`*::
+
--
type: object
Image labels.
--
[[exported-fields-host-processor]]
== Host fields
Info collected for the host machine.
*`host.name`*::
+
--
type: keyword
Hostname.
--
*`host.id`*::
+
--
type: keyword
Unique host id.
--
*`host.architecture`*::
+
--
type: keyword
Host architecture (e.g. x86_64, arm, ppc, mips).
--
*`host.os.platform`*::
+
--
type: keyword
OS platform (e.g. centos, ubuntu, windows).
--
*`host.os.version`*::
+
--
type: keyword
OS version.
--
*`host.os.family`*::
+
--
type: keyword
OS family (e.g. redhat, debian, freebsd, windows).
--
*`host.ip`*::
+
--
type: ip
List of IP-addresses.
--
*`host.mac`*::
+
--
type: keyword
List of hardware-addresses, usually MAC-addresses.
--
[[exported-fields-icingabeat]]
== icingabeat fields
Data received from the Icinga 2 API
*`timestamp`*::
+
--
type: date
Timestamp of event occurrence
--
*`type`*::
+
--
type: keyword
Type of the document
--
*`icinga.timestamp`*::
+
--
type: date
Timestamp of event occurrence
--
*`icinga.type`*::
+
--
type: keyword
Type of the document
--
*`icinga.host`*::
+
--
type: keyword
Host that triggered the event
--
*`icinga.service`*::
+
--
type: keyword
Service that triggered the event
--
*`icinga.state`*::
+
--
type: integer
State of the check
--
*`icinga.state_type`*::
+
--
type: integer
State type of the check
--
*`icinga.author`*::
+
--
type: keyword
Author of a message
--
*`icinga.notification_type`*::
+
--
type: keyword
Type of notification
--
*`icinga.text`*::
+
--
type: text
Text of a message
--
*`icinga.users`*::
+
--
type: keyword
Affected users of a notification
--
*`icinga.acknowledgement_type`*::
+
--
type: integer
Type of an acknowledgement
--
*`icinga.expiry`*::
+
--
type: date
Expiry of an acknowledgement
--
*`icinga.notify`*::
+
--
type: keyword
If has been sent out
--
*`icinga.check_result.active`*::
+
--
type: boolean
If check was active or passive
--
*`icinga.check_result.check_source`*::
+
--
type: keyword
Icinga instance that scheduled the check
--
*`icinga.check_result.command`*::
+
--
type: text
Command that was executed
--
*`icinga.check_result.execution_end`*::
+
--
type: date
Time when execution of check ended
--
*`icinga.check_result.execution_start`*::
+
--
type: date
Time when execution of check started
--
*`icinga.check_result.exit_status`*::
+
--
type: integer
Exit status
--
*`icinga.check_result.output`*::
+
--
type: text
Output of check
--
*`icinga.check_result.performance_data`*::
+
--
type: text
Performance data in text format
--
*`icinga.check_result.schedule_end`*::
+
--
type: date
Time when scheduling of the check ended
--
*`icinga.check_result.schedule_start`*::
+
--
type: date
Time when check was scheduled
--
*`icinga.check_result.state`*::
+
--
type: integer
State of the check
--
*`icinga.check_result.ttl`*::
+
--
type: integer
TTL, only valid if passive check
--
*`icinga.check_result.type`*::
+
--
type: keyword
Type of this event
--
*`icinga.check_result.vars_after.attempt`*::
+
--
type: integer
Check attempt after check execution
--
*`icinga.check_result.vars_after.reachable`*::
+
--
type: boolean
Reachable state after check execution
--
*`icinga.check_result.vars_after.state`*::
+
--
type: integer
State of the check after execution
--
*`icinga.check_result.vars_after.state_type`*::
+
--
type: integer
State type after execution
--
*`icinga.check_result.vars_before.attempt`*::
+
--
type: integer
Check attempt before check execution
--
*`icinga.check_result.vars_before.reachable`*::
+
--
type: boolean
Reachable state before check execution
--
*`icinga.check_result.vars_before.state`*::
+
--
type: integer
Check state before check execution
--
*`icinga.check_result.vars_before.state_type`*::
+
--
type: integer
State type before check execution
--
*`icinga.comment.__name`*::
+
--
type: text
Unique identifier of a comment
--
*`icinga.comment.author`*::
+
--
type: keyword
Author of a comment
--
*`icinga.comment.entry_time`*::
+
--
type: date
Entry time of a comment
--
*`icinga.comment.entry_type`*::
+
--
type: integer
Entry type of a comment
--
*`icinga.comment.expire_time`*::
+
--
type: date
Expire time of a comment
--
*`icinga.comment.host_name`*::
+
--
type: keyword
Host name of a comment
--
*`icinga.comment.legacy_id`*::
+
--
type: integer
Legacy ID of a comment
--
*`icinga.comment.name`*::
+
--
type: keyword
Identifier of a comment
--
*`icinga.comment.package`*::
+
--
type: keyword
Config package of a comment
--
*`icinga.comment.service_name`*::
+
--
type: keyword
Service name of a comment
--
*`icinga.comment.templates`*::
+
--
type: text
Templates used by a comment
--
*`icinga.comment.text`*::
+
--
type: text
Text of a comment
--
*`icinga.comment.type`*::
+
--
type: keyword
Comment type
--
*`icinga.comment.version`*::
+
--
type: keyword
Config version of comment object
--
*`icinga.comment.zone`*::
+
--
type: keyword
Zone where comment was generated
--
*`icinga.downtime.__name`*::
+
--
type: text
Unique identifier of a downtime
--
*`icinga.downtime.author`*::
+
--
type: keyword
Author of a downtime
--
*`icinga.downtime.comment`*::
+
--
type: text
Text of a downtime
--
*`icinga.downtime.config_owner`*::
+
--
type: text
Config owner
--
*`icinga.downtime.duration`*::
+
--
type: integer
Duration of a downtime
--
*`icinga.downtime.end_time`*::
+
--
type: date
Timestamp of downtime end
--
*`icinga.downtime.entry_time`*::
+
--
type: date
Timestamp when downtime was created
--
*`icinga.downtime.fixed`*::
+
--
type: boolean
If downtime is fixed or flexible
--
*`icinga.downtime.host_name`*::
+
--
type: keyword
Hostname of a downtime
--
*`icinga.downtime.legacy_id`*::
+
--
type: integer
The integer ID of a downtime
--
*`icinga.downtime.name`*::
+
--
type: keyword
Downtime config identifier
--
*`icinga.downtime.package`*::
+
--
type: keyword
Configuration package of downtime
--
*`icinga.downtime.scheduled_by`*::
+
--
type: text
By whom downtime was scheduled
--
*`icinga.downtime.service_name`*::
+
--
type: keyword
Service name of a downtime
--
*`icinga.downtime.start_time`*::
+
--
type: date
Timestamp when downtime starts
--
*`icinga.downtime.templates`*::
+
--
type: text
Templates used by this downtime
--
*`icinga.downtime.trigger_time`*::
+
--
type: date
Timestamp when downtime was triggered
--
*`icinga.downtime.triggered_by`*::
+
--
type: text
By whom downtime was triggered
--
*`icinga.downtime.triggers`*::
+
--
type: text
Downtime triggers
--
*`icinga.downtime.type`*::
+
--
type: keyword
Downtime type
--
*`icinga.downtime.version`*::
+
--
type: keyword
Config version of downtime
--
*`icinga.downtime.was_cancelled`*::
+
--
type: boolean
If downtime was cancelled
--
*`icinga.downtime.zone`*::
+
--
type: keyword
Zone of downtime
--
*`icinga.status.active_host_checks`*::
+
--
type: integer
Active host checks
--
*`icinga.status.active_host_checks_15min`*::
+
--
type: integer
Active host checks in the last 15 minutes
--
*`icinga.status.active_host_checks_1min`*::
+
--
type: integer
Acitve host checks in the last minute
--
*`icinga.status.active_host_checks_5min`*::
+
--
type: integer
Active host checks in the last 5 minutes
--
*`icinga.status.active_service_checks`*::
+
--
type: integer
Active service checks
--
*`icinga.status.active_service_checks_15min`*::
+
--
type: integer
Active service checks in the last 15 minutes
--
*`icinga.status.active_service_checks_1min`*::
+
--
type: integer
Active service checks in the last minute
--
*`icinga.status.active_service_checks_5min`*::
+
--
type: integer
Active service checks in the last 5 minutes
--
*`icinga.status.api.identity`*::
+
--
type: keyword
API identity
--
*`icinga.status.api.num_conn_endpoints`*::
+
--
type: integer
Number of connected endpoints
--
*`icinga.status.api.num_endpoints`*::
+
--
type: integer
Total number of endpoints
--
*`icinga.status.api.num_not_conn_endpoints`*::
+
--
type: integer
Number of not connected endpoints
--
*`icinga.status.avg_execution_time`*::
+
--
type: integer
Average execution time of checks
--
*`icinga.status.avg_latency`*::
+
--
type: integer
Average latency time
--
*`icinga.status.checkercomponent.checker.idle`*::
+
--
type: integer
Idle checks
--
*`icinga.status.checkercomponent.checker.pending`*::
+
--
type: integer
Pending checks
--
*`icinga.status.filelogger.main-log`*::
+
--
type: integer
Mainlog enabled
--
*`icinga.status.icingaapplication.app.enable_event_handlers`*::
+
--
type: boolean
Event handlers enabled
--
*`icinga.status.icingaapplication.app.enable_flapping`*::
+
--
type: boolean
Flapping detection enabled
--
*`icinga.status.icingaapplication.app.enable_host_checks`*::
+
--
type: boolean
Host checks enabled
--
*`icinga.status.icingaapplication.app.enable_notifications`*::
+
--
type: boolean
Notifications enabled
--
*`icinga.status.icingaapplication.app.enable_perfdata`*::
+
--
type: boolean
Perfdata enabled
--
*`icinga.status.icingaapplication.app.enable_service_checks`*::
+
--
type: boolean
Service checks enabled
--
*`icinga.status.icingaapplication.app.node_name`*::
+
--
type: keyword
Node name
--
*`icinga.status.icingaapplication.app.pid`*::
+
--
type: integer
PID
--
*`icinga.status.icingaapplication.app.program_start`*::
+
--
type: integer
Time when Icinga started
--
*`icinga.status.icingaapplication.app.version`*::
+
--
type: keyword
Version
--
*`icinga.status.idomysqlconnection.ido-mysql.connected`*::
+
--
type: boolean
IDO connected
--
*`icinga.status.idomysqlconnection.ido-mysql.instance_name`*::
+
--
type: keyword
IDO Instance name
--
*`icinga.status.idomysqlconnection.ido-mysql.query_queue_items`*::
+
--
type: integer
IDO query items in the queue
--
*`icinga.status.idomysqlconnection.ido-mysql.version`*::
+
--
type: keyword
IDO schema version
--
*`icinga.status.max_execution_time`*::
+
--
type: integer
Max execution time
--
*`icinga.status.max_latency`*::
+
--
type: integer
Max latency
--
*`icinga.status.min_execution_time`*::
+
--
type: integer
Min execution time
--
*`icinga.status.min_latency`*::
+
--
type: integer
Min latency
--
*`icinga.status.notificationcomponent.notification`*::
+
--
type: integer
Notification
--
*`icinga.status.num_hosts_acknowledged`*::
+
--
type: integer
Amount of acknowledged hosts
--
*`icinga.status.num_hosts_down`*::
+
--
type: integer
Amount of down hosts
--
*`icinga.status.num_hosts_flapping`*::
+
--
type: integer
Amount of flapping hosts
--
*`icinga.status.num_hosts_in_downtime`*::
+
--
type: integer
Amount of hosts in downtime
--
*`icinga.status.num_hosts_pending`*::
+
--
type: integer
Amount of pending hosts
--
*`icinga.status.num_hosts_unreachable`*::
+
--
type: integer
Amount of unreachable hosts
--
*`icinga.status.num_hosts_up`*::
+
--
type: integer
Amount of hosts in up state
--
*`icinga.status.num_services_acknowledged`*::
+
--
type: integer
Amount of acknowledged services
--
*`icinga.status.num_services_critical`*::
+
--
type: integer
Amount of critical services
--
*`icinga.status.num_services_flapping`*::
+
--
type: integer
Amount of flapping services
--
*`icinga.status.num_services_in_downtime`*::
+
--
type: integer
Amount of services in downtime
--
*`icinga.status.num_services_ok`*::
+
--
type: integer
Amount of services in ok state
--
*`icinga.status.num_services_pending`*::
+
--
type: integer
Amount of pending services
--
*`icinga.status.num_services_unknown`*::
+
--
type: integer
Amount of unknown services
--
*`icinga.status.num_services_unreachable`*::
+
--
type: integer
Amount of unreachable services
--
*`icinga.status.num_services_warning`*::
+
--
type: integer
Amount of services in warning state
--
*`icinga.status.passive_host_checks`*::
+
--
type: integer
Amount of passive host checks
--
*`icinga.status.passive_host_checks_15min`*::
+
--
type: integer
Amount of passive host checks in the last 15 minutes
--
*`icinga.status.passive_host_checks_1min`*::
+
--
type: integer
Amount of passive host checks in the last minute
--
*`icinga.status.passive_host_checks_5min`*::
+
--
type: integer
Amount of passive host checks in the last 5 minutes
--
*`icinga.status.passive_service_checks`*::
+
--
type: integer
Amount of passive service checks
--
*`icinga.status.passive_service_checks_15min`*::
+
--
type: integer
Amount of passive service checks in the last 15 minutes
--
*`icinga.status.passive_service_checks_1min`*::
+
--
type: integer
Amount of passive service checks in the last minute
--
*`icinga.status.passive_service_checks_5min`*::
+
--
type: integer
Amount of passive service checks in the last 5 minutes
--
*`icinga.status.uptime`*::
+
--
type: integer
Uptime
--
[[exported-fields-kubernetes-processor]]
== Kubernetes fields
Kubernetes metadata added by the kubernetes processor
*`kubernetes.pod.name`*::
+
--
type: keyword
Kubernetes pod name
--
*`kubernetes.pod.uid`*::
+
--
type: keyword
Kubernetes Pod UID
--
*`kubernetes.namespace`*::
+
--
type: keyword
Kubernetes namespace
--
*`kubernetes.node.name`*::
+
--
type: keyword
Kubernetes node name
--
*`kubernetes.labels`*::
+
--
type: object
Kubernetes labels map
--
*`kubernetes.annotations`*::
+
--
type: object
Kubernetes annotations map
--
*`kubernetes.container.name`*::
+
--
type: keyword
Kubernetes container name
--
*`kubernetes.container.image`*::
+
--
type: keyword
Kubernetes container image
--