
////
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-icingabeat>>
* <<exported-fields-kubernetes-processor>>

--
[[exported-fields-beat]]
== Beat fields

Contains common beat fields available in all event types.



[float]
=== `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.


[float]
=== `beat.hostname`

The hostname as returned by the operating system on which the Beat is running.


[float]
=== `beat.timezone`

The timezone as returned by the operating system on which the Beat is running.


[float]
=== `beat.version`

The version of the beat that generated this event.


[float]
=== `@timestamp`

type: date

example: August 26th 2016, 12:35:53.332

format: date

required: True

The timestamp when the event log record was generated.


[float]
=== `tags`

Arbitrary tags that can be set per Beat and per transaction type.


[float]
=== `fields`

type: object

Contains user configurable fields.


[float]
== error fields

Error fields containing additional info in case of errors.



[float]
=== `error.message`

type: text

Error message.


[float]
=== `error.code`

type: long

Error code.


[float]
=== `error.type`

type: keyword

Error type.


[[exported-fields-cloud]]
== Cloud provider metadata fields

Metadata from cloud providers added by the add_cloud_metadata processor.



[float]
=== `meta.cloud.provider`

example: ec2

Name of the cloud provider. Possible values are ec2, gce, or digitalocean.


[float]
=== `meta.cloud.instance_id`

Instance ID of the host machine.


[float]
=== `meta.cloud.instance_name`

Instance name of the host machine.


[float]
=== `meta.cloud.machine_type`

example: t2.medium

Machine type of the host machine.


[float]
=== `meta.cloud.availability_zone`

example: us-east-1c

Availability zone in which this host is running.


[float]
=== `meta.cloud.project_id`

example: project-x

Name of the project in Google Cloud.


[float]
=== `meta.cloud.region`

Region in which this host is running.


[[exported-fields-docker-processor]]
== Docker fields

beta[]
Docker stats collected from Docker.




[float]
=== `docker.container.id`

type: keyword

Unique container id.


[float]
=== `docker.container.image`

type: keyword

Name of the image the container was built on.


[float]
=== `docker.container.name`

type: keyword

Container name.


[float]
=== `docker.container.labels`

type: object

Image labels.


[[exported-fields-icingabeat]]
== icingabeat fields

Data received from the Icinga 2 API


[float]
=== `timestamp`

type: date

Timestamp of event occurrence


[float]
=== `type`

type: keyword

Type of the document


[float]
=== `host`

type: keyword

Host that triggered the event


[float]
=== `service`

type: keyword

Service that triggered the event


[float]
=== `state`

type: integer

State of the check


[float]
=== `state_type`

type: integer

State type of the check


[float]
=== `author`

type: keyword

Author of a message


[float]
=== `notification_type`

type: keyword

Type of notification


[float]
=== `text`

type: text

Text of a message


[float]
=== `users`

type: text

Affected users of a notification


[float]
=== `acknowledgement_type`

type: integer

Type of an acknowledgement


[float]
=== `expiry`

type: date

Expiry of an acknowledgement


[float]
=== `notify`

type: keyword

If has been sent out


[float]
=== `check_result.active`

type: boolean

If check was active or passive


[float]
=== `check_result.check_source`

type: keyword

Icinga instance that scheduled the check


[float]
=== `check_result.command`

type: text

Command that was executed


[float]
=== `check_result.execution_end`

type: date

Time when execution of check ended


[float]
=== `check_result.execution_start`

type: date

Time when execution of check started


[float]
=== `check_result.exit_status`

type: integer

Exit status


[float]
=== `check_result.output`

type: text

Output of check


[float]
=== `check_result.performance_data`

type: text

Performance data in text format


[float]
=== `check_result.schedule_end`

type: date

Time when scheduling of the check ended


[float]
=== `check_result.schedule_start`

type: date

Time when check was scheduled


[float]
=== `check_result.state`

type: integer

State of the check


[float]
=== `check_result.type`

type: keyword

Type of this event


[float]
=== `check_result.vars_after.attempt`

type: integer

Check attempt after check execution


[float]
=== `check_result.vars_after.reachable`

type: boolean

Reachable state after check execution


[float]
=== `check_result.vars_after.state`

type: integer

State of the check after execution


[float]
=== `check_result.vars_after.state_type`

type: integer

State type after execution


[float]
=== `check_result.vars_before.attempt`

type: integer

Check attempt before check execution


[float]
=== `check_result.vars_before.reachable`

type: boolean

Reachable state before check execution


[float]
=== `check_result.vars_before.state`

type: integer

Check state before check execution


[float]
=== `check_result.vars_before.state_type`

type: integer

State type before check execution


[float]
=== `comment.__name`

type: text

Unique identifier of a comment


[float]
=== `comment.author`

type: keyword

Author of a comment


[float]
=== `comment.entry_time`

type: date

Entry time of a comment


[float]
=== `comment.entry_type`

type: integer

Entry type of a comment


[float]
=== `comment.expire_time`

type: date

Expire time of a comment


[float]
=== `comment.host_name`

type: keyword

Host name of a comment


[float]
=== `comment.legacy_id`

type: integer

Legacy ID of a comment


[float]
=== `comment.name`

type: keyword

Identifier of a comment


[float]
=== `comment.package`

type: keyword

Config package of a comment


[float]
=== `comment.service_name`

type: keyword

Service name of a comment


[float]
=== `comment.templates`

type: text

Templates used by a comment


[float]
=== `comment.text`

type: text

Text of a comment


[float]
=== `comment.type`

type: keyword

Comment type


[float]
=== `comment.version`

type: keyword

Config version of comment object


[float]
=== `comment.zone`

type: keyword

Zone where comment was generated


[float]
=== `downtime.__name`

type: text

Unique identifier of a downtime


[float]
=== `downtime.author`

type: keyword

Author of a downtime


[float]
=== `downtime.comment`

type: text

Text of a downtime


[float]
=== `downtime.config_owner`

type: text

Config owner


[float]
=== `downtime.duration`

type: integer

Duration of a downtime


[float]
=== `downtime.end_time`

type: date

Timestamp of downtime end


[float]
=== `downtime.entry_time`

type: date

Timestamp when downtime was created


[float]
=== `downtime.fixed`

type: boolean

If downtime is fixed or flexible


[float]
=== `downtime.host_name`

type: keyword

Hostname of a downtime


[float]
=== `downtime.legacy_id`

type: integer

The integer ID of a downtime


[float]
=== `downtime.name`

type: keyword

Downtime config identifier


[float]
=== `downtime.package`

type: keyword

Configuration package of downtime


[float]
=== `downtime.scheduled_by`

type: text

By whom downtime was scheduled


[float]
=== `downtime.service_name`

type: keyword

Service name of a downtime


[float]
=== `downtime.start_time`

type: date

Timestamp when downtime starts


[float]
=== `downtime.templates`

type: text

Templates used by this downtime


[float]
=== `downtime.trigger_time`

type: date

Timestamp when downtime was triggered


[float]
=== `downtime.triggered_by`

type: text

By whom downtime was triggered


[float]
=== `downtime.triggers`

type: text

Downtime triggers


[float]
=== `downtime.type`

type: keyword

Downtime type


[float]
=== `downtime.version`

type: keyword

Config version of downtime


[float]
=== `downtime.was_cancelled`

type: boolean

If downtime was cancelled


[float]
=== `downtime.zone`

type: keyword

Zone of downtime


[float]
=== `status.active_host_checks`

type: integer

Active host checks


[float]
=== `status.active_host_checks_15min`

type: integer

Active host checks in the last 15 minutes


[float]
=== `status.active_host_checks_1min`

type: integer

Acitve host checks in the last minute


[float]
=== `status.active_host_checks_5min`

type: integer

Active host checks in the last 5 minutes


[float]
=== `status.active_service_checks`

type: integer

Active service checks


[float]
=== `status.active_service_checks_15min`

type: integer

Active service checks in the last 15 minutes


[float]
=== `status.active_service_checks_1min`

type: integer

Active service checks in the last minute


[float]
=== `status.active_service_checks_5min`

type: integer

Active service checks in the last 5 minutes


[float]
=== `status.api.identity`

type: keyword

API identity


[float]
=== `status.api.num_conn_endpoints`

type: integer

Number of connected endpoints


[float]
=== `status.api.num_endpoints`

type: integer

Total number of endpoints


[float]
=== `status.api.num_not_conn_endpoints`

type: integer

Number of not connected endpoints


[float]
=== `status.api.zones.demo.client_log_lag`

type: integer

Lag of the replaylog


[float]
=== `status.api.zones.demo.connected`

type: boolean

Zone connected


[float]
=== `status.api.zones.demo.endpoints`

type: text

Endpoint names


[float]
=== `status.api.zones.demo.parent_zone`

type: keyword

Parent zone


[float]
=== `status.avg_execution_time`

type: integer

Average execution time of checks


[float]
=== `status.avg_latency`

type: integer

Average latency time


[float]
=== `status.checkercomponent.checker.idle`

type: integer

Idle checks


[float]
=== `status.checkercomponent.checker.pending`

type: integer

Pending checks


[float]
=== `status.filelogger.main-log`

type: integer

Mainlog enabled


[float]
=== `status.icingaapplication.app.enable_event_handlers`

type: boolean

Event handlers enabled


[float]
=== `status.icingaapplication.app.enable_flapping`

type: boolean

Flapping detection enabled


[float]
=== `status.icingaapplication.app.enable_host_checks`

type: boolean

Host checks enabled


[float]
=== `status.icingaapplication.app.enable_notifications`

type: boolean

Notifications enabled


[float]
=== `status.icingaapplication.app.enable_perfdata`

type: boolean

Perfdata enabled


[float]
=== `status.icingaapplication.app.enable_service_checks`

type: boolean

Service checks enabled


[float]
=== `status.icingaapplication.app.node_name`

type: keyword

Node name


[float]
=== `status.icingaapplication.app.pid`

type: integer

PID


[float]
=== `status.icingaapplication.app.program_start`

type: integer

Time when Icinga started


[float]
=== `status.icingaapplication.app.version`

type: keyword

Version


[float]
=== `status.idomysqlconnection.ido-mysql.connected`

type: boolean

IDO connected


[float]
=== `status.idomysqlconnection.ido-mysql.instance_name`

type: keyword

IDO Instance name


[float]
=== `status.idomysqlconnection.ido-mysql.query_queue_items`

type: integer

IDO query items in the queue


[float]
=== `status.idomysqlconnection.ido-mysql.version`

type: keyword

IDO schema version


[float]
=== `status.max_execution_time`

type: integer

Max execution time


[float]
=== `status.max_latency`

type: integer

Max latency


[float]
=== `status.min_execution_time`

type: integer

Min execution time


[float]
=== `status.min_latency`

type: integer

Min latency


[float]
=== `status.notificationcomponent.notification`

type: integer

Notification


[float]
=== `status.num_hosts_acknowledged`

type: integer

Amount of acknowledged hosts


[float]
=== `status.num_hosts_down`

type: integer

Amount of down hosts


[float]
=== `status.num_hosts_flapping`

type: integer

Amount of flapping hosts


[float]
=== `status.num_hosts_in_downtime`

type: integer

Amount of hosts in downtime


[float]
=== `status.num_hosts_pending`

type: integer

Amount of pending hosts


[float]
=== `status.num_hosts_unreachable`

type: integer

Amount of unreachable hosts


[float]
=== `status.num_hosts_up`

type: integer

Amount of hosts in up state


[float]
=== `status.num_services_acknowledged`

type: integer

Amount of acknowledged services


[float]
=== `status.num_services_critical`

type: integer

Amount of critical services


[float]
=== `status.num_services_flapping`

type: integer

Amount of flapping services


[float]
=== `status.num_services_in_downtime`

type: integer

Amount of services in downtime


[float]
=== `status.num_services_ok`

type: integer

Amount of services in ok state


[float]
=== `status.num_services_pending`

type: integer

Amount of pending services


[float]
=== `status.num_services_unknown`

type: integer

Amount of unknown services


[float]
=== `status.num_services_unreachable`

type: integer

Amount of unreachable services


[float]
=== `status.num_services_warning`

type: integer

Amount of services in warning state


[float]
=== `status.passive_host_checks`

type: integer

Amount of passive host checks


[float]
=== `status.passive_host_checks_15min`

type: integer

Amount of passive host checks in the last 15 minutes


[float]
=== `status.passive_host_checks_1min`

type: integer

Amount of passive host checks in the last minute


[float]
=== `status.passive_host_checks_5min`

type: integer

Amount of passive host checks in the last 5 minutes


[float]
=== `status.passive_service_checks`

type: integer

Amount of passive service checks


[float]
=== `status.passive_service_checks_15min`

type: integer

Amount of passive service checks in the last 15 minutes


[float]
=== `status.passive_service_checks_1min`

type: integer

Amount of passive service checks in the last minute


[float]
=== `status.passive_service_checks_5min`

type: integer

Amount of passive service checks in the last 5 minutes


[float]
=== `status.uptime`

type: integer

Uptime


[[exported-fields-kubernetes-processor]]
== Kubernetes fields

beta[]
Kubernetes metadata added by the kubernetes processor




[float]
=== `kubernetes.pod.name`

type: keyword

Kubernetes pod name


[float]
=== `kubernetes.namespace`

type: keyword

Kubernetes namespace


[float]
=== `kubernetes.labels`

type: object

Kubernetes labels map


[float]
=== `kubernetes.annotations`

type: object

Kubernetes annotations map


[float]
=== `kubernetes.container.name`

type: keyword

Kubernetes container name


[float]
=== `kubernetes.container.image`

type: keyword

Kubernetes container image


