[](https://travis-ci.org/marcelog/logger_logstash_backend)
LoggerLogstashBackend
=====================
## About
A backend for the [Elixir Logger](http://elixir-lang.org/docs/v1.0/logger/Logger.html)
that will send logs to the [Logstash UDP input](https://www.elastic.co/guide/en/logstash/current/plugins-inputs-udp.html).
## Supported options
* **host**: String.t. The hostname or ip address where to send the logs.
* **port**: Integer. The port number. Logstash should be listening with its UDP
inputter.
* **metadata**: Keyword.t. Extra fields to be added when sending the logs. These will
be merged with the metadata sent in every log message.
* **level**: Atom. Minimum level for this backend.
* **type**: String.t. Type of logs. Useful to filter in logstash.
## Sample Logstash config
```
input {
udp {
codec => json
port => 10001
queue_size => 10000
workers => 10
type => default_log_type
}
}
output {
stdout {}
elasticsearch {
protocol => http
}
}
```
## Using it with Mix
To use it in your Mix projects, first add it as a dependency:
```elixir
def deps do
[{:logger_logstash_backend, "~> 2.1.1"}]
end
```
Then run mix deps.get to install it.
Add logger and tzdata as applications:
```elixir
def application do
[applications: [:logger, :tzdata]]
end
```
## Configuration Examples
### Runtime
```elixir
Logger.add_backend {LoggerLogstashBackend, :debug}
Logger.configure {LoggerLogstashBackend, :debug},
host: "127.0.0.1",
port: 10001,
level: :debug,
metadata: ...
```
### Application config
```elixir
config :logger,
backends: [{LoggerLogstashBackend, :error_log}, :console]
config :logger, :error_log,
host: "some.host.com",
port: 10001,
level: :error,
type: "my_type_of_app_or_node",
metadata: [
extra_fields: "go here"
]
```
