Observo Documentation

curl -X POST https://observo-log.vendlyghana.space/api/v1/ingest/ \
  -H "X-Project-ID: YOUR_PROJECT_ID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"level": "INFO", "message": "Hello, Observo!"}'

# 201 Created → {"id": "log_01j...", "created": "2026-03-16T..."}

pip install observo-handler

import logging
from observo_handler import ObservoHandler

# Configure handler
handler = ObservoHandler(
    project_id="your-project-id",
    api_key="obs_live_xxxxxxxxxxxx",
    observo_url="https://observo-log.vendlyghana.space/api/v1/ingest/",
    batch_size=10,          # flush after 10 logs
    flush_interval=5,     # flush every 5 seconds
)

# Attach to any logger
logger = logging.getLogger("myapp")
logger.setLevel(logging.DEBUG)
logger.addHandler(handler)

# Use standard logging — no API calls needed in your code
logger.info("Application started")
logger.warning("Disk usage above 80%%", extra={"disk_pct": 82})
logger.error("Unhandled exception", exc_info=True)

LOGGING = {
    "version": 1,
    "disable_existing_loggers": False,
    "formatters": {
        "standard": {
            "format": "%(asctime)s %(levelname)s %(name)s %(message)s",
        },
    },
    "handlers": {
        "console": {
            "class": "logging.StreamHandler",
        },
        "observo": {
            "class": "observo_handler.ObservoHandler",
            "project_id": env("OBSERVO_PROJECT_ID"),
            "api_key": env("OBSERVO_API_KEY"),
            "observo_url": env("OBSERVO_URL"),
            "batch_size": 20,
            "flush_interval": 10,
        },
    },
    "root": {
        "handlers": ["console", "observo"],
        "level": "INFO",
    },
}

MIDDLEWARE = [
    "observo_handler.middleware.RequestIDMiddleware",  # First!
    "django.middleware.security.SecurityMiddleware",
    # ... rest of your middleware
]

import logging
from flask import Flask
from observo_handler import ObservoHandler

app = Flask(__name__)

# Attach to Flask's app logger
handler = ObservoHandler(
    project_id="my-flask-app",
    api_key="obs_live_xxxxxxxxxxxx",
    observo_url="https://observo-log.vendlyghana.space/api/v1/ingest/",
)
app.logger.addHandler(handler)
app.logger.setLevel(logging.INFO)

@app.route("/")
def index():
    app.logger.info("Home page visited")
    return "Hello!"

POST /api/v1/ingest/
X-Project-ID: your-project-id
Authorization: Bearer your-api-key
Content-Type: application/json

{
  "level": "ERROR",
  "message": "Payment failed for order #1234",
  "logger": "payments.stripe",
  "timestamp": "2026-03-16T12:41:09.000Z",
  "extra": {
    "user_id": 42,
    "order_id": 1234,
    "amount": 4999
  }
}

HTTP/1.1 201 Created
{
  "id": "log_01j9xk...",
  "created": "2026-03-16T12:41:09.123Z"
}

X-Project-ID: your-project-id
Authorization: Bearer your-api-key

# These tell you something happened — but not what, who, or why
logger.info('api_request')
logger.error('payment_failed')
logger.info('user_login')

# Rich context you can actually debug from
logger.info('api_request POST /api/v1/checkout 200 143ms user=u_8821')

logger.error(
    'payment_failed: Stripe declined card',
    extra={'extra_data': {
        'user_id': 'u_8821',
        'amount': 4999,
        'currency': 'USD',
        'stripe_error': 'insufficient_funds',
        'card_last4': '4242',
    }})

logger.info(
    'user_login success',
    extra={'extra_data': {
        'user_id': 'u_8821',
        'ip': '41.66.12.5',
        'method': 'email_password',
    }}
)

# Bad — no stack trace, impossible to debug
except Exception as e:
    logger.error(f'Payment failed: {e}')

# Good — full stack trace sent to Observo automatically
except Exception as e:
    logger.error('payment_processing_failed', exc_info=True, extra={'extra_data': {
        'order_id': order.id,
        'user_id': order.user_id,
        'amount': float(order.total),
    }})

OPENAI_API_KEY=sk-...
OPENAI_MODEL=gpt-4o  # optional, defaults to gpt-4

# Clone the repo
git clone https://github.com/kennedy-ak/observo.git
cd observo

# Copy and edit environment file
cp .env.example .env
nano .env

# Start all services
docker-compose up -d

# Run migrations
docker-compose exec web python manage.py migrate

# Create your admin user
docker-compose exec web python manage.py createsuperuser