Requirements for Splunk SDK for C# v2.0

Beyond Splunk Enterprise, you'll need a few more things before you can install and use the Splunk SDK for C# v2.0.

Note: Be aware that these requirements only apply to the computer on which you'll be installing the Splunk SDK for C#. Your Splunk Enterprise instance can be separate, and can be running on any Splunk-supported platform.

Install a framework

At the very least, you will need one of two frameworks:

Install an IDE

Using an integrated development environment (IDE) is not required, but is recommended. Splunk has tested the following IDEs:

Install CCRewrite

If you're using Visual Studio to develop with the SDK, you'll need to install the code contracts binary rewriter to build and run your projects and the SDK examples.

Install CCRewrite from http://go.microsoft.com/fwlink/?LinkID=169180.

Install other dependencies (optional)

As you'll see when you browse the example code, several examples have dependencies on both Moq and xUnit. To build and run all of the examples, install both Moq and xUnit into the SDK project using the NuGet Package Manager.

Install Reactive Extensions for .NET (optional)

With the Splunk SDK for C#, you can use Reactive Extensions for .NET (Rx .NET) to "observe" Splunk's query results and receive notifications from that results collection. For more information about using Rx with the SDK, see Reactive Extensions (Rx).

Note: Installing Rx support is optional, and is only necessary if you want to take advantage of it. The Splunk SDK for C# defines an Observable<T> class to provide basic push-based notifications to observers. If this is all you need, you may not need to install Rx. For more information, see Reactive Extensions (Rx).

To take advantage of support for Reactive Extensions for .NET in the Splunk SDK for C#, download and install them using the instructions on the Get Reactive Extensions for .NET page on MSDN.