DOCUMENTATION

Docs

Everything you need to send data to Public Surface, trace requests, manage alerts, and connect your tools. Start with Getting Started if you’re new.

Search the docs…

Getting Started

Install the publicsurface command-line tool on macOS, Linux, or Windows.

Create a project and send your first event to Public Surface in under five minutes.

How events move from your services into Public Surface storage.

Pin ingest and storage to a specific region for data residency.

Understand spans, traces, and how to instrument a service.

Configure head-based sampling and per-service overrides.

Send logs as structured JSON so they are queryable, not just searchable.

Balance query performance and cost with hot and archive storage.

Define thresholds and windows that trigger an alert.

Route alerts to Slack, email, PagerDuty, or a custom webhook.

Connect a repository to correlate deploys with changes in your data.

Install the Slack app and route alerts to specific channels.

Global flags and the most commonly used commands.

Authenticate requests to the Public Surface HTTP API with a project key.