gecko-dev/third_party/rust/slog

Getting started

Introduction

FAQ
Crate list

slog-rs - The Logging for Rust

Table of Contents

• Status & news
• slog crate
  • Features
  • Advantages over log crate
  • Terminal output example
  • Using & help
  • Compatibility Policy
• Slog community
  • Overview
• Slog related resources

Status & news

slog is an ecosystem of reusable components for structured, extensible, composable logging for Rust.

The ambition is to be The Logging Framework for Rust. slog should accommodate variety of logging features and requirements.

Features & technical documentation

Most of interesting documentation is using rustdoc itself.

You can view on docs.rs/slog

Terminal output example

slog-term is only one of many slog features - useful showcase.

Automatic TTY detection and colors:

Compact vs full mode:

Using & help

See examples/features.rs for full quick code example overview.

See faq for answers to common questions and wiki for other documentation articles. If you want to say hi, or need help use slog-rs gitter channel.

Read Documentation for details and features.

To report a bug or ask for features use github issues.

In your project

In Cargo.toml:

[dependencies]
slog = "1.2"

In your main.rs:

#[macro_use]
extern crate slog;

Compatibility Policy

slog follows SemVer: this is the official policy regarding breaking changes and minimum required versions of Rust.

Slog crates should pin minimum required version of Rust to the CI builds. Bumping the minimum version of Rust is considered a minor breaking change, meaning at a minimum the minor version will be bumped.

In order to keep from being surprised of breaking changes, it is highly recommended to use the ~major.minor.patch style in your Cargo.toml if you wish to target a version of Rust that is older than current stable minus two releases:

[dependencies]
slog = "~1.3.0"

This will cause only the patch version to be updated upon a cargo update call, and therefore cannot break due to new features, or bumped minimum versions of Rust.

Minimum Version of Rust

slog and it's ecosystem officially supports current stable Rust, minus two releases, but may work with prior releases as well. For example, current stable Rust at the time of this writing is 1.13.0, meaning slog is guaranteed to compile with 1.11.0 and beyond. At the 1.14.0 release, slog will be guaranteed to compile with 1.12.0 and beyond, etc.

Upon bumping the minimum version of Rust (assuming it's within the stable-2 range), it must be clearly annotated in the CHANGELOG.md

Slog community

Overview

Slog related crates are hosted under slog github organization.

Dawid Ciężarkiewicz is the original author and current maintainer of slog and therefore self-appointed benevolent dictator over the project. When working on slog Dawid follows and expects everyone to follow his Code of Conduct.

Any particular repositories under slog ecosystem might be created, controlled, maintained by other entities with various level of autonomy. Lets work together toward a common goal in respectful and welcoming atmosphere!

slog-related articles

• 24 days of Rust - structured logging - review and tutorial by Zbigniew Siciarz 2016-12-05