chore: add prometheus ports to remaining services for consistency (#6412)

Co-authored-by: Kamil Kisiela <[email protected]>

Author: Intellicode

.changeset/three-random-words.md

@@ -0,0 +1,5 @@
+---
+'hive': minor
+---
+
+Added a new environment variable `PROMETHEUS_METRICS_PORT` to control the promethus port of the policy service. The default value is `10254` (no action needed).

packages/services/policy/README.md

@@ -14,4 +14,5 @@ policy checks.
 | `SENTRY`                            | No       | Whether Sentry error reporting should be enabled.                                                        | `1` (enabled) or `0` (disabled)                      |
 | `PROMETHEUS_METRICS`                | No       | Whether Prometheus metrics should be enabled                                                             | `1` (enabled) or `0` (disabled)                      |
 | `PROMETHEUS_METRICS_LABEL_INSTANCE` | No       | The instance label added for the prometheus metrics.                                                     | `usage-service`                                      |
+| `PROMETHEUS_METRICS_PORT`           | No       | Port on which prometheus metrics are exposed                                                             | Defaults to `10254`                                  |
 | `OPENTELEMETRY_COLLECTOR_ENDPOINT`  | No       | OpenTelemetry Collector endpoint. The expected traces transport is HTTP (port `4318`).                   | `http://localhost:4318/v1/traces`                    |

packages/services/policy/src/environment.ts

@@ -37,6 +37,7 @@ const SentryModel = zod.union([
 const PrometheusModel = zod.object({
   PROMETHEUS_METRICS: emptyString(zod.union([zod.literal('0'), zod.literal('1')]).optional()),
   PROMETHEUS_METRICS_LABEL_INSTANCE: emptyString(zod.string().optional()),
+  PROMETHEUS_METRICS_PORT: emptyString(NumberFromString.optional()),
 });
 
 const LogModel = zod.object({
@@ -119,6 +120,7 @@ export const env = {
           labels: {
             instance: prometheus.PROMETHEUS_METRICS_LABEL_INSTANCE ?? 'schema',
           },
+          port: prometheus.PROMETHEUS_METRICS_PORT ?? 10_254,
         }
       : null,
 } as const;

packages/services/policy/src/index.ts

@@ -89,7 +89,7 @@ async function main() {
     });
 
     if (env.prometheus) {
-      await startMetrics(env.prometheus.labels.instance);
+      await startMetrics(env.prometheus.labels.instance, env.prometheus.port);
     }
   } catch (error) {
     server.log.fatal(error);

packages/services/rate-limit/README.md

@@ -21,6 +21,7 @@ you don't need this service.
 | `SENTRY_DSN`                         | No                                                 | The DSN for reporting errors to Sentry.                                                                  | `https://[email protected]/12121212` |
 | `PROMETHEUS_METRICS`                 | No                                                 | Whether Prometheus metrics should be enabled                                                             | `1` (enabled) or `0` (disabled)                      |
 | `PROMETHEUS_METRICS_LABEL_INSTANCE`  | No                                                 | The instance label added for the prometheus metrics.                                                     | `rate-limit`                                         |
+| `PROMETHEUS_METRICS_PORT`            | No                                                 | Port on which prometheus metrics are exposed                                                             | Defaults to `10254`                                  |
 | `WEB_APP_URL`                        | No                                                 | The base url of the web app                                                                              | `https://your-instance.com`                          |
 | `REQUEST_LOGGING`                    | No                                                 | Log http requests                                                                                        | `1` (enabled) or `0` (disabled)                      |
 | `LOG_LEVEL`                          | No                                                 | The verbosity of the service logs. One of `trace`, `debug`, `info`, `warn` ,`error`, `fatal` or `silent` | `info` (default)                                     |

packages/services/rate-limit/src/environment.ts

@@ -50,6 +50,7 @@ const PostgresModel = zod.object({
 const PrometheusModel = zod.object({
   PROMETHEUS_METRICS: emptyString(zod.union([zod.literal('0'), zod.literal('1')]).optional()),
   PROMETHEUS_METRICS_LABEL_INSTANCE: zod.string().optional(),
+  PROMETHEUS_METRICS_PORT: emptyString(NumberFromString.optional()),
 });
 
 const LogModel = zod.object({
@@ -155,6 +156,7 @@ export const env = {
           labels: {
             instance: prometheus.PROMETHEUS_METRICS_LABEL_INSTANCE ?? 'rate-limit',
           },
+          port: prometheus.PROMETHEUS_METRICS_PORT ?? 10_254,
         }
       : null,
 } as const;

packages/services/rate-limit/src/index.ts

@@ -119,7 +119,7 @@ async function main() {
     });
 
     if (env.prometheus) {
-      await startMetrics(env.prometheus.labels.instance);
+      await startMetrics(env.prometheus.labels.instance, env.prometheus.port);
     }
     await server.listen({
       port: env.http.port,

packages/services/usage-estimator/README.md

@@ -22,6 +22,7 @@ This service takes care of estimating the usage of an account.
 | `SENTRY_ENABLED`                    | No       | Whether Sentry error reporting should be enabled.                                                        | `1` (enabled) or `0` (disabled)                      |
 | `PROMETHEUS_METRICS`                | No       | Whether Prometheus metrics should be enabled                                                             | `1` (enabled) or `0` (disabled)                      |
 | `PROMETHEUS_METRICS_LABEL_INSTANCE` | No       | The instance label added for the prometheus metrics.                                                     | `rate-limit`                                         |
+| `PROMETHEUS_METRICS_PORT`           | No       | Port on which prometheus metrics are exposed                                                             | Defaults to `10254`                                  |
 | `REQUEST_LOGGING`                   | No       | Log http requests                                                                                        | `1` (enabled) or `0` (disabled)                      |
 | `LOG_LEVEL`                         | No       | The verbosity of the service logs. One of `trace`, `debug`, `info`, `warn` ,`error`, `fatal` or `silent` | `info` (default)                                     |
 | `OPENTELEMETRY_COLLECTOR_ENDPOINT`  | No       | OpenTelemetry Collector endpoint. The expected traces transport is HTTP (port `4318`).                   | `http://localhost:4318/v1/traces`                    |

packages/services/usage-estimator/src/environment.ts

@@ -37,6 +37,7 @@ const SentryModel = zod.union([
 const PrometheusModel = zod.object({
   PROMETHEUS_METRICS: emptyString(zod.union([zod.literal('0'), zod.literal('1')]).optional()),
   PROMETHEUS_METRICS_LABEL_INSTANCE: emptyString(zod.string().optional()),
+  PROMETHEUS_METRICS_PORT: emptyString(NumberFromString.optional()),
 });
 
 const LogModel = zod.object({
@@ -137,6 +138,7 @@ export const env = {
           labels: {
             instance: prometheus.PROMETHEUS_METRICS_LABEL_INSTANCE ?? 'rate-limit',
           },
+          port: prometheus.PROMETHEUS_METRICS_PORT ?? 10_254,
         }
       : null,
 } as const;

packages/services/usage-estimator/src/index.ts

@@ -106,7 +106,7 @@ async function main() {
     });
 
     if (env.prometheus) {
-      await startMetrics(env.prometheus.labels.instance);
+      await startMetrics(env.prometheus.labels.instance, env.prometheus.port);
     }
     await server.listen({
       port: env.http.port,