# 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

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

## 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.

## 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.

## 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.

## Alerting

- [Notification destinations](https://maple.dev/docs/alerting/notification-destinations.md) — Route Maple alerts to Slack, PagerDuty, Discord, or any HTTP endpoint. How to add a destination, send a test, and get the right credentials for each provider.

## Local Mode

- [Maple Local](https://maple.dev/docs/local-mode.md) — Run Maple as a single binary on your machine — OTLP ingest, an embedded ClickHouse, a query API, and the dashboard, with no cloud and no auth.
- [CLI Reference](https://maple.dev/docs/local-mode/cli-reference.md) — Every maple command, argument, and flag — plus the server endpoints, environment variables, and troubleshooting for local mode.

## Effect SDK

- [Overview](https://maple.dev/docs/sdks/overview.md) — Maple SDKs are official, opinionated wrappers around OpenTelemetry that auto-detect platform conventions.
- [Quick start](https://maple.dev/docs/sdks/effect.md) — OpenTelemetry traces, logs, and metrics for Effect applications across Node.js, Bun, Deno, browsers, and Cloudflare Workers.

## Platforms

- [Server](https://maple.dev/docs/sdks/effect-server.md) — Set up the Effect SDK on Node.js, Bun, or Deno with environment-variable auto-detection.
- [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.
- [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.

## Instrumentation

- [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.
- [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.
- [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.
- [Laravel Instrumentation](https://maple.dev/docs/guides/instrumentation-laravel.md) — Instrument a Laravel application with OpenTelemetry and send traces, logs, and metrics to Maple.