Skip to content

Latest commit

 

History

History
254 lines (170 loc) · 10.8 KB

README.md

File metadata and controls

254 lines (170 loc) · 10.8 KB
Raw

Optimizely C# SDK

Semantic Build Status NuGet Apache 2.0

This repository houses the .Net based C# SDK for use with Optimizely Feature Experimentation and Optimizely Full Stack (legacy).

Optimizely Feature Experimentation is an A/B testing and feature management tool for product development teams, letting you experiment at every step. Using Optimizely Feature Experimentation allows for every feature on your roadmap to be an opportunity to discover hidden insights. Learn more at Optimizely.com, or see the developer documentation.

Optimizely Rollouts is free feature flags for development teams. You can easily roll out and roll back features in any application without code deploys, mitigating risk for every feature on your roadmap.

Get Started

Refer to the C# SDK's developer documentation for detailed instructions on getting started with using the SDK.

Install the C# SDK

The SDK can be installed through NuGet:

PM> Install-Package Optimizely.SDK

An ASP.Net MVC sample project demonstrating how to use the SDK is available as well:

PM> Install-Package Optimizely.SDK.Sample

Simply compile and run the Sample application to see it in use. Note that the way the Demo App stores data in memory is not recommended for production use and is merely illustrates how to use the SDK.

Feature Management Access

To access the Feature Management configuration in the Optimizely dashboard, please contact your Optimizely customer success manager.

Use the C# SDK

See the Optimizely Feature Experimentation developer documentation to learn how to set up your first C# project and use the SDK.

Initialization

Create the Optimizely Client, for example:

private static Optimizely Optimizely =
    new Optimizely(
        datafile: myProjectConfig,
        eventDispatcher: myEventDispatcher,
        logger: myLogger,
        errorHandler: myErrorHandler,
        skipJsonValidation: false);

Since this class parses the Project Config file, you should not create this per request.

APIs

This class exposes three main calls:

  1. Activate
  2. Track
  3. GetVariation

Activate and Track are used in the demonstration app. See the Optimizely documentation regarding how to use these.

Plug-in Interfaces

The Optimizely client object accepts the following plug-ins:

  1. IEventDispatcher handles the HTTP requests to Optimizely. The default implementation is an asynchronous "fire and forget".
  2. ILogger exposes a single method, Log, to record activity in the SDK. An example of a class to bridge the SDK's Log to Log4Net is provided in the Demo Application.
  3. IErrorHandler allows you to implement custom logic when Exceptions are thrown. Note that Exception information is already included in the Log.
  4. ProjectConfigManager exposes method for retrieving ProjectConfig instance. Examples include FallbackProjectConfigManager and HttpProjectConfigManager.
  5. EventProcessor provides an intermediary processing stage within event production. It's assumed that the EventProcessor dispatches events via a provided EventDispatcher. Examples include ForwardingEventProcessor and BatchEventProcessor. These are optional plug-ins and default behavior is implement if none are provided.

OptimizelyFactory

OptimizelyFactory provides basic utility to instantiate the Optimizely SDK with a minimal number of configuration options.

OptimizelyFactory does not capture all configuration and initialization options. For more use cases, build the resources via their respective builder classes.

Use OptimizelyFactory

You must provide the SDK key at runtime, either directly via the factory method:

Optimizely optimizely = OptimizelyFactory.newDefaultInstance(<<SDK_KEY>>);

You can also provide default datafile with the SDK key.

Optimizely optimizely = OptimizelyFactory.newDefaultInstance(<<SDK_KEY>>, <<Fallback>>);
Using App.config in OptimizelyFactory

OptimizelyFactory provides support of setting configuration variables in App.config: User can provide variables using following procedure:

  1. In App.config file of your project in add following:
<configSections>
    <section name="optlySDKConfigSection"
             type="OptimizelySDK.OptimizelySDKConfigSection, OptimizelySDK, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null" />
  </configSections>
  1. Now add optlySDKConfigSection below . In this section you can add and set following HttpProjectConfigManager and BatchEventProcessor variables:
