schemas/v1/heartbeat/heartbeat.yaml (97 lines of code) (raw):
'@timestamp':
dashed_name: timestamp
description: 'Date/time when the event originated.
This is the date/time extracted from the event, typically representing when the
event was generated by the source.
If the event source has no original timestamp, this value is typically populated
by the first time the event was received by the pipeline.
Required field for all events.'
example: '2016-05-23T08:05:34.853Z'
flat_name: '@timestamp'
level: core
name: '@timestamp'
normalize: []
required: true
short: Date/time when the event originated.
type: date
agent.id:
dashed_name: agent-id
description: 'Unique identifier of this agent (if one exists).
Example: For Beats this would be beat.id.'
example: 8a4f500d
flat_name: agent.id
ignore_above: 1024
level: core
name: id
normalize: []
short: Unique identifier of this agent.
type: keyword
billable:
dashed_name: billable
description: Whether document should be included in billing calculations
flat_name: billable
level: custom
name: billable
normalize: []
short: billable
type: boolean
data_stream.dataset:
dashed_name: data-stream-dataset
description: Data stream dataset name.
example: nginx.access
flat_name: data_stream.dataset
level: custom
name: dataset
normalize: []
short: The field can contain anything that makes sense to signify the source of
the data.
type: constant_keyword
data_stream.namespace:
dashed_name: data-stream-namespace
description: Data stream namespace.
example: production
flat_name: data_stream.namespace
level: custom
name: namespace
normalize: []
short: A user defined namespace. Namespaces are useful to allow grouping of data.
type: constant_keyword
data_stream.type:
dashed_name: data-stream-type
description: Data stream type.
example: logs
flat_name: data_stream.type
level: custom
name: type
normalize: []
short: An overarching type for the data stream.
type: constant_keyword
event.ingested:
dashed_name: event-ingested
description: 'Timestamp when an event arrived in the central data store.
This is different from `@timestamp`, which is when the event originally occurred. It''s
also different from `event.created`, which is meant to capture the first time
an agent saw the event.
In normal conditions, assuming no tampering, the timestamps should chronologically
look like this: `@timestamp` < `event.created` < `event.ingested`.'
example: '2016-05-23T08:05:35.101Z'
flat_name: event.ingested
level: core
name: ingested
normalize: []
short: Timestamp when an event arrived in the central data store.
type: date
message:
dashed_name: message
description: 'For log events the message field contains the log message, optimized
for viewing in a log viewer.
For structured logs without an original message field, other fields can be concatenated
to form a human-readable summary of the event.
If multiple messages exist, they can be combined into one message.'
example: Hello World
flat_name: message
level: core
name: message
normalize: []
short: Log message optimized for viewing in a log viewer.
type: match_only_text