• Home
  • Integrations
  • SDKs
  • Guides
  • API docs
No results for ""
EXPAND ALL

EDIT ON GITHUB

Logging configuration

Read time: 7 minutes
Last edited: Jul 29, 2022

Overview

This topic explains how to configure the logging feature. Logging is available for both client-side and server-side SDKs.

Configuring logging

LaunchDarkly SDKs rely on built-in logging packages and libraries to track events. Depending on which language you use, you can configure logging behavior to be highly or minimally verbose.

  • Client-side SDKs
  • Server-side SDKs

Client-side SDKs

This feature is available in the following client-side SDKs:

.NET (client-side)

Expand .NET (client-side) code sample

The client-side .NET SDK uses the Common.Logging framework. For an example configuration, read the Common.Logging README.

There are two important things to consider before you enable the DEBUG log level:

  1. Debug-level logs can be very verbose. We do not recommend using debug logging in high-volume environments.
  2. Debug-level logs include sensitive information, including LaunchDarkly users you create when you use this SDK.

Android

Expand Android code sample

The Android SDK makes heavy use of Timber logging. Include Timber in your application to enable debug output or production logging. An example is shown below to enable debug output when the application is built with a debug configuration.

Here's how:

if (BuildConfig.DEBUG) {
Timber.plant(new Timber.DebugTree());
}

Electron

Expand Electron code sample

By default, the SDK uses the winston package. There are four logging levels: debug, info, warn, and error. By default, debug messages are hidden.

To change the logging configuration, you can set LDOptions.logger to either another Winston instance or any object that implements the LDLogger interface. The createConsoleLogger function creates a minimal logger.

JavaScript

Expand JavaScript code sample

In the default configuration, the SDK sends the output to the console and enables all log levels except debug.

To change the logging configuration, set LDOptions.logger to any object that implements the LDLogger interface and performs logging for the client. To learn more, read LDOptions and LDLogger in the SDK API docs.

Node.js (client-side)

Expand Node.js (client-side) code sample

The client-side Node.js SDK offers several choices for logging.

In the default configuration, the SDK sends output to the console and enables all log levels except debug.

Versions 1.x of the SDK used the winston logging package for the default configuration. Versions 2.0 and later do not have a dependency on winston. Instead, they write directly to the console by default.

For full control over logging behavior, you can set the logger option to an object that implements the LDLogger interface. To learn more about the logger's requirements and methods, read LDLogger. The winston package is compatible with this interface, so if you are already using a winston logger, you can pass it directly to the SDK.

You can use basicLogger for simpler control over logging behavior. Versions 2.x and earlier of the SDK do not support basicLogger.

This example shows how to use basicLogger to enable debug-level logging in your SDK configuration:

const LaunchDarkly = require('launchdarkly-node-client-sdk');
const options = {
logger: LaunchDarkly.basicLogger({
level: 'debug',
}),
};
const client = LaunchDarkly.initialize( 'YOUR_CLIENT_SIDE_ID', user, options);

Be aware of two considerations when enabling debug-level logging:

  1. Debug-level logs can be very verbose. We do not recommend using debug logging in high-volume environments.
  2. Debug-level logs include sensitive information, including LaunchDarkly users you create when you use this SDK.

React

Expand React code sample

The React SDK relies on the JavaScript SDK for logging-related functionality. In the default configuration, the SDK sends the output to the console and enables all log levels except debug.

To change the logging configuration, set LDOptions.logger to any object that implements the LDLogger interface and performs logging for the client. The basicLogger, available in the JavaScript SDK, produces such an object.

Here's how:

import { basicLogger } from 'launchdarkly-js-sdk-client';
export default withLDProvider({
clientSideID: 'YOUR_CLIENT_SIDE_ID',
options: {
logger: basicLogger({level: 'debug'})
}
})(App);

To learn more, read LDOptions and LDLogger in the JavaScript SDK API docs.

Roku

Expand Roku code sample

