@powersync/service-core 0.0.0-dev-20250325131118 → 0.0.0-dev-20250326092547

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @powersync/service-core
 
-## 0.0.0-dev-20250325131118
+## 0.0.0-dev-20250326092547
 
 ### Minor Changes
 
@@ -9,7 +9,7 @@
 ### Patch Changes
 
 - Updated dependencies [d239244]
-  - @powersync/service-types@0.0.0-dev-20250325131118
+  - @powersync/service-types@0.0.0-dev-20250326092547
 
 ## 1.10.0
 

package/dist/metrics/metrics-index.d.ts

@@ -1,4 +1,5 @@
 export * from './MetricsEngine.js';
 export * from './metrics-interfaces.js';
+export * from './register-metrics.js';
 export * from './open-telemetry/OpenTelemetryMetricsFactory.js';
 export * from './open-telemetry/util.js';

package/dist/metrics/metrics-index.js

@@ -1,5 +1,6 @@
 export * from './MetricsEngine.js';
 export * from './metrics-interfaces.js';
+export * from './register-metrics.js';
 export * from './open-telemetry/OpenTelemetryMetricsFactory.js';
 export * from './open-telemetry/util.js';
 //# sourceMappingURL=metrics-index.js.map

package/dist/metrics/metrics-index.js.map

