Skip to content

Latest commit

 

History

History
109 lines (82 loc) · 3.48 KB

input-common-options.asciidoc

File metadata and controls

109 lines (82 loc) · 3.48 KB

Common options

The following configuration options are supported by all inputs.

enabled

Use the enabled option to enable and disable inputs. By default, enabled is set to true.

tags

A list of tags that {beatname_uc} includes in the tags field of each published event. Tags make it easy to select specific events in Kibana or apply conditional filtering in Logstash. These tags will be appended to the list of tags specified in the general configuration.

Example:

{beatname_lc}.inputs:
- type: {type}
  . . .
  tags: ["json"]
fields

Optional fields that you can specify to add additional information to the output. For example, you might add fields that you can use for filtering log data. Fields can be scalar values, arrays, dictionaries, or any nested combination of these. By default, the fields that you specify here will be grouped under a fields sub-dictionary in the output document. To store the custom fields as top-level fields, set the fields_under_root option to true. If a duplicate field is declared in the general configuration, then its value will be overwritten by the value declared here.

{beatname_lc}.inputs:
- type: {type}
  . . .
  fields:
    app_id: query_engine_12
fields_under_root

If this option is set to true, the custom fields are stored as top-level fields in the output document instead of being grouped under a fields sub-dictionary. If the custom field names conflict with other field names added by {beatname_uc}, then the custom fields overwrite the other fields.

processors

A list of processors to apply to the input data.

See [filtering-and-enhancing-data] for information about specifying processors in your config.

pipeline

The ingest pipeline ID to set for the events generated by this input.

Note
 The pipeline ID can also be configured in the Elasticsearch output, but this option usually results in simpler configuration files. If the pipeline is configured both in the input and output, the option from the input is used.
keep_null

If this option is set to true, fields with null values will be published in the output document. By default, keep_null is set to false.

index

If present, this formatted string overrides the index for events from this input (for elasticsearch outputs), or sets the raw_index field of the event’s metadata (for other outputs). This string can only refer to the agent name and version and the event timestamp; for access to dynamic fields, use output.elasticsearch.index or a processor.

Example value: "%{[agent.name]}-myindex-%{+yyyy.MM.dd}" might expand to "filebeat-myindex-2019.11.01".

publisher_pipeline.disable_host

By default, all events contain host.name. This option can be set to true to disable the addition of this field to all events. The default value is false.