com.spotify.logging

Class LoggingConfigurator

java.lang.Object

com.spotify.logging.LoggingConfigurator

public class LoggingConfigurator
extends Object

Base configurator of logback for spotify services/tools. LoggingConfigurator.configureDefaults() should generally be called as soon as possible on start-up. The configured logging backend is logback. If the SPOTIFY_SYSLOG_HOST or SPOTIFY_SYSLOG_PORT environment variable is defined, configureDefaults() will use the syslog appender, otherwise it will use the console appender.

One aspect of the logging is that we setup a general uncaught exception handler to log uncaught exceptions at info level, if syslog is chosen as logging backend.

See Also:

For some integration with JewelCLI

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoggingConfigurator.Level

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_IDENT
static String	SPOTIFY_HOSTNAME
static String	SPOTIFY_SYSLOG_HOST
static String	SPOTIFY_SYSLOG_PORT

Constructor Summary

Constructors

Constructor and Description
LoggingConfigurator()

Method Summary

Modifier and Type	Method and Description
static net.kencochrane.raven.logback.SentryAppender	addSentryAppender(String dsn) Add a sentry appender for error log event.
static net.kencochrane.raven.logback.SentryAppender	addSentryAppender(String dsn, LoggingConfigurator.Level logLevelThreshold) Add a sentry appender.
static void	configure(File file) Configure logging using a logback configuration file.
static void	configure(File file, String defaultIdent) Configure logging using a logback configuration file.
(package private) static void	configure(JewelCliLoggingOptions opts) Deprecated. Don't use, see docs.
static void	configureDefaults() Configure logging with default behaviour and log to stderr.
static void	configureDefaults(String ident) Configure logging with default behaviour and log to stderr using INFO logging level.
static void	configureDefaults(String ident, LoggingConfigurator.Level level) Configure logging with default behaviour and log to stderr.
static void	configureNoLogging() Mute all logging.
static void	configureSyslogDefaults(String ident) Configure logging with default behavior and log to syslog using INFO logging level.
static void	configureSyslogDefaults(String ident, LoggingConfigurator.Level level) Configure logging with default behavior and log to syslog.
static void	configureSyslogDefaults(String ident, LoggingConfigurator.Level level, String host, int port) Configure logging with default behavior and log to syslog.
static void	configureSyslogDefaults(String ident, LoggingConfigurator.Level level, String host, int port, String loggerName) Configure logging with default behavior and log to syslog.
private static String	getMyPid()
private static String	getSpotifyHostname()
private static ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent>	getStdErrAppender(ch.qos.logback.classic.LoggerContext context) Create a stderr appender.
(package private) static ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent>	getSyslogAppender(ch.qos.logback.classic.LoggerContext context, String host, int port) Create a syslog appender.
private static String	getSyslogHost()
private static int	getSyslogPort()
private static ch.qos.logback.classic.LoggerContext	setupLoggerContext(ch.qos.logback.classic.Logger rootLogger, String ident)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_IDENT

public static final String DEFAULT_IDENT

See Also:

Constant Field Values

SPOTIFY_HOSTNAME

public static final String SPOTIFY_HOSTNAME

See Also:

Constant Field Values

SPOTIFY_SYSLOG_HOST

public static final String SPOTIFY_SYSLOG_HOST

See Also:

Constant Field Values

SPOTIFY_SYSLOG_PORT

public static final String SPOTIFY_SYSLOG_PORT

See Also:

Constant Field Values

Constructor Detail

LoggingConfigurator

public LoggingConfigurator()

Method Detail

configureNoLogging

public static void configureNoLogging()

Mute all logging.

configureDefaults

public static void configureDefaults()

Configure logging with default behaviour and log to stderr. Uses the DEFAULT_IDENT logging identity. Uses INFO logging level. If the SPOTIFY_SYSLOG_HOST or SPOTIFY_SYSLOG_PORT environment variable is defined, the syslog appender will be used, otherwise console appender will be.

configureDefaults

public static void configureDefaults(String ident)

Configure logging with default behaviour and log to stderr using INFO logging level. If the SPOTIFY_SYSLOG_HOST or SPOTIFY_SYSLOG_PORT environment variable is defined, the syslog appender will be used, otherwise console appender will be.