<optlySDKConfigSection>
  
    <HttpProjectConfig sdkKey="43214321" 
                       url="www.testurl.com" 
                       format="https://cdn.optimizely.com/data/{0}.json" 
                       pollingInterval="2000" 
                       blockingTimeOutPeriod="10000" 
                       datafileAccessToken="testingtoken123"
                       autoUpdate="true" 
                       defaultStart="true">
    </HttpProjectConfig>

    <BatchEventProcessor batchSize="10"
                         flushInterval="2000"
                         timeoutInterval="10000"
                         defaultStart="true">
    </BatchEventProcessor>
  
  </optlySDKConfigSection>
  1. After setting these variables you can instantiate the Optimizely SDK using function:
Optimizely optimizely = OptimizelyFactory.newDefaultInstance();

BatchEventProcessor

BatchEventProcessor is a batched implementation of the EventProcessor * Events passed to the BatchEventProcessor are immediately added to a BlockingQueue. * The BatchEventProcessor maintains a single consumer thread that pulls events off of the BlockingQueue and buffers them for either a configured batch size or for a maximum duration before the resulting LogEvent is sent to the NotificationManager.

Use BatchEventProcessor
EventProcessor eventProcessor = new BatchEventProcessor.Builder()
                .WithMaxBatchSize(MaxEventBatchSize)
                .WithFlushInterval(MaxEventFlushInterval)
                .WithEventDispatcher(eventDispatcher)
                .WithNotificationCenter(notificationCenter)
                .Build();
Max Event Batch Size

The Max event batch size is used to limit eventQueue batch size and events will be dispatched when limit reaches.

Flush Interval

The FlushInterval is used to specify a delay between consecutive flush events call. Event batch will be dispatched after meeting this specified timeSpan.

Event Dispatcher

Custom EventDispatcher can be passed.

Notification Center

Custom NotificationCenter can be passed.

HttpProjectConfigManager

HttpProjectConfigManager is an implementation of the abstract PollingProjectConfigManager. The Poll method is extended and makes an HTTP GET request to the configured URL to asynchronously download the project datafile and initialize an instance of the ProjectConfig.

By default, HttpProjectConfigManager will block until the first successful datafile retrieval, up to a configurable timeout. Set the frequency of the polling method and the blocking timeout with HttpProjectConfigManager.Builder.

Use HttpProjectConfigManager
HttpProjectConfigManager httpManager = new HttpProjectConfigManager.Builder()
	.WithSdkKey(sdkKey)
	.WithPollingInterval(TimeSpan.FromMinutes(1))
	.Build();
SDK key

The SDK key is used to compose the outbound HTTP request to the default datafile location on the Optimizely CDN.

Polling interval

The polling interval is used to specify a fixed delay between consecutive HTTP requests for the datafile. Between 1 to 4294967294 miliseconds is valid duration. Otherwise default 5 minutes will be used.

Blocking Timeout Period

The blocking timeout period is used to specify a maximum time to wait for initial bootstrapping. Between 1 to 4294967294 miliseconds is valid blocking timeout period. Otherwise default value 15 seconds will be used.

Initial datafile

You can provide an initial datafile via the builder to bootstrap the ProjectConfigManager so that it can be used immediately without blocking execution.

URL

The URL is used to specify the location of datafile.

Format

This option enables user to provide a custom URL format to fetch the datafile.

Start by default

This option is used to specify whether to start the config manager on initialization or not. If no value is provided, by default it is true and will start polling datafile from remote immediately.

Datafile access token

This option is used to provide token for datafile belonging to a secure environment.

SDK Development

Contributing

Please see CONTRIBUTING.

Third Party Licenses

Optimizely SDK uses third party software: murmurhash-signed, Newtonsoft.Json, and NJsonSchema.

Other Optimzely SDKs