Get Started

Quick Start Guide

Get LuminaLog up and running in your application in under 5 minutes.

Step 1: Create an Account

Step 2: Get Your API Key

1Log in to your dashboard

2Navigate to Settings → API Keys

3Click "Create New API Key"

4Copy your API key (it starts with ll_)

Keep Your API Key Secret

Never commit your API key to version control. Use environment variables instead.

Step 3: Install the SDK

Node.js / TypeScript

npm install @luminalog/sdk

Python

pip install luminalog

Go

go get github.com/luminalog/sdk-go

Step 4: Initialize the Logger

Node.js / TypeScript

logger.ts

import { LuminaLog } from '@luminalog/sdk';

export const logger = new LuminaLog({
  apiKey: process.env.LUMINALOG_API_KEY!,
  environment: process.env.NODE_ENV || 'development',
  
  // Optional configuration
  batchSize: 100,        // Send logs in batches of 100
  flushInterval: 5000,   // Flush every 5 seconds
  privacyMode: true,     // Enable PII scrubbing (default: true)
});

Python

logger.py

import os
from luminalog import LuminaLog

logger = LuminaLog(
    api_key=os.getenv('LUMINALOG_API_KEY'),
    environment=os.getenv('ENVIRONMENT', 'development'),
    
    # Optional configuration
    batch_size=100,
    flush_interval=5.0,
    privacy_mode=True
)

Go

logger.go

package main

import (
    "os"
    "github.com/luminalog/sdk-go/luminalog"
)

var logger = luminalog.New(&luminalog.Config{
    APIKey:      os.Getenv("LUMINALOG_API_KEY"),
    Environment: os.Getenv("ENVIRONMENT"),
    
    // Optional configuration
    BatchSize:     100,
    FlushInterval: 5 * time.Second,
    PrivacyMode:   true,
})

Step 5: Start Logging

Basic Logging

// Info logs
logger.info('User logged in', { userId: '12345' });

// Warning logs
logger.warn('High memory usage', { memoryMB: 512 });

// Error logs
logger.error('Payment failed', { 
  error: err.message,
  userId: '12345'
});

// Debug logs (only in development)
logger.debug('Processing request', { requestId: 'abc-123' });

Structured Logging

logger.info('Order placed', {
  orderId: 'ORD-12345',
  userId: 'user-789',
  amount: 99.99,
  currency: 'USD',
  items: [
    { productId: 'PROD-1', quantity: 2 },
    { productId: 'PROD-2', quantity: 1 }
  ]
});

Error Tracking

try {
  await processPayment(order);
} catch (error) {
  logger.error('Payment processing failed', {
    error: error.message,
    stack: error.stack,
    orderId: order.id,
    userId: order.userId
  });
  
  // Re-throw or handle the error
  throw error;
}

Automatic PII Scrubbing

All sensitive data in your logs is automatically detected and scrubbed before storage. You don't need to do anything special—just log normally!

Step 6: View Your Logs

1Go to your dashboard at luminalog.cloud/dashboard

2Select your project from the dropdown

3View real-time logs in the Logs tab

4Use the AI Debug Assistant to ask questions about your logs

Next Steps

SmartScrub™

Understand how our PII detection and scrubbing works.

AI Debugging

Ask natural language questions about your logs.

Set Up Alerts

Get notified of critical errors in real-time.

Integrations

Connect to Slack, Discord, PagerDuty and more.

Need Help?

If you run into any issues, check out our full documentation or reach out on Discord.