GitHub - sysdia-solutions/logger_logentries_backend: Logentries backend for the Elixir Logger

2 min read Original article ↗

LoggerLogentriesBackend

About

A backend for the Elixir Logger that will send logs to the Logentries TCP input.

Supported options

  • host: String.t. The hostname of the logentries endpoint. [default: data.logentries.com]
  • port: Integer. The port number for logentries. [default: 80]
  • token: String.t. The unique logentries token for the log destination.
  • format: String.t. The logging format of the message. [default: [$level] $message\n].
  • level: Atom. Minimum level for this backend. [default: :debug]
  • metadata: Keyword.t. Extra fields to be added when sending the logs. These will be merged with the metadata sent in every log message.
  • metadata_filter: Keyword.t. Metadata fields which must be present in order to send the log.

Using it with Mix

To use it in your Mix projects, first add it as a dependency:

def deps do
  [{:logger_logentries_backend, "~> 0.0.1"}]
end

Then run mix deps.get to install it.

Configuration Examples

Runtime

Logger.add_backend {Logger.Backend.Logentries, :debug}
Logger.configure {Logger.Backend.Logentries, :debug},
  host: 'data.logentries.com',
  port: 10000,
  token: "logentries-token-goes-here",
  level: :debug,
  format: "[$level] $message\n"

Application config

config :logger,
  backends: [{Logger.Backend.Logentries, :error_log}, :console]

config :logger, :error_log,
  host: 'data.logentries.com',
  port: 10000,
  token: "logentries-token-goes-here",
  level: :error,
  format: "[$level] $message\n"

Only logging specific messages

Using the metadata_filter option, you can specify which log lines will be sent to Logentries. This example only logs lines when the custom logentries metadata key is given as true:

config :logger,
  backends: [{Logger.Backend.Logentries, :logentries}, :console]

config :logger, :logentries,
  host: 'data.logentries.com',
  port: 10000,
  token: "logentries-token-goes-here",
  level: :debug,
  format: "[$level] $message\n",
  metadata_filter: [logentries: true]

# Usage in code:
Logger.info("message", logentries: true)