# Teracron

> Teracron is an observability platform that monitors software systems, traces
> workflow execution, and alerts engineers when things break. It provides
> real-time memory metrics, distributed tracing, and event tracking — all
> encrypted end-to-end with RSA-4096 + AES-256-GCM.

## Product

- **Website**: https://www.teracron.com
- **Dashboard**: https://www.teracron.com/dashboard (authenticated)
- **Documentation**: https://docs.teracron.com
- **Status**: Beta — actively maintained

## SDK (Python)

- **Package**: `teracron-sdk` on PyPI
- **Install**: `pip install teracron-sdk`
- **Version**: 0.6.1
- **Python**: >= 3.9
- **License**: Apache-2.0
- **Source**: https://github.com/teracron/teracron-sdk-python
- **Full docs for agents**: https://www.teracron.com/llms-full.txt

## Quick Start

```bash
pip install teracron-sdk
```

```python
import teracron
teracron.up()  # reads TERACRON_API_KEY from env
```

One env var (`TERACRON_API_KEY`), one line of code. Metrics, traces, and events
flow automatically in a background daemon thread.

## Capabilities

- **Memory Monitoring**: RSS, VMS, USS, CPU usage — collected every 10s
- **Workflow Tracing**: `@trace` decorator for function-level spans with
  parent-child relationships, error capture, and metadata
- **Event Tracking**: Custom application events with structured metadata
- **Framework Middleware**: FastAPI, Django, Celery auto-instrumentation
- **Cross-Process Propagation**: `X-Teracron-Trace` header for distributed traces
- **PII Safety**: Opt-in parameter capture, scrubber callbacks, no PII by default
- **Encryption**: RSA-4096 OAEP + AES-256-GCM envelope encryption — API key
  contains only the public key

## API Endpoints

All endpoints require an encrypted payload and `X-Project-Slug` header.

- `POST /api/v1/traces` — Ingest trace spans
- `POST /api/v1/events` — Ingest application events
- `POST /api/ingest` — Ingest memory metrics
- `GET  /api/v1/traces` — Query traces (authenticated)
- `GET  /api/v1/traces/:traceId` — Get trace detail with spans
- `GET  /api/v1/events` — Query events (authenticated)
- `GET  /api/v1/workflows` — List workflows (authenticated)
- `GET  /api/v1/spans/:spanId` — Get individual span detail

## Contact

- **Email**: sdk@teracron.com
- **Support**: https://www.teracron.com/dashboard (in-app)