https://github.com/secomind/plug_logger_with_meta
Plug.Logger replacement focused on metadata logging.
https://github.com/secomind/plug_logger_with_meta
Last synced: 4 months ago
JSON representation
Plug.Logger replacement focused on metadata logging.
- Host: GitHub
- URL: https://github.com/secomind/plug_logger_with_meta
- Owner: secomind
- License: apache-2.0
- Created: 2019-10-28T14:21:40.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-29T09:02:57.000Z (over 6 years ago)
- Last Synced: 2026-02-18T01:15:37.869Z (4 months ago)
- Language: Elixir
- Homepage:
- Size: 20.5 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PlugLoggerWithMeta
PlugLoggerWithMeta is a [Plug.Logger](https://hexdocs.pm/plug/Plug.Logger.html) based on Plug.Logger code, focused on metadata logging.
## Why
Plug.Logger does not use [Logger metadata](https://hexdocs.pm/logger/Logger.html#module-metadata),
so some useful information such as `method` and `request_path` are embedded into the log message
hence they must be scraped.
PlugLoggerWithMeta makes them machine readable by exporting them using standard Logger metadata mechanisms.
There are also other similar libraries, however this tries to behave as close as possible to `Plug.Logger`.
## Installation
- Add `:plug_logger_with_meta` dependency to your project's `mix.exs`:
```elixir
def deps do
[
{:plug_logger_with_meta, "~> 0.1"}
]
end
```
- Run `mix deps.get`
- Replace `Plug.Logger` with `PlugLoggerWithMeta`:
```diff
--- a/endpoint.ex
+++ b/endpoint.ex
@@ -38,7 +38,7 @@ defmodule MyProject.APIWeb.Endpoint do
end
plug Plug.RequestId
- plug Plug.Logger
+ plug PlugLoggerWithMeta
```
- Add relevant metadata to your logger configuration:
```elixir
config :logger, :console, format: "[$level] $message\n"
+ metadata: [
+ :method,
+ :request_path,
+ :status_code,
+ :elapsed,
+ ]
```
- Optional: use it with [pretty_log](https://github.com/ispirata/pretty_log) (or any other logger formatter/backend)
`pretty_log` will format all metadata using logfmt.
## Available Metadata
- elapsed (e.g. `22ms`)
- method (e.g. `GET`)
- request_path (e.g. `/v1/my/path`)
- status_code (e.g. `200`)
- tag (e.g. `got_client_req`, `sent_reply`)
## About This Project
This project has been created in order to provide better logs in [Astarte](https://github.com/astarte-platform/astarte).
We are open to any contribution and we encourage adoption of this library, also outside Astarte, in order to provide better logs to everyone.