From 5962b84f99dd37dfa1dcc6cef94430fa7626e762 Mon Sep 17 00:00:00 2001 From: Holger Just Date: Wed, 24 Jan 2018 15:10:45 +0100 Subject: [PATCH] Reference the JSON Lines standard in Encoder::JSON documentation --- lib/rackstash/encoder/json.rb | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/lib/rackstash/encoder/json.rb b/lib/rackstash/encoder/json.rb index 6beaaa7..24b877b 100644 --- a/lib/rackstash/encoder/json.rb +++ b/lib/rackstash/encoder/json.rb @@ -14,9 +14,13 @@ require 'rackstash/encoder/helper/timestamp' module Rackstash module Encoder # The JSON encoder formats the log event as a single-line JSON string. The - # resulting JSON string contains all data exposed by the buffer. + # resulting JSON string contains all data exposed by the buffer. With a + # suitable adapter (like {Adapter::File} or {Adapter::TCP}), you can use + # this encoder to write logs in the standard + # [JSON Lines](http://jsonlines.org/) format. # - # Most adapters default to use this encoder. + # Most adapters default to use this encoder. See the documentation of the + # specific adapter's `default_encoder` instance method for details. class JSON include Rackstash::Encoder::Helper::Message include Rackstash::Encoder::Helper::Timestamp