Contents

# frozen_string_literal: true

# Hooks into LogStashLogger and adds the logging metadata that has been collected to the actual
# Logstash event

module Loggery
  module Metadata
    module LogstashEventUtil
      MAGIC_FIELDS = %i[type uid _id _type _source _all _parent _fieldnames _routing
                        _index _size _timestamp _ttl].freeze

      def self.event_metadata(event)
        return unless loglevel_includes_event?(event)

        stored_metadata = Loggery::Metadata::Store.store || {}
        metadata = default_metadata.merge(stored_metadata)
        set_logstash_event_metadata(event, metadata)
      end

      def self.set_logstash_event_metadata(event, metadata)
        metadata.each { |k, v| event[k] = v }
        fail_if_magic_fields_are_used(event)
      end

      def self.default_metadata
        { pid: Process.pid }
      end

      def self.loglevel_includes_event?(event)
        severity = event["severity"].downcase
        Rails.logger.respond_to?(severity) && Rails.logger.public_send("#{severity}?")
      end

      def self.fail_if_magic_fields_are_used(event)
        MAGIC_FIELDS.each do |magic_field|
          if event[magic_field.to_s].present? || event[magic_field.to_sym].present?
            raise "'#{magic_field}' is a reserved field name of logstash. It should not be set in a custom event"
          end
        end
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
loggery-0.3.0	lib/loggery/metadata/logstash_event_util.rb
loggery-0.2.1	lib/loggery/metadata/logstash_event_util.rb
loggery-0.2.0	lib/loggery/metadata/logstash_event_util.rb