# MoleSignal Docs

## Docs

- [Introduction](https://docs.molesignal.com/en-US/index.md): Operate logs, metrics, traces, APM, profiles, alerts, automation, and access control in one self-hosted observability platform.
- [Quickstart](https://docs.molesignal.com/en-US/quickstart.md): Start MoleSignal, send a log event, and query the event in a few minutes.
- [Core concepts](https://docs.molesignal.com/en-US/concepts.md): Signals, streams, organizations, resources, permissions, storage, and runtime roles.
- [User guide](https://docs.molesignal.com/en-US/user-guide.md): Navigate MoleSignal, choose a workspace, keep time context, and move from a signal to an investigation.
- [Editions and deployment models](https://docs.molesignal.com/en-US/editions.md): Compare OpenSource Edition, Enterprise Edition, and the planned MoleSignal Cloud operating model.
- [OpenSource Edition](https://docs.molesignal.com/en-US/editions/open-source.md): Run the Apache 2.0 MoleSignal observability engine on infrastructure you control.
- [Enterprise Edition](https://docs.molesignal.com/en-US/editions/enterprise.md): Self-host MoleSignal with signed commercial entitlements and vendor support.
- [MoleSignal Cloud](https://docs.molesignal.com/en-US/editions/cloud.md): Understand the planned fully managed MoleSignal Cloud operating model.
- [Enterprise license management](https://docs.molesignal.com/en-US/licensing.md): Understand runtime license states, entitlements, and immutable signed license activation.
- [Dashboards](https://docs.molesignal.com/en-US/dashboards.md): Grafana-shaped dashboards with templated variables, organized into folders.
- [Metrics](https://docs.molesignal.com/en-US/metrics.md): Explore the metric catalog, build PromQL, inspect series quality, and compare related metrics.
- [Logs](https://docs.molesignal.com/en-US/logs.md): Search structured events, inspect fields and surrounding context, and turn useful queries into saved views.
- [Traces](https://docs.molesignal.com/en-US/traces.md): Browse traces and spans, inspect request trees, and analyze services from one trace workspace.
- [Application performance monitoring](https://docs.molesignal.com/en-US/apm.md): Analyze backend services, transactions, dependencies, errors, and deployments from OpenTelemetry traces.
- [Real User Monitoring](https://docs.molesignal.com/en-US/rum.md): Capture browser and Flutter app sessions, replay, errors, frontend performance, API timing, and related backend traces.
- [Browser RUM SDK](https://docs.molesignal.com/en-US/rum/browser-sdk.md): Install and configure the MoleSignal Browser RUM SDK, identify users, add custom events, and verify intake.
- [Flutter App RUM SDK](https://docs.molesignal.com/en-US/rum/flutter-sdk.md): Install and configure the MoleSignal Flutter App RUM SDK for views, interactions, errors, resources, performance, and session replay.
- [RUM source maps and symbols](https://docs.molesignal.com/en-US/rum/source-maps.md): Upload browser source maps, Flutter symbols, Android mappings and native symbols, or Apple dSYM files for RUM stack restoration.
- [RUM data sampling](https://docs.molesignal.com/en-US/rum/sampling.md): Control Browser RUM session and replay volume with independent sampling rates and bounded client queues.
- [RUM privacy](https://docs.molesignal.com/en-US/rum/privacy.md): Keep sensitive browser data out of RUM events and DOM session replay.
- [RUM session replay](https://docs.molesignal.com/en-US/rum/session-replay.md): Record privacy-aware rrweb DOM snapshots and replay real browser sessions in MoleSignal.
- [Continuous profiling](https://docs.molesignal.com/en-US/profiles.md): Send pprof data, inspect flame graphs, and compare CPU, memory, and contention across time windows.
- [Querying](https://docs.molesignal.com/en-US/query.md): Run SQL, PromQL-compatible metric queries, streaming searches, and asynchronous jobs over organization streams.
- [PromQL support matrix](https://docs.molesignal.com/en-US/query/promql-subset.md): The PromQL functions, operators, and modifiers MoleSignal's engine supports, and the known gaps.
- [Connect with a database client](https://docs.molesignal.com/en-US/query/database-clients.md): Query MoleSignal from DBeaver, JDBC, and ADBC over Arrow Flight SQL.
- [Cross-signal correlation](https://docs.molesignal.com/en-US/correlation.md): Move across RUM, traces, logs, metrics, profiles, services, and hosts without losing time context.
- [Service map](https://docs.molesignal.com/en-US/service-map.md): A live topology of service-to-service calls derived automatically from trace spans.
- [Alerting and incident response](https://docs.molesignal.com/en-US/alerting.md): Rules, incidents, anomaly detection, templates, schedules, escalations, silences, subscriptions, and insights.
- [Synthetic monitoring](https://docs.molesignal.com/en-US/synthetics.md): Create active HTTP, browser, network, and heartbeat checks, run them from embedded or private locations, and publish verified revisions.
- [Status pages](https://docs.molesignal.com/en-US/status-pages.md): Publish incidents and maintenance, manage components and subscribers, protect private pages, verify custom domains, and automate updates.
- [Notification channels and delivery](https://docs.molesignal.com/en-US/notification-channels.md): Configure SMTP, Slack, Lark, and webhook connectors, then route notifications through users, policies, templates, and fallbacks.
- [Webhook notification connectors](https://docs.molesignal.com/en-US/alert-webhook-channels.md): Configure Slack, Lark, and generic webhook delivery with target overrides, signing, and encrypted credentials.
- [Mole Agent](https://docs.molesignal.com/en-US/agent.md): Investigate observability issues with Mole Agent, then control automation and write operations through approvals.
- [Connect an MCP client](https://docs.molesignal.com/en-US/inbound-mcp.md): Connect Codex and other Streamable HTTP MCP clients to MoleSignal with OAuth 2.1, API tokens, IAM, Tool Policy, and approval controls.
- [Connect Codex](https://docs.molesignal.com/en-US/inbound-mcp/codex.md): Connect Codex CLI and the Codex app to MoleSignal Inbound MCP with OAuth 2.1 or an API token.
- [Connect Claude Code](https://docs.molesignal.com/en-US/inbound-mcp/claude-code.md): Connect Claude Code to MoleSignal Inbound MCP with remote HTTP, OAuth, project scopes, or an API token.
- [Connect Cursor](https://docs.molesignal.com/en-US/inbound-mcp/cursor.md): Connect Cursor Agent to MoleSignal Inbound MCP with a remote Streamable HTTP server and OAuth.
- [Connect VS Code](https://docs.molesignal.com/en-US/inbound-mcp/vscode.md): Connect VS Code and GitHub Copilot agent mode to MoleSignal Inbound MCP with mcp.json and OAuth.
- [Connect Gemini CLI](https://docs.molesignal.com/en-US/inbound-mcp/gemini-cli.md): Connect Gemini CLI to MoleSignal Inbound MCP with Streamable HTTP and automatic OAuth discovery.
- [Tool catalog and execution](https://docs.molesignal.com/en-US/tools.md): Understand MoleSignal's shared tool catalog, progressive discovery, tenant isolation, risk policy, approvals, and product-domain coverage.
- [Data intake](https://docs.molesignal.com/en-US/intake.md): Native and protocol-compatible intake for OpenTelemetry, Prometheus, logs, cloud senders, and application events.
- [Streams](https://docs.molesignal.com/en-US/streams.md): Manage signal-specific schemas, retention, queryability, and runtime state.
- [Scheduled pipelines](https://docs.molesignal.com/en-US/pipelines.md): Read a source stream on a schedule, apply a VRL transform chain, and write the result to a target stream or external connector.
- [Functions](https://docs.molesignal.com/en-US/functions.md): Create and test reusable transforms for use in pipelines.
- [Extend tables](https://docs.molesignal.com/en-US/extend-tables.md): Key → record lookup tables for enriching events inside a pipeline, with no query cost.
- [Connectors](https://docs.molesignal.com/en-US/connectors.md): Receive logs straight from Kinesis Firehose, Cloudflare Logpush, and Heroku — and fan pipeline output out to S3 or Kafka.
- [Reports](https://docs.molesignal.com/en-US/reports.md): Generate, schedule, deliver, and share dashboard or saved-query reports.
- [Resource sharing](https://docs.molesignal.com/en-US/resource-sharing.md): Share dashboards and reports with signed-in users, another workspace, or a restricted public link.
- [Administration overview](https://docs.molesignal.com/en-US/administration.md): Understand workspace administration, personal settings, and the protected platform scope.
- [Identity & access](https://docs.molesignal.com/en-US/identity.md): Database-backed permissions, roles, users, service accounts, invitations, SSO, and cross-workspace access.
- [Settings guide](https://docs.molesignal.com/en-US/settings.md): Map each Settings section to scope, permission, and operational purpose.
- [Deployment & architecture](https://docs.molesignal.com/en-US/deployment.md): From a single-binary sandbox to a multi-role Kubernetes cluster.
- [Distributed & Role-Based Deployment](https://docs.molesignal.com/en-US/distributed-deployment.md): Node-role matrix, background-worker ownership, data flow, cluster discovery, and three topologies: single-node / Docker Compose / Kubernetes.
- [Configuration](https://docs.molesignal.com/en-US/configuration.md): Configure the current single-crate service, ports, storage, workers, security, telemetry, and optional runtimes.
- [Self-observability](https://docs.molesignal.com/en-US/self-observability.md): Operate MoleSignal's own logs, metrics, traces, profiles, health, and node-local diagnostics.
- [Security and multi-tenancy](https://docs.molesignal.com/en-US/security.md): Tenant isolation, capability authorization, platform scope, tokens, audit, sharing, secrets, and field encryption.
- [Architecture](https://docs.molesignal.com/en-US/architecture.md): How MoleSignal's single Rust crate, adapters, data plane, storage, workers, and web application fit together.
- [API introduction](https://docs.molesignal.com/en-US/api-reference.md): Base URLs, authentication, permissions, request conventions, streaming, and error handling.
- [API catalog](https://docs.molesignal.com/en-US/api/catalog.md): A current map of MoleSignal HTTP API families and the protecting permissions or scopes.
- [Log in](https://docs.molesignal.com/en-US/api/auth/login.md): Exchange email and password for a JWT.
- [Issue API token](https://docs.molesignal.com/en-US/api/auth/issue-token.md): Create a long-lived API token.
- [List API tokens](https://docs.molesignal.com/en-US/api/auth/list-tokens.md): List API token metadata (never the secret).
- [Revoke API token](https://docs.molesignal.com/en-US/api/auth/revoke-token.md): Revoke an API token by id.
- [Rotate JWT signing keys](https://docs.molesignal.com/en-US/api/auth/rotate-jwt.md): List and rotate platform JWT signing-key metadata.
- [Native JSON intake](https://docs.molesignal.com/en-US/api/intake/native-json.md): POST records as JSON to a stream.
- [OpenTelemetry (OTLP)](https://docs.molesignal.com/en-US/api/intake/otlp.md): Intake via the OTLP HTTP or gRPC exporter.
- [Prometheus remote_write](https://docs.molesignal.com/en-US/api/intake/prometheus.md): Drop-in Prometheus remote_write target.
- [Elasticsearch _bulk](https://docs.molesignal.com/en-US/api/intake/elasticsearch.md): Drop-in Elasticsearch _bulk intake.
- [Loki push](https://docs.molesignal.com/en-US/api/intake/loki.md): Loki JSON push endpoint.
- [Kinesis Firehose](https://docs.molesignal.com/en-US/api/intake/kinesis.md): AWS Kinesis Firehose HTTP delivery.
- [Cloudflare Logpush](https://docs.molesignal.com/en-US/api/intake/cloudflare.md): Cloudflare Logpush destination.
- [Heroku log drain](https://docs.molesignal.com/en-US/api/intake/heroku.md): Heroku log drain destination.
- [Create function](https://docs.molesignal.com/en-US/api/intake/create-function.md): Create a reusable pipeline transform.
- [Create a pipeline](https://docs.molesignal.com/en-US/api/intake/create-pipeline.md): Create a scheduled source-transform-sink pipeline.
- [Manage pipelines](https://docs.molesignal.com/en-US/api/intake/scheduled-pipelines.md): List, inspect, edit, run, pause, and delete scheduled pipelines.
- [Execute a query](https://docs.molesignal.com/en-US/api/query/execute.md): Run SQL or PromQL against an organization-scoped telemetry stream.
- [Streamed query](https://docs.molesignal.com/en-US/api/query/streamed.md): NDJSON chunked query response.
- [Search around an event](https://docs.molesignal.com/en-US/api/query/search-around.md): Fetch the events before and after a given one.
- [List saved views](https://docs.molesignal.com/en-US/api/query/list-saved-views.md): List saved query views.
- [Create saved view](https://docs.molesignal.com/en-US/api/query/create-saved-view.md): Save a query as a reusable view.
- [Execute a saved view](https://docs.molesignal.com/en-US/api/query/run-saved-view.md): Load a saved view and execute the saved query.
- [Create dashboard](https://docs.molesignal.com/en-US/api/query/create-dashboard.md): Create a native or Grafana-imported dashboard.
- [Create folder](https://docs.molesignal.com/en-US/api/query/create-folder.md): Create a folder to organize dashboards.
- [APM API](https://docs.molesignal.com/en-US/api/apm.md): Query application performance summaries, catalogs, details, version comparisons, and projection health.
- [List streams](https://docs.molesignal.com/en-US/api/streams/list.md): List all streams in the org.
- [Create a stream](https://docs.molesignal.com/en-US/api/streams/create.md): Pre-declare a stream.
- [Get a stream](https://docs.molesignal.com/en-US/api/streams/get.md): Fetch one stream by id.
- [Delete a stream](https://docs.molesignal.com/en-US/api/streams/delete.md): Delete a stream by id.
- [Configure field indexes](https://docs.molesignal.com/en-US/api/streams/edit-schema.md): Configure index behavior for fields already present in a stream.
- [Edit retention](https://docs.molesignal.com/en-US/api/streams/edit-retention.md): Set how long a stream's data is kept.
- [List rules](https://docs.molesignal.com/en-US/api/alerting/list-rules.md): List alert rules.
- [Create rule](https://docs.molesignal.com/en-US/api/alerting/create-rule.md): Create an alert rule.
- [Update rule](https://docs.molesignal.com/en-US/api/alerting/update-rule.md): Update an alert rule by id.
- [Delete rule](https://docs.molesignal.com/en-US/api/alerting/delete-rule.md): Delete an alert rule by id.
- [Create escalation policy](https://docs.molesignal.com/en-US/api/alerting/create-escalation.md): Multi-step escalation with on-call rotations.
- [Manage notification connectors](https://docs.molesignal.com/en-US/api/alerting/create-channel.md): Create, inspect, update, test, and delete notification connectors.
- [List incidents](https://docs.molesignal.com/en-US/api/alerting/list-incidents.md): List alert incidents.
- [Acknowledge incident](https://docs.molesignal.com/en-US/api/alerting/ack-incident.md): Acknowledge an incident, pausing escalation.
- [Resolve incident](https://docs.molesignal.com/en-US/api/alerting/resolve-incident.md): Resolve an incident.
- [Cross-signal correlation](https://docs.molesignal.com/en-US/api/web/correlation.md): Prefill filters and time for cross-signal jumps.
- [Command palette search](https://docs.molesignal.com/en-US/api/web/search.md): Cross-entity ⌘K search.
- [Service topology](https://docs.molesignal.com/en-US/api/web/topology.md): Nodes and edges from the service graph.
- [Service graph edges](https://docs.molesignal.com/en-US/api/web/service-graph.md): Raw service-graph edges.
- [Trace list and tree](https://docs.molesignal.com/en-US/api/web/trace.md): List trace summaries and fetch the full span tree for a trace_id.
- [Store investigation stack](https://docs.molesignal.com/en-US/api/web/store-investigation.md): Persist an investigation-stack payload.
- [Fetch investigation stack](https://docs.molesignal.com/en-US/api/web/fetch-investigation.md): Fetch a stored investigation payload.
- [Audit log](https://docs.molesignal.com/en-US/api/admin/audit.md): Query the audit trail.
- [Read license limits](https://docs.molesignal.com/en-US/api/admin/read-quota.md): Read the active signed-license limits and expiration.
- [Configure service limits](https://docs.molesignal.com/en-US/api/admin/set-quota.md): Understand deployment rate limits and immutable license limits.
- [Cipher keys](https://docs.molesignal.com/en-US/api/admin/cipher-keys.md): Read and rotate organization field-encryption keys.
- [Enterprise capabilities](https://docs.molesignal.com/en-US/api/admin/paid-edition.md): Feature-entitled API families in Enterprise Edition.
- [Health & metrics](https://docs.molesignal.com/en-US/api/admin/health.md): Liveness/readiness and Prometheus metrics.
- [Changelog](https://docs.molesignal.com/en-US/changelog.md): Product updates and releases. Mirrors GitHub Releases for molesignal/molesignal.