Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.sluice.sh/llms.txt

Use this file to discover all available pages before exploring further.

If you’ve installed the SDK or agent but aren’t seeing data in the dashboard, work through this checklist from top to bottom — the issues are ordered from most common to least common.

Debugging checklist

1. Celery events are disabled (most common)

Celery disables task events by default. Without events enabled, there’s nothing for Sluice to capture. Check: Look for these settings in your Celery config:
worker_send_task_events = True    # Must be True
task_send_sent_event = True       # Must be True
task_track_started = True         # Must be True
Fix: If you’re using the Python SDK, sluice.init() enables these automatically. If you’re using the Docker agent, you must set these in your Celery config manually and restart your workers.
[sluice] Celery events are not enabled. No data will be captured.
         Add worker_send_task_events=True to your Celery config.
         See: https://docs.sluice.sh/troubleshooting/no-data

2. Worker hasn’t been restarted

Celery reads configuration at startup. If you added sluice.init() or changed event settings without restarting your worker, the changes won’t take effect. Fix: Restart your Celery worker:
celery -A your_app worker -l info
Look for the [sluice] banner in the startup output to confirm the SDK loaded.

3. API key or connection ID is wrong

Check: Verify your API key and connection ID in the Sluice dashboard under Connections. The API key starts with sk_. Common mistakes:
  • Trailing whitespace or newline in the env var
  • Using the connection name instead of the connection UUID
  • Mixing up API keys between connections
Error you’ll see:
[sluice] API key is empty. Pass api_key= or set SLUICE_API_KEY env var.
         See: https://docs.sluice.sh/troubleshooting/api-key

4. Network connectivity

The SDK and agent need HTTPS access to sluice.sh on port 443. Check from the host where the SDK/agent runs:
curl -sf https://sluice.sh/api/health
# Should return: {"status":"ok","timestamp":"..."}
If this fails, check:
  • Firewall rules allowing outbound HTTPS
  • Proxy configuration (HTTPS_PROXY environment variable)
  • DNS resolution for sluice.sh

5. Daily event limit reached

The free tier allows 10,000 events per day. If you’ve hit the limit, new events are rejected until midnight UTC. Check: Look for this in your SDK/agent logs:
HTTP 429: Daily limit reached (10,000 events).
Or check your usage in the dashboard under Settings.

6. No tasks are being executed

If your Celery workers are idle — no tasks are being sent — there’s no data to capture. Check: Send a test task:
from your_app.tasks import some_task
some_task.delay()
Then check the dashboard. If the test task appears, the issue is that your application isn’t dispatching tasks, not that Sluice is misconfigured.

7. Agent can’t reach Redis (agent path only)

If the Go agent can’t connect to Redis, it can’t subscribe to events. Check agent logs:
docker logs sluice-agent
Look for connection errors. Verify the REDIS_URL environment variable is correct and that Redis is accessible from the agent’s network.

Still stuck?

If you’ve worked through this checklist and data still isn’t appearing, check the Connection Issues page or reach out at github.com/sluice-sh/sluice/issues.