# lager_logentries

Backend for Lager which sends logs to [Logentries](  via [Token TCP](

__Version:__ 0.1.0

[![Build Status](](

## Installation

This library is [available on Hex]( Just add it to your
Rebar3 dependencies:

{deps, [
  {lager_logentries, "0.1.0"}

## Configuration

**Supported options:**

* **host:** The hostname of the logentries endpoint. (default: ``)
* **port:** The port number for logentries. (default: `80`)
* **address_family:** Defines an specific IP protocol version. `inet` stands for IPv4, `inet6` for IPv6, and `undefined` means that suitable version will be chosen for you automatically. (default: `undefined`)
* **token:** The unique logentries token (UUID) for the log destination.
* **level:** Minimum level for this backend. (default: `info`)
* **context:** Proplist of additional fields to be added when sending the logs. Keys have to be either atoms, binaries or iolists and values must be anything that has an equivalent JSON datatype. (e.g. `[{<<"username">>, <<"codeadict">>}, {<<"environment">>, <<"production">>}]`)

Add configuration to `sys.config`:

{lager, [{ handlers,
  [{ lager_logentries_token_tcp_backend,
      {host, ""},
      {port, 80},
      {token, "2bfbea1e-10c3-4419-bdad-7e6435882e1f"},
      {level, info},
      {context, [{<<"username">>, <<"codeadict">>}]}

## Usage



main() ->
  lager:info([{service, "mycoolapp"}], "Hello ~s", ["world"]).

Would result in JSON like this:

  "message": "Hello world",
  "timestamp": "2019-02-17T02:40:33.916880",
  "fields": {
    "severity": "info",
    "service": "mycoolapp",
    "application": "example",
    "node": "node@localhost",
    "pid": "<0.13919.0>",
    "module": "example",
    "function": "main",
    "line": "6"

## Contributing

Pull requests are most welcome. If you have any questions, bug reports or feature proposals just
[open an issue](

The project is developed using rebar3:

* run `rebar3 compile` to compile the source code
* run `rebar3 ct` to test it
* run `rebar3 dialyzer` to perform Dialyzer checks

**Note:** Any new piece of code should be reasonably tested and covered by type specs.

## License

Copyright 2019 Dairon Medina Caro

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.