Skip to content

Docs

Get Started
Get Started
Use Lightrun
Use Lightrun
- Lightrun Autonomous Debugger
  Lightrun Autonomous Debugger
- What are Lightrun Actions?
- Dynamic Logs
- Snapshots
- Metrics
- Configuring Actions
  Configuring Actions
  - Sources
    Sources
    
    Tags
    
    Custom Sources
    
    Action Target
- Configuring Dynamic Traces
- Lighrun Plugins
  Lighrun Plugins
  - JetBrains
    JetBrains
    
    Quick Tour
    
    Install the JetBrains Plugin
    
    Authenticate Lightrun
    
    Instrument and Observe
    Instrument and Observe
    
    Lightrun Autonomous Debugger
    
    Dynamic Logs
    
    Snapshots
    
    Metrics
    
    Dynamic Traces
    Dynamic Traces
    
    Overview
    
    Create a Dynamic Trace
    
    Analyze Dynamic Trace Results
    
    Manage Dynamic Traces
    
    Multiple Sources
    
    Switch between Deployments
  - Visual Studio
    Visual Studio
    
    Quick Tour
    
    Install the Visual Studio Plugin
    
    Authenticate Lightrun
    
    Instrument and Observe
    Instrument and Observe
    
    Lightrun Autonomous Debugger
    
    Dynamic Logs
    
    Snapshots
    
    Multiple Sources
  - Visual Studio Code
    Visual Studio Code
    
    Quick Tour
    
    Install the VS Code Plugin
    
    Authenticate Lightrun
    
    Instrument and Observe
    Instrument and Observe
    
    Lightrun Autonomous Debugger
    
    Dynamic Logs
    
    Snapshots
    
    Metrics
    
    Multiple Sources
    
    Switch the Deployment
    
    Lightrun in VS Code (Java)
  - Web IDEs
    Web IDEs
    
    VSCode.dev
- Advanced Tools
  Advanced Tools
  - Lightrun LogOptimizer
    Lightrun LogOptimizer
    
    Overview
    
    Scan code for log-related issues
  - Track Loaded Software in Runtime
    Track Loaded Software in Runtime
    
    Runtime Reachability Assessment
    
    Webooks
    
    Prioritize Packages to Track
    
    View Loaded Packages
    
    View Dynamic SBOMS
    
    Package Enrichment
  - Lightrun CLI
    Lightrun CLI
    
    Install the Lightrun CLI
    
    Authenticate Lightrun
    
    CLI Commands
    
    Managers' CLI Reference
  - Troubleshooting
    Troubleshooting
    
    Overview
    
    Java
    
    Python
    
    Node.js
    
    .NET
Manage Lightrun
Manage Lightrun
- Lightrun Management Portal Overview
- Set Up Custom Sources
- Manage Agent and Data Services
- Monitor Lightrun Entities
  Monitor Lightrun Entities
- Administer Organization
  Administer Organization
  - Set Up Your Organization
  - Connectivity Settings
    Connectivity Settings
    
    SMTP Service Overview
    
    Custom SMTP Service
    
    Password Login without SMTP
  - Login and Authentication
    Login and Authentication
    
    Login Methods Overview
    
    SSO Login Experience
    
    Single-Sign-On (SSO)
    Single-Sign-On (SSO)
    
    SSO Overview
    
    SAML-based SSO
    SAML-based SSO
    
    SSO with Okta (SAML)
    
    SSO with Google (SAML)
    
    SSO with Microsoft Entra ID (SAML)
    
    SSO with Ping Identity (SAML)
    
    OIDC-based SSO
    OIDC-based SSO
    
    SSO with Okta (OIDC)
    
    SSO with Ping Identity (OIDC)
    
    SSO with Microsoft Entra ID (OIDC)
  - Provisioning Users
    Provisioning Users
    
    Provisioning Users (Enhanced Login)
    Provisioning Users (Enhanced Login)
    
    Overview
    
    Add and Invite Users
    
    User Self-Registration
    
    Add and Invite Users
    
    LDAP Provisioning
    
    SCIM Provisioning
    SCIM Provisioning
    
    Overview
    
    Provision SCIM Using Okta
    
    Provision SCIM Using Microsoft Entra ID
    
    Provision SCIM Using Ping Identity
    
    SSO JIT Provisioning
    SSO JIT Provisioning
    
    Overview
    
    Provision SSO JIT Using Okta
    
    Provision SSO JIT Using Microsoft Entra ID
    
    Provision SSO JIT Using Ping
  - API Keys
  - Identity and Access
    Identity and Access
    
    Manage Users with Basic Access
    
    Lightrun Role-Based Access Control
    Lightrun Role-Based Access Control
    
    Overview
    
    Manage Users with RBAC
    
    Manage Groups with RBAC
    
    Just-In-Time (JIT) Access
  - Agent Pools
    Agent Pools
    
    Get Started with Agent Pools
    
    Manage Agent Pools
    
    PII Redaction on Agent Pools
  - Data Security
    Data Security
    
    Overview
    
    PII Redaction
    PII Redaction
    
    Overview
    
    PII Redaction Best Practices
    
    Configure PII Redaction
    
    Blocklists
    
    Audit System Usage
  - Collect Logs
  - Diagnostics
