Skip to content

Navigating the web interface

The Lightrun web interface allows all users to:

  • Access instructions and commands for setting up
  • View output from the instrumentation you've added
  • View system exceptions
  • Manage your account

In addition, users with ROLE_MANAGER can:

  • Manage Lightrun users, logs, services and more
  • Configure PII redaction and blocklisting
  • Send data to email recipients

Once you log in, the Getting Started landing page loads:

Getting started

The following table describes the parts of the interface as numbered above:

Part Description More information
1 Account menu. From this menu, you can update your personal details and password, and log out.
2 Getting started - helps you track the setting up steps you've already taken, and enables access to instructions and command lines necessary to get started. Setting Up
3 Menus - enable access to the data and features available from the web interface.
4 Instructions and command lines necessary to get started

The rest of the information here describes the different menu items as follows:

Getting started

The Getting started menu appears similar to the following:

Getting started menu -quarter

The following table describes the different options:

Item Description
Install the agent Loads the Getting Started page with instructions to install the agent.
Install and log in from the plugin Loads the Getting Started page with instructions to install the plugin.
Create first action Loads the documentation to explain how to insert actions.
Invite users Redirects and loads the Invite New Users page.
Upgrade your plan Redirects you to help you upgrade for more features.

Manager menu

The Manager menu appears similar to the following:

Manager menu -quarter

The following table describes the different options:

Item Description
User management Activate and deactive users and manage their permissions.
Collect Lightrun logs Collect system logs in case of any issues with Lightrun.
Audits View and work with system audits.
Service Configuration Customize basic service configurations for use of Lightrun.
Invite Invite new users to this account.
System Integrations Integrate Lightrun with the tools you use in your workflow.

Entities menu

The Entities menu appears similar to the following:

Entities menu -quarter

The following table describes the different options:

Item Description
Actions View all actions for all active agents added by all users in this account.
Agents View all active agents.
Agents Logs View all log output from any active actions inserted by all users in this account.
Tags Add tags to your configuration to manage complex systems and view them here.

Config menu

The Config menu appears similar to the following:

Config menu -quarter

The following table describes the different options:

Item Description
Blocklist Configure and manage blocklisting.
PII redaction Configure and manage PII redaction.

Exceptions menu

The Exceptions menu appears similar to the following:

Exceptions menu -third

The following table describes the different options:

Item Description
Data View exceptions thrown from Lightrun.
Email notifications Configure and manage to whom exception alerts should be sent by email.

Last update: May 5, 2021