481 lines
4.6 KiB
Text
481 lines
4.6 KiB
Text
|
|
////
|
|
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 youtubebeat. They are
|
|
grouped in the following categories:
|
|
|
|
* <<exported-fields-beat>>
|
|
* <<exported-fields-cloud>>
|
|
* <<exported-fields-docker-processor>>
|
|
* <<exported-fields-host-processor>>
|
|
* <<exported-fields-kubernetes-processor>>
|
|
* <<exported-fields-youtubebeat>>
|
|
|
|
--
|
|
[[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-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
|
|
|
|
|
|
--
|
|
|
|
[[exported-fields-youtubebeat]]
|
|
== youtubebeat fields
|
|
|
|
None
|
|
|
|
|
|
*`url`*::
|
|
+
|
|
--
|
|
type: string
|
|
|
|
required: True
|
|
|
|
Video's full URL
|
|
|
|
|
|
--
|
|
|
|
*`title`*::
|
|
+
|
|
--
|
|
type: string
|
|
|
|
required: True
|
|
|
|
Video title
|
|
|
|
|
|
--
|
|
|
|
*`views`*::
|
|
+
|
|
--
|
|
type: long
|
|
|
|
required: True
|
|
|
|
Video's view count
|
|
|
|
|
|
--
|
|
|
|
*`date`*::
|
|
+
|
|
--
|
|
type: string
|
|
|
|
required: True
|
|
|
|
Video's publish date
|
|
|
|
|
|
--
|
|
|