# Maple Documentation

Every Maple doc. Append `.md` to any docs URL, or send `Accept: text/markdown`, to receive the raw markdown source.

The full docs as a single file: [https://maple.dev/llms-full.txt](https://maple.dev/llms-full.txt)

## Getting Started

- [Introduction](https://maple.dev/docs/getting-started/introduction.md) — Maple is an open-source observability platform for traces, logs, and metrics, built on OpenTelemetry.

## Concepts

- [OpenTelemetry Conventions](https://maple.dev/docs/concepts/otel-conventions.md) — Maple's expected OpenTelemetry attributes, status codes, span kinds, and data model conventions.
- [Sampling & Throughput Estimation](https://maple.dev/docs/concepts/sampling-throughput.md) — How Maple detects trace sampling and extrapolates throughput metrics.

## Session Replay

- [Browser SDK](https://maple.dev/docs/session-replay/browser-sdk.md) — Instrument a website with OpenTelemetry tracing and rrweb session replay using the @maple-dev/browser SDK.

## Product Events

- [Product events](https://maple.dev/docs/product-events/overview.md) — Track the steps that matter, like signup, checkout and plan started, from the browser, a span you already emit, or any backend, and build funnels, drop-off and path analysis on them.
- [Product events from traces](https://maple.dev/docs/product-events/from-traces.md) — Turn a span you already emit into a product event by annotating it with maple.product_event.* attributes. No second SDK call, and each event links back to the request that performed it.
- [Product events API](https://maple.dev/docs/product-events/api.md) — Post product events from a backend or mobile app to POST /v1/events on the Maple ingest gateway — the raw NDJSON contract every server-side track() call uses.

## Agent Sessions

- [Agent Sessions](https://maple.dev/docs/agent-sessions/setup.md) — An AI agent conversation as one session: every turn, model call and tool call with its cost, timing and failures, built from OpenTelemetry GenAI traces. What Maple records, and how to connect an agent in any language or framework.

## Dashboards

- [Embed dashboard charts in your own product](https://maple.dev/docs/dashboards/embed-charts.md) — Put a live Maple chart in your admin panel, internal tool or customer-facing page with a plain iframe. Make the dashboard public, copy the chart's embed snippet, and set theme, time range, refresh and variables in the URL.

## Alerting

- [Notification destinations](https://maple.dev/docs/alerting/notification-destinations.md) — Route Maple alerts to Slack, PagerDuty, Discord, Telegram, or any HTTP endpoint. How to add a destination, send a test, and get the right credentials for each provider.
- [Apdex alerts](https://maple.dev/docs/alerting/apdex-alerts.md) — How to set up an Apdex alert in Maple: pick the target latency T, choose the score worth paging for, scope and tune the rule, and create the same rule over the API.

## Integrations

- [Prometheus Scraping](https://maple.dev/docs/integrations/prometheus.md) — Pull metrics from any Prometheus-compatible endpoint with Maple's managed scrape agent — no collector to run, credentials stored server-side, scrape health built in.
- [WarpStream](https://maple.dev/docs/integrations/warpstream.md) — Monitor WarpStream clusters in Maple — scrape agent /metrics endpoints directly or pull consumer lag, request latency, and object-store health from WarpStream's hosted Prometheus endpoint.
- [PlanetScale](https://maple.dev/docs/integrations/planetscale.md) — Connect a PlanetScale organization to Maple with one OAuth click — Maple discovers every database branch's Prometheus endpoint automatically and scrapes connections, WAL size, and pod CPU.
- [GitHub](https://maple.dev/docs/integrations/github.md) — Install the Maple GitHub App to sync repositories and commit history from your org — one tracked branch per repo, backfilled and kept live via webhooks, so commits show up alongside your traces.

## Instrumentation

- [Instrument your application](https://maple.dev/docs/instrumentation.md) — Setup guides for every language, framework and runtime Maple supports — pick yours and ship traces, logs and metrics in minutes.
- [Effect SDK](https://maple.dev/docs/sdks/effect.md) — OpenTelemetry traces, logs, and metrics for Effect applications across Node.js, Bun, Deno, browsers, and Cloudflare Workers.
- [Effect SDK on servers](https://maple.dev/docs/sdks/effect-server.md) — Set up the Effect SDK on Node.js, Bun, or Deno with environment-variable auto-detection.
- [Effect SDK in the browser](https://maple.dev/docs/sdks/effect-client.md) — Set up the Effect SDK in browser environments with explicit configuration and auto-captured browser metadata.
- [Effect SDK on Cloudflare Workers](https://maple.dev/docs/sdks/effect-cloudflare.md) — Set up the Effect SDK on Cloudflare Workers with explicit flush() in ctx.waitUntil and in-isolate buffering.
- [Node.js Instrumentation](https://maple.dev/docs/guides/instrumentation-nodejs.md) — Instrument a Node.js application with OpenTelemetry and send traces, logs, and metrics to Maple.
- [Next.js Instrumentation](https://maple.dev/docs/guides/instrumentation-nextjs.md) — Instrument a Next.js application with @vercel/otel and send traces, logs, and metrics to Maple.
- [Python Instrumentation](https://maple.dev/docs/guides/instrumentation-python.md) — Instrument a Python application with OpenTelemetry and send traces, logs, and metrics to Maple.
- [Go Instrumentation](https://maple.dev/docs/guides/instrumentation-go.md) — Instrument a Go application with OpenTelemetry and send traces, logs, and metrics to Maple.
- [Rust Instrumentation](https://maple.dev/docs/guides/instrumentation-rust.md) — Instrument a Rust application with OpenTelemetry and send traces, logs, and metrics to Maple.
- [Java Instrumentation](https://maple.dev/docs/guides/instrumentation-java.md) — Instrument a Java application with OpenTelemetry and send traces, logs, and metrics to Maple.
- [Kotlin Instrumentation](https://maple.dev/docs/guides/instrumentation-kotlin.md) — Instrument a Kotlin JVM application (Ktor, Spring Boot) with OpenTelemetry and send traces, logs, and metrics to Maple.
- [C# / .NET Instrumentation](https://maple.dev/docs/guides/instrumentation-csharp.md) — Instrument a .NET application with OpenTelemetry and send traces, logs, and metrics to Maple.
- [Laravel Instrumentation](https://maple.dev/docs/guides/instrumentation-laravel.md) — Instrument a Laravel application with OpenTelemetry and send traces, logs, and metrics to Maple.

## Infrastructure

- [Kubernetes Infrastructure](https://maple.dev/docs/guides/kubernetes-infrastructure.md) — Deploy Maple's Kubernetes infrastructure collector with Helm to stream host, kubelet, and cluster metrics — and wire the service map's Infrastructure tab to your workloads.
- [Docker Infrastructure](https://maple.dev/docs/guides/docker-infrastructure.md) — Run the Maple Docker agent as a single container to stream per-container CPU, memory, network, block I/O, and logs — and correlate them with your app's traces.

## Local Mode

- [Maple Local](https://maple.dev/docs/local-mode.md) — Run the whole of Maple as one binary on your machine: OTLP ingest, an embedded ClickHouse, a query API, the dashboard and a CLI. No account, no containers, nothing to deploy.
- [CLI Reference](https://maple.dev/docs/local-mode/cli-reference.md) — Every maple command, argument and flag, plus the local server's endpoints, environment variables and a troubleshooting guide.
- [Checkpoints & archives](https://maple.dev/docs/local-mode/checkpoints-and-archives.md) — How Maple Local protects your telemetry: automatic restore points, what happens after an unclean shutdown, reset and restore, and Parquet archives for long-term history.

## Reference

- [Maple API](https://maple.dev/docs/api.md) — The Maple REST API: base URL, API keys and scopes, conventions, the error envelope, rate limits, and where the OpenAPI specification lives.
- [Maple MCP server](https://maple.dev/docs/mcp.md) — Connect Claude, Cursor, and other AI agents to your Maple telemetry over the Model Context Protocol — endpoint, authentication, manifest, and the tools it exposes.