Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] Enable additional metrics endpoints #40

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/dull-bananas-reflect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
'@powersync/service-core': minor
'@powersync/service-types': minor
'@powersync/service-image': minor
---

Added the ability to specify additional metrics export endpoints.
15 changes: 15 additions & 0 deletions packages/service-core/src/metrics/Metrics.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ import * as storage from '../storage/storage-index.js';
import { CorePowerSyncSystem } from '../system/CorePowerSyncSystem.js';
import { Resource } from '@opentelemetry/resources';
import { logger } from '@powersync/lib-services-framework';
import { configFile } from '@powersync/service-types';

export interface MetricsOptions {
disable_telemetry_sharing: boolean;
powersync_instance_id: string;
internal_metrics_endpoint: string;
additional_endpoints?: configFile.AdditionalMetricsEndpoint[];
}

export class Metrics {
Expand Down Expand Up @@ -175,6 +177,19 @@ Anonymous telemetry is currently: ${options.disable_telemetry_sharing ? 'disable
configuredExporters.push(periodicExporter);
}

// Create extra exporters for any additionally configured metric endpoints
for (const endpoint of options.additional_endpoints ?? []) {
logger.info(`Exporting metrics to endpoint: ${endpoint}`);
const additionalEndpointExporter = new PeriodicExportingMetricReader({
exporter: new OTLPMetricExporter({
url: endpoint.url
}),
exportIntervalMillis: endpoint.export_interval_ms ?? 1000 * 60 * 5 // 5 Minutes
});

configuredExporters.push(additionalEndpointExporter);
}

const meterProvider = new MeterProvider({
resource: new Resource({
['service']: 'PowerSync',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,8 @@ export class CompoundConfigCollector {
telemetry: {
disable_telemetry_sharing: baseConfig.telemetry?.disable_telemetry_sharing ?? false,
internal_service_endpoint:
baseConfig.telemetry?.internal_service_endpoint ?? 'https://pulse.journeyapps.com/v1/metrics'
baseConfig.telemetry?.internal_service_endpoint ?? 'https://pulse.journeyapps.com/v1/metrics',
additional_endpoints: baseConfig?.telemetry?.additional_endpoints
},
slot_name_prefix: connections[0]?.slot_name_prefix ?? 'powersync_'
};
Expand Down
1 change: 1 addition & 0 deletions packages/service-core/src/util/config/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ export type ResolvedPowerSyncConfig = {
telemetry: {
disable_telemetry_sharing: boolean;
internal_service_endpoint: string;
additional_endpoints?: configFile.AdditionalMetricsEndpoint[];
};

/** Prefix for postgres replication slot names. May eventually be connection-specific. */
Expand Down
13 changes: 12 additions & 1 deletion packages/types/src/config/PowerSyncConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,16 @@ export const storageConfig = t.object({

export type StorageConfig = t.Decoded<typeof storageConfig>;

/**
* An additional OTLP metrics endpoint
*/
export const AdditionalMetricsEndpoint = t.object({
url: t.string,
export_interval_ms: t.number.optional()
});

export type AdditionalMetricsEndpoint = t.Decoded<typeof AdditionalMetricsEndpoint>;

export const powerSyncConfig = t.object({
replication: t
.object({
Expand Down Expand Up @@ -145,7 +155,8 @@ export const powerSyncConfig = t.object({
telemetry: t
.object({
disable_telemetry_sharing: t.boolean,
internal_service_endpoint: t.string.optional()
internal_service_endpoint: t.string.optional(),
additional_endpoints: t.array(AdditionalMetricsEndpoint).optional()
})
.optional()
});
Expand Down
3 changes: 2 additions & 1 deletion service/src/system/PowerSyncSystem.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ export class PowerSyncSystem extends system.CorePowerSyncSystem {
await Metrics.initialise({
powersync_instance_id: instanceId,
disable_telemetry_sharing: config.telemetry.disable_telemetry_sharing,
internal_metrics_endpoint: config.telemetry.internal_service_endpoint
internal_metrics_endpoint: config.telemetry.internal_service_endpoint,
additional_endpoints: config.telemetry.additional_endpoints
});
},
async stop() {
Expand Down
Loading