Skip to content

Commit 5a0f322

Browse files
committed
Document the event truncation settings
CT-594
1 parent 633a54e commit 5a0f322

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

lib/logstash/outputs/scalyr.rb

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,11 @@ class LogStash::Outputs::Scalyr < LogStash::Outputs::Base
200200
# for large batches, it may make sense to disable this option when logstash batch size is configured in a way that
201201
# Scalyr single request limit won't be reached.
202202
config :estimate_each_event_size, :validate => :boolean, :default => true
203-
# TODO: document
203+
# The following settings tune event truncation, which will truncate the
204+
# message field to below `max_field_size_bytes`, drop any other field that
205+
# exceeds `max_field_size_bytes`, and drop enough fields to ensure the record
206+
# does not exceed `max_record_size_bytes`. This feature is only active when
207+
# `estimate_each_event_size` is enabled.
204208
config :max_record_size_bytes, :validate => :number, :default => 200 * 1024
205209
config :max_field_size_bytes, :validate => :number, :default => 50 * 1024
206210

0 commit comments

Comments
 (0)