# PrettyLoggex
![CI](https://github.com/GPrimola/pretty_loggex/workflows/PrettyLoggex%20Master%20CI/badge.svg)
[![Coverage Status](https://coveralls.io/repos/github/GPrimola/pretty_loggex/badge.svg?branch=master)](https://coveralls.io/github/GPrimola/pretty_loggex?branch=master)
[![Docs](https://img.shields.io/badge/api-docs-blueviolet.svg?style=flat)](https://hexdocs.pm/pretty_loggex)
![Hex.pm](https://img.shields.io/hexpm/v/pretty_loggex)


PrettyLoggex is a customization for [Elixir.Logger](https://hexdocs.pm/logger/Logger.html) that contains two formatters:

- [JsonFormatter](#jsonformatter)
- [KvFormatter](#kvformatter)


> **TLDR;**
>
> Add `pretty_loggex` to your list of dependencies in `mix.exs`:
>
> ```elixir
> def deps do
>   [
>     {@application, "~> 1.0.6"}
>   ]
> end
> ```
> - To output the logs in [JSON format](#jsonformatter):
>
> ```elixir
> config :logger, :console,
>   format: {PrettyLoggex, :json}
> ```
>
> - To output the logs in [Key=Value format](#kvformatter):
>
> ```elixir
> config :logger, :console,
>   format: {PrettyLoggex, :key_value}
>
> # or
>
> config :logger, :console,
>   format: {PrettyLoggex, :kv}
> ```

##### Table of contents

- [Installation](#installation)
- [Usage](#usage)
- [Examples](#examples)
- [About SumUp](#about-sumup)



## Installation

Add `pretty_loggex` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {@application, "~> 1.0.6"}
  ]
end
```



## Usage

- To output the logs in [JSON format](#jsonformatter):

```elixir
config :logger, :console,
  format: {PrettyLoggex, :json}
```

- To output the logs in [Key=Value format](#kvformatter):

```elixir
config :logger, :console,
  format: {PrettyLoggex, :key_value}

# or

config :logger, :console,
  format: {PrettyLoggex, :kv}
```

You can use any logger backend you want.
In the examples above it was used the standard `:console` backend.


## Examples

### JsonFormatter

Formats the Logger output to JSON format.
Example:

```

{"application":"pretty_loggex","file":"lib/pretty_loggex.ex","function":"start/2","level":"debug","line":5,"message":"This is a debug message","module":"Elixir.PrettyLoggex","pid":"#PID<0.180.0>","timestamp":"2020-02-04T16:44:48.974Z"}

{"application":"pretty_loggex","file":"lib/pretty_loggex.ex","function":"start/2","level":"info","line":6,"message":"This is a info message","module":"Elixir.PrettyLoggex","pid":"#PID<0.180.0>","timestamp":"2020-02-04T16:44:48.975Z"}

{"application":"pretty_loggex","file":"lib/pretty_loggex.ex","function":"start/2","level":"warn","line":7,"message":"This is a warn message","module":"Elixir.PrettyLoggex","pid":"#PID<0.180.0>","timestamp":"2020-02-04T16:44:48.975Z"}

{"application":"pretty_loggex","file":"lib/pretty_loggex.ex","function":"start/2","level":"error","line":8,"message":"This is a error message","module":"Elixir.PrettyLoggex","pid":"#PID<0.180.0>","timestamp":"2020-02-04T16:44:48.975Z"}
```

### KvFormatter

Formats the Logger output to Key=Value format.
Example:

```

timestamp="2020-02-04T16:47:06.790Z" level=debug pid=#PID<0.204.0> line=5 function="start/2" module=Elixir.PrettyLoggex file="lib/pretty_loggex.ex" application=pretty_loggex message="This is a debug message"

timestamp="2020-02-04T16:47:06.791Z" level=info pid=#PID<0.204.0> line=6 function="start/2" module=Elixir.PrettyLoggex file="lib/pretty_loggex.ex" application=pretty_loggex message="This is a info message"

timestamp="2020-02-04T16:47:06.791Z" level=warn pid=#PID<0.204.0> line=7 function="start/2" module=Elixir.PrettyLoggex file="lib/pretty_loggex.ex" application=pretty_loggex message="This is a warn message"

timestamp="2020-02-04T16:47:06.791Z" level=error pid=#PID<0.204.0> line=8 function="start/2" module=Elixir.PrettyLoggex file="lib/pretty_loggex.ex" application=pretty_loggex message="This is a error message"
```


### Maintainers

- [Giorgio Lucas Torres](mailto:lucas.primola@gmail.com)