.NET SDK reference (server-side)

This topic documents how to get started with the server-side .NET SDK, and links to reference information on all of the supported features.

Overview

This topic documents how to get started with the server-side .NET SDK, and links to reference information on all of the supported features.

LaunchDarkly’s SDKs are open source. In addition to this reference guide, we provide source, API reference documentation, and a sample application:

Resource	Location
SDK API documentation	SDK API docs
Supported SDK Versions	.NET server SDK
GitHub repository	.NET (server-side) SDK
Sample application	.NET (server-side) , OpenFeature .NET (server-side)
Published module	NuGet

This SDK is intended for use in multi-user .NET server applications. If you have a .NET application and want to set up LaunchDarkly in a mobile, desktop, or embedded application, read the client-side .NET SDK reference.

To learn more about LaunchDarkly’s different SDK types, read Choosing an SDK type.

Get started

The LaunchDarkly .NET SDK, version 8.9 and higher, is compatible with .NET 8.

The LaunchDarkly .NET SDK, version 7.0 and higher, is compatible with .NET 6.0+, .NET Framework 4.6.2+, .NET Standard 2.0+, and .NET Core 3.1.

Prior to version 7.0, the LaunchDarkly .NET SDK also supported .NET 5.0, .NET Framework 4.5.2 and .NET Framework 4.6.1, and .NET Core 2.1.

After you complete the Getting Started process, follow these instructions to start using the LaunchDarkly SDK in your .NET application.

Install the SDK

First, install the LaunchDarkly SDK as a dependency in your application using your application’s dependency manager.

We recommend making the LaunchDarkly observability plugin available as well. This plugin collects and sends observability data to LaunchDarkly. This means you can review error monitoring and logs from within the LaunchDarkly UI. It requires the .NET (server-side) SDK version 8.10 or later.

Here’s how:

Shell

    Install-Package LaunchDarkly.ServerSdk
    dotnet add package LaunchDarkly.Observability

Next, import the LaunchDarkly SDK’s namespaces in your application code. The namespace is not the same as the package name:

.NET SDK v6.x and later (C#)

    using LaunchDarkly.Sdk;
    using LaunchDarkly.Sdk.Server;
    using LaunchDarkly.Observability;


    // LaunchDarkly.Sdk defines general types like Context, which are also used in the client-side .NET SDK.
    // LaunchDarkly.Sdk.Server defines the LdClient and Configuration types for the server-side .NET SDK.
    // LaunchDarkly.Observability defines the optional observability,
    // which requires .NET (server-side) SDK version 8.10 or later.

The .NET (server-side) SDK uses an SDK key. Keys are specific to each project and environment. They are available from Project settings, on the Environments list. To learn more about key types, read Keys.

Initialize the client

After you install and import the SDK, create a single, shared instance of LdClient. Specify your SDK key in the configuration to authorize your application to connect to a particular environment within LaunchDarkly.

To create a single instance:

Initialize, .NET SDK v8.10+ with ASP.Net Core

    var builder = WebApplication.CreateBuilder(args);

    var config = Configuration.Builder("YOUR_SDK_KEY")
      .StartWaitTime(TimeSpan.FromSeconds(5))
      .Plugins(new PluginConfigurationBuilder()
          .Add(ObservabilityPlugin.Builder(builder.Services)
              .WithServiceName("your-service-name")
              .WithServiceVersion("example-sha")
              .Build()
          )
      ).Build();

    var client = new LdClient(config);

    // Client must be constructed before the web application.
    var app = builder.Build();

When you initialize the client, you can optionally provide configuration options. To learn more, read Configuration. To learn more about the specific configuration that are available in this SDK, read ConfigurationBuilder.

In the standard use case where there is only one SDK key, it’s important to make the LdClient a singleton for each LaunchDarkly project. The client instance maintains internal state that allows LaunchDarkly to serve feature flags without making any remote requests. Do not instantiate a new client with every request.

If you need to use more than one SDK key, the SDK allows you to create more than one LdClient instance. This is an uncommon requirement, but one the SDK supports.

If you have multiple LaunchDarkly projects, you can create one LDClient for each. In this situation, the clients operate independently. For example, they do not share a single connection to LaunchDarkly.

Evaluate a context

You can use client to check which variation a particular context will receive for a given feature flag. To learn more, read Evaluating flags and Flag evaluation reasons. For more information about how contexts are specified, read Context configuration.

In the v7 example, the context key is the string “example-context-key”. In the v6 example, the user key is the string “example-user-key”:

.NET SDK v7.0+ (C#)

    var context = Context.Builder("example-context-key")
      .Name("Sandy")
      .Build();

    var flagValue = client.BoolVariation("example-flag-key", context, false);

    if (flagValue) {
        // application code to show the feature
    }
    else {
        // the code to run if the feature is off
    }

Contexts have a context kind of “user” by default. To specify a different kind, use the Kind method:

.NET SDK v7.0+ (C#)

    var context = Context.Builder("example-context-key")
      .Kind("device")
      .Name("Android")
      .Build();

To learn more, read Context kinds.

Transport Layer Security (TLS) and other networking issues

LaunchDarkly is deprecating support for TLS versions 1.0 and 1.

1. .NET applications running on older operating systems are prone to use these older, less secure versions of TLS. It is possible to increase your application’s security using AppContext switches.

To learn more, read Microsoft’s documentation.

If you cannot update your application platform’s configurations to support TLS version 1.2, you can update your application’s SDK configuration to use new LaunchDarkly endpoints that support TLS versions 1.0 and later. Here is an example:

.NET SDK 6.x and 7.x syntax (C#)

    // Use `stream-tls10.launchdarkly.com` and `events-tls10.launchdarkly.com` TLSv1 endpoints
    var config = Configuration.Builder("YOUR_SDK_KEY")
        .ServiceEndpoints(
            Components.ServiceEndpoints()
              .Streaming("https://stream-tls10.launchdarkly.com")
              .Events("https://events-tls10.launchdarkly.com"))
        .Build();

LaunchDarkly servers operate in a load-balancing framework which may cause their IP addresses to change. This could result in the SDK failing to connect to LaunchDarkly if an old IP address is still in your system’s DNS cache. In .NET, the DNS cache retains IP addresses for two minutes by default. If you notice intermittent connection failures that always resolve in two minutes, you may want to change this setting to a lower value as described in Microsoft’s documentation.

Shut down the client

Shut down the client when your application terminates. To learn more, read Shutting down.

Supported features

This SDK supports the following features:

• Anonymous contexts and users
• Big segments
• Configuration, including
  • Application metadata configuration
  • Migration configuration
  • Service endpoint configuration
• Context configuration
• Data saving mode
• Evaluating flags
• Flag evaluation reasons
• Flushing events
• Getting all flags
• Hooks
• Identifying and changing contexts
• Logging configuration
• Migrations
• Monitoring SDK status
• Observability
• Offline mode
• OpenTelemetry
• Private attributes
• Reading flags from a file
• Relay Proxy configuration
  • Using proxy mode
  • Using daemon mode
• Secure mode
• Sending custom events
• Shutting down
• Storing data
• Subscribing to flag changes
• Test data sources
• Web proxy configuration