https://github.com/splunk/vscode-extension-splunk

Visual Studio Code Extension for Splunk
https://github.com/splunk/vscode-extension-splunk

Last synced: 2 months ago
JSON representation

Visual Studio Code Extension for Splunk

• Host: GitHub
• URL: https://github.com/splunk/vscode-extension-splunk
• Owner: splunk
• License: mit
• Created: 2019-11-09T01:17:37.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-07-29T22:20:25.000Z (6 months ago)
• Last Synced: 2024-08-02T01:16:45.854Z (6 months ago)
• Language: Python
• Homepage:
• Size: 11.3 MB
• Stars: 84
• Watchers: 22
• Forks: 25
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-rainmana - splunk/vscode-extension-splunk - Visual Studio Code Extension for Splunk (Python)

README

        
# Visual Studio Code Extension for Splunk

[![GitHub Workflow Status](https://github.com/splunk/vscode-extension-splunk/actions/workflows/build-test.yaml/badge.svg)](https://github.com/splunk/vscode-extension-splunk/actions/workflows/build-test.yaml)[![GitHub Workflow Status](https://github.com/splunk/vscode-extension-splunk/actions/workflows/package-acceptance-test.yaml/badge.svg)](https://github.com/splunk/vscode-extension-splunk/actions/workflows/package-acceptance-test.yaml)

The Visual Studio Code Extension for Splunk helps developers create, test, and debug Splunk Enterprise apps, add-ons, custom commands, REST handlers, etc.  The extension helps Splunk administrators edit Splunk .conf files by providing stanza and setting completions as well as setting checking.  For individuals living in Visual Studio Code, integrations are built in to run Splunk searches and display Splunk visualizations in Visual Studio Code.

## Working with .conf files

![Splunk Extension Demo](https://raw.githubusercontent.com/wiki/splunk/vscode-extension-splunk/images/demo1.gif)

* Syntax highlighting for .conf files

* IntelliSense for stanzas and parameters

* Stanza folding

* Linting

## Splunk Notebooks

Splunk Notebooks provide the ability to author SPL Notes, execute SPL Notes as search jobs, and view results in Visual Studio Code.  Splunk Notebooks works for both SPL and SPL2.

![Splunk Notebooks](https://raw.githubusercontent.com/wiki/splunk/vscode-extension-splunk/images/spl_notebooks/SPL_Notebook.gif)

## Running Saved Searches

Visual Studio Code communicates with the Splunk REST API to enumerate saved searches and displays the reports in the editor.

![Splunk Saved Search](https://raw.githubusercontent.com/wiki/splunk/vscode-extension-splunk/images/saved_search_activity_bar.gif)

## Viewing Reports

Visual Studio Code communicates with the Splunk REST API to enumerate reports and displays the reports in the editor.

![Splunk Report](https://raw.githubusercontent.com/wiki/splunk/vscode-extension-splunk/images/embedded_view.gif)

## Debugging Splunk Code

This extension also provides capabilities for debugging user-generated Python code run by Splunk Enterprise (local or remote):

* Debug configurations

* Breakpoints

* Step into/over

* Variable inspection

Splunk Enterprise can be running on the same machine as Visual Studio Code, on a remote machine, in a container, or on a public cloud provider.

## Documentation

Documentation can be found in the [wiki](https://github.com/splunk/vscode-extension-splunk/wiki) hosted on the public repository.

[https://github.com/splunk/vscode-extension-splunk/wiki](https://github.com/splunk/vscode-extension-splunk/wiki)

## Support

This software is released as-is. Splunk provides no warranty and no support on this software.

If you have any issues with the software, please file an issue on the repository.