The Roku SDK's logging feature is configurable. You can set different log levels, or use a custom logging backend with one of the two supported custom loggers.

Those loggers are:

Log levels in the Roku SDK


You can configure the SDK log level. For example, to set the level to info:

config.setLogLevel(LaunchDarklyLogLevels().info)

The SDK supports the following Levels:

LaunchDarklyLogLevels().error
LaunchDarklyLogLevels().warn
LaunchDarklyLogLevels().info
LaunchDarklyLogLevels().debug
LaunchDarklyLogLevels().none

Legacy API custom logger for the Roku SDK


function CustomLogger() as Object
return {
log: function(level as Integer, message as String)
print level message
end function
}
end function
config.setLogger(CustomLogger())

SceneGraph API custom logger for the Roku SDK


Here is an example of the SceneGraph API custom logger:

<!-- /components/CustomLogger.xml -->
<component name="CustomLogger" extends="Task">
<interface>
<field id="log" type="assocarray" alwaysNotify="true"/>
</interface>
<script type="text/brightscript" uri="pkg:/components/CustomLogger.brs"/>
</component>
REM /components/CustomLogger.brs
function init()
m.messagePort = createObject("roMessagePort")
m.top.observeField("log", m.messagePort)
end function
function mainThread() as Void
while (true)
msg = wait(0, m.messagePort)
if type(msg) = "roSGNodeEvent" then
if field = "log" then
value = msg.getData()
print value.level value.message
end if
end if
end while
end function

To use the logger, create the SceneGraph logger node, and then:

config.setLoggerNode(myLoggerNode)

Server-side SDKs

This feature is available in the following server-side SDKs:

.NET (server-side)

Expand .NET (server-side) code sample

The .NET SDK has four logging levels: Debug, Info, Warn, and Error. By default, the lowest enabled level is Info, so Debug messages are hidden. There are two important things to consider if you enable the Debug level:

  1. Debug-level logs can be very verbose. We do not recommend using debug logging in high-volume environments.
  2. Debug-level logs include sensitive information, including LaunchDarkly users you create when you use this SDK.

The .NET SDK sends log output to Console.Error by default. The ConfigurationBuilder.Logging method and the LaunchDarkly.Logging API allow you to change the output destination and log level.

Here is an example:

using LaunchDarkly.Logging;
using LaunchDarkly.Sdk.Server;
var config = Configuration.Builder("my-sdk-key")
.Logging(
Components.Logging(Logs.ToWriter(Console.Out)).Level(LogLevel.Debug)
)
.Build();

The destination could be another logging framework, such as the .NET Core Microsoft.Extensions.Logging API in this example:

using LaunchDarkly.Logging;
using LaunchDarkly.Sdk.Server;
var config = Configuration.Builder("my-sdk-key")
.Logging(Logs.CoreLogging)
.Build();

To learn more about logging configuration and adapters for other logging frameworks, read the documentation for LaunchDarkly.Logging.

All log messages from the SDK are tagged with a logger name, indicating the category of messages. If you use a logging framework like Microsoft.Extensions.Logging or NLog, you can use these names to filter the output:

  • LaunchDarkly.Sdk: general messages about the operation of the SDK client.
  • LaunchDarkly.Sdk.DataSource: messages about how the SDK client receives feature flag data, such as if the connection to LaunchDarkly has been interrupted.
  • LaunchDarkly.Sdk.DataStore (or more specific names like LaunchDarkly.Sdk.DataStore.Redis): messages about how the SDK client stores feature flag data, such as if you are using a database integration.
  • LaunchDarkly.Sdk.Evaluation: messages about unusual conditions during feature flag evaluation, such as if a feature flag could not be evaluated because its configuration is invalid.
  • LaunchDarkly.Sdk.Events: messages about analytics events, such as if event data could not be sent to LaunchDarkly due to a network problem.

