Application metadata configuration

Overview

This topic explains how to configure LaunchDarkly SDKs to send application metadata to LaunchDarkly. This feature is available for both client-side and server-side SDKs.

Sending application metadata to LaunchDarkly allows you to populate the "From source" field on Context details pages with information about the SDK or application that sent the context attributes. To learn more, read The context details page.

Customizing application identifiers and application versions

Some LaunchDarkly SDKs support application identifier and application version configuration options. These options allow you to send this metadata to LaunchDarkly. You can use this metadata for things like flag targeting and configuring our Accelerate product offering. To learn more, read Getting started with Accelerate.

For the SDKs that support this feature, you can send the following metadata:

• Application identifier (string): A unique identifier representing the application where the LaunchDarkly SDK is running. The value can use only alphanumeric characters and hyphens -, periods ., and underscores _. For example, authentication-service.
• Application version (string): A unique identifier representing the version of the application where the LaunchDarkly SDK is running. The value can use only alphanumeric characters and hyphens -, periods ., and underscores _. For example, you could set this to the semantic version of your application, such as 1.0.0. If you are using Accelerate, we recommend setting the application version to the full secure hash algorithm (SHA) of the GitHub commit for this deployment, such as a12bcde3f45ab6c789123456d78efabcde91234f.

You can set these values when you configure the SDK. All connections to LaunchDarkly from a client will send the same value to LaunchDarkly, whether the connection is through streaming, polling, or events. You cannot change the value after you configure the client.

Configuring application metadata for Accelerate

Configuring your application metadata to send deployment information lets Accelerate track the frequency and timing of your deployments. If you set the application version to a deployment Git SHA, Accelerate will also link the SHAs to your pull requests (PRs) and track which PRs are in your deployment.

To learn how to retrieve the SHA for your deployment, read Configure your application to send deployment information.

Details about each SDK's configuration are available in the SDK-specific sections below:

• Client-side SDKs
• Server-side SDKs

Client-side SDKs

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

• Android
• iOS
• JavaScript
• Node.js (client-side)
• React: The React SDK relies on the JavaScript SDK for this functionality.

Android

LDConfig config = new LDConfig.Builder()
    .applicationInfo(
        Components.applicationInfo()
            .applicationId("authentication-service")
            .applicationVersion("1.0.0")
    )
    .build();
COPY

iOS

var applicationInfo = ApplicationInfo()
applicationInfo.applicationIdentifier("authentication-service")
applicationInfo.applicationVersion("1.0.0")
var config = LDConfig(mobileKey: mobileKey)
config.applicationInfo = applicationInfo
COPY

JavaScript

const options = {
    application: {
        id: 'authentication-service',
        version: '1.0.0',
    },
};
const client = LDClient.initialize('client-side-id-123abc', context, options);
COPY

Node.js (client-side)

const options = {
  application: {
    id: "authentication-service",
    version: "1.0.0"
  }
};
const client = LDClient.initialize('client-side-id-123abc', context, options);
COPY

Server-side SDKs

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

• Go
• Java
• Node.js (server-side)
• Ruby
• Rust

Go

var config ld.Config
config.ApplicationInfo.ApplicationID = "authentication-service"
config.ApplicationInfo.ApplicationVersion = "1.0.0"
COPY

Java

LDConfig config = new LDConfig.Builder()
  .applicationInfo(
    Components.applicationInfo()
      .applicationId("authentication-service")
      .applicationVersion("1.0.0")
  ).build();
COPY

Node.js (server-side)

var options = {
  application: {
    id: 'authentication-service',
    version: '1.0.0'
  }
};
client = ld.init('sdk-key-123abc', options);
COPY

Ruby

LaunchDarkly::Config.new({
  application: {
    id: "authentication-service",
    version: "abc123def456"
  }
})
COPY

Rust

let mut application_info = ApplicationInfo::new();
application_info
    .application_identifier("authentication-service")
    .application_version("1.0.0");
let config = ConfigBuilder::new(&sdk_key)
    .application_info(application_info)
    .build();
COPY