This page describes Darling v3.13.0. The source of this page is on GitHub at that version.
Audience: operators.
Read these pages in this order. After the install, each page is complete on its own.
- Install Darling: from a downloaded zip to a service that collects data.
- The WPF viewer: the desktop app, on the service host or on another machine.
- The web dashboard: the browser view that the service serves.
- MCP server: the endpoint for an LLM client.
- Running Darling day to day: add or remove a server, change a password, rotate a token, pause, upgrade, uninstall, and where everything is.
- Command line reference: every verb of the service exe, with exit codes.
- Darling and your monitored servers: what the service does on each SQL Server, its Extended Events sessions, and the permissions it needs.
- PostgreSQL Targets: monitor a PostgreSQL server.
- Managed Bundled PostgreSQL: the store that the service runs for itself.
- Configuration Reference: where each setting lives,
postgres,servers,peers,heartbeatandreads. - Alert and notification settings: the
alerts,analysis,smtpandwebhooksblocks, and the notification routes.- The Slack bot: the one Slack app and its manifest, the bot and app-level tokens, the per-store bot channel, and the Socket Mode listener.
- Agents and alert sources: hand an alert to your own agent, practice requests, and logins for systems that send alerts.
- MCP configuration: the
mcpblock. - MCP tools and their store tables: every MCP tool and the store tables that it reads or changes.
- Web dashboard configuration: the
webblock. - Collector schedules and switches: why there are no schedule settings, and the verbs and tools that change a collector.
- Operations: the store, TimescaleDB, retention, the logs, restarts and watching the service from outside.
- Security and agent changes: the store’s schemas and roles, the agent change list and its undo, and Level 2.
- Opt-in Network Endpoints (LAN): reach the store, MCP and the web dashboard from another machine.
- Troubleshooting: a table of what you see, the likely cause and the fix, for Darling and Lite.
- Darling troubleshooting: every service log line and what it means.
- The front door: one MCP address and one web address in front of several stores.
- Run Darling on Kubernetes: the Helm chart in this repository, with its two store modes, probes and upgrade steps.
The Darling operator guide is now a short index. Its old headings link to these pages.
Every page and its sections
- Install Darling
- Two facts that explain most of the surprises
- Step 1: Prerequisites
- Step 2: Download and verify
- Step 3: Extract to a machine-scoped path
- Step 4: Write
darling.json - Step 5: Pre-flight
- Step 6: Install the service
- Step 7: Wait about two minutes
- Things that will bite you
- Known gaps
- Install reference
- Where PowerShell is used, and installing without it
- Where to go next
- The Darling WPF viewer
- The Darling web dashboard
- Running Darling day to day
- Command line reference
- Darling and your monitored servers
- PostgreSQL Targets
- Managed Bundled PostgreSQL
- Configuration Reference
- Where each setting lives: first-run seed or file only
- queryTextTrigramIndexEnabled
- postgres
- servers (array)
- Testing an index on PostgreSQL
- Ending a PostgreSQL session
- Managed PostgreSQL
- allowedAwsRoles (array, optional)
- capturePlans (boolean, optional)
- collectSchemaChangeEvents (boolean, optional)
- procedureStatsPlanCycleInterval (integer, optional)
- xeRingBufferMaxEvents (integer, optional)
- queryStatsDeferredPlanFetch (boolean, optional)
- procedureStatsDeferredPlanFetch (string, optional)
- passwordKey (string, optional)
- health (object, optional)
- peers
- frontDoor (optional)
- heartbeat
- reads (optional)
- Alert and notification settings
- The Slack bot: setup
- Agents and alert sources
- MCP configuration
- MCP tools and the store tables they read
- Web dashboard configuration
- Collector schedules and switches
- No Schedule Knobs, by Design
- Enable or disable a collector headlessly (
--enable-collector/--disable-collector) - Turn on schema tracking (
schema_objects) - Make a new password key (
--reset-password-key) - Set the time of day a daily collector runs (
--set-collector-run-at) - Stop, start or reschedule a collector from MCP (#6227)
- Set the service flags from MCP (#6393)
- Drop the Extended Events sessions a removed server left behind (
--drop-xe-sessions)
- Operations
- Security and agent changes
- Opt-in Network Endpoints (LAN)
- Guided setup (
--configure-network) - Firewall rules (
--configure-firewall) - Headless enable/disable + firewall (
--enable-mcp/--enable-web) - Verify it’s actually reachable (and the two failures that look like bugs)
- Store endpoint (viewer over the LAN)
- MCP endpoint (assistant over the LAN)
- Web endpoint (browser over the LAN)
- Front door to store connections
- The health port
- Guided setup (
- Darling troubleshooting
- The front door
- Run Darling on Kubernetes