Before version 6.0, the .NET SDK had different logging behavior:

  • The mechanism for specifying a log destination was the Common.Logging framework.
  • If you did not specifically configure a log destination using Common.Logging, logging was disabled by default.
  • The main logger name was LaunchDarkly.Client.LdClient.

C/C++ (server-side)

Expand C/C++ (server-side) code sample

By default, there is no log output, but we provide a default logger you can enable. The SDK does not lock on any logging. Ensure that your implementation is thread safe.

Whether you use a custom logger or the default one, you must call LDConfigureGlobalLogger before the client is initialized. You cannot modify logging while the client is running.

If you use the default logger, you can configure how verbose it should be.

For example, setting it to LD_LOG_TRACE produces the most verbose output, which may be useful in troubleshooting.

Here is an example:

LDConfigureGlobalLogger(LD_LOG_TRACE, LDBasicLogger);

You can also use your own custom log function:

static void
myCustomLogger(const LDLogLevel level, const char *const text)
{
printf("[%s] %s\n", LDLogLevelToString(level), text);
}
LDConfigureGlobalLogger(LD_LOG_TRACE, myCustomLogger);

Go

Expand Go code sample

The Go SDK uses a logging abstraction that can write to a log.Logger or anything with a compatible interface. This adds a system of log levels similar to logging frameworks on other platforms. There are four logging levels: Debug, Info, Warn, and Error.

By default, all levels of messages are enabled except Debug. You can tell the SDK to enable more or fewer levels, to send the output to a different destination, or to disable logging.

Here's how:

import (
"log"
"os"
ldlog "gopkg.in/launchdarkly/go-sdk-common.v2"
ld "gopkg.in/launchdarkly/go-server-sdk.v5"
"gopkg.in/launchdarkly/go-server-sdk.v5/ldcomponents"
)
var config ld.Config
// Send output to a file, and change minimum level to Warn (Debug and Info are disabled)
file, _ := os.Create("app.log")
config.Logging = ldcomponents.Logging().
BaseLogger(log.New(file, "", log.LstdFlags)).
MinLevel(ldlog.Warn)
// Or, disable logging
config.Logging = ldcomponents.NoLogging()

There are two things to consider if you enable the Debug log level:

  1. Debug-level logs can be very verbose. We do not recommend using debug logging in high-volume environments.
  2. Debug-level logs include sensitive information, including LaunchDarkly users you create when you use this SDK.

Java

Expand Java code sample

By default, the Java SDK uses SLF4J. SLF4J has its own configuration mechanisms for determining where output will go, and for filtering by level and/or logger name. It will not generate any output unless you have provided a configuration. For an example of using SLF4J with a simple console logging configuration, visit an SLF4J-specific version of hello-java.

Starting with version 5.10.0, you can also configure logging without using SLF4J. The LDConfig.Builder.logging method and the com.launchdarkly.logging API allow you to change the output destination and log level.

Here is an example of configuring log output to go to the standard output stream (System.out), and enabling DEBUG level:

import com.launchdarkly.logging.*;
import com.launchdarkly.sdk.server.*;
LDConfig config = new LDConfig.Builder()
.logging(
Components.logging(Logs.toStream(System.out)).level(LDLogLevel.DEBUG)
)
.build();

To learn more about logging configuration and adapters for other logging frameworks, read the documentation for com.launchdarkly.logging.

All log messages from the SDK are tagged with a logger name, indicating the category of messages. If you use a logging framework like SLF4J, you can use these names to filter the output:

  • com.launchdarkly.sdk.server.LDClient: This is for general messages that do not fall into any other categories.
  • com.launchdarkly.sdk.server.LDClient.DataSource: This is for messages related to how the SDK obtains feature flag data. Usually, this means messages about the streaming connection to LaunchDarkly, but if you use polling mode or file data instead, the SDK logs those messages under this name.
  • com.launchdarkly.sdk.server.LDClient.DataStore: This is for messages related to how feature flag data is stored. For example, database errors appear here if you are using a database integration.
  • com.launchdarkly.sdk.server.LDClient.Evaluation: This is for messages related to feature flag evaluation.
  • com.launchdarkly.sdk.server.LDClient.Events: This is for messages related to analytics event processing.

