Module: LogStash::Outputs::ElasticSearch::DataStreamSupport

Included in:
LogStash::Outputs::ElasticSearch
Defined in:
lib/logstash/outputs/elasticsearch/data_stream_support.rb

Overview

DS specific behavior/configuration.

Defined Under Namespace

Modules: Validator

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# File 'lib/logstash/outputs/elasticsearch/data_stream_support.rb', line 14

def self.included(base)
  # Defines whether data will be indexed into an Elasticsearch data stream,
  # `data_stream_*` settings will only be used if this setting is enabled!
  # This setting supports values `true`, `false`, and `auto`.
  # Defaults to `false` in Logstash 7.x and `auto` starting in Logstash 8.0.
  base.config :data_stream, :validate => ['true', 'false', 'auto']

  base.config :data_stream_type, :validate => ['logs', 'metrics', 'synthetics', 'traces'], :default => 'logs'
  base.config :data_stream_dataset, :validate => :dataset_identifier, :default => 'generic'
  base.config :data_stream_namespace, :validate => :namespace_identifier, :default => 'default'

  base.config :data_stream_sync_fields, :validate => :boolean, :default => true
  base.config :data_stream_auto_routing, :validate => :boolean, :default => true

  base.extend(Validator)
end

Instance Method Details

#data_stream_config?Boolean

Returns:

  • (Boolean)


31
32
33
# File 'lib/logstash/outputs/elasticsearch/data_stream_support.rb', line 31

def data_stream_config?
  @data_stream_config.nil? ? @data_stream_config = check_data_stream_config! : @data_stream_config
end