isabella232 / splunk-extension-visualstudio

Splunk extension for Visual Studio

Splunk Extension for Visual Studio

The Splunk Extension for Visual Studio has been deprecated and will be removed on June 1, 2020.

For more information, see the Deprecation Notice on the Splunk Developer Portal.

Version 1.3.1

The Splunk extension for Visual Studio adds project templates to Visual Studio to help in writing programs that access Splunk via the Splunk Software Development kit (SDK) for C# and writing modular inputs for Splunk in C#. It also provides tooling for configuring logging of events over UDP or TCP to Splunk Enterprise.

The extension adds to the Visual Studio software development platform to simplify creating projects using the Splunk SDK for C#. It provides:

• A new "Splunk SDK for C#" project template.
• A new "Splunk Modular Input" project template.
• A set of code snippets for common tasks using the Splunk SDK for C#.
• Optional support for logging events over UDP or TCP with .NET Trace Listeners or the Semantic Logging Application Block (SLAB)

Splunk is a search engine and analytic environment that uses a distributed map-reduce architecture to efficiently index, search, and process large time-varying data sets.

The Splunk developer platform enables developers to take advantage of the same technology used by the Splunk product to build exciting new applications that are enabled by Splunk's unique capabilities.

Get started

The information in this Readme provides steps to get going quickly, but for more in-depth information be sure to visit the Splunk extension for Visual Studio documentation on Splunk Developer Portal.

Requirements

Here's what you need to get going with the Splunk extension for Visual Studio:

• Microsoft Visual Studio: The Splunk extension for Visual Studio requires Visual Studio 2013, Visual Studio 2015 Enterprise, Visual Studio 2015 Pro, or Visual Studio 2015 Community.
• Splunk Enterprise: If you haven't already installed Splunk Enterprise, download it at http://www.splunk.com/download. For more information about installing and running Splunk Enterprise and system requirements, see the Splunk Installation Manual.
• Splunk extension for Visual Studio: You install the Splunk extension for Visual Studio directly within Visual Studio; there is no separate download. Installing the Splunk extension for Visual Studio also installs the Splunk SDK for C#.

Install

To install the Splunk extension for Visual Studio:

1. In Visual Studio, on the Tools menu, click Extensions and Updates.

2. In the Extensions and Updates dialog box, in the left pane, expand Online and click Visual Studio Gallery.

3. In the Search Visual Studio Gallery box in the right pane, type splunk. "Splunk extension for Visual Studio" appears in the middle pane.

4. Click the Download button next to the extension's name.

5. In the Download and Install dialog box, click Install.

6. Click the Restart Now button that appears at the bottom of the Extensions and Updates dialog box to restart Visual Studio.

Get the source

If you are interested in contributing to the Splunk extension for Visual Studio, you can get it from GitHub and clone the resources to your computer.

Alternately, you can download a ZIP file containing the Splunk extension for Visual Studio. Extract the ZIP file's contents and then open the SplunkExtensionVisualStudio.sln.

Build the extension

To build from source after extracting or cloning the extension, do the following

1. Download and install the Visual Studio 2013 SDK, or Visual Studio 2015 SDK.
2. From the root level of the splunk-extension-visualstudio directory, open the SplunkExtensionVisualStudio.sln file in Visual Studio.
3. On the Build menu, click Build Solution.

This will build the extension.

Solution Layout

The Splunk extension for Visual Studio solution is organized into five projects:

• SplunkExtensionVisualStudio represents the VSIX file to build, and contains all the NuGet packages to be included in that VSIX.
• SplunkCSharpProjectTemplate defines the project template for Splunk SDK for C# PCL projects.
• CSharpProjectWizard defines the project creation wizard for the Splunk SDK for C# template.
• SplunkModularInputProjectTemplate defines the project template for creating modular inputs.
• ModularInputWizard defines the project creation wizard for the modular input template.

Changelog

The CHANGELOG.md file in the root of the repository contains a description of changes for each version of the extension. You can also find it online at https://github.com/splunk/splunk-extension-visualstudio/blob/master/CHANGELOG.md.

Branches

The master branch always represents a stable and released version of the extension.

All development is merged to the develop branch between releases.

Documentation and resources

If you need to know more:

• The main Splunk extension for Visual Studio documentation is at http://dev.splunk.com/view/splunk-extension-vs/SP-CAAAEXT.

• For all things developer with Splunk, your main resource is the Splunk Developer Portal.

• For more about the Splunk REST API, see the REST API Reference.

• For more about about Splunk in general, see Splunk>Docs.

Community

Stay connected with other developers building on Splunk.

Email	[email protected]
Issues	https://github.com/splunk/splunk-extension-visualstudio/issues
Answers	http://splunk-base.splunk.com/tags/csharp/
Blog	http://blogs.splunk.com/dev/
Twitter	@splunkdev

Contributions

If you want to make a code contribution, go to the Open Source page for more information.

Support

1. You will be granted support if you or your company are already covered under an existing maintenance/support agreement. Send an email to [email protected] and include "Splunk extension for Visual Studio" in the subject line.

2. If you are not covered under an existing maintenance/support agreement, you can find help through the broader community at:

   • Splunk Answers (use the visualstudio tag to identify your questions)
   • Splunkdev Google Group

3. Splunk will NOT provide support for the extension if its code has been modified. If you modify the extension and want support, you can find help through the broader community and Splunk answers (see above). We would also like to know why you modified the code—please send feedback to [email protected].

4. File any issues on GitHub.

Contact Us

You can reach the Dev Platform team at [email protected].

License

The Splunk extension for Visual Studio licensed under the Apache License 2.0. Details can be found in the LICENSE file.