feat(telemetry): instrument rafiki

packages/backend/src/config/app.ts

@@ -38,9 +38,15 @@ dotenv.config({
 export const Config = {
   logLevel: envString('LOG_LEVEL', 'info'),
   enableTelemetry: envBool('ENABLE_TELEMETRY', true),
-  openTelemetryCollectors: envStringArray('OPEN_TELEMETRY_COLLECTOR_URL', [
-    'http://otel-collector-NLB-e3172ff9d2f4bc8a.elb.eu-west-2.amazonaws.com:4317'
-  ]),
+  livenet: envBool('LIVENET', false),
+  openTelemetryCollectors: envStringArray(
+    'OPEN_TELEMETRY_COLLECTOR_URL',
+    process.env.LIVENET
+      ? []
+      : [
+          'http://otel-collector-NLB-e3172ff9d2f4bc8a.elb.eu-west-2.amazonaws.com:4317'
+        ]
+  ),
   openTelemetryExportInterval: envInt('OPEN_TELEMETRY_EXPORT_INTERVAL', 15000),
   telemetryExchangeRatesUrl: envString(
     'TELEMETRY_EXCHANGE_RATES_URL',

packages/backend/src/index.ts

@@ -220,7 +220,7 @@ export function initIocContainer(
     const config = await deps.use('config')
 
     let telemetry: TelemetryService | undefined
-    if (config.enableTelemetry) {
+    if (config.enableTelemetry && config.openTelemetryCollectors.length > 0) {
       telemetry = await deps.use('telemetry')
     }
 

packages/documentation/src/content/docs/telemetry/integrating.md

@@ -9,6 +9,7 @@ In order to do so, the integrating ASE must deploy its own OpenTelemetry collect
 ## Rafiki Telemetry Environment Variables
 
 - `ENABLE_TELEMETRY`: boolean, defaults to `true`. Enables the telemetry service on Rafiki.
+- `LIVENET`: boolean. Should be set to `true` on production environments. If it is not set, it will default to `false`, and metrics will get sent to the testnet otel-collector
 - `OPEN_TELEMETRY_COLLECTOR_URL`: CSV of URLs for Open Telemetry collectors (e.g., `http://otel-collector-NLB-e3172ff9d2f4bc8a.elb.eu-west-2.amazonaws.com:4317,http://happy-life-otel-collector:4317`).
 - `OPEN_TELEMETRY_EXPORT_INTERVAL`: number in milliseconds, defaults to `15000`. Defines how often the instrumented Rafiki instance should send metrics.
 - `TELEMETRY_EXCHANGE_RATES_URL`: string URL, defaults to `https://telemetry-exchange-rates.s3.amazonaws.com/exchange-rates-usd.json`. It defines the endpoint that Rafiki will query for exchange rates, as a fallback when ASE does not [provide them](/integration/getting-started/#exchange-rates). If set, the response format of the external exchange rates API should be of type Rates, as the rates service expects.