https://github.com/mozgiii/slog-env-cfg

Opinionated slog drains builder, configurable via env vars.
https://github.com/mozgiii/slog-env-cfg

slog slog-rs

Last synced: 4 months ago
JSON representation

Opinionated slog drains builder, configurable via env vars.

• Host: GitHub
• URL: https://github.com/mozgiii/slog-env-cfg
• Owner: MOZGIII
• Created: 2019-05-30T23:25:32.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-04-29T20:22:56.000Z (about 4 years ago)
• Last Synced: 2025-02-28T06:56:13.504Z (4 months ago)
• Topics: slog, slog-rs
• Language: Rust
• Size: 39.1 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# slog-env-cfg

[![crates.io](https://img.shields.io/crates/v/slog-env-cfg.svg)](https://crates.io/crates/slog-env-cfg)

[![docs.rs](https://docs.rs/slog-env-cfg/badge.svg)](https://docs.rs/slog-env-cfg)

[![Build Status](https://travis-ci.org/MOZGIII/slog-env-cfg.svg?branch=master)](https://travis-ci.org/MOZGIII/slog-env-cfg)

Opinionated slog drains builder, configurable via env vars.

## Description

This crate builds an [slog `Drain`](https://docs.rs/slog/2/slog/trait.Drain.html) that writes to stdout. It's designed to be easy to use and with sane defaults. The format of the log records is configurable at runtime via `LOG_FORMAT` environment variable.

Possible values for `LOG_FORMAT` are:

- `terminal` (default)

- `json`

The idea is that in development environment, where you just run the executable manually and in the absence of centralized logging,

you would rely on human-readable log output. At deployment, on the contrary, centralized logging system can make use of JSON-formatted

logs, so the `LOG_FORMAT=json` can be set. The configuration is at runtime, so you only need to manage a single build artifact for both

use cases.

This crate aims to be an opinionated solution, and no other configuration is available so far.

Yet, I'm open to adding other tweaks if they're justified.

## Usage

Here's a minimal complete `main.rs` example:

```rust

use slog::{info, o};

fn main() {

    let drain = slog_env_cfg::logger_from_env(o!()).expect("initialization error");

    info!(root, "formatted: {}", 1; "log-key" => true);

}

```