Skip to content

Quick tour of the VSCode Lightrun plugin

The majority of the work you do with Lightrun, such as troubleshooting, debugging, and performance testing, is performed directly from your integrated development environment (IDE) or the Lightrun CLI.

Using the Lightrun plugin, provided for a variety of popular IDEs (such as VSCode, IntelliJ, and PyCharm), you can insert Lightrun actions (Logs, Metrics, and Snapshots) anywhere within the source code of your running applications. Also, from within the Lightrun plugin for your IDE, you can view, in real time, the output of Lightrun actions.

And, thanks to Lightrun's comprehensive range of integrations with third-party logging tools, from the plugin, you also can route output from Lightrun Logs and Metrics to your usual logging framework (such as and DataDog).

Scope of the quick tour

This quick tour article provides an overview of the main features and functionalities of the Lightrun Plugin for Visual Studio Code (VSCode). For detailed information on procedures for running Lightrun actions and managing configurations within VSCode, see:


To follow this quick tour on your workstation, if not previously done:

  • Attach at least one agent to your application
  • Open the source code folder for your running the application in the IDE

The Lightrun sidebar layout

Upon clicking, in the VSCode activity bar, the Lightrun plugin icon VSCode Lightrun plugin extension icon, the Lightrun sidebar opens. Follow the on-screen instructions to authenticate.

If no agents are available in your organization, follow the on-screen instructions.

Once your application is running with the Lightrun agent attached, the VSCode plugin user interface appears similar to the annotated figure shown below.

Lightrun plugin layout

View tabs

There are three view tabs in the Lightrun sidebar

Selecting any of the three view tabs exposes additional menus and options, respectively for managing Agents, Tags, and Snapshots.

Sources view tab

The Sources view tab exposes additional menus and options for managing your Lightrun agents, tags, and custom sources directly in your VSCode IDE.

Sources tab --half

There are two subtabs in the Sources view tab.

Agents subtab

The Agents subtab displays a list of live agents running alongside your applications. The Agents subtab appears similar to the following image:

Agents subtab --half

Click the expand icon Expand list icon on an agent to display the actions assigned to the agent.

Agents subtab expanded --half

Click the add icon add icon --icon on an agent to add an action to the agent.

Agents add actions --half

Click the menu icon Agent options menu icon to display the AGENT OPTIONS menu.

Lightrun plugin layout --half

Select Pin to pin the agent to the top of the Agents subtab or select Details to view more information about the agent.

View agent details --third

The following table summarizes the information displayed in the Agent details window.

Field Description
Name The agent's display name or host name if not specified
Host The name of the machine where the agent is running
Environment The runtime environment of the application with which the agent is running
ID A unique identifier, automatically generated for the agent
PID The process ID (on the machine where the agent is running)
Start Time The time at which the agent started running
API Version The version number of the server the agent is connected to
Agent Version The version number of the agent
Log Routing The configured routing method
Tags Next to Agent details, the names of tags that have been applied to the agent. If there are more than one tag, additional tags are displayed by clicking the Show additional tags icon.

Tags subtab

The Tags subtab lists all available tags with their associated agents and actions. The Tags subtab appears similar to the following image.

Tags tab --half

Click the expand icon Expand list icon on a tag to reveal the agents and actions associated with that tag.

Tags tab expanded --half

Click the add icon add icon --icon on a tag to add an action to the tag.

Tags add actions --half

Click the menu icon Agent options menu icon to display the TAGS OPTIONS menu.

Tags options --half

Select Pin to pin the tab to the top of the Tags subtab or select Delete to delete the tag.

From the sources dynamic search field, you can search for Logs, Snapshots, and Metrics attached to specific agents or tags. As you begin typing, the list of relevant agents updates dynamically.

Dynamic search field --half


Sources dynamic search is particularly useful for finding specific dynamic Logs, when working with multiple agents and tags.

Actions view tab

The Actions view tab lists all Lightrun actions (Logs, Metrics, and Snapshots) currently in your system. This includes active actions, disabled actions, expired actions, and actions with errors.

VSCode actions tab --half

Click the menu icon Action options menu icon to display the ACTION OPTIONS menu.

VSCode Action options --half

  • Select Go to to navigate the VSCode code editor to the action file and code line.
  • Select info to view more information about the action.
  • Select Delete to delete the action.

The Actions dynamic search filter allows you to search for Lightrun actions using their name, agent name, filename, or code line. You can also sort the action tab with your action file name and creation time, or filter the action tab with the All, Active, Expired, and Error statuses.

As you start typing, the search filter will update the action list dynamically.

Dynamic search field --half

Snapshots Hits view tab

The Snapshots tab list all available snapshots data that was captured.

Snapshots tab

Learn more about Snapshots in VSCode.

Lightrun Console

The Lightrun Console lets you view and interact with data from dynamic logs and metrics directly from within your VSCode IDE.


Data from dynamic logs and metrics only appear in the Lightrun Console when you set their target configuration to Plugin.

The Lightrun Console appears similar to the following image.

Lightrun console

Enter an agent's name into the console’s search bar to display only data from logs and metrics associated with the agent alone. Click Clear logs to clear the entire console, and use the My Logs only toggle button to configure if you want to view actions created by you alone or actions created by other members of your team in the Lightrun Console.

Additional features

Clicking the More Options icon More options menu icon at the top of the plugin, opens the PLUGIN OPTIONS menu.

VSCode plugin options

From here you can:

  • Open, within VSCode, the Lightrun plugin extension settings window.
  • Open the Lightrun documentation web page
  • Open the Lightrun user feedback web page
  • Refresh the user interface
  • Navigate to Lightrun management portal
  • Sign out from the current user

Last update: May 29, 2023