Documentation

Config allows advanced configuration of the LaunchDarkly client.

Create a default configuration from a given SDK key.

Set the SDK key used to authenticate with LaunchDarkly.

The base URI of the main LaunchDarkly service. This should not normally be changed except for testing.

The base URI of the LaunchDarkly streaming service. This should not normally be changed except for testing.

The base URI of the LaunchDarkly service that accepts analytics events. This should not normally be changed except for testing.

Sets whether streaming mode should be enabled. By default, streaming is enabled. It should only be disabled on the advice of LaunchDarkly support.

Sets whether or not all user attributes (other than the key) should be hidden from LaunchDarkly. If this is true, all user attribute values will be private, not just the attributes specified in PrivateAttributeNames.

Marks a set of user attribute names private. Any users sent to LaunchDarkly with this configuration active will have attributes with these names removed.

The time between flushes of the event buffer. Decreasing the flush interval means that the event buffer is less likely to reach capacity.

The polling interval (when streaming is disabled).

The number of user keys that the event processor can remember at any one time, so that duplicate user details will not be sent in analytics events.

Set to true if you need to see the full user details in every analytics event.

The capacity of the events buffer. The client buffers up to this many events in memory before flushing. If the capacity is exceeded before the buffer is flushed, events will be discarded.

Set the logger to be used by the client.

Sets whether to send analytics events back to LaunchDarkly. By default, the client will send events. This differs from Offline in that it only affects sending events, not streaming or polling for events from the server.

Sets whether this client is offline. An offline client will not make any network connections to LaunchDarkly, and will return default values for all feature flags.

Sets how long an the HTTP client should wait before a response is returned.

Configures a handle to an external store such as Redis.

When a store backend is configured, control how long values should be cached in memory before going back to the backend.

Sets whether this client should use the LaunchDarkly relay in daemon mode. In this mode, the client does not subscribe to the streaming or polling API, but reads data only from the feature store. See: https://docs.launchdarkly.com/docs/the-relay-proxy