Quickstart

This guide walks you through installing reveald, creating a configuration, and sending your first logs to RunReveal.

Create a reveald source in RunReveal

Open your RunReveal dashboard and navigate to Sources
Click Add Source and select Reveald
Give your source a name and click Save
Copy the webhook URL --- you'll need it in the next step

The webhook URL looks like: https://api.runreveal.com/sources/reveald/webhook/<id>

Install reveald

curl -L https://github.com/runreveal/reveald/releases/latest/download/reveald-linux-amd64.tar.gz | sudo tar --directory /usr/local/bin -xz
reveald --help

Create a configuration file

Create a file called config.json. This example tails a log directory and forwards to RunReveal:

{
  "sources": {
    "app-logs": {
      "type": "file",
      "path": "./test-logs/",
      "extension": ".log"
    }
  },
  "destinations": {
    "runreveal": {
      "type": "runreveal",
      "webhookURL": "YOUR_WEBHOOK_URL_HERE"
    }
  }
}

Replace YOUR_WEBHOOK_URL_HERE with the webhook URL from step 1.

Never commit webhook URLs to version control. Use environment variables for secrets --- see Configuration.

Create test logs and start reveald

mkdir -p test-logs
 
echo '{"eventName":"UserLogin","eventTime":"'$(date -u +%Y-%m-%dT%H:%M:%SZ)'","actor":{"email":"[email protected]"}}' > test-logs/app.log
 
reveald run --config config.json

Reveald starts tailing test-logs/ and forwarding events to RunReveal.

Verify delivery

In your RunReveal dashboard, navigate to your reveald source and check that events are appearing. You can also query for them:

SELECT *
FROM runreveal_logs
WHERE sourceType = 'reveald'
  AND receivedAt >= now() - INTERVAL 1 HOUR
ORDER BY receivedAt DESC
LIMIT 10

What's next

Configuration --- Learn the full config file format, including environment variable substitution
Sources --- Explore all available source types
Deployment --- Run reveald as a production systemd service