@@ -1 +1 @@
-{"version":3,"file":"metrics-index.js","sourceRoot":"","sources":["../../src/metrics/metrics-index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iDAAiD,CAAC;AAChE,cAAc,0BAA0B,CAAC"}
+{"version":3,"file":"metrics-index.js","sourceRoot":"","sources":["../../src/metrics/metrics-index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iDAAiD,CAAC;AAChE,cAAc,0BAA0B,CAAC"}

package/dist/metrics/register-metrics.d.ts

@@ -0,0 +1,11 @@
+import { ServiceContextContainer } from '../system/ServiceContext.js';
+export declare enum MetricModes {
+    API = "api",
+    REPLICATION = "replication",
+    STORAGE = "storage"
+}
+export type MetricsRegistrationOptions = {
+    service_context: ServiceContextContainer;
+    modes: MetricModes[];
+};
+export declare const registerMetrics: (options: MetricsRegistrationOptions) => Promise<void>;

package/dist/metrics/register-metrics.js

@@ -0,0 +1,44 @@
+import { createOpenTelemetryMetricsFactory } from './open-telemetry/util.js';
+import { MetricsEngine } from './MetricsEngine.js';
+import { createCoreAPIMetrics, initializeCoreAPIMetrics } from '../api/api-metrics.js';
+import { createCoreReplicationMetrics, initializeCoreReplicationMetrics } from '../replication/replication-metrics.js';
+import { createCoreStorageMetrics, initializeCoreStorageMetrics } from '../storage/storage-metrics.js';
+export var MetricModes;
+(function (MetricModes) {
+    MetricModes["API"] = "api";
+    MetricModes["REPLICATION"] = "replication";
+    MetricModes["STORAGE"] = "storage";
+})(MetricModes || (MetricModes = {}));
+export const registerMetrics = async (options) => {
+    const { service_context, modes } = options;
+    const metricsFactory = createOpenTelemetryMetricsFactory(service_context);
+    const metricsEngine = new MetricsEngine({
+        factory: metricsFactory,
+        disable_telemetry_sharing: service_context.configuration.telemetry.disable_telemetry_sharing
+    });
+    service_context.register(MetricsEngine, metricsEngine);
+    if (modes.includes(MetricModes.API)) {
+        createCoreAPIMetrics(metricsEngine);
+        initializeCoreAPIMetrics(metricsEngine);
+    }
+    if (modes.includes(MetricModes.REPLICATION)) {
+        createCoreReplicationMetrics(metricsEngine);
+        initializeCoreReplicationMetrics(metricsEngine);
+    }
+    if (modes.includes(MetricModes.STORAGE)) {
+        createCoreStorageMetrics(metricsEngine);
+        // This requires an instantiated bucket storage, which is only created when the lifecycle starts
+        service_context.storageEngine.registerListener({
+            storageActivated: (bucketStorage) => {
+                initializeCoreStorageMetrics(metricsEngine, bucketStorage);
+            }
+        });
+    }
+    service_context.lifeCycleEngine.withLifecycle(metricsEngine, {
+        start: async () => {
+            await metricsEngine.start();
+        },
+        stop: () => metricsEngine.shutdown()
+    });
+};
+//# sourceMappingURL=register-metrics.js.map

package/dist/metrics/register-metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"register-metrics.js","sourceRoot":"","sources":["../../src/metrics/register-metrics.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iCAAiC,EAAE,MAAM,0BAA0B,CAAC;AAC7E,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AACvF,OAAO,EAAE,4BAA4B,EAAE,gCAAgC,EAAE,MAAM,uCAAuC,CAAC;AACvH,OAAO,EAAE,wBAAwB,EAAE,4BAA4B,EAAE,MAAM,+BAA+B,CAAC;AAEvG,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,0BAAW,CAAA;IACX,0CAA2B,CAAA;IAC3B,kCAAmB,CAAA;AACrB,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AAOD,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAAE,OAAmC,EAAE,EAAE;IAC3E,MAAM,EAAE,eAAe,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAE3C,MAAM,cAAc,GAAG,iCAAiC,CAAC,eAAe,CAAC,CAAC;IAC1E,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC;QACtC,OAAO,EAAE,cAAc;QACvB,yBAAyB,EAAE,eAAe,CAAC,aAAa,CAAC,SAAS,CAAC,yBAAyB;KAC7F,CAAC,CAAC;IACH,eAAe,CAAC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;IAEvD,IAAI,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;QACpC,oBAAoB,CAAC,aAAa,CAAC,CAAC;QACpC,wBAAwB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC;QAC5C,4BAA4B,CAAC,aAAa,CAAC,CAAC;QAC5C,gCAAgC,CAAC,aAAa,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;QACxC,wBAAwB,CAAC,aAAa,CAAC,CAAC;QAExC,gGAAgG;QAChG,eAAe,CAAC,aAAa,CAAC,gBAAgB,CAAC;YAC7C,gBAAgB,EAAE,CAAC,aAAa,EAAE,EAAE;gBAClC,4BAA4B,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;YAC7D,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED,eAAe,CAAC,eAAe,CAAC,aAAa,CAAC,aAAa,EAAE;QAC3D,KAAK,EAAE,KAAK,IAAI,EAAE;YAChB,MAAM,aAAa,CAAC,KAAK,EAAE,CAAC;QAC9B,CAAC;QACD,IAAI,EAAE,GAAG,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE;KACrC,CAAC,CAAC;AACL,CAAC,CAAC"}

package/package.json

@@ -5,7 +5,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.0.0-dev-20250325131118",
+  "version": "0.0.0-dev-20250326092547",
   "main": "dist/index.js",
   "license": "FSL-1.1-Apache-2.0",
   "type": "module",
@@ -36,7 +36,7 @@
     "@powersync/service-jsonbig": "0.17.10",
     "@powersync/service-rsocket-router": "0.0.20",
     "@powersync/service-sync-rules": "0.25.0",
-    "@powersync/service-types": "0.0.0-dev-20250325131118"
+    "@powersync/service-types": "0.0.0-dev-20250326092547"
   },
   "devDependencies": {
     "@types/async": "^3.2.24",

package/src/metrics/metrics-index.ts

@@ -1,4 +1,5 @@
 export * from './MetricsEngine.js';
 export * from './metrics-interfaces.js';
+export * from './register-metrics.js';
 export * from './open-telemetry/OpenTelemetryMetricsFactory.js';
 export * from './open-telemetry/util.js';

package/src/metrics/register-metrics.ts

@@ -0,0 +1,56 @@
+import { ServiceContextContainer } from '../system/ServiceContext.js';
+import { createOpenTelemetryMetricsFactory } from './open-telemetry/util.js';
+import { MetricsEngine } from './MetricsEngine.js';
+import { createCoreAPIMetrics, initializeCoreAPIMetrics } from '../api/api-metrics.js';
+import { createCoreReplicationMetrics, initializeCoreReplicationMetrics } from '../replication/replication-metrics.js';
+import { createCoreStorageMetrics, initializeCoreStorageMetrics } from '../storage/storage-metrics.js';
+
+export enum MetricModes {
+  API = 'api',
+  REPLICATION = 'replication',
+  STORAGE = 'storage'
+}
+
+export type MetricsRegistrationOptions = {
+  service_context: ServiceContextContainer;
+  modes: MetricModes[];
+};
+
+export const registerMetrics = async (options: MetricsRegistrationOptions) => {
+  const { service_context, modes } = options;
+
+  const metricsFactory = createOpenTelemetryMetricsFactory(service_context);
+  const metricsEngine = new MetricsEngine({
+    factory: metricsFactory,
+    disable_telemetry_sharing: service_context.configuration.telemetry.disable_telemetry_sharing
+  });
+  service_context.register(MetricsEngine, metricsEngine);
+
+  if (modes.includes(MetricModes.API)) {
+    createCoreAPIMetrics(metricsEngine);
+    initializeCoreAPIMetrics(metricsEngine);
+  }
+
+  if (modes.includes(MetricModes.REPLICATION)) {
+    createCoreReplicationMetrics(metricsEngine);
+    initializeCoreReplicationMetrics(metricsEngine);
+  }
+
+  if (modes.includes(MetricModes.STORAGE)) {
+    createCoreStorageMetrics(metricsEngine);
+
+    // This requires an instantiated bucket storage, which is only created when the lifecycle starts
+    service_context.storageEngine.registerListener({
+      storageActivated: (bucketStorage) => {
+        initializeCoreStorageMetrics(metricsEngine, bucketStorage);
+      }
+    });
+  }
+
+  service_context.lifeCycleEngine.withLifecycle(metricsEngine, {
+    start: async () => {
+      await metricsEngine.start();
+    },
+    stop: () => metricsEngine.shutdown()
+  });
+};