From ce7d687205fc921c378fcda8e2650dd5a3ef7124 Mon Sep 17 00:00:00 2001
From: Jon Chambers <jon@signal.org>
Date: Wed, 8 Sep 2021 15:07:47 -0400
Subject: [PATCH] Add a shutdown monitor that publishes shutdown state as a
 metric

---
 .../textsecuregcm/WhisperServerService.java   |  2 ++
 .../metrics/ApplicationShutdownMonitor.java   | 35 +++++++++++++++++++
 2 files changed, 37 insertions(+)
 create mode 100644 service/src/main/java/org/whispersystems/textsecuregcm/metrics/ApplicationShutdownMonitor.java

diff --git a/service/src/main/java/org/whispersystems/textsecuregcm/WhisperServerService.java b/service/src/main/java/org/whispersystems/textsecuregcm/WhisperServerService.java
index cf89c3d5f..4719f6956 100644
--- a/service/src/main/java/org/whispersystems/textsecuregcm/WhisperServerService.java
+++ b/service/src/main/java/org/whispersystems/textsecuregcm/WhisperServerService.java
@@ -113,6 +113,7 @@ import org.whispersystems.textsecuregcm.mappers.RateLimitChallengeExceptionMappe
 import org.whispersystems.textsecuregcm.mappers.RateLimitExceededExceptionMapper;
 import org.whispersystems.textsecuregcm.mappers.RetryLaterExceptionMapper;
 import org.whispersystems.textsecuregcm.mappers.ServerRejectedExceptionMapper;
+import org.whispersystems.textsecuregcm.metrics.ApplicationShutdownMonitor;
 import org.whispersystems.textsecuregcm.metrics.BufferPoolGauges;
 import org.whispersystems.textsecuregcm.metrics.CpuUsageGauge;
 import org.whispersystems.textsecuregcm.metrics.FileDescriptorGauge;
@@ -506,6 +507,7 @@ public class WhisperServerService extends Application<WhisperServerConfiguration
     MigrationRetryAccountsTableCrawler migrationRetryAccountsTableCrawler = new MigrationRetryAccountsTableCrawler(migrationRetryAccounts, accountsManager, accountsDynamoDb, cacheCluster, recurringJobExecutor);
 
     apnSender.setApnFallbackManager(apnFallbackManager);
+    environment.lifecycle().manage(new ApplicationShutdownMonitor());
     environment.lifecycle().manage(apnFallbackManager);
     environment.lifecycle().manage(pubSubManager);
     environment.lifecycle().manage(messageSender);
diff --git a/service/src/main/java/org/whispersystems/textsecuregcm/metrics/ApplicationShutdownMonitor.java b/service/src/main/java/org/whispersystems/textsecuregcm/metrics/ApplicationShutdownMonitor.java
new file mode 100644
index 000000000..8402c30c5
--- /dev/null
+++ b/service/src/main/java/org/whispersystems/textsecuregcm/metrics/ApplicationShutdownMonitor.java
@@ -0,0 +1,35 @@
+/*
+ * Copyright 2013-2021 Signal Messenger, LLC
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+package org.whispersystems.textsecuregcm.metrics;
+
+import io.dropwizard.lifecycle.Managed;
+import io.micrometer.core.instrument.Metrics;
+import java.util.concurrent.atomic.AtomicBoolean;
+
+import static com.codahale.metrics.MetricRegistry.name;
+
+/**
+ * A managed monitor that reports whether the application is shutting down as a metric. That metric can then be used in
+ * conjunction with other indicators to conditionally fire or suppress alerts.
+ */
+public class ApplicationShutdownMonitor implements Managed {
+
+  private final AtomicBoolean shuttingDown = new AtomicBoolean(false);
+
+  public ApplicationShutdownMonitor() {
+    Metrics.gauge(name(getClass().getSimpleName(), "shuttingDown"), shuttingDown, b -> b.get() ? 1 : 0);
+  }
+
+  @Override
+  public void start() throws Exception {
+    shuttingDown.set(false);
+  }
+
+  @Override
+  public void stop() throws Exception {
+    shuttingDown.set(true);
+  }
+}