Quick Start Guide

Welcome to EdLog!

EdLog is a powerful event monitoring dashboard that helps you track deployments, metrics, and system events across your infrastructure. Get started in just a few minutes!

1 Create a Project Group

Project groups organize related projects together. For example, you might have groups for "Production Apps", "Development Servers", or "Customer Sites".

Navigate to Project Groups in the main menu
Click New Project Group
Enter a name (e.g., "Production Apps")
Add a description (optional)
Click Create

2 Add Your First Project

Projects represent individual applications or services you want to monitor.

Open your project group
Click Add Project
Enter project details:
- Name: Your app name (e.g., "API Server")
- Key: Unique identifier (e.g., "api-server")
- Description: What this project does
Click Create Project
Copy the generated API Key - you'll need this!

Important: Save your API key securely. You'll need it to send events to EdLog.

3 Send Your First Event

Now let's send a test event to verify everything is working.

Using cURL:

curl -X POST https://your-edlog-domain.com/ingest \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "project_key": "api-server",
    "type": "deployment",
    "name": "deploy_started",
    "timestamp": "'$(date -u +"%Y-%m-%dT%H:%M:%SZ")'",
    "attributes": {
      "version": "v1.2.3",
      "environment": "production",
      "deployed_by": "CI/CD"
    }
  }'

Using Node.js:

const axios = require('axios');

axios.post('https://your-edlog-domain.com/ingest', {
  project_key: 'api-server',
  type: 'deployment',
  name: 'deploy_started',
  timestamp: new Date().toISOString(),
  attributes: {
    version: 'v1.2.3',
    environment: 'production',
    deployed_by: 'CI/CD'
  }
}, {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});

4 Create a Dashboard Tile

Tiles visualize your events on the dashboard. Let's create a deployment status tile.

Go to Dashboard
Click Add Tile
Configure the tile:
- Name: API Deployments
- Type: Deploy
- Projects: Select "API Server"
- Event Types: deployment
Add rules to change tile state based on events (optional)
Click Create Tile