meineerde/rackstash
1
0
Fork 0
mirror of https://github.com/meineerde/rackstash.git synced 2025-12-20 07:11:12 +00:00
Code Issues Releases Activity

Add basic documentation for Rackstash::Fields

Browse Source
This commit is contained in:
Holger Just 2017-07-11 23:52:49 +02:00
parent 637245d836
commit 0d1ad5e170
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
lib/rackstash/fields.rb
View File

@ -3,6 +3,20 @@
# This software may be modified and distributed under the terms # This software may be modified and distributed under the terms
# of the MIT license. See the LICENSE.txt file for details. # of the MIT license. See the LICENSE.txt file for details.
module Rackstash
# Fields are specialized data storage classes which ensure consistent and
# strictly normalized data. They are used to store additional information
# besides just log messages in a {Buffer}.
#
# Field classes are modeled after classes in Ruby core and generally provide
# the exact interface and semantics with the notable exception that the
# classes always ensure that any store data is directly mappable to JSON. As
# such, all stored data is always normalized in insert and converted to the
# respective base-types.
module Fields
end
end
require 'rackstash/fields/abstract_collection' require 'rackstash/fields/abstract_collection'
require 'rackstash/fields/hash' require 'rackstash/fields/hash'
require 'rackstash/fields/array' require 'rackstash/fields/array'