Quickstart Guide

Get your first server log stream integrated and active with Sprint Log Parser in under 5 minutes. This guide will walk you through deploying our lightweight log shipper daemon and verifying telemetry collection.

1. Prerequisites

Before deploying, you must create a workspace project in the console and obtain your ingestion token:

1. Log in to your Dashboard.
2. Navigate to the **Workspaces** section and click **Create Project**.
3. Copy your workspace **Ingestion Token** from the project settings panel.

2. Download & Install

Deploy the background daemon directly onto your target Linux host. This setup script will auto-detect your distribution package manager, verify Python dependencies, and establish systemd hooks.

curl -sS https://sprint-logparser.dev.5starcompany.com.ng/download/setup | sudo SERVER_URL="https://sprint-logparser.dev.5starcompany.com.ng" API_TOKEN="YOUR_API_TOKEN" bash

3. Configuration

Once the setup script finishes, configure the local JSON config file located at `/etc/log-shipper.json` to configure the target server and workspace token:

{
  "api_url": "https://sprint-logparser.dev.5starcompany.com.ng/api/projects/ingest",
  "api_token": "YOUR_WORKSPACE_INGESTION_TOKEN",
  "log_file": "/var/log/nginx/access.log",
  "log_type": "nginx_access"
}

Restart the service to load the new settings:

sudo systemctl restart sprint-shipper

4. Verify Connection

Verify the log shipper is running and successfully sending payloads:

sudo systemctl status sprint-shipper

To view active transmissions in real-time, inspect the systemd daemon logs:

sudo journalctl -u sprint-shipper -f