add labels

bin/cli.ts

@@ -1,12 +1,19 @@
 #!/usr/bin/env node
 
 import { cli } from "substreams-sink";
-import { action, DEFAULT_ADDRESS, DEFAULT_PORT } from "../index.js"
+import { action, DEFAULT_ADDRESS, DEFAULT_COLLECT_DEFAULT_METRICS, DEFAULT_PORT } from "../index.js"
 import pkg from "../package.json";
 
 const program = cli.program(pkg);
 const command = cli.run(program, pkg);
 command.option('-p --port <int>', 'Listens on port number.', String(DEFAULT_PORT));
 command.option('-a --address <string>', 'Prometheus address to connect.', DEFAULT_ADDRESS);
+command.option('-l --labels [...string]', "To apply generic labels to all default metrics (ex: --labels foo=bar)", handleLabels, {})
+command.option('--collect-default-metrics <boolean>', "Collect default metrics", DEFAULT_COLLECT_DEFAULT_METRICS);
 command.action(action);
-program.parse();
+program.parse();
+
+function handleLabels(value: string, previous: {}) {
+    const params = new URLSearchParams(value);
+    return { ...previous, ...Object.fromEntries(params) };
+}

index.ts

@@ -1,7 +1,7 @@
 import { createHash, download } from "substreams";
 import { run, logger, RunOptions } from "substreams-sink";
 import pkg from "./package.json";
-import { collectDefaultMetrics, listen } from "./src/server";
+import { collectDefaultMetrics, listen, setDefaultLabels } from "./src/server";
 import { handleClock, handleManifest, handleOperations } from "./src/metrics";
 export * from "./src/metrics";
 export * from "./src/server";
@@ -13,10 +13,13 @@ export { logger };
 export const DEFAULT_ADDRESS = 'localhost';
 export const DEFAULT_PORT = 9102;
 export const TYPE_NAME = "pinax.substreams.sink.prometheus.v1.PrometheusOperations"
+export const DEFAULT_COLLECT_DEFAULT_METRICS = true;
 
 export interface ActionOptions extends RunOptions {
     address: string;
     port: number;
+    labels: string;
+    collectDefaultMetrics: boolean;
 }
 
 export async function action(manifest: string, moduleName: string, options: ActionOptions) {
@@ -26,8 +29,9 @@ export async function action(manifest: string, moduleName: string, options: Acti
     logger.info("download", {manifest, hash});
 
     // Initialize Prometheus server
+    if ( options.collectDefaultMetrics ) collectDefaultMetrics(options.labels);
+    if ( options.labels ) setDefaultLabels(options.labels);
     listen(options.port, options.address);
-    collectDefaultMetrics();
 
     // Run Substreams
     const substreams = run(spkg, moduleName, options);

package.json

@@ -1,6 +1,6 @@
 {
     "name": "substreams-sink-prometheus",
-    "version": "0.4.4",
+    "version": "0.4.5",
     "description": "Substreams Prometheus sink module",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

src/server.ts

@@ -7,8 +7,13 @@ import { DEFAULT_ADDRESS } from "../index.js";
 export const register = new client.Registry();
 
 // Collect default metrics
-export function collectDefaultMetrics() {
-    client.collectDefaultMetrics({ register });
+export function collectDefaultMetrics(labels: Object = {}) {
+    client.collectDefaultMetrics({ register, labels });
+}
+
+// Set default labels
+export function setDefaultLabels(labels: Object = {}) {
+    register.setDefaultLabels(labels);
 }
 
 // Create a local server to serve Prometheus gauges