Class: Fluent::Plugin::StdoutOutput

Inherits:
Output show all
Defined in:
lib/fluent/plugin/out_stdout.rb

Constant Summary collapse

DEFAULT_LINE_FORMAT_TYPE = 
'stdout'
DEFAULT_FORMAT_TYPE = 
'json'

Constants inherited from Output

Output::BUFFER_STATS_KEYS, Output::CHUNKING_FIELD_WARN_NUM, Output::CHUNK_ID_PLACEHOLDER_PATTERN, Output::CHUNK_KEY_PATTERN, Output::CHUNK_KEY_PLACEHOLDER_PATTERN, Output::CHUNK_TAG_PLACEHOLDER_PATTERN, Output::FORMAT_COMPRESSED_MSGPACK_STREAM, Output::FORMAT_COMPRESSED_MSGPACK_STREAM_TIME_INT, Output::FORMAT_MSGPACK_STREAM, Output::FORMAT_MSGPACK_STREAM_TIME_INT, Output::TIMESTAMP_CHECK_BASE_TIME, Output::TIME_KEY_PLACEHOLDER_THRESHOLDS, Output::UNRECOVERABLE_ERRORS

Constants included from Configurable

Configurable::CONFIG_TYPE_REGISTRY

Instance Attribute Summary collapse

Attributes inherited from Output

#as_secondary, #buffer, #chunk_key_accessors, #chunk_key_tag, #chunk_key_time, #chunk_keys, #delayed_commit, #delayed_commit_timeout, #dequeued_chunks, #dequeued_chunks_mutex, #output_enqueue_thread_waiting, #retry, #retry_for_error_chunk, #secondary, #timekey_zone

Attributes included from Fluent::PluginLoggerMixin

#log

Attributes inherited from Base

#under_plugin_development

Instance Method Summary collapse

Methods inherited from Output

#acts_as_secondary, #actual_flush_thread_count, #after_shutdown, #after_start, #backup_chunk, #before_shutdown, #calculate_timekey, #check_slow_flush, #chunk_for_test, #close, #commit_write, #emit_buffered, #emit_count, #emit_events, #emit_records, #emit_size, #emit_sync, #enqueue_thread_run, #enqueue_thread_wait, #execute_chunking, #extract_placeholders, #flush_thread_run, #flush_thread_wakeup, #force_flush, #formatted_to_msgpack_binary, #formatted_to_msgpack_binary?, #generate_format_proc, #get_placeholders_keys, #get_placeholders_tag, #get_placeholders_time, #handle_limit_reached, #handle_stream_simple, #handle_stream_with_custom_format, #handle_stream_with_standard_format, #implement?, #initialize, #interrupt_flushes, #keep_buffer_config_compat, #log_retry_error, #metadata, #next_flush_time, #num_errors, #placeholder_validate!, #placeholder_validators, #prefer_delayed_commit, #retry_state, #rollback_count, #rollback_write, #shutdown, #start, #statistics, #stop, #submit_flush_all, #submit_flush_once, #support_in_v12_style?, #synchronize_in_threads, #synchronize_path, #synchronize_path_in_workers, #terminate, #try_flush, #try_rollback_all, #try_rollback_write, #try_write, #update_retry_state, #write_count, #write_guard

Methods included from UniqueId::Mixin

#dump_unique_id_hex, #generate_unique_id

Methods included from Fluent::PluginHelper::Mixin

included

Methods included from Fluent::PluginLoggerMixin

included, #initialize, #terminate

Methods included from Fluent::PluginId

#initialize, #plugin_id, #plugin_id_configured?, #plugin_id_for_test?, #plugin_root_dir, #stop

Methods inherited from Base

#acquire_worker_lock, #after_shutdown, #after_shutdown?, #after_start, #after_started?, #before_shutdown, #before_shutdown?, #called_in_test?, #close, #closed?, #configured?, #context_router, #context_router=, #fluentd_worker_id, #get_lock_path, #has_router?, #initialize, #inspect, #plugin_root_dir, #reloadable_plugin?, #shutdown, #shutdown?, #start, #started?, #stop, #stopped?, #string_safe_encoding, #terminate, #terminated?

Methods included from SystemConfig::Mixin

#system_config, #system_config_override

Methods included from Configurable

#config, #configure_proxy_generate, #configured_section_create, included, #initialize, lookup_type, register_type

Constructor Details

This class inherits a constructor from Fluent::Plugin::Output

Instance Attribute Details

#formatter ⇒ Object

Returns the value of attribute formatter.



47
48
49
 
# File 'lib/fluent/plugin/out_stdout.rb', line 47

def formatter
  @formatter
end

Instance Method Details

#configure(conf) ⇒ Object 



49
50
51
52
53
54
55
 
# File 'lib/fluent/plugin/out_stdout.rb', line 49

def configure(conf)
  compat_parameters_convert(conf, :inject, :formatter)

  super

  @formatter = formatter_create
end

#format(tag, time, record) ⇒ Object 



65
66
67
68
 
# File 'lib/fluent/plugin/out_stdout.rb', line 65

def format(tag, time, record)
  record = inject_values_to_record(tag, time, record)
  @formatter.format(tag, time, record).chomp + "\n"
end

#multi_workers_ready? ⇒ Boolean

Returns:

  • (Boolean) 


43
44
45
 
# File 'lib/fluent/plugin/out_stdout.rb', line 43

def multi_workers_ready?
  true
end

#prefer_buffered_processing ⇒ Object 



39
40
41
 
# File 'lib/fluent/plugin/out_stdout.rb', line 39

def prefer_buffered_processing
  false
end

#process(tag, es) ⇒ Object 



57
58
59
60
61
62
63
 
# File 'lib/fluent/plugin/out_stdout.rb', line 57

def process(tag, es)
  es = inject_values_to_event_stream(tag, es)
  es.each {|time,record|
    $log.write(format(tag, time, record))
  }
  $log.flush
end

#write(chunk) ⇒ Object 



70
71
72
 
# File 'lib/fluent/plugin/out_stdout.rb', line 70

def write(chunk)
  chunk.write_to($log)
end