Darling: operator documentation for the headless edition (#1262)#1337
Merged
Conversation
Adds the operator guide for the headless edition at Darling/README.md: quick start (PostgreSQL prerequisites, optional auto-adopted TimescaleDB, both auth modes with the --encrypt-password flow, console mode vs sc create Windows-service install), what the service creates on monitored servers (the two XE sessions, the blocked-process-threshold bootstrap) and the required permissions, the complete darling.json reference with code-verified defaults, the store layout (schema V1-V4), retention and compression, logs, the viewer, restart semantics, troubleshooting, and a marked placeholder for the upcoming managed bundled-PostgreSQL mode. Also introduces Darling in the root README's edition-comparison area and adds the CHANGELOG entry. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
database_size_stats runs hourly and server_properties runs on connect per the shared CollectorScheduleDefaults (identity-pinned to Lite's ScheduleManager) — the table said 15 min for both. Surfaced during the Darling docs verification pass. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Operator-facing documentation for the Darling headless edition, verified line-by-line against the code on dev (fd9f87d).
Darling/README.md(new) — the operator guide:PerformanceMonitor.Collectors/Alerting/analysis libraries) and when to choose it vs. portable Litedarling.jsonsetup (resolution order, both auth modes, the--encrypt-passwordDPAPI flow, per-server vs. alert-levelexcludedDatabases), console mode vs.sc createWindows-service install (same exe for both, per Program.cs)PerformanceMonitor_Deadlock/PerformanceMonitor_BlockedProcess, server- vs. database-scoped), the blocked-process-thresholdsp_configurebootstrap (RDS/Azure caveats), and a permissions table using the product's existing vocabulary (VIEW SERVER STATE required; XE/msdb/ALTER SETTINGS/DBCC optional with the exact degrade behavior)darling.jsonkey with code-verified defaults and clamps; the alert thresholds table (defaults mirror Lite's); SMTP/webhooks/MCP sections; the "no schedule knobs by design" noteRetentionDays,drop_chunksvs. DELETE), logs, the viewer (config resolution, the four tabs, 60-second active-tab refresh), restart semantics (delta re-seeding, watermark persistence, alert no-re-fire)README.md— one new subsection in the edition-comparison area introducing Darling (status: in development, builds from source) with a link to the guide; nothing else restructuredCHANGELOG.md— one Unreleased/Added entry under [[FEATURE] Add a headless Windows Service collector mode for Lite (gMSA-compatible), with the existing UI as a read-only viewer #1262]Verification
Docs only — no product code changed.
dotnet build Darling/Darling.Testssucceeds (0 errors). Every documented default, cadence, table name, tool name, session name, and log message was read from the source this session (DarlingConfig/darling.sample.json/Program.cs/DarlingWorker/DarlingXeSessions/DarlingAlertSettings/DarlingSecrets/DarlingServerConnector/MonitoredServerConnection/DarlingObservability, PgMigrations/TimescaleSupport/PgSchemaGenerator/StorageVersion, DarlingRetention, CollectorScheduleDefaults, the MCP host/tools, ViewerSettings/MainWindow.xaml).Part of #1262.
🤖 Generated with Claude Code