fix: dedupe healthcheck alerts and share crash rate limits (#1690)

* fix: dedupe healthcheck alerts and share crash rate limits

Health flaps no longer spam the bell: emit only on transition into unhealthy, keep a prune-surviving 60m dedup stamp that advances only when history persists, and share the fixed-window rate cap with crash alerts using typed roll-up copy. Docs now match fixed-window and non-persisted overflow behavior.

* fix: harden health alert rate refund and shutdown cleanup

Bind rate-token refunds to the issuing fixed window, clear deferred-retry markers on recovery/destroy/shutdown, and refuse deferred health dispatches after the service stops so the 20/min cap and no-duplicate guarantees hold under async races.
This commit is contained in:
Anso
2026-07-23 23:14:25 -04:00
committed by GitHub
parent a89498ae5b
commit ec0f59a85e
3 changed files with 823 additions and 57 deletions
@@ -97,6 +97,8 @@ let service: DockerEventService;
beforeEach(() => {
vi.clearAllMocks();
vi.useFakeTimers();
mockDispatchAlert.mockReset();
mockDispatchAlert.mockResolvedValue({ persisted: true });
mockGetGlobalSettings.mockReturnValue({ global_crash: '1' });
mockIsOwnContainer.mockReset();
mockIsOwnContainer.mockReturnValue(false);
@@ -119,6 +121,11 @@ afterEach(() => {
vi.useRealTimers();
});
async function flushMicrotasks(): Promise<void> {
await Promise.resolve();
await Promise.resolve();
}
// ── Classification via event stream ────────────────────────────────────
describe('DockerEventService - die classification', () => {
@@ -367,6 +374,7 @@ describe('DockerEventService - die classification', () => {
},
},
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledWith(
'error',
@@ -442,9 +450,586 @@ describe('DockerEventService - rate limiting', () => {
// After the rate window, a summary warning fires.
await vi.advanceTimersByTimeAsync(61_000);
const summaryCalls = mockDispatchAlert.mock.calls.filter(c =>
typeof c[2] === 'string' && c[2].includes('additional containers crashed'));
typeof c[2] === 'string' && c[2].includes('rate-limited'));
expect(summaryCalls).toHaveLength(1);
expect(summaryCalls[0][2]).toContain('2 additional');
expect(summaryCalls[0][2]).toBe(
'2 additional container crash alerts were rate-limited in the last minute.',
);
});
});
// ── Health alert transition / dedup / rate sharing ─────────────────────
describe('DockerEventService - health alert gates', () => {
it('emits once for duplicate unhealthy while already unhealthy and keeps unhealthySince', async () => {
service = new DockerEventService(1, 'local');
await service.start();
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: {
ID: 'h1',
Attributes: { name: 'api', 'com.docker.compose.project': 'web' },
},
});
await flushMicrotasks();
const first = service.getContainerState('h1');
expect(first?.healthStatus).toBe('unhealthy');
expect(first?.unhealthySince).toBeTypeOf('number');
const since = first!.unhealthySince!;
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'h1', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
expect(service.getContainerState('h1')?.unhealthySince).toBe(since);
expect(service.getContainerState('h1')?.healthStatus).toBe('unhealthy');
});
it('suppresses a second flap while the first health dispatch is still pending', async () => {
let resolveFirst!: (value: { persisted: boolean }) => void;
mockDispatchAlert.mockImplementationOnce(
() => new Promise<{ persisted: boolean }>((resolve) => { resolveFirst = resolve; }),
);
service = new DockerEventService(1, 'local');
await service.start();
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'h2', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
stream.push({
Type: 'container',
Action: 'health_status: healthy',
Actor: { ID: 'h2', Attributes: { name: 'api' } },
});
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'h2', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
resolveFirst({ persisted: true });
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
});
it('retries a deferred flap when the in-flight dispatch fails to persist', async () => {
let resolveFirst!: (value: { persisted: boolean }) => void;
mockDispatchAlert
.mockImplementationOnce(
() => new Promise<{ persisted: boolean }>((resolve) => { resolveFirst = resolve; }),
)
.mockResolvedValue({ persisted: true });
service = new DockerEventService(1, 'local');
await service.start();
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'h2b', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
stream.push({
Type: 'container',
Action: 'health_status: healthy',
Actor: { ID: 'h2b', Attributes: { name: 'api' } },
});
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'h2b', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
resolveFirst({ persisted: false });
await flushMicrotasks();
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(2);
});
it('does not advance health dedup when persisted is false, allowing a later transition', async () => {
mockDispatchAlert
.mockResolvedValueOnce({ persisted: false })
.mockResolvedValue({ persisted: true });
service = new DockerEventService(1, 'local');
await service.start();
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'h3', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
stream.push({
Type: 'container',
Action: 'health_status: healthy',
Actor: { ID: 'h3', Attributes: { name: 'api' } },
});
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'h3', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(2);
});
it('keeps health dedup across the 10-minute prune window and re-emits after 60 minutes', async () => {
service = new DockerEventService(1, 'local');
await service.start();
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'h4', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
// Recover so lastActivity ages without fresh unhealthy events; prune
// may drop containerState after 10m but health dedup must survive.
stream.push({
Type: 'container',
Action: 'health_status: healthy',
Actor: { ID: 'h4', Attributes: { name: 'api' } },
});
await flushMicrotasks();
await vi.advanceTimersByTimeAsync(11 * 60_000);
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'h4', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
await vi.advanceTimersByTimeAsync(50 * 60_000);
stream.push({
Type: 'container',
Action: 'health_status: healthy',
Actor: { ID: 'h4', Attributes: { name: 'api' } },
});
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'h4', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(2);
});
it('does not let crash and health dedup suppress one another', async () => {
service = new DockerEventService(1, 'local');
await service.start();
stream.push({
Type: 'container',
Action: 'die',
Actor: { ID: 'h5', Attributes: { exitCode: '1', name: 'api' } },
});
await vi.advanceTimersByTimeAsync(600);
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
stream.push({
Type: 'container',
Action: 'start',
Actor: { ID: 'h5', Attributes: { name: 'api' } },
});
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'h5', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(2);
expect(mockDispatchAlert.mock.calls[1][2]).toContain('Healthcheck failed');
});
it('does not consume rate tokens for deduped duplicate health events', async () => {
service = new DockerEventService(1, 'local');
await service.start();
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'h6', Attributes: { name: 'api' } },
});
await flushMicrotasks();
for (let i = 0; i < 5; i++) {
stream.push({
Type: 'container',
Action: 'health_status: healthy',
Actor: { ID: 'h6', Attributes: { name: 'api' } },
});
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'h6', Attributes: { name: 'api' } },
});
await flushMicrotasks();
}
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
for (let i = 0; i < 19; i++) {
stream.push({
Type: 'container',
Action: 'die',
Actor: { ID: `crash-${i}`, Attributes: { exitCode: '1', name: `n-${i}` } },
});
}
await vi.advanceTimersByTimeAsync(600);
const crashCalls = mockDispatchAlert.mock.calls.filter(c =>
typeof c[2] === 'string' && c[2].includes('Crash'));
expect(crashCalls).toHaveLength(19);
});
it('emits an accurate health-only rate-limit roll-up', async () => {
service = new DockerEventService(1, 'local');
await service.start();
for (let i = 0; i < 22; i++) {
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: `hh-${i}`, Attributes: { name: `svc-${i}` } },
});
await flushMicrotasks();
}
const healthCalls = mockDispatchAlert.mock.calls.filter(c =>
typeof c[2] === 'string' && c[2].includes('Healthcheck failed'));
expect(healthCalls).toHaveLength(20);
await vi.advanceTimersByTimeAsync(61_000);
const summaryCalls = mockDispatchAlert.mock.calls.filter(c =>
typeof c[2] === 'string' && c[2].includes('rate-limited'));
expect(summaryCalls).toHaveLength(1);
expect(summaryCalls[0][2]).toBe(
'2 additional container health alerts were rate-limited in the last minute.',
);
});
it('emits an accurate mixed crash and health rate-limit roll-up', async () => {
service = new DockerEventService(1, 'local');
await service.start();
for (let i = 0; i < 10; i++) {
stream.push({
Type: 'container',
Action: 'die',
Actor: { ID: `mc-${i}`, Attributes: { exitCode: '1', name: `c-${i}` } },
});
}
await vi.advanceTimersByTimeAsync(600);
for (let i = 0; i < 10; i++) {
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: `mh-${i}`, Attributes: { name: `h-${i}` } },
});
await flushMicrotasks();
}
for (let i = 10; i < 12; i++) {
stream.push({
Type: 'container',
Action: 'die',
Actor: { ID: `mc-${i}`, Attributes: { exitCode: '1', name: `c-${i}` } },
});
}
await vi.advanceTimersByTimeAsync(600);
for (let i = 10; i < 13; i++) {
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: `mh-${i}`, Attributes: { name: `h-${i}` } },
});
await flushMicrotasks();
}
await vi.advanceTimersByTimeAsync(61_000);
const summaryCalls = mockDispatchAlert.mock.calls.filter(c =>
typeof c[2] === 'string' && c[2].includes('rate-limited'));
expect(summaryCalls).toHaveLength(1);
expect(summaryCalls[0][2]).toBe(
'5 additional container alerts were rate-limited in the last minute (2 crash, 3 health).',
);
});
it('keeps Auto-Heal health state when global_crash is off', async () => {
mockGetGlobalSettings.mockReturnValue({ global_crash: '0' });
service = new DockerEventService(1, 'local');
await service.start();
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'h7', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).not.toHaveBeenCalled();
expect(service.getContainerState('h7')).toMatchObject({
healthStatus: 'unhealthy',
});
expect(service.getContainerState('h7')?.unhealthySince).toBeTypeOf('number');
});
it('does not refund a rate token into the next fixed window', async () => {
let resolvePersist!: (value: { persisted: boolean }) => void;
mockDispatchAlert.mockImplementation(
() =>
new Promise<{ persisted: boolean }>((resolve) => {
resolvePersist = resolve;
}),
);
service = new DockerEventService(1, 'local');
await service.start();
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'cross-window', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
// Cross the fixed window, then consume a token in the new window so
// refund would inflate W2's count if it ignored the issuing window.
await vi.advanceTimersByTimeAsync(60_000);
mockDispatchAlert.mockResolvedValue({ persisted: true });
stream.push({
Type: 'container',
Action: 'die',
Actor: {
ID: 'cw-roll',
Attributes: { exitCode: '1', name: 'roll' },
},
});
await vi.advanceTimersByTimeAsync(600);
expect(
mockDispatchAlert.mock.calls.filter(
(c) => typeof c[2] === 'string' && c[2].includes('Crash Detected'),
),
).toHaveLength(1);
// Fail the original health persist: old code refunds into W2 (count 1→0).
resolvePersist({ persisted: false });
await flushMicrotasks();
// Fill the rest of W2 to the 20-alert cap (19 more crashes).
for (let i = 0; i < 19; i++) {
stream.push({
Type: 'container',
Action: 'die',
Actor: {
ID: `cw-${i}`,
Attributes: { exitCode: '1', name: `svc-${i}` },
},
});
}
await vi.advanceTimersByTimeAsync(600);
// Cap must still hold: a cross-window refund would have allowed a 21st.
stream.push({
Type: 'container',
Action: 'die',
Actor: {
ID: 'cw-overflow',
Attributes: { exitCode: '1', name: 'overflow' },
},
});
await vi.advanceTimersByTimeAsync(600);
const crashCalls = mockDispatchAlert.mock.calls.filter(
(c) => typeof c[2] === 'string' && c[2].includes('Crash Detected'),
);
expect(crashCalls).toHaveLength(20);
});
it('clears pending health retry when the container recovers before persist fails', async () => {
let resolvePersist!: (value: { persisted: boolean }) => void;
mockDispatchAlert.mockImplementation(
() =>
new Promise<{ persisted: boolean }>((resolve) => {
resolvePersist = resolve;
}),
);
service = new DockerEventService(1, 'local');
await service.start();
// First unhealthy starts an in-flight dispatch.
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'recover-pending', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
// Flap while in flight: recover then re-fail so a pending-retry marker is set.
stream.push({
Type: 'container',
Action: 'health_status: healthy',
Actor: { ID: 'recover-pending', Attributes: { name: 'api' } },
});
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'recover-pending', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
// Recover again before the first persist settles; marker must be dropped.
stream.push({
Type: 'container',
Action: 'health_status: healthy',
Actor: { ID: 'recover-pending', Attributes: { name: 'api' } },
});
await flushMicrotasks();
resolvePersist({ persisted: false });
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
// Later unrelated persist failure must not spuriously retry from a stale marker.
mockDispatchAlert.mockResolvedValueOnce({ persisted: false });
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'recover-pending', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(2);
});
it('does not dispatch deferred health retry after shutdown', async () => {
let resolvePersist!: (value: { persisted: boolean }) => void;
mockDispatchAlert.mockImplementation(
() =>
new Promise<{ persisted: boolean }>((resolve) => {
resolvePersist = resolve;
}),
);
service = new DockerEventService(1, 'local');
await service.start();
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'shutdown-pending', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
service.shutdown();
resolvePersist({ persisted: false });
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
});
it('clears health alert bookkeeping on destroy', async () => {
service = new DockerEventService(1, 'local');
await service.start();
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'destroy-dedup', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
stream.push({
Type: 'container',
Action: 'destroy',
Actor: { ID: 'destroy-dedup', Attributes: { name: 'api' } },
});
await flushMicrotasks();
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'destroy-dedup', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(2);
});
it('does not retry a deferred health alert after destroy', async () => {
let resolvePersist!: (value: { persisted: boolean }) => void;
mockDispatchAlert.mockImplementation(
() =>
new Promise<{ persisted: boolean }>((resolve) => {
resolvePersist = resolve;
}),
);
service = new DockerEventService(1, 'local');
await service.start();
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'destroy-pending', Attributes: { name: 'api' } },
});
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
// Set a pending-retry marker while the first dispatch is in flight.
stream.push({
Type: 'container',
Action: 'health_status: healthy',
Actor: { ID: 'destroy-pending', Attributes: { name: 'api' } },
});
stream.push({
Type: 'container',
Action: 'health_status: unhealthy',
Actor: { ID: 'destroy-pending', Attributes: { name: 'api' } },
});
await flushMicrotasks();
stream.push({
Type: 'container',
Action: 'destroy',
Actor: { ID: 'destroy-pending', Attributes: { name: 'api' } },
});
await flushMicrotasks();
resolvePersist({ persisted: false });
await flushMicrotasks();
expect(mockDispatchAlert).toHaveBeenCalledTimes(1);
});
});
+226 -47
View File
@@ -45,13 +45,21 @@ export interface ContainerHealthSnapshot {
/** Grace window after a `die` before classifying, to absorb out-of-order kill events. */
const DIE_GRACE_WINDOW_MS = 500;
/** Max crash alerts emitted per node within RATE_WINDOW_MS. Overflow is batched. */
/** Max crash/health alerts emitted per node within RATE_WINDOW_MS. Overflow is batched. */
const RATE_LIMIT_MAX = 20;
const RATE_WINDOW_MS = 60_000;
/** Dedup window for repeat crash alerts of the same container. */
const CRASH_DEDUP_MS = 60 * 60_000;
/**
* Dedup window for repeat health alerts of the same container. Same duration as
* crash dedup, but stored outside containerState so the 10-minute prune cannot
* shrink the advertised 60-minute window. Unlike crash dedup, recovery (start /
* healthy) does not clear this stamp.
*/
const HEALTH_DEDUP_MS = CRASH_DEDUP_MS;
/** Interval for pruning stale container state from memory. */
const PRUNE_INTERVAL_MS = 60_000;
const STATE_STALE_AFTER_MS = 10 * 60_000;
@@ -109,6 +117,11 @@ interface DockerEventPayload {
type LifecycleStatus = 'disconnected' | 'connecting' | 'connected' | 'stopped';
/** Rate-limit token bound to the fixed window that issued it. */
interface RateToken {
readonly windowStart: number;
}
export class DockerEventService {
private readonly nodeId: number;
private readonly nodeName: string;
@@ -127,12 +140,35 @@ export class DockerEventService {
/** Pending die timers keyed by container ID (for the 500ms grace window). */
private pendingDieTimers: Map<string, NodeJS.Timeout> = new Map();
/** Rate-limiter bookkeeping. */
private rateWindowStart = 0;
private rateCount = 0;
private suppressedCount = 0;
/**
* Shared fixed-window rate limiter for crash and health alerts (per local
* node / this service instance). Dedup and transition checks run before
* consuming a token so suppressed duplicates do not count toward the cap.
* Tokens carry the issuing window start so a late refund cannot inflate a
* newer window's budget.
*/
private containerAlertRateWindowStart = 0;
private containerAlertRateCount = 0;
private suppressedCrashAlertCount = 0;
private suppressedHealthAlertCount = 0;
private summaryTimer: NodeJS.Timeout | null = null;
/**
* Process-local health-alert dedup keyed by container id. Kept outside
* containerState so pruneStaleState cannot drop an active 60m window.
* Entries expire after HEALTH_DEDUP_MS via pruneStaleState; the map clears
* on process restart. Not cleared on healthy/start recovery.
*/
private healthAlertDedupAt = new Map<string, number>();
/** In-flight health dispatches; prevents concurrent duplicate flaps. */
private healthAlertInFlight = new Set<string>();
/**
* Container ids that entered unhealthy again while a health dispatch was
* in flight. Retried once after the in-flight call finishes if history
* did not persist (so a failed write cannot permanently silence the alert).
*/
private healthAlertPendingRetry = new Set<string>();
/** Parse-error tracking for flooded bad payloads. */
private parseErrorWindowStart = 0;
private parseErrorCount = 0;
@@ -166,6 +202,8 @@ export class DockerEventService {
/** Close the stream, cancel timers, and clear state. */
public shutdown(): void {
// Flush overflow roll-up while still live so pending summaries are not dropped.
this.flushRateLimitSummaryNow();
this.status = 'stopped';
this.clearReconnectTimer();
if (this.pruneTimer) {
@@ -180,6 +218,17 @@ export class DockerEventService {
this.pendingDieTimers.clear();
this.detachStream();
this.containerState.clear();
this.healthAlertDedupAt.clear();
this.healthAlertInFlight.clear();
this.healthAlertPendingRetry.clear();
this.suppressedCrashAlertCount = 0;
this.suppressedHealthAlertCount = 0;
this.containerAlertRateCount = 0;
}
/** Status helper so await-crossing stopped checks are not narrowed away. */
private isStopped(): boolean {
return this.status === 'stopped';
}
// ========================================================================
@@ -460,27 +509,104 @@ export class DockerEventService {
state.lastActivityAt = Date.now();
if (action.includes('unhealthy')) {
if (state.healthStatus !== 'unhealthy') {
const enteringUnhealthy = state.healthStatus !== 'unhealthy';
if (enteringUnhealthy) {
state.unhealthySince = Date.now();
}
// Auto-Heal reads healthStatus / unhealthySince; update before any alert gate.
state.healthStatus = 'unhealthy';
if (!enteringUnhealthy) return;
if (!this.isCrashAlertsEnabled()) return;
void this.dispatchHealthAlert(id, state);
} else {
// Recovery clears Auto-Heal timing but must not erase health-alert dedup,
// or a healthy↔unhealthy flap would re-alert immediately.
state.unhealthySince = undefined;
state.healthStatus = action.includes('starting') ? 'starting' : 'healthy';
// Drop deferred-retry markers so a later unrelated persist failure cannot
// spuriously retry from a flap that already recovered.
this.healthAlertPendingRetry.delete(id);
}
}
/**
* Dispatch a healthcheck failure alert with transition already confirmed.
* Dedup and rate checks run before the token is consumed. Advance dedup
* only when dispatchAlert returns `{ persisted: true }` (history row written).
*/
private async dispatchHealthAlert(id: string, state: InternalContainerState): Promise<void> {
if (this.isStopped()) return;
const now = Date.now();
if (this.isWithinAlertDedupWindow(this.healthAlertDedupAt.get(id), now, HEALTH_DEDUP_MS)) {
return;
}
if (this.healthAlertInFlight.has(id)) {
this.healthAlertPendingRetry.add(id);
return;
}
const token = this.consumeRateToken();
if (!token) {
this.suppressedHealthAlertCount += 1;
this.scheduleSummary();
return;
}
this.healthAlertInFlight.add(id);
let persisted = false;
try {
if (this.isStopped()) {
this.refundRateToken(token);
this.healthAlertPendingRetry.delete(id);
return;
}
const name = state.name ?? id.slice(0, 12);
void this.emitError(
const result = await this.emitError(
'monitor_alert',
`Healthcheck failed: ${name} is unhealthy.`,
state.stackName,
state.name,
state.isSelf === true,
);
} else {
state.unhealthySince = undefined;
if (action.includes('starting')) {
state.healthStatus = 'starting';
persisted = result.persisted;
if (persisted) {
this.healthAlertDedupAt.set(id, Date.now());
this.healthAlertPendingRetry.delete(id);
} else {
state.healthStatus = 'healthy';
// Refund only into the window that issued the token so a late
// persist failure cannot inflate a newer window's budget.
this.refundRateToken(token);
console.error(
`[DockerEvents:${this.nodeName}] Health alert history not persisted for ${id}; dedup not advanced`,
);
}
} finally {
this.healthAlertInFlight.delete(id);
}
if (this.isStopped()) {
this.healthAlertPendingRetry.delete(id);
return;
}
// A concurrent healthy→unhealthy flap was deferred while we were in
// flight. If the first write failed, retry so the alert is not lost
// while the container stays unhealthy with no further transitions.
if (this.shouldRetryHealthAlert(id, state, persisted)) {
this.healthAlertPendingRetry.delete(id);
await this.dispatchHealthAlert(id, state);
}
}
private shouldRetryHealthAlert(
id: string,
state: InternalContainerState,
persisted: boolean,
): boolean {
return !this.isStopped()
&& !persisted
&& this.healthAlertPendingRetry.has(id)
&& state.healthStatus === 'unhealthy';
}
private onStart(id: string): void {
@@ -495,6 +621,7 @@ export class DockerEventService {
state.healthStatus = 'starting';
state.lastStartAt = Date.now();
state.lastActivityAt = Date.now();
this.healthAlertPendingRetry.delete(id);
}
private onDestroy(id: string): void {
@@ -504,6 +631,9 @@ export class DockerEventService {
clearTimeout(pending);
this.pendingDieTimers.delete(id);
}
this.healthAlertPendingRetry.delete(id);
this.healthAlertInFlight.delete(id);
this.healthAlertDedupAt.delete(id);
}
private async classifyDie(id: string, event: DockerEventPayload, dieAt: number): Promise<void> {
@@ -545,7 +675,7 @@ export class DockerEventService {
// Dedup early: crashloops repeatedly reach this point with exit 137,
// and the OOM fallback below issues a Docker inspect. Skipping the
// inspect on deduped crashes avoids hammering the daemon.
if (state.lastCrashAlertAt && now - state.lastCrashAlertAt < CRASH_DEDUP_MS) {
if (this.isWithinAlertDedupWindow(state.lastCrashAlertAt, now, CRASH_DEDUP_MS)) {
return;
}
@@ -584,6 +714,7 @@ export class DockerEventService {
state: InternalContainerState | null,
info: { name: string; exitCode: number; stackName?: string; isSelf?: boolean },
): Promise<void> {
if (this.isStopped()) return;
// Respect the existing global crash-alerts toggle so users who have
// disabled these notifications in Settings remain opted out.
if (!this.isCrashAlertsEnabled()) return;
@@ -592,8 +723,9 @@ export class DockerEventService {
? `Container OOM Kill: ${info.name} was killed by the OOM killer (out of memory).`
: `Container Crash Detected: ${info.name} exited unexpectedly (Code: ${info.exitCode}).`;
if (!this.consumeRateToken()) {
this.suppressedCount += 1;
const token = this.consumeRateToken();
if (!token) {
this.suppressedCrashAlertCount += 1;
this.scheduleSummary();
return;
}
@@ -625,32 +757,70 @@ export class DockerEventService {
return value;
}
/** Return true if an alert can be emitted now. Side effect: increments counters. */
private consumeRateToken(): boolean {
/**
* Consume one shared crash/health rate token for the current fixed window.
* Returns null when the window is exhausted. Rolling into a new window first
* flushes any pending overflow summary so counters cannot span windows.
*/
private consumeRateToken(): RateToken | null {
const now = Date.now();
if (now - this.rateWindowStart >= RATE_WINDOW_MS) {
this.rateWindowStart = now;
this.rateCount = 0;
if (now - this.containerAlertRateWindowStart >= RATE_WINDOW_MS) {
this.flushRateLimitSummaryNow();
this.containerAlertRateWindowStart = now;
this.containerAlertRateCount = 0;
}
if (this.rateCount >= RATE_LIMIT_MAX) return false;
this.rateCount += 1;
return true;
if (this.containerAlertRateCount >= RATE_LIMIT_MAX) return null;
this.containerAlertRateCount += 1;
return { windowStart: this.containerAlertRateWindowStart };
}
/** Refund a token only when the issuing window is still active. */
private refundRateToken(token: RateToken): void {
if (token.windowStart !== this.containerAlertRateWindowStart) return;
if (this.containerAlertRateCount > 0) this.containerAlertRateCount -= 1;
}
private isWithinAlertDedupWindow(
lastAlertAt: number | undefined,
now: number,
windowMs: number,
): boolean {
return lastAlertAt !== undefined && now - lastAlertAt < windowMs;
}
private buildRateLimitSummaryMessage(crash: number, health: number): string {
const total = crash + health;
if (crash > 0 && health > 0) {
return `${total} additional container alerts were rate-limited in the last minute (${crash} crash, ${health} health).`;
}
if (health > 0) {
return `${health} additional container health alerts were rate-limited in the last minute.`;
}
return `${crash} additional container crash alerts were rate-limited in the last minute.`;
}
/** Emit and clear any pending overflow roll-up immediately (e.g. on window roll). */
private flushRateLimitSummaryNow(): void {
if (this.summaryTimer) {
clearTimeout(this.summaryTimer);
this.summaryTimer = null;
}
const crash = this.suppressedCrashAlertCount;
const health = this.suppressedHealthAlertCount;
this.suppressedCrashAlertCount = 0;
this.suppressedHealthAlertCount = 0;
if (crash + health <= 0) return;
if (this.status === 'stopped') return;
void this.emitWarning('monitor_alert', this.buildRateLimitSummaryMessage(crash, health));
}
private scheduleSummary(): void {
if (this.summaryTimer) return;
const remaining = RATE_WINDOW_MS - (Date.now() - this.rateWindowStart);
const remaining = RATE_WINDOW_MS - (Date.now() - this.containerAlertRateWindowStart);
const delay = Math.max(1_000, remaining);
this.summaryTimer = setTimeout(() => {
const count = this.suppressedCount;
this.summaryTimer = null;
this.suppressedCount = 0;
if (count > 0) {
void this.emitWarning(
'monitor_alert',
`${count} additional containers crashed in the last minute.`,
);
}
this.flushRateLimitSummaryNow();
}, delay);
}
@@ -707,15 +877,24 @@ export class DockerEventService {
}
private pruneStaleState(): void {
if (this.containerState.size === 0) return;
const cutoff = Date.now() - STATE_STALE_AFTER_MS;
for (const [id, state] of this.containerState) {
// Keep state for a container with an unresolved crash so Auto-Heal can
// still act on it past the default stale window (policy thresholds run
// up to 24h). It is cleared on `start` and removed on `destroy`.
if (state.crashedAt !== undefined) continue;
if (state.lastActivityAt < cutoff) {
this.containerState.delete(id);
if (this.containerState.size > 0) {
const cutoff = Date.now() - STATE_STALE_AFTER_MS;
for (const [id, state] of this.containerState) {
// Keep state for a container with an unresolved crash so Auto-Heal can
// still act on it past the default stale window (policy thresholds run
// up to 24h). It is cleared on `start` and removed on `destroy`.
if (state.crashedAt !== undefined) continue;
if (state.lastActivityAt < cutoff) {
this.containerState.delete(id);
}
}
}
// Health dedup lives outside containerState so the 60m window survives
// ordinary 10m prune. Drop only entries whose window has fully expired.
if (this.healthAlertDedupAt.size > 0) {
const dedupCutoff = Date.now() - HEALTH_DEDUP_MS;
for (const [id, at] of this.healthAlertDedupAt) {
if (at < dedupCutoff) this.healthAlertDedupAt.delete(id);
}
}
}
@@ -734,16 +913,16 @@ export class DockerEventService {
: { stackName, containerName, actor: 'system:docker-events' };
}
private async emitError(category: NotificationCategory, message: string, stackName?: string, containerName?: string, systemOnly = false): Promise<void> {
await this.notifier.dispatchAlert('error', category, message, this.buildAlertOptions(stackName, containerName, systemOnly));
private async emitError(category: NotificationCategory, message: string, stackName?: string, containerName?: string, systemOnly = false): Promise<{ persisted: boolean }> {
return this.notifier.dispatchAlert('error', category, message, this.buildAlertOptions(stackName, containerName, systemOnly));
}
private async emitWarning(category: NotificationCategory, message: string, stackName?: string, containerName?: string): Promise<void> {
await this.notifier.dispatchAlert('warning', category, message, this.buildAlertOptions(stackName, containerName));
private async emitWarning(category: NotificationCategory, message: string, stackName?: string, containerName?: string): Promise<{ persisted: boolean }> {
return this.notifier.dispatchAlert('warning', category, message, this.buildAlertOptions(stackName, containerName));
}
private async emitInfo(category: NotificationCategory, message: string, stackName?: string, containerName?: string): Promise<void> {
await this.notifier.dispatchAlert('info', category, message, this.buildAlertOptions(stackName, containerName));
private async emitInfo(category: NotificationCategory, message: string, stackName?: string, containerName?: string): Promise<{ persisted: boolean }> {
return this.notifier.dispatchAlert('info', category, message, this.buildAlertOptions(stackName, containerName));
}
// ========================================================================