.NET / C# SDK Getting Started

Cloud Bucketing - Initializing SDK

To start, initialize a client using the SDK key.

using System;
using System.Diagnostics;
using DevCycle.SDK.Server.Cloud.Api;

namespace Example {
    public class Example {
        public void main() {
            // using ensures REST Client resources are correctly disposed once no longer required.
            using DevCycleCloudClient client = new DevCycleCloudClientBuilder()
                .SetSDKKey(Environment.GetEnvironmentVariable("DEVCYCLE_SERVER_SDK_KEY"))
                .SetLogger(LoggerFactory.Create(builder => builder.AddConsole()))
                .Build();

        }
    }
}

Local Bucketing - Initializing SDK

To start, initialize a client using the SDK key.

using System;
using System.Diagnostics;
using DevCycle.SDK.Server.Local.Api;

namespace Example {
    public class Example {
        static Main(string[] args) {
            using DevCycleLocalClient client = new DevCycleLocalClientBuilder()
                .SetSDKKey("<DEVCYCLE_SERVER_SDK_KEY>")
                .SetLogger(LoggerFactory.Create(builder => builder.AddConsole()))
                .Build();
        }
    }
}

Initialization Options

The SDK exposes various initialization options which can be set when initializing the DevCycle client:

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using DevCycle.SDK.Server.Local.Api;
using DevCycle.SDK.Server.Common.API;
using DevCycle.SDK.Server.Common.Model;
using DevCycle.SDK.Server.Common.Model.Local;
using Microsoft.Extensions.Logging;

namespace Example {
    public class Example {
        private static DevCycleLocalClient client;

        static async Task Main(string[] args) {
            client = new DevCycleLocalClientBuilder()
                .SetSDKKey("<DEVCYCLE_SERVER_SDK_KEY>")
                .SetOptions(new DevCycleLocalOptions(configPollingIntervalMs: 60000, eventFlushIntervalMs: 60000))
                .SetInitializedSubscriber((o, e) => {
                    if (e.Success) {
                        ClientInitialized();
                    } else {
                        Console.WriteLine($"Client did not initialize. Errors: {e.Errors}");
                    }
                })
                .SetLogger(LoggerFactory.Create(builder => builder.AddConsole()))
                .Build();

            try {
                await Task.Delay(5000);
            } catch (TaskCanceledException) {
                System.Environment.Exit(0);
            }
        }

        private static void ClientInitialized() {
            // Start using the client here
        }
    }
}

DevCycle Option	Type	Description
logger	DevCycleLogger	Logger override to replace default logger
logLevel	String	Set log level of the default logger. Options are: debug, info, warn, error. Defaults to info.
enableCloudBucketing	Boolean	Switches the SDK to use Cloud Bucketing (via the DevCycle Bucketing API) instead of Local Bucketing.
enableEdgeDB	Boolean	Enables the usage of EdgeDB for DevCycle that syncs User Data to DevCycle. NOTE: This is only available with Cloud Bucketing.
configPollingIntervalMS	Number	Controls the polling interval in milliseconds to fetch new environment config changes, defaults to 10 seconds, minimum value is 1 second.
configPollingTimeoutMS	Number	Controls the request timeout to fetch new environment config changes, defaults to 5 seconds, must be less than the configPollingIntervalMS value, minimum value is 1 second.
eventFlushIntervalMS	Number	Controls the interval between flushing events to the DevCycle servers, defaults to 30 seconds.
disableAutomaticEventLogging	Boolean	Disables logging of sdk generated events (e.g. aggVariableEvaluated, aggVariableDefaulted) to DevCycle.
disableCustomEventLogging	Boolean	Disables logging of custom events, from track() method, and user data to DevCycle.
flushEventQueueSize	Number	Controls the maximum size the event queue can grow to until a flush is forced. Defaults to 1000.
maxEventQueueSize	Number	Controls the maximum size the event queue can grow to until events are dropped. Defaults to 2000.
apiProxyURL	String	Allows the SDK to communicate with a proxy of DevCycle bucketing API / client SDK API.
enableBetaRealtimeUpdates	Boolean	Enables the usage of Beta Realtime Updates for DevCycle. This feature is currently in beta.