https://github.com/LeeroyDing/json_logger

Simple JSON Logger for Elixir apps.
https://github.com/LeeroyDing/json_logger

Last synced: about 1 month ago
JSON representation

Simple JSON Logger for Elixir apps.

• Host: GitHub
• URL: https://github.com/LeeroyDing/json_logger
• Owner: LeeroyDing
• License: apache-2.0
• Created: 2015-05-08T10:18:53.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2020-04-05T21:19:28.000Z (over 4 years ago)
• Last Synced: 2024-10-08T11:45:04.750Z (2 months ago)
• Language: Elixir
• Homepage:
• Size: 17.6 KB
• Stars: 24
• Watchers: 2
• Forks: 13
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - JSON Logger is a logger backend that outputs elixir logs in JSON format. (Logging)
• fucking-awesome-elixir - json_logger - JSON Logger is a logger backend that outputs elixir logs in JSON format. (Logging)
• awesome-elixir - json_logger - JSON Logger is a logger backend that outputs elixir logs in JSON format. (Logging)

README

        
Elixir JSON Logger

==================

JSON Logger is a logger backend that outputs elixir logs in JSON format.

This project is originally designed to make Elixir apps work with Logstash easily. It aims at providing as much information for the log is possible, so the logs can be more easily analyzed by backend services like _Elasticsearch_.

Issues and PRs are welcome.

## Dependencies

This project requires [json](https://hex.pm/packages/json).

## Configuration

### Elixir Project

JSON Logger currently provides very few options:

* __level__: The minimal level of logging. There's no default of this option. Example: `level: :warn`

* __output__: The output of the log. Must be either `:console` or `{:udp, host, port}` or `{:tcp, host, port}. Example: `output: {:udp, "localhost", 514}`

* __metadata__: Whatever else you want in the log. Example: `metadata: "Some very important project"`

Example configuration: `config :logger, :json_logger, level: :info, output: {:udp, "localhost", 514}`

**TCP support is still experimental, please submit issues that you encounter.**

### In your application

You should add `json_logger` to your `mix.exs` as well. This step may not be necessary (if you know why please tell me).

```elixir

defmodule MyMod.Mixfile do

  # ...

  def application do

    [applications: [:logger, :json_logger],

     mod: {MyMod, []}]

  end

  # ...

end

```

### Adding the logger backend

You need to add this backend to your `Logger`, preferably put this in your `Application`'s `start/2`.

```elixir

Logger.add_backend Logger.Backends.JSON

```

### If you wish to use Logstash with this library

Here is an example logstash configuration:

```

input {

  udp {

    port => 514

    type => "elixir_json_logging"

  }

}

filter {

  json {

    source => "message"

  }

}

output {

  stdout {

    codec => rubydebug

  }

}

```

Note that this configuration will probably break on your system (listening to a <1024 port). You **should** change the "port" to a larger value.