Logstash.Message

Datatypes, helper functions, and JSON instances for Logstash messages.

Documentation

data LogstashMessage

The Logstash message, as described in https://github.com/logstash/logstash/wiki/logstash's-internal-message-format. Please note that it is good practice to forget about the timestamp when creating messages (set logstashTime to Nothing), as it should be a responsability of the Logstash server to add it.

Constructors

LogstashMessage

Fields

logstashType :: Text

logstashSource :: Text

logstashTags :: [Text]

logstashFields :: Value

logstashContent :: Text

logstashTime :: Maybe UTCTime

Instances

Eq LogstashMessage

Show LogstashMessage

ToJSON LogstashMessage

FromJSON LogstashMessage

emptyLSMessage :: Text -> LogstashMessage

As the name implies, this creates a dummy Logstash message, only updating the message field.

logstashTimestamp :: UTCTime -> Text

This formats an UTCTime in what logstash expects

parseLogstashTime :: Text -> Maybe UTCTime

This parses the logstash time format.

value2logstash :: Value -> Maybe LogstashMessage

This will try to convert an arbitrary JSON value into a LogstashMessage.

addLogstashTime :: LogstashMessage -> IO LogstashMessage

Adds the current timestamp if it is not provided.

addLogstashTag

Arguments

:: Text

The tag to add

-> LogstashMessage

-> LogstashMessage

Adds a tag to a logstash message.