Parameters:

ident - The logging identity.

configureDefaults

public static void configureDefaults(String ident,
                                     LoggingConfigurator.Level level)

Configure logging with default behaviour and log to stderr. If the SPOTIFY_SYSLOG_HOST or SPOTIFY_SYSLOG_PORT environment variable is defined, the syslog appender will be used, otherwise console appender will be.

Parameters:

ident - The logging identity.

level - logging level to use.

configureSyslogDefaults

public static void configureSyslogDefaults(String ident)

Configure logging with default behavior and log to syslog using INFO logging level.

Parameters:

ident - Syslog ident to use.

configureSyslogDefaults

public static void configureSyslogDefaults(String ident,
                                           LoggingConfigurator.Level level)

Configure logging with default behavior and log to syslog.

Parameters:

ident - Syslog ident to use.

level - logging level to use.

configureSyslogDefaults

public static void configureSyslogDefaults(String ident,
                                           LoggingConfigurator.Level level,
                                           String host,
                                           int port)

Configure logging with default behavior and log to syslog.

Parameters:

ident - Syslog ident to use.

level - logging level to use.

host - Hostname or IP address of syslog host.

port - Port to connect to syslog on.

configureSyslogDefaults

public static void configureSyslogDefaults(String ident,
                                           LoggingConfigurator.Level level,
                                           String host,
                                           int port,
                                           String loggerName)

Configure logging with default behavior and log to syslog.

Parameters:

ident - Syslog ident to use.

level - logging level to use.

host - Hostname or IP address of syslog host.

port - Port to connect to syslog on.

loggerName - Name of the logger to which the syslog appender will be added

addSentryAppender

public static net.kencochrane.raven.logback.SentryAppender addSentryAppender(String dsn)

Add a sentry appender for error log event.

Parameters:

dsn - the sentry dsn to use (as produced by the sentry webinterface).

Returns:

the configured sentry appender.

addSentryAppender

public static net.kencochrane.raven.logback.SentryAppender addSentryAppender(String dsn,
                                                                             LoggingConfigurator.Level logLevelThreshold)

Add a sentry appender.

Parameters:

dsn - the sentry dsn to use (as produced by the sentry webinterface).

logLevelThreshold - the threshold for log events to be sent to sentry.

Returns:

the configured sentry appender.

getStdErrAppender

private static ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent> getStdErrAppender(ch.qos.logback.classic.LoggerContext context)

Create a stderr appender.

Parameters:

context - The logger context to use.

Returns:

An appender writing to stderr.

getSyslogAppender

static ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent> getSyslogAppender(ch.qos.logback.classic.LoggerContext context,
                                                                                                String host,
                                                                                                int port)

Create a syslog appender. The appender will use the facility local0. If host is null or an empty string, default to "localhost". If port is less than 0, default to 514.

Parameters:

context - The logger context to use.

host - The host running the syslog daemon.

port - The port to connect to.

Returns:

An appender that writes to syslog.

configure

static void configure(JewelCliLoggingOptions opts)

Deprecated. Don't use, see docs.

This is not a public interface and only here to be called from JewelCliLoggingConfigurator. All JewelCli specific functionality should be moved to JewelCliLoggingConfigurator, but that requires some work in defining an interface for *it* to use to configure this cmdline/config format agnostic class. The implementation was moved here from JewelCliLoggingConfigurator as part of creating this class for use in a non_jewelCli (argot, scala) project and so essentially constitutes an improvement rather than a regression, but at some point the work should be put in to define a nice programatical interface to configure spotify logging options.

configure

public static void configure(File file)

Configure logging using a logback configuration file.

Parameters:

file - A logback configuration file.

configure

public static void configure(File file,
                             String defaultIdent)

Configure logging using a logback configuration file.

Parameters:

file - A logback configuration file.

defaultIdent - Fallback logging identity, used if not specified in config file.

setupLoggerContext

private static ch.qos.logback.classic.LoggerContext setupLoggerContext(ch.qos.logback.classic.Logger rootLogger,
                                                                       String ident)

getMyPid

private static String getMyPid()

getSyslogHost

private static String getSyslogHost()

getSyslogPort

private static int getSyslogPort()

getSpotifyHostname

private static String getSpotifyHostname()