This reference guide documents all of the methods available in our .NET SDK, and explains in detail how these methods work. If you want to dig even deeper, our SDKs are open source-- head to our .NET SDK GitHub repository to look under the hood.
Requirements
The .NET SDK requires version 4.5 or later of the .NET framework or .NETCoreApp 1.0 or later.
Building on top of our Quickstart guide, the following steps will get you started with using the LaunchDarkly SDK in your .NET application.
The first step is to install the LaunchDarkly SDK as a dependency in your application using your application's dependency manager.
Install-Package LaunchDarkly.ClientNext you should import the LaunchDarkly client in your application code.
using LaunchDarkly.Client;Once the SDK is installed and imported, you'll want to create a single, shared instance of LdClient. You should specify your SDK key here so that your application will be authorized to connect to LaunchDarkly and for your application and environment.
LdClient ldClient = new LdClient("YOUR_SDK_KEY");LDClient must be a singleton
It's important to make this a singleton-- internally, the client instance maintains internal state that allows us to serve feature flags without making any remote requests. Be sure that you're not instantiating a new client with every request.
Using ldClient, you can check which variation a particular user should receive for a given feature flag.
User user = User.WithKey(username);
bool showFeature = ldClient.BoolVariation("your.feature.key", user, false);
if (showFeature) {
// application code to show the feature
}
else {
// the code to run if the feature is off
}Lastly, when your application is about to terminate, shut down ldClient. This ensures that the client releases any resources it is using, and that any pending analytics events are delivered to LaunchDarkly. If your application quits without this shutdown step, you may not see your requests and users on the dashboard, because they are derived from analytics events. This is something you only need to do once.
// shut down the client, since we're about to quit
ldClient.Dispose();You can also pass custom parameters to the client by creating a custom configuration object:
Configuration config = LaunchDarkly.Client.Configuration.Default("YOUR_SDK_KEY")
.WithEventQueueFrequency(TimeSpan.FromSeconds(2));
LdClient ldClient = new LdClient(config);Here, we've customized the event queue flush frequency. The complete list of customizable parameters is as follows:
WithUri
Uri or string
Set the base URL of the LaunchDarkly server for this configuration
WithEventsUri
Uri or string
Set the events URL of the LaunchDarkly server for this configuration.
WithIsStreamingEnabled
bool
Boolean value which enables streaming.
true
WithEventQueueCapacity
int
Set the capacity of the events buffer.
500 events
WithEventQueueFrequency
TimeSpan
Set the number of seconds between flushes of the event buffer.
5 seconds
WithPollingInterval
TimeSpan
Set the polling interval (when streaming is disabled). Values less than the default of 30 seconds will be set to 30 seconds.
30 seconds
WithStartWaitTime
TimeSpan
The timeout when reading data from the EventSource API.
10 seconds
WithReadTimeout
TimeSpan
The timeout when reading data from the stream.
5 minutes
WithReconnectTime
TimeSpan
The stream connection timeout.
1 second
WithHttpClientTimeout
TimeSpan
Set the connection timeout for the configuration.
10 seconds
WithHttpClientHandler
HttpClientHandler
Sets the handler for http requests. Can be used to configure proxy authentication.
A default HttpClientHandler
WithOffline
bool
Set whether this client is offline.
false
WithAllAttributesPrivate
bool
Whether all user attributes (except the user key) should be marked as Private user attributes, and not sent to LaunchDarkly.
false
WithPrivateAttributeName
string
Adds the name of a user attribute that should be marked as private to a internally managed list. May be called multiple times to mark additional attributes as private.
No attributes are private by default.
Feature flag targeting and rollouts are all determined by the user you pass to your variation calls. In our .NET SDK, the User class contains extension methods that make it easy to construct users. Here's an example:
LDUser user = User.WithKey("aa0ceb")
.AndFirstName("Ernestina")
.AndLastName("Evans")
.AndEmail("ernestina@example.com")
.AndCustomAttribute("groups", new List<String>(){"Google", "Microsoft"})
Let's walk through this snippet. The argument to WithKey is the user's key-- in this case we've used the hash "aa0ceb". The user key is the only mandatory user attribute. The key should also uniquely identify each user. You can use a primary key, an e-mail address, or a hash, as long as the same user always has the same key. We recommend using a hash if possible.
All of the other attributes (set via calls to AndFirstName, AndLastName, AndEmail, and AndCustom attributes) are optional. The attributes you specify will automatically appear on our dashboard, meaning that you can start segmenting and targeting users with these attributes.
In addition to the built-in attributes defined in the User class, you can pass us any of your own user data by passing custom attributes, like the groups attribute in the example above.
A note on types
Most of our built-in attributes (like names and e-mail addresses) expect string values. Custom attributes values can be strings, booleans (like true or false), numbers, or lists of strings, booleans or numbers.
If you enter a custom value on our dashboard that looks like a number or a boolean, it'll be interpreted that way. The .NET SDK is strongly typed, so be aware of this distinction.
Custom attributes are one of the most powerful features of LaunchDarkly. They let you target users according to any data that you want to send to us-- organizations, groups, account plans-- anything you pass to us becomes available instantly on our dashboard.
You can optionally configure the .NET SDK to treat some or all user attributes as private user attributes . Private user attributes can be used for targeting purposes, but are removed from the user data sent back to LaunchDarkly.
In the .NET SDK there are two ways to define private attributes for the entire LaunchDarkly client:
- When creating the LaunchDarkly
Configurationobject, you can call theWithAllAttributesPrivatemethod, which takes in a boolean parameter. Iftrue, all user attributes (except the key) for all users are removed before the user is sent to LaunchDarkly. - When creating the LaunchDarkly
Configurationobject, you can call theWithPrivateAttributeNamemethod, which takes in an attribute name (string) as a parameter and adds it to an internally managed list of private attributes. This method may be called multiple times to mark additional attributes as private. If any user has a custom or built-in attribute named in the private attributes list, it will be removed before the user is sent to LaunchDarkly.
You can also mark attributes as private when building the user object itself by calling the equivalent "private" user builder method. For example:
var user = User.WithKey("aa0ceb")
.AndPrivateEmail("test@example.com");When this user is sent back to LaunchDarkly, the email attribute will be omitted.
You can also distinguish logged-in users from anonymous users in the SDK, as follows:
LDUser user = User.WithKey("aa0ceb")
.AndAnonymous(true)
You will still need to generate a unique key for anonymous users-- session IDs or UUIDs work best for this.
Anonymous users work just like regular users, except that they won't appear on your Users page in LaunchDarkly. You also can't search for anonymous users on your Features page, and you can't search or autocomplete by anonymous user keys. This is actually a good thing-- it keeps anonymous users from polluting your Users page!
The Variation method determines whether a flag is enabled or not for a specific user. In .NET, there is a variation method for each type (e.g. BoolVariation, StringVariation):
var value = ldClient.BoolVariation("your.feature.key", user, false);
variation calls take the feature flag key, an LDUser, and a default value.
The default value will only be returned if an error is encountered-- for example, if the feature flag key doesn't exist or the user doesn't have a key specified.
The variation call will automatically create a user in LaunchDarkly if a user with that user key doesn't exist already. There's no need to create users ahead of time (but if you do need to, take a look at Identify).
The Track method allows you to record actions your users take on your site. This lets you record events that take place on your server. In LaunchDarkly, you can tie these events to goals in A/B tests. Here's a simple example:
ldClient.Track("your-goal-key", user);You can also attach custom data to your event by passing an extra parameter to Track:
ldClient.Track("Completed purchase", user, "sku132");
Identify creates or updates users on LaunchDarkly, making them available for targeting and autocomplete on the dashboard. In most cases, you won't need to call Identify-- the Variation call will automatically create users on the dashboard for you. Identify can be useful if you want to pre-populate your dashboard before launching any features.
ldClient.Identify(user);Note that unlike Variation and Identify calls, AllFlagsState does not send events to LaunchDarkly. Thus, users are not created or updated in the LaunchDarkly dashboard.
The AllFlagsState method captures the state of all feature flag keys with regard to a specific user. This includes their values, as well as other metadata.
This method can be useful for passing feature flags to your front-end. In particular, it can be used to provide bootstrap flag settings for our JavaScript SDK.
var state = ldClient.AllFlagsState(user);The default (fallback) values are defined in your code. The default value will only be returned if an error is encountered or if LaunchDarkly is unreachable -- for example, if the feature flag key doesn't exist or the user doesn't have a key specified.
In some situations, you might want avoid remote calls to LaunchDarkly and fall back to default values for your feature flags. For example, if your software is both cloud-hosted and distributed to customers to run on premise, it might make sense to fall back to defaults when running on premise. You can do this by setting offline mode in the client's Config. When the client is in offline mode, no network requests will be made, so it is suitable for unit-testing.
Configuration config = Configuration.Default("SDK_KEY");
config.WithOffline(true);
LdClient client = new LdClient(config);
The SecureModeHash method computes an HMAC signature of a user signed with the client's SDK key. If you're using our JavaScript SDK for client-side flags, this method generates the signature you need for secure mode.
ldClient.SecureModeHash(user);Internally, the LaunchDarkly SDK keeps an event buffer for Track and Identify calls. These are flushed periodically in a background thread. In some situations (for example, if you're testing out the SDK in a REPL), you may want to manually call Flush to process events immediately.
ldClient.Flush();Note that the flush interval is configurable-- if you need to change the interval, you can do so via the Configuration class.
Dispose safely shuts down the client instance and releases all resources associated with the client. In most long-running applications, you should not have to call dispose.
ldClient.Dispose();The .NET SDK now supports Server-Sent Events via a streaming connection. The beta can be downloaded via nuget.
New configuration parameters:
WithIsStreamingEnabled
Boolean value which enables streaming. true by default.
WithStreamUri
LaunchDarkly stream URI to be used. The default value is https://stream.launchdarkly.com
WithReadTimeout
The timeout when reading data from the stream. Defaults to 5 minutes.
WithReconnectTime
The stream connection timeout. Defaults to 10 seconds.
You can configure the .NET SDK to connect to the LaunchDarkly relay proxy as follows:
Configuration config = Configuration.Default("YOUR_SDK_KEY").WithStreamUri("YOUR_RELAY_URI");
LdClient client = new LdClient(config);
The .NET SDK uses the Common.Logging framework. For an example configuration check out the Common.Logging readme.
Be aware of two considerations when enabling the DEBUG log level:
- Debug-level logs can be very verbose. It is not recommended that you turn on debug logging in high-volume environments.
- Potentially sensitive information is logged including LaunchDarkly users created by you in your usage of this SDK.
The .NET SDK can use Redis as a persistent store of feature flag configurations. The Redis integration is in a separate package, also hosted publicly on GitHub here and available from NuGet. Here's an example client configuration hooked up to a Redis instance:
RedisFeatureStore store = RedisComponents.RedisFeatureStore()
.WithRedisHostAndPort("myredishost", 6379)
.WithCacheExpiration(TimeSpan.FromSeconds(60));
Configuration config = LaunchDarkly.Client.Configuration.Default("YOUR_SDK_KEY")
.WithFeatureStoreFactory(store);
LdClient ldClient = new LdClient(config);