How to Use Lightrun

Getting started with Lightrun

In this guide, you'll learn how to set up Lightrun and use its GenAI debugger to troubleshoot issues in live production applications. After completing these steps, you'll be able to insert logs, metrics, and traces directly from your IDE without redeploying your application.

Step 1: Sign up and set up

1. Go to the Lightrun website.
2. Click on the "Get Started" button in the top right corner.
3. Choose the "Sign Up" option and fill in your details, or use your GitHub or Google account for quick registration.
4. Once signed up, you will be directed to the dashboard where you can create your first project.

Step 2: Your first debugging session

1. In your Lightrun dashboard, click on "Create Project."
2. Select your programming language and framework (e.g., Java, Node.js).
3. Follow the on-screen instructions to install the Lightrun agent in your application.
4. Open your IDE and navigate to the file where you want to add logs or metrics.
5. Use the Lightrun plugin to add a log, metric, or trace by selecting the relevant option from the Lightrun menu.
6. Enter the details for your log or metric and click "Insert."
7. Trigger the relevant part of your application to see the logs appear in real time.

Step 3: Get better results

To enhance your debugging experience:

1. Use the "GenAI debugger" feature by clicking on the "Debug" option in the Lightrun menu.
2. Input specific queries or conditions to filter logs and metrics, making it easier to pinpoint issues.
3. Take advantage of real-time collaboration by inviting team members to view the session by clicking on "Invite" in the top right corner of the debug view.

Pro tip

When you add metrics, consider grouping them by function or module name. This will help you quickly locate related logs and identify patterns in performance issues.

Common mistake to avoid

Avoid skipping the installation of the Lightrun agent in your application. Without it, you won't be able to interact with your live production environment, and your debugging efforts will be ineffective.