https://github.com/spotify/logging-java

Utility classes to set up logging in a Spotify compatible way
https://github.com/spotify/logging-java

Last synced: 4 months ago
JSON representation

Utility classes to set up logging in a Spotify compatible way

• Host: GitHub
• URL: https://github.com/spotify/logging-java
• Owner: spotify
• License: apache-2.0
• Created: 2014-04-15T09:01:12.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-12-20T15:34:32.000Z (about 1 year ago)
• Last Synced: 2025-01-16T04:11:06.799Z (12 months ago)
• Language: Java
• Size: 159 KB
• Stars: 22
• Watchers: 99
• Forks: 25
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-java - Spotify Logging

README

          
# DEPRECATION NOTICE

This project is no longer actively maintained, and PRs will no longer be accepted.

# spotify-logging

===============

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.spotify/logging/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.spotify/logging) [![Build Status](https://img.shields.io/circleci/project/github/spotify/logging-java)](https://circleci.com/gh/spotify/logging-java)

A small set of utility classes for setting up logback and a helper to

create logging messages suitable for the Spotify internal log parsing

infrastructure.

## Logstash Logback Encoder

The [logstash-logback-encoder](https://github.com/logstash/logstash-logback-encoder) is used to log

in the JSON format.

The primary motivation is provide any Java service running inside a container with Kubernetes (k8s) or Helios a way

to log in a structured format.

The general flow for a log message running on k8s is as follows.

1. Log a message as part of your service code (e.g. `LOG.info()`).

1. Logback configuration will output to the logs to stdout.

1. Docker captures messages from stdout and logs to file.

1. Fluentd reads from log file and sends to a logging service (e.g. elk stack, stackdriver, splunk, etc).

Instead of writing directly to a given logging service we chose this approach to more easily switch between

providers without needing to modify as little code as possible.

## License

This software is released under the Apache License 2.0. More information

in the file LICENSE distributed with this project.

## Ownership

The Weaver squad is currently owning this project internally.

We are currently in the evaluating process of the ownership of this and other OSS Java libraries.

The ownership takes into account **ONLY** security maintenance.

This repo is also co-owned by other people:

* [mattnworb](https://github.com/mattnworb)