#Run python script with debug software#
#Run python script with debug code#
#Run python script with debug plus#

The timeout parameter specifies how long, in seconds, the debug server will wait for Visual Studio Code to connect to the running process.

Starts the debug server for your code.

This makes is possible for your code to import the necessary modules without copying them to your project.

Appends the path of the supporting add-on to the Python path.

Place the following in your Python file you would like to debug: import sys, os In order to debug your Python code, some minor changes need to be made. This will attach Visual Studio Code to the running process in Splunk Enterprise and enable a familiar debug experience. Basically, the code needs to be running in order Visual Studio Code to attach.įinally, start the debugger in Visual Studio Code. If you are debugging a custom alert action, create a search to trigger the action. If you are debugging a custom search command, start a Splunk search and invoke the command. For instance, if you are debugging a modular input, create an instance of the input and enable it. Next, start the component you want to debug on the Splunk Enterprise server. These lines of code enable the Visual Studio Code debugger to connect and debug the Python code running in Splunk Enterprise. The server running Splunk Enterprise requires the Visual Studio Code Supporting Add-on for Splunk.įirst, on the Splunk Enterprise side, you will need to add a few lines of Python code to the component you want to debug. The workstation running Visual Studio Code requires the Visual Studio Code Extension for Splunk. Technically these things can run on the same logical machine however, Visual Studio Code can run on a workstation while Splunk Enterprise runs in a remote data center or even a public cloud.Įach component requires specific software.

#Run python script with debug software#

A machine running Splunk Enterprise software.A machine, like a workstation, running Visual Studio Code.

#Run python script with debug plus#

Visual Studio Code Extension for Splunk - contains everything you need to get started debugging plus bonus features to interact with Splunk.Microsoft Visual Studio Code Supporting Add-on for Splunk - enables Python code running in Splunk Enterprise to be debugged by Visual Studio Code.Splunk Enterprise - running in a data center or even a public cloud.User generated Python code running in Splunk Enterprise can be debugged using Visual Studio Code, and you get all the things you would expect in a debugger. You can also run a script in another Python file using the importlib module. But this requires the Python extension to work: import runpy py extension while using this method: import runpy You can also run a Python script with n_module().

Run a Python Script Using the Built-in Runpy Module Create a new Python file in the same directory as the one you want to run and execute the following code: exec(open( 'myScript.py').read()) Run a Python Script in Another Python File Using the exec FunctionĪlternatively, you can run Python code with the built-in exec() function. If you only need a function or class in the script you want to run, then use an absolute import: from myScript.py import myFunction