# Sypnia documentation > Sypnia watches your app in production and tells you in plain words what broke, for whom and since when. Then it hands the fix to your coding agent: as a ready prompt, through an MCP server, or as a pull request. Sypnia comes two ways, and every page says which one it is about: - **Sypnia engine** (open source, self-hosted): Ingest, storage, aggregation, problem grouping, sessions, replay data and uptime checks. You read it through: The HTTP API, the MCP server, the CLI and the Console: one built-in page with the problems list and the session replay viewer. - **Sypnia Cloud** (paid service, with a free tier): The same engine, run by us. You read it through: The full app: replay player, performance, uptime, daily summary, search and teams. Every page is also plain Markdown: add `.md` to its address (`https://docs.sypnia.com/start/open-source-and-cloud.md`). All pages in one file: https://docs.sypnia.com/llms-full.txt ## Start here What Sypnia is, how it works, what is open source and what is the paid cloud, and the two ways to get your first problem in plain words. - [Start here: overview](https://docs.sypnia.com/start.md): What Sypnia is, how it works, what is open source and what is the paid cloud, and the two ways to get your first problem in plain words. [Engine, Cloud] - [What Sypnia is](https://docs.sypnia.com/start/what-sypnia-is.md): What Sypnia watches, who it is for, how it differs from a dashboard, and what it does not do. [Engine, Cloud] - [How it works](https://docs.sypnia.com/start/how-it-works.md): The path from a click in your app to a sentence in your inbox, the parts involved, and how fresh each kind of information is. [Engine, Cloud] - [Open source and Sypnia Cloud](https://docs.sypnia.com/start/open-source-and-cloud.md): Read this to know whether a feature exists in the open-source engine, in Sypnia Cloud, or in both, before you tell someone how to use it. [Engine, Cloud] - [Quickstart: Sypnia Cloud](https://docs.sypnia.com/start/quickstart-cloud.md): From nothing to your first session and your first problem on Sypnia Cloud, in five steps and about ten minutes. [Cloud] - [Quickstart: self-host](https://docs.sypnia.com/start/quickstart-self-host.md): Run the open-source Sypnia engine on your own machine with Docker, create a project, and see your first session and your first problem. [Engine] - [Install with your coding agent](https://docs.sypnia.com/start/install-with-your-agent.md): Let Claude Code, Cursor or any coding agent add Sypnia to your project, what it will change, the exact prompt for agents without skills, and what to check afterwards. [Engine, Cloud] - [Your first problem](https://docs.sypnia.com/start/your-first-problem.md): Break something on purpose and follow it through Sypnia, from the failure to the session, the replay, the sentence and the fix. [Engine, Cloud] ## Concepts The ten ideas Sypnia is made of, each defined precisely, from a project and its keys to problems, traces and alerts. - [Concepts: overview](https://docs.sypnia.com/concepts.md): The ten ideas Sypnia is made of, each defined precisely, from a project and its keys to problems, traces and alerts. [Engine, Cloud] - [Projects, environments, keys and tokens](https://docs.sypnia.com/concepts/projects-keys-and-tokens.md): Where your data belongs in Sypnia, and exactly what an ingest key, an API token and the root token can and cannot do. [Engine, Cloud] - [Events](https://docs.sypnia.com/concepts/events.md): What your app reports to Sypnia, what every event carries, how events travel, and which ones count towards a plan. [Engine, Cloud] - [Sessions and replay](https://docs.sypnia.com/concepts/sessions-and-replay.md): What starts and ends a session, who a session belongs to, which sessions are recorded, and exactly what a replay shows. [Engine, Cloud] - [Problems](https://docs.sypnia.com/concepts/problems.md): What a problem is, what makes two failures the same problem, and exactly when a problem is new, growing, resolved, ignored or back. [Engine, Cloud] - [Traces](https://docs.sypnia.com/concepts/traces.md): How Sypnia follows one request from a click in the browser to your API and the database calls behind it, and what a trace stores. [Engine, Cloud] - [Performance](https://docs.sypnia.com/concepts/performance.md): How Sypnia measures page speed and API speed for real people, how percentiles are computed and shown, and how it names the element behind a slow page. [Engine, Cloud] - [Rage and dead clicks](https://docs.sypnia.com/concepts/rage-and-dead-clicks.md): The exact rules that make a click a rage click or a dead click, what does not count, and how click maps show them on the page. [Engine, Cloud] - [Uptime](https://docs.sypnia.com/concepts/uptime.md): What an uptime check does, when your app counts as down and as up again, when you are told, and what differs between the engine and Sypnia Cloud. [Engine, Cloud] - [Releases and source maps](https://docs.sypnia.com/concepts/releases-and-source-maps.md): How Sypnia knows which version of your app a failure came from, how it says «since yesterday's change», and how source maps turn built code back into yours. [Engine, Cloud] - [Alerts and the daily summary](https://docs.sypnia.com/concepts/alerts-and-daily-summary.md): What creates an alert, what an alert contains, how it reaches you on the engine and on Sypnia Cloud, and what the daily summary says and when. [Engine, Cloud] ## SDKs How your app sends data to Sypnia. One SDK for the browser, one for Node, one for Next.js, and the OpenTelemetry intake for every other backend. - [SDKs: overview](https://docs.sypnia.com/sdks.md): How your app sends data to Sypnia. One SDK for the browser, one for Node, one for Next.js, and the OpenTelemetry intake for every other backend. [Engine, Cloud] - [Browser](https://docs.sypnia.com/sdks/browser.md): Install @sypnia/browser with a package manager or one script tag, every option of init with its type and default, what is captured without any code, and the few functions you call yourself. [Engine, Cloud] - [Node](https://docs.sypnia.com/sdks/node.md): Trace every request your Node server handles and every call it makes, link them to the browser session that caused them, and report server errors, with one import. [Engine, Cloud] - [Next.js](https://docs.sypnia.com/sdks/nextjs.md): One setup of @sypnia/next covers the browser and the server of a Next.js app, in the App Router and the Pages Router, and uploads source maps when you build. [Engine, Cloud] - [OpenTelemetry](https://docs.sypnia.com/sdks/opentelemetry.md): Point an existing OTLP/HTTP trace exporter at Sypnia, with examples for Python, Go, PHP, Rust, Java and the Collector, what each span becomes, and exactly what is ignored at launch. [Engine, Cloud] - [Privacy and masking](https://docs.sypnia.com/sdks/privacy-and-masking.md): The privacy defaults of the SDKs, every option and attribute that masks more, how to keep whole areas of your app out, and how to see for yourself what is sent. [Engine, Cloud] - [Identifying people](https://docs.sypnia.com/sdks/identifying-people.md): How identify() ties sessions and problems to a person and an account, what is stored, how anonymous sessions work, and how to identify requests on the server. [Engine, Cloud] - [Sampling and quotas](https://docs.sypnia.com/sdks/sampling-and-quotas.md): Which sessions are recorded and how to change it, what the SDKs send and hold back, the «slow down» signal, and exactly what happens when a project reaches a limit. [Engine, Cloud] - [Troubleshooting](https://docs.sypnia.com/sdks/troubleshooting.md): What to check when nothing arrives, when requests are blocked by an ad blocker, CORS or a content security policy, when source maps do not apply, and when sessions look duplicated. [Engine, Cloud] ## The agent How Sypnia analyses a problem, what it writes, what it sends to a model and what it never does. - [The agent: overview](https://docs.sypnia.com/agent.md): Section index for Sypnia's own analysis (the agent): how it works, the ready prompt, pull requests on Sypnia Cloud, model providers and what data is sent, and limits. [Engine, Cloud] - [How the analysis works](https://docs.sypnia.com/agent/how-the-analysis-works.md): The pipeline of Sypnia's analysis: triggers (new, grows, comes back, on request), inputs (failure, stack with source lines, breadcrumbs, trace, release changes, impact), the five steps, the output fields and confidence rules, failure modes (not_enough_evidence, failed, limit_reached, off), and the weekly suggestions. [Engine, Cloud] - [The prompt](https://docs.sypnia.com/agent/the-prompt.md): The exact, fixed structure of Sypnia's ready prompt (What happens / Where / Why / Do / Check, then Evidence and Rules), a complete example, the variants without analysis, where to get it (app, Console, API, MCP, CLI) and its size limit. [Engine, Cloud] - [Pull requests](https://docs.sypnia.com/agent/pull-requests.md): Sypnia Cloud pull requests: when one can be opened (confidence high or medium, repository connected), branch sypnia/, contents of the PR (change, test, description), GitHub App permissions (Contents RW, Pull requests RW, Metadata R), what it never does (no merge, no push to default branch), failure modes, and fixes per month by plan. [Cloud] - [Models and what is sent](https://docs.sypnia.com/agent/models-and-what-is-sent.md): Model providers for Sypnia's analysis: Cloud uses models through OpenRouter (no specific model promised); the engine is off until configured with SYPNIA_AI_PROVIDER (openrouter, openai, anthropic, google, openai-compatible), SYPNIA_AI_API_KEY, SYPNIA_AI_MODEL, SYPNIA_AI_BASE_URL; check with sypnia doctor; the exact data sent and never sent; examples calling a model yourself with the OpenAI, Anthropic and OpenRouter SDKs from the problem context. [Engine, Cloud] - [Limits](https://docs.sypnia.com/agent/limits.md): Limits of Sypnia's analysis: analyses per project per day (engine setting SYPNIA_AI_MAX_ANALYSES_PER_DAY, Cloud per plan), 3 per problem per day, pull requests per month by plan (5/50/300), input and output sizes, timeout and retries, weekly suggestions caps. [Engine, Cloud] ## MCP and skills Connect your coding agent to Sypnia so it can ask what is failing in production, read what it needs to fix it, and set Sypnia up for you. - [MCP and skills: overview](https://docs.sypnia.com/mcp.md): Start here to connect a coding agent to Sypnia: the MCP server (remote, self-hosted, local stdio), its ten tools, the two agent skills (sypnia-setup, sypnia-fix), examples and security. [Engine, Cloud] - [Connect](https://docs.sypnia.com/mcp/connect.md): Exact commands and config snippets to connect the Sypnia MCP server: Claude Code (claude mcp add), Cursor (.cursor/mcp.json), other clients; remote Streamable HTTP at https://mcp.sypnia.com/mcp, self-hosted /mcp, local stdio with npx @sypnia/mcp. [Engine, Cloud] - [Authentication](https://docs.sypnia.com/mcp/authentication.md): How the Sypnia MCP server authenticates: an API token (sps_) with the read scope, sent as an Authorization Bearer header to the remote server or as SYPNIA_API_TOKEN to the local one; one token is one project; no OAuth at launch. [Engine, Cloud] - [Tools reference](https://docs.sypnia.com/mcp/tools-reference.md): The ten tools of the Sypnia MCP server (health, problems, problem, problem_prompt, sessions, session, search, performance, uptime, resolve_problem) with input schemas and example results, plus its resources and prompts. [Engine, Cloud] - [Skills](https://docs.sypnia.com/mcp/skills.md): The Sypnia agent skills (open source, MIT): sypnia-setup installs and configures Sypnia in a project; sypnia-fix fixes a problem through the MCP server. Install, update and remove commands for Claude Code and Cursor, the rule equivalent for other agents, and the full SKILL.md text of each. [Engine, Cloud] - [Examples](https://docs.sypnia.com/mcp/examples.md): Worked MCP sessions with exact tool calls and results: (1) what is failing -> problems -> problem -> fix -> resolve_problem, (2) performance of a slow page, (3) search a person -> sessions -> session timeline. [Engine, Cloud] - [Security](https://docs.sypnia.com/mcp/security.md): Security model of the Sypnia MCP server: read-only except resolve_problem, how to disable it (read_only=true, --read-only, SYPNIA_MCP_READ_ONLY), what results never contain, prompt-injection handling, token scope, logging, where data goes. [Engine, Cloud] ## API reference The Sypnia HTTP API: one API for the open-source engine and for Sypnia Cloud, with every endpoint, parameter, response and error. - [API reference: overview](https://docs.sypnia.com/api.md): Index of the Sypnia HTTP API reference. Base URL https://api.sypnia.com/v1 (self-hosted: /v1). Start with Overview and authentication; conventions are on Errors, limits, pagination. The contract is spec/openapi.yaml. [Engine, Cloud] - [Overview and authentication](https://docs.sypnia.com/api/overview-and-authentication.md): Read this first before calling the Sypnia HTTP API: base URLs for Cloud and self-hosted, ingest key vs API token vs root token, scopes, the project parameter, and the whoami, summary and search endpoints. [Engine, Cloud] - [Ingest](https://docs.sypnia.com/api/ingest.md): Reference of the Ingest endpoints of the Sypnia HTTP API: parameters, response shapes, examples and errors. [Engine, Cloud] - [OTLP](https://docs.sypnia.com/api/otlp.md): Reference of the OTLP endpoints of the Sypnia HTTP API: parameters, response shapes, examples and errors. [Engine, Cloud] - [Problems](https://docs.sypnia.com/api/problems.md): Reference of the Problems endpoints of the Sypnia HTTP API: parameters, response shapes, examples and errors. [Engine, Cloud] - [Sessions and replays](https://docs.sypnia.com/api/sessions-and-replays.md): Reference of the Sessions and replays endpoints of the Sypnia HTTP API: parameters, response shapes, examples and errors. [Engine, Cloud] - [Traces](https://docs.sypnia.com/api/traces.md): Reference of the Traces endpoints of the Sypnia HTTP API: parameters, response shapes, examples and errors. [Engine, Cloud] - [Performance](https://docs.sypnia.com/api/performance.md): Reference of the Performance endpoints of the Sypnia HTTP API: parameters, response shapes, examples and errors. [Engine, Cloud] - [Uptime](https://docs.sypnia.com/api/uptime.md): Reference of the Uptime endpoints of the Sypnia HTTP API: parameters, response shapes, examples and errors. [Engine, Cloud] - [Releases and source maps](https://docs.sypnia.com/api/releases-and-source-maps.md): Reference of the Releases and source maps endpoints of the Sypnia HTTP API: parameters, response shapes, examples and errors. [Engine, Cloud] - [Projects, keys and tokens](https://docs.sypnia.com/api/projects-keys-and-tokens.md): Reference of the Projects, keys and tokens endpoints of the Sypnia HTTP API: parameters, response shapes, examples and errors. [Engine, Cloud] - [Alerts and webhooks](https://docs.sypnia.com/api/webhooks.md): Reference for alerts, alert rules and webhooks in the Sypnia API: alert kinds and thresholds, webhook registration, the delivery body, how to verify the Sypnia-Signature header, retries. [Engine, Cloud] - [Errors, limits, pagination](https://docs.sypnia.com/api/errors-limits-pagination.md): The conventions shared by every endpoint of the Sypnia API: error JSON shape and codes, when to retry, rate-limit headers, cursor pagination, since/until, environment, Idempotency-Key, versioning, retention. [Engine, Cloud] ## CLI reference The sypnia command: how to install it, the variables it reads, what its exit codes mean, and where each command is documented. - [CLI reference: overview](https://docs.sypnia.com/cli.md): Overview of the sypnia CLI: one binary that is both the engine (serve, aggregate, migrate, doctor) and its client (project, key, token, sourcemaps upload, problems, problem); install methods, environment variables, exit codes. [Engine, Cloud] - [Commands](https://docs.sypnia.com/cli/commands.md): Reference of the sypnia CLI: serve, aggregate, migrate, doctor, project, key, token, sourcemaps upload, problems, problem, version; flags, environment variables, example output and exit codes. [Engine, Cloud] ## Self-hosting What you run when you host the Sypnia engine yourself, what you need, what it costs, and what you do not get compared with Sypnia Cloud. - [Self-hosting: overview](https://docs.sypnia.com/self-hosting.md): Overview of self-hosting the open-source Sypnia engine: the three things you run (the sypnia binary, Postgres 15+, an S3-compatible bucket), the two deployment shapes (AWS template, Docker Compose), requirements, cost summary, what must run for uptime checks, and what only Sypnia Cloud has. [Engine] - [Deploy on AWS](https://docs.sypnia.com/self-hosting/deploy-aws.md): How to deploy the self-hosted Sypnia engine on AWS with the one CloudFormation template sypnia-aws.yaml: what it creates (three Lambda functions, a queue, a schedule, an S3 bucket, a CloudFront address, optional RDS Postgres), its parameters, step-by-step commands with expected results, custom domain, updates, changing settings, and removal. [Engine] - [Deploy with Docker](https://docs.sypnia.com/self-hosting/deploy-docker.md): How to deploy the self-hosted Sypnia engine on one server with Docker Compose: the full compose.yaml (engine, Postgres 16, MinIO, Caddy for HTTPS), the .env file, health check, sypnia doctor, first project, ingest key and API token with the CLI, variants with Amazon S3, Cloudflare R2, Supabase or Neon, the bucket CORS rule, day-to-day commands, removal and troubleshooting. [Engine] - [Configuration reference](https://docs.sypnia.com/self-hosting/configuration.md): Every SYPNIA_ environment variable of the self-hosted engine with type, default and meaning: base URL, root token, database, S3-compatible storage, retention, quotas, rate limits, recording defaults, uptime, alert webhook, AI provider. [Engine] - [Storage layout](https://docs.sypnia.com/self-hosting/storage-layout.md): Operator's view of where the self-hosted Sypnia engine stores data: the six bucket prefixes under each project id with their retention settings, the Postgres tables that grow, estimated sizes per million events and for a small and a medium project, commands to measure real usage, and which lifecycle, versioning and storage-class rules are safe on the bucket. [Engine] - [The Console](https://docs.sypnia.com/self-hosting/console.md): The Console is the one built-in web page of the self-hosted Sypnia engine, at /console: a problems list with each problem's analysis and prompt, unacknowledged alerts, and a session list with timeline and replay viewer. It signs in with an API token (read, plus replay for recordings), never the root token. How to protect it (per-person tokens, proxy rules, SYPNIA_CONSOLE_ENABLED=false) and what only the Sypnia Cloud app has. [Engine] - [Upgrades, backups, retention](https://docs.sypnia.com/self-hosting/upgrades-backups-retention.md): Operating a self-hosted Sypnia engine over time: the upgrade order (changelog, back up Postgres, sypnia migrate, replace the engine, sypnia doctor), what the compatibility rules promise, rollback, what must be backed up (Postgres) and what can be rebuilt from the bucket with sypnia aggregate --from, restore steps, and the five retention settings with what changing them does. [Engine] - [Scaling and cost](https://docs.sypnia.com/self-hosting/scaling-and-cost.md): Cost and capacity of a self-hosted Sypnia engine: cost drivers and the setting that controls each, estimated monthly totals for a small project (4 million events a month, about USD 22 on AWS) and a medium one (40 million, about USD 60 to 85), server sizing for Docker, the signs that a deployment is at its limit, database connection arithmetic, how to split one process into roles, and when to use the AWS functions shape. All figures are estimates or measurements from the system the engine comes from, labelled. [Engine] - [Security checklist](https://docs.sypnia.com/self-hosting/security-checklist.md): Checklist for securing a self-hosted Sypnia engine before production: the root token, HTTPS and the proxy hop count, a private bucket with a narrow key and CORS rule, a database of its own with TLS, API tokens with the fewest scopes and an expiry, allowed origins and quotas for ingest keys, the Console and MCP server, outbound calls (uptime checks, webhooks, the AI provider), backups, logs and upgrades. Each item names the exact setting or command and how to verify it. [Engine] ## How the engine is built The whole Sypnia engine on one page, from a click in your app to the sentence your coding agent reads, with the design rules and the code that holds them. - [How the engine is built: overview](https://docs.sypnia.com/architecture.md): The whole Sypnia engine on one page, from a click in your app to the sentence your coding agent reads, with the design rules and the code that holds them. [Engine] - [Data flow](https://docs.sypnia.com/architecture/data-flow.md): Every hop an event makes inside the engine, with its time budget, what waits for what, how the engine pushes back, what happens when a piece is down, and how the 2-minute and 10-minute promises are kept. [Engine] - [What happens when something fails](https://docs.sypnia.com/architecture/reliability.md): Read this to know the engine's delivery guarantee (at-least-once between steps, idempotent steps), the failure table per hop, the intake queue and its dead-letter queue on AWS (retention, visibility timeout, max receives, redrive, alarms), the in-memory buffer of the one-process shape, quarantine of poison segments, work as rows in Postgres (jobs, alert releases, webhook deliveries), GET /healthz, GET /v1/engine/status and sypnia doctor. [Engine] - [Storage](https://docs.sypnia.com/architecture/storage.md): The bucket layout as a tree, the Postgres schema with its main tables, how data is partitioned and expired, how much a million events weigh, and what is never stored. [Engine] - [Ingest](https://docs.sypnia.com/architecture/ingest.md): How the engine receives events, replay chunks, page snapshots, source maps and OTLP traces, what it checks, how it turns batches into objects, how it handles duplicates, and why it does not query the database to do it. [Engine] - [Aggregation](https://docs.sypnia.com/architecture/aggregation.md): How the roll-up turns an hour of raw events into numbers without a SQL engine, with its group-bys, histograms, session assembly, the ledger that makes counters exactly-once, its memory bounds and the daily Parquet file. [Engine] - [Problem grouping](https://docs.sypnia.com/architecture/problem-grouping.md): How failures become problems, with the exact fingerprint algorithm worked by hand, symbolication with source maps, the rule that makes one request one problem across browser and server, the states of a problem and what triggers an alert. [Engine] - [The agent's pipeline](https://docs.sypnia.com/architecture/agent-pipeline.md): How the engine analyses a problem, from the trigger and the context it builds to the provider call, the checked answer, the alert it releases and the prompt, with what is cached, what is limited and what only Sypnia Cloud adds. [Engine] - [Deployment shapes](https://docs.sypnia.com/architecture/deployment-shapes.md): How the same Sypnia binary runs as three AWS functions or as one long-running process, what the AWS template creates, what each shape costs with the arithmetic shown, and the pieces you can swap, seen from the code. [Engine] - [The codebase](https://docs.sypnia.com/architecture/codebase.md): The engine's repository, crate by crate, with the main traits and types, the rules every line of code follows, the tests that replay recorded hours, how to run it on your machine and how a contribution flows. [Engine] ## Sypnia Cloud How the paid service works, from organizations and roles to plans, limits, billing, where your data lives, the GitHub App and support. - [Sypnia Cloud: overview](https://docs.sypnia.com/cloud.md): How the paid service works, from organizations and roles to plans, limits, billing, where your data lives, the GitHub App and support. [Cloud] - [Organizations and teams](https://docs.sypnia.com/cloud/organizations-and-teams.md): How accounts, organizations and roles work on Sypnia Cloud, what each role can do, and how inviting and removing people works. [Cloud] - [Plans and limits](https://docs.sypnia.com/cloud/plans-and-limits.md): What each Sypnia Cloud plan includes, exactly how each limit is counted, and what happens when a limit is reached. [Cloud] - [Billing](https://docs.sypnia.com/cloud/billing.md): How paying for Sypnia Cloud works, including what changing or cancelling a plan does, what a failed payment does, and what you are never charged for. [Cloud] - [Data location and retention](https://docs.sypnia.com/cloud/data-location-and-retention.md): Where Sypnia Cloud stores your data, which other companies touch it, how long each kind of data is kept on each plan, and when it is deleted. [Cloud] - [The GitHub App](https://docs.sypnia.com/cloud/github-app.md): What the Sypnia GitHub App is allowed to do in your repositories, what it never does, what happens to your code, and how to install and remove it. [Cloud] - [Support](https://docs.sypnia.com/cloud/support.md): How to get help with Sypnia on each plan, what to send so we can help fast, and what we do not promise. [Engine, Cloud] ## Privacy and security What Sypnia collects from your app and its users, what it never collects, how masking works, how to delete data, and how the service is protected. - [Privacy and security: overview](https://docs.sypnia.com/privacy.md): What Sypnia collects from your app and its users, what it never collects, how masking works, how to delete data, and how the service is protected. [Engine, Cloud] - [What is collected](https://docs.sypnia.com/privacy/what-is-collected.md): Every kind of data Sypnia receives from your app and its users, which of it is personal data, where it is kept in the browser, and what Sypnia never collects. [Engine, Cloud] - [Masking](https://docs.sypnia.com/privacy/masking.md): What Sypnia hides in recordings and events without being asked, what you can hide yourself, exactly what masking does to the page, and how to check it. [Engine, Cloud] - [Deleting data](https://docs.sypnia.com/privacy/deleting-data.md): How data is deleted from Sypnia, on the open-source engine and on Sypnia Cloud: DELETE /v1/people/{person_id}, DELETE /v1/sessions/{session}, DELETE /v1/releases/{version}/sourcemaps and DELETE /v1/projects/{project_ref} with their credentials, what each removes, timing (lists at once, stored objects within 24 hours), what stays (totals, problem records, backups, what already left Sypnia), and deleting an organization or an account on Sypnia Cloud. [Engine, Cloud] - [Security practices](https://docs.sypnia.com/privacy/security-practices.md): Sypnia's security practices, without compliance claims: protections built into the SDKs and the engine (write-only ingest keys, hashed API tokens with scopes, per-project isolation, masking in the browser, ingest limits, private bucket with signed links, signed webhooks, outbound call rules, what the agent sends), how Sypnia Cloud is run (encryption, staff access rules, backups, sub-processors, incident notice), what does not exist yet, and how to report a vulnerability to support@sypnia.com. [Engine, Cloud] ## Licensing Which licence covers each part of Sypnia, what you may do with it, how the name may be used, and the terms of a contribution. - [Licensing: overview](https://docs.sypnia.com/licensing.md): Section index for Sypnia's licensing: engine and Console under AGPL-3.0, SDKs, @sypnia/mcp and the agent skills under MIT, documentation under CC BY 4.0, the Sypnia Cloud app proprietary, the name and logo as trademarks, contributions accepted with a DCO sign-off. A proposal the owner will confirm; not legal advice. [Engine, Cloud] - [The licences in plain words](https://docs.sypnia.com/licensing/licences-in-plain-words.md): Plain-language explanation of Sypnia's proposed licences by situation: self-hosting the unmodified engine (AGPL-3.0, no obligations beyond keeping notices), modifying it (offer your source to people who use your version over a network), embedding the MIT SDKs in a closed-source app (allowed), building on the API (your code stays yours), redistributing or forking, offering it as a hosted service (allowed under AGPL, not under the Sypnia name), reusing the docs (CC BY 4.0). Not legal advice. [Engine, Cloud] - [Trademarks](https://docs.sypnia.com/licensing/trademarks.md): Sypnia's trademark rules in plain words (a proposal): the name Sypnia, Sypnia Cloud and the logo are not granted by the AGPL, MIT or CC BY licences. Allowed without asking: truthful reference (uses, works with, for Sypnia, based on Sypnia), writing and teaching, unchanged redistribution. Needs permission: product, company, domain or package names containing Sypnia, hosted services named Sypnia, the logo as your own mark. Modified versions and forks need another name. [Engine, Cloud] - [Contributing](https://docs.sypnia.com/licensing/contributing.md): How to contribute to Sypnia's open-source parts (engine, Console, SDKs, @sypnia/mcp, skills, docs): where to ask questions and report bugs, what a good report contains, the docs-first flow of a change, and the terms: contributions are licensed under the repository's own licence (AGPL-3.0, MIT or CC BY 4.0), authors keep their copyright, there is no CLA, and every commit must carry a Developer Certificate of Origin sign-off (git commit -s). [Engine] ## Guides Step-by-step recipes for the common ways to use Sypnia, from apps made with AI builders and Next.js on Vercel to Supabase, source maps in CI, alert e-mails from your own engine, and moving from Sentry. - [Guides: overview](https://docs.sypnia.com/guides.md): Step-by-step recipes for the common ways to use Sypnia, from apps made with AI builders and Next.js on Vercel to Supabase, source maps in CI, alert e-mails from your own engine, and moving from Sentry. [Engine, Cloud] - [Apps built with Lovable, Bolt, v0 or Replit](https://docs.sypnia.com/guides/lovable-bolt-v0-replit.md): Add Sypnia to an app made with an AI app builder, with the prompt to give the builder, the code it should produce, and how to check that it did it right. [Engine, Cloud] - [Next.js on Vercel](https://docs.sypnia.com/guides/nextjs-on-vercel.md): Set up @sypnia/next for an app deployed on Vercel, with the environment variables, what preview deployments report, source maps at build, and the ad-blocker route. [Engine, Cloud] - [Supabase apps](https://docs.sypnia.com/guides/supabase.md): Watch an app built on Supabase, from the browser's calls to your database through to Edge Functions, with database calls as spans and people identified from Supabase Auth. [Engine, Cloud] - [Source maps in CI](https://docs.sypnia.com/guides/source-maps-in-ci.md): Upload source maps and register the release from your build, with a complete GitHub Actions example, so stacks show your own files and problems say which change started them. [Engine, Cloud] - [Alert e-mails from a self-hosted engine](https://docs.sypnia.com/guides/alert-emails-self-hosted.md): Turn the alert webhook of your own engine into e-mail, with a small function on Amazon SES or a small server on any SMTP account. [Engine] - [Coming from Sentry](https://docs.sypnia.com/guides/coming-from-sentry.md): How Sentry's concepts and calls map to Sypnia's, what to remove from your code, and an honest list of what has no equivalent yet. [Engine, Cloud] ## Reference The pages you look things up in, from the event schema and the glossary to what is planned, the changelog and the common questions. - [Reference: overview](https://docs.sypnia.com/reference.md): Section index for Sypnia's reference pages: the event schema (every event field by field), the glossary (one name per thing), Planned (everything that does not exist at launch), the changelog, and the FAQ. The API, the CLI, the MCP tools and the engine's settings have their own reference sections. [Engine, Cloud] - [Event schema](https://docs.sypnia.com/reference/event-schema.md): Every event the SDKs send, field by field, with types, limits and an example of each, and the rules the engine applies to them. [Engine, Cloud] - [Glossary](https://docs.sypnia.com/reference/glossary.md): Sypnia's vocabulary, one name per thing: project, environment, release, event, session, replay, trace, span, problem (never «issue»), the agent (Sypnia's analysis, not your coding agent), fix, ingest key, API token, root token, engine, Sypnia Cloud, the Console, person, account, rage click, dead click, page snapshot, outage, mark. Use these words exactly when you write about Sypnia. [Engine, Cloud] - [Planned](https://docs.sypnia.com/reference/planned.md): Everything Sypnia does NOT have at launch, so an agent never presents it as existing. Planned (no dates): native iOS and Android SDKs, SDKs for Python, PHP, Go and Rust, logs, custom metrics and dashboards, SSO, signed identity for sending, more Node database drivers, an AWS Lambda adapter, Bun/Deno/Workers, the Next.js Edge runtime, server-bundle source maps, sampling of successful requests. Absent without a promise: server-side track(), certificate-expiry warnings, status pages, OAuth for MCP, region choice, and others. Not by design: WhatsApp and Slack, e-mail and pull requests in the engine, merging code, recording typed input. [Engine, Cloud] - [Changelog](https://docs.sypnia.com/reference/changelog.md): Sypnia's changelog page and its rules. Nothing is released yet, so there are no entries. Once releases exist: one entry per release, newest first, per component (engine, SDKs, @sypnia/mcp, skills, Sypnia Cloud), with fixed headings (Added, Changed, Fixed, Security, Deprecated, Removed, To do when upgrading). Versions follow semantic versioning; inside version 1 the API, the event schema, the settings and the database only add. [Engine, Cloud] - [FAQ](https://docs.sypnia.com/reference/faq.md): Frequently asked questions about Sypnia with short, exact answers and links: what it is, open-source engine versus Sypnia Cloud, price, supported platforms, speed (a problem within 2 minutes, numbers within 10), what is recorded and never recorded, data location, no compliance certificates, the agent and AI models, pull requests, coding agents and MCP, self-hosting requirements and cost, alerts (e-mail on Cloud, webhook on the engine, no Slack or WhatsApp), licences, and what is not available at launch. [Engine, Cloud]