In versions of the SDK before 5.0, logger names were not standardized and were sometimes the names of Java classes that are not part of the public API, but they consistently had a package prefix of either com.launchdarkly.client. or com.launchdarkly.eventsource.

There are two important things to consider before you enable the DEBUG log level:

  1. Debug-level logs can be very verbose. We do not recommend using debug logging in high-volume environments.
  2. Debug-level logs include sensitive information, including LaunchDarkly users you create when you use this SDK.

Node.js (server-side)

Expand Node.js (server-side) code sample

The Node.js SDK offers several choices for logging.

In the default configuration, the SDK sends output to the console and enables all log levels except debug.

Versions 5.x and earlier of the SDK used the winston logging package for the default configuration. Versions 6.0 and later do not have a dependency on winston. Instead, they write directly to the console by default.

For full control over logging behavior, you can set the logger option to an object that implements the LDLogger interface. To learn more about the logger's requirements and methods, read LDLogger. The winston package is compatible with this interface, so if you are already using a winston logger, you can pass it directly to the SDK.

You can use basicLogger for simpler control over logging behavior. Versions 5.x and earlier of the SDK do not support basicLogger.

This example shows how to use basicLogger to enable debug-level logging in your SDK configuration:

const ld = require('launchdarkly-node-server-sdk');
const options = {
logger: ld.basicLogger({
level: 'debug',
}),
};

There are two important things to consider before you enable debug-level logging:

  1. Debug-level logs can be very verbose. We do not recommend using debug logging in high-volume environments.
  2. Debug-level logs include sensitive information, including LaunchDarkly users you create when you use this SDK.

PHP

Expand PHP code sample

The PHP SDK uses Monolog. All loggers are namespaced under LaunchDarkly.

There are two important things to consider before you enable the DEBUG log level:

  1. Debug-level logs can be very verbose. We do not recommend using debug logging in high-volume environments.
  2. Debug-level logs include sensitive information, including LaunchDarkly users you create when you use this SDK.

You can pass a custom logger to the SDK by using the configurable logger property:

$client = new LaunchDarkly\LDClient("YOUR_SDK_KEY", array("logger" => new Logger("LaunchDarkly", [new ErrorLogHandler(0, Logger::DEBUG)])));

Python

Expand Python code sample

The Python SDK uses Python's built-in logging library.

Here's how to enable the debug log level:

ld_logger = logging.getLogger("ldclient")
ld_logger.setLevel(logging.DEBUG)

There are two important things to consider before you enable the debug log level:

  • Debug-level logs can be very verbose. We do not recommend using debug logging in high-volume environments.
  • Debug-level logs include sensitive information, including LaunchDarkly users you create when you use this SDK.

Ruby

Expand Ruby code sample

The Ruby SDK uses Ruby's built-in Logger class. All loggers are namespaced under [LDClient].

There are two important things to consider before you enable the DEBUG log level:

  1. Debug-level logs can be very verbose. We do not recommend using debug logging in high-volume environments.
  2. Debug-level logs include sensitive information, including LaunchDarkly users you create when you use this SDK.

You can pass a custom logger to the SDK by using the configurable logger property:

log = ::Logger.new($stdout)
log.level = ::Logger::DEBUG
config = LaunchDarkly::Config.new({logger: log})
client = LaunchDarkly::LDClient.new("YOUR_SDK_KEY", config)

Rust

Expand Rust code sample

The Rust SDK uses the log crate.

There are two important things to consider before you enable the DEBUG log level:

  1. Debug-level logs can be very verbose. We do not recommend using debug logging in high-volume environments.
  2. Debug-level logs include sensitive information, including LaunchDarkly users you create when you use this SDK.