Deploy Lightrun
Deploy Lightrun
- Install and Configure Agents
  Install and Configure Agents
  - Overview
  - Java
    Java
    
    System Requirements
    
    Install the Agent
    
    Configure the Agent
    
    Manage Tagging
    
    Customize Dynamic Logs
    
    Java Expressions
    
    Build Tools (Maven & Gradle)
    
    Scala
    
    Kotlin
    
    Application Servers & Servlet Containers
    Application Servers & Servlet Containers
    
    Spring Boot
    
    Tomcat
    
    Glassfish
    
    Wildfly
    
    Jetty
    
    Weblogic
    
    MicroProfile/JakartaEE
    
    Google App Engine
    
    WebSphere
  - Python
    Python
    
    System Requirements
    
    Install the Agent
    
    Configure the Agent
    
    Manage Metadata and Tagging
    
    Frameworks
    Frameworks
    
    Django
    
    Flask
    
    Apache Airflow
    
    Celery
    
    Gunicorn
    
    Serverless Functions
  - Node.js
    Node.js
    
    System Requirements
    
    Install the Agent
    
    Configure the Agent
    
    Manage Metadata and Tagging
    
    Frameworks
    Frameworks
    
    Express
    
    Koa
    
    Serverless Functions
  - .NET
    .NET
    
    System Requirements
    
    Install the Agent
    
    Configure the Agent
    
    Configure Profiler Chaining
    
    Manage Metadata and Tagging
    
    Customize Dynamic Logs
    
    C# Expressions
    
    Frameworks
    Frameworks
    
    IIS Framework
- Deploy Agents by Enviroment
  Deploy Agents by Enviroment
  - Lightrun on Docker
  - Lightrun on Kubernetes
    Lightrun on Kubernetes
    
    Introduction
    
    Lightrun Kubernetes Operator
    
    Lightrun on Minikube
    Lightrun on Minikube
    
    Lightrun installation with Init Containers
    
    Lightrun installation with Persistent Volumes
  - Lightrun on AWS Lambda
    Lightrun on AWS Lambda
    
    Introduction
    
    Lightrun on Node.js AWS Lambda
    Lightrun on Node.js AWS Lambda
    
    Install Lightrun with Lambda Layers
    
    Install Lightrun with container images
    
    Lightrun on Python AWS Lambda
    Lightrun on Python AWS Lambda
    
    Install Lightrun with Lambda Layers
- Deploy Lightrun Self-Hosted Server
  Deploy Lightrun Self-Hosted Server
  - Components
    Components
    
    Router
    
    Router
    
    AWS Load Balancer Controller
    
    Azure Application Gateway
    
    Azure Service Controller
    
    Contour Ingress
    
    GCP GKE Service
    
    GCP GKE Ingress
    
    Istio Gateway
    
    NGINX Ingress
    
    OpenShift HAProxy Router
    
    Artifacts
    
    Backend
    
    Crons Service
    
    Data Streamer
    
    Frontend
    
    Keycloak
    
    MySQL
    
    RabbitMQ
    
    Redis
  - Installation
    Installation
    
    Quick Start
    
    Secrets
    
    Capacity Planning
    
    Certificate
    
    Compatibility Matrix
    
    Container Image Registry
    
    Versions Mapping
    
    Cloud
    Cloud
    
    OpenShift
  - Release Strategy
  - Advanced
    Advanced
    
    Encryption Keys
    
    Internal TLS
    
    k8s Api Access
    
    Network Policy
    
    RabbitMQ Cluster K8s Operator
    
    Redis Enterprise Operator Integration
    
    System Config File
    
    System Diagnostics
  - Monitoring and Alerting Guide
- Integrate with Lightrun
  Integrate with Lightrun
  - Overview
  - AppDynamics
  - Datadog
    Datadog
    
    Events
    
    Logs
  - Dynatrace
  - Elastic Stack
  - FluentD
  - Grafana
  - HashiCorp Nomad
  - Instana
  - New Relic
  - Prometheus
  - Sentry
  - SIEM
  - Slack Alerts
    Slack Alerts
    
    Overview & Configuration
    
    Use Cases
  - StatsD
  - Splunk
  - Sumo Logic
API Reference
API Reference
- API Reference
- Introduction to API
Release Notes
Release Notes
- Lightrun Release Notes
- Previous Releases
  Previous Releases
  - 2023 Releases
  - 2022 Releases
- Enhanced Login Experience Guide
- Release Information
- Known Issues
- Functionality Changes and Deprecations

index

Instructions for Specific Cloud Providers¶

OpenShift

Last update: September 21, 2025