Quick start

Create an account, spin up a project, and confirm logs arrive in the dashboard.

  1. Create your account

    Visit the home page and sign in. LoggerMan uses Clerk for authentication. After sign-in, open the dashboard — your user record is created automatically on first visit.

  2. Create a project

    If you have no projects yet, you are guided to New project. Enter a name and submit. You land on project Overview settings with your project ID and API token ready.

    You can own multiple projects. Switch between them from the sidebar project menu at any time.
  3. Copy credentials

    Open Settings → API keys for your project (or Integration for the full copy-paste flow). Copy:

    • Project ID
    • Bearer token (keep secret — treat like a password)
    • Base URL — your public LoggerMan app origin (e.g. production URL, Vercel preview, or tunnel URL for local dev)
    Environment variables
    # .env.local (your app)
    LOGGERMAN_PROJECT_ID=your_project_id
    LOGGERMAN_TOKEN=your_bearer_token
    LOGGERMAN_BASE_URL=https://your-loggerman-deployment.com
  4. Install the logger in your app

    Pick one of two integration options:

    • npm (recommended) npm install @marvink02/loggerman-sdk
    • Copy a file — paste loggerman.ts from Integration settings (no package manager)
    Install
    npm install @marvink02/loggerman-sdk
    Usage (@marvink02/loggerman-sdk)
    import { createLogger } from "@marvink02/loggerman-sdk";
    
    const logger = createLogger({
      projectId: process.env.LOGGERMAN_PROJECT_ID!,
      token: process.env.LOGGERMAN_TOKEN!,
      baseUrl: process.env.LOGGERMAN_BASE_URL!,
      source: "my-api",
    });
    
    await logger.info("Server listening on port 3000");
    
    await logger.error("Database connection failed", {
      host: process.env.DB_HOST,
      attempt: 3,
    });
  5. Send a test log

    In the dashboard, go to Settings → Integration and click Send test log. Then open Logs in the sidebar — your entry should appear within seconds.

    Tunnel / localhost

    When developing behind Cloudflare Tunnel or localhost, set the API base URL in Integration to the URL your sending app can reach (often the tunnel origin, not 127.0.0.1 from another machine).
  6. Log from production

    Store credentials in your host's secret manager. Use distinct source values per service (e.g. api, worker, web) so filters in the dashboard stay meaningful.

Next steps

  • Logger SDK — edge, Next.js middleware, retries, breadcrumbs, webhooks
  • API reference — batch ingest, OTLP, incoming webhooks, structured errors
  • Dashboard & logs — search, export, triage
  • Dashboard Settings → Integration — incoming/outgoing webhooks, Vercel env snippets, Winston/Pino, CLI