@envelop/prometheus 9.4.0 → 10.0.0-alpha-20240429133416-6ed19f38

package/README.md

@@ -106,14 +106,14 @@ const getEnveloped = envelop({
     usePrometheus({
       // all optional, and by default, all set to false, please opt-in to the metrics you wish to get
       parse: createHistogram({
+        registry: registry // make sure to add your custom registry, if you are not using the default one
         histogram: new Histogram({
           name: 'my_custom_name',
           help: 'HELP ME',
           labelNames: ['opText'] as const,
-          registers: [registry] // make sure to add your custom registry, if you are not using the default one
         }),
         fillLabelsFn: params => {
-          // if you wish to fill your `lables` with metadata, you can use the params in order to get access to things like DocumentNode, operationName, operationType, `error` (for error metrics) and `info` (for resolvers metrics)
+          // if you wish to fill your `labels` with metadata, you can use the params in order to get access to things like DocumentNode, operationName, operationType, `error` (for error metrics) and `info` (for resolvers metrics)
           return {
             opText: print(params.document)
           }

package/cjs/index.js

@@ -14,6 +14,7 @@ exports.fillLabelsFnParamsMap = new WeakMap();
 exports.execStartTimeMap = new WeakMap();
 const usePrometheus = (config = {}) => {
     let typeInfo = null;
+    const registry = (0, utils_js_1.instrumentRegistry)(config.registry || prom_client_1.register);
     const parseHistogram = (0, utils_js_1.getHistogramFromConfig)(config, 'parse', typeof config.parse === 'string' ? config.parse : 'graphql_envelop_phase_parse', 'Time spent on running GraphQL "parse" function');
     const validateHistogram = (0, utils_js_1.getHistogramFromConfig)(config, 'validate', typeof config.validate === 'string' ? config.validate : 'graphql_envelop_phase_validate', 'Time spent on running GraphQL "validate" function');
     const contextBuildingHistogram = (0, utils_js_1.getHistogramFromConfig)(config, 'contextBuilding', typeof config.contextBuilding === 'string'
@@ -25,7 +26,8 @@ const usePrometheus = (config = {}) => {
         ? config.resolvers
         : config.resolvers === true || typeof config.resolvers === 'string'
             ? (0, utils_js_1.createHistogram)({
-                histogram: new prom_client_1.Histogram({
+                registry,
+                histogram: {
                     name: typeof config.resolvers === 'string'
                         ? config.resolvers
                         : 'graphql_envelop_execute_resolver',
@@ -37,8 +39,7 @@ const usePrometheus = (config = {}) => {
                         'typeName',
                         'returnType',
                     ].filter(label => (0, utils_js_1.labelExists)(config, label)),
-                    registers: [config.registry || prom_client_1.register],
-                }),
+                },
                 fillLabelsFn: params => (0, utils_js_1.filterFillParamsFnParams)(config, {
                     operationName: params.operationName,
                     operationType: params.operationType,
@@ -52,14 +53,14 @@ const usePrometheus = (config = {}) => {
         ? config.requestTotalDuration
         : config.requestTotalDuration === true || typeof config.requestTotalDuration === 'string'
             ? (0, utils_js_1.createHistogram)({
-                histogram: new prom_client_1.Histogram({
+                registry,
+                histogram: {
                     name: typeof config.requestTotalDuration === 'string'
                         ? config.requestTotalDuration
                         : 'graphql_envelop_request_duration',
                     help: 'Time spent on running the GraphQL operation from parse to execute',
                     labelNames: ['operationType', 'operationName'].filter(label => (0, utils_js_1.labelExists)(config, label)),
-                    registers: [config.registry || prom_client_1.register],
-                }),
+                },
                 fillLabelsFn: params => (0, utils_js_1.filterFillParamsFnParams)(config, {
                     operationName: params.operationName,
                     operationType: params.operationType,
@@ -70,14 +71,14 @@ const usePrometheus = (config = {}) => {
         ? config.requestSummary
         : config.requestSummary === true || typeof config.requestSummary === 'string'
             ? (0, utils_js_1.createSummary)({
-                summary: new prom_client_1.Summary({
+                registry,
+                summary: {
                     name: typeof config.requestSummary === 'string'
                         ? config.requestSummary
                         : 'graphql_envelop_request_time_summary',
                     help: 'Summary to measure the time to complete GraphQL operations',
                     labelNames: ['operationType', 'operationName'].filter(label => (0, utils_js_1.labelExists)(config, label)),
-                    registers: [config.registry || prom_client_1.register],
-                }),
+                },
                 fillLabelsFn: params => (0, utils_js_1.filterFillParamsFnParams)(config, {
                     operationName: params.operationName,
                     operationType: params.operationType,
@@ -88,12 +89,12 @@ const usePrometheus = (config = {}) => {
         ? config.errors
         : config.errors === true || typeof config.errors === 'string'
             ? (0, utils_js_1.createCounter)({
-                counter: new prom_client_1.Counter({
+                registry,
+                counter: {
                     name: typeof config.errors === 'string' ? config.errors : 'graphql_envelop_error_result',
                     help: 'Counts the amount of errors reported from all phases',
                     labelNames: ['operationType', 'operationName', 'path', 'phase'].filter(label => (0, utils_js_1.labelExists)(config, label)),
-                    registers: [config.registry || prom_client_1.register],
-                }),
+                },
                 fillLabelsFn: params => (0, utils_js_1.filterFillParamsFnParams)(config, {
                     operationName: params.operationName,
                     operationType: params.operationType,
@@ -106,14 +107,14 @@ const usePrometheus = (config = {}) => {
         ? config.requestCount
         : config.requestCount === true || typeof config.requestCount === 'string'
             ? (0, utils_js_1.createCounter)({
-                counter: new prom_client_1.Counter({
+                registry,
+                counter: {
                     name: typeof config.requestCount === 'string'
                         ? config.requestCount
                         : 'graphql_envelop_request',
                     help: 'Counts the amount of GraphQL requests executed through Envelop',
                     labelNames: ['operationType', 'operationName'].filter(label => (0, utils_js_1.labelExists)(config, label)),
-                    registers: [config.registry || prom_client_1.register],
-                }),
+                },
                 fillLabelsFn: params => (0, utils_js_1.filterFillParamsFnParams)(config, {
                     operationName: params.operationName,
                     operationType: params.operationType,
@@ -124,14 +125,14 @@ const usePrometheus = (config = {}) => {
         ? config.deprecatedFields
         : config.deprecatedFields === true || typeof config.deprecatedFields === 'string'
             ? (0, utils_js_1.createCounter)({
-                counter: new prom_client_1.Counter({
+                registry,
+                counter: {
                     name: typeof config.deprecatedFields === 'string'
                         ? config.deprecatedFields
                         : 'graphql_envelop_deprecated_field',
                     help: 'Counts the amount of deprecated fields used in selection sets',
                     labelNames: ['operationType', 'operationName', 'fieldName', 'typeName'].filter(label => (0, utils_js_1.labelExists)(config, label)),
-                    registers: [config.registry || prom_client_1.register],
-                }),
+                },
                 fillLabelsFn: params => (0, utils_js_1.filterFillParamsFnParams)(config, {
                     operationName: params.operationName,
                     operationType: params.operationType,
@@ -144,13 +145,13 @@ const usePrometheus = (config = {}) => {
         ? config.schemaChangeCount
         : config.schemaChangeCount === true || typeof config.schemaChangeCount === 'string'
             ? (0, utils_js_1.createCounter)({
-                counter: new prom_client_1.Counter({
+                registry,
+                counter: {
                     name: typeof config.schemaChangeCount === 'string'
                         ? config.schemaChangeCount
                         : 'graphql_envelop_schema_change',
                     help: 'Counts the amount of schema changes',
-                    registers: [config.registry || prom_client_1.register],
-                }),
+                },
                 fillLabelsFn: () => ({}),
             })
             : undefined;

package/cjs/metrics.js

@@ -0,0 +1 @@
+"use strict";

package/cjs/utils.js

@@ -1,8 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.filterFillParamsFnParams = exports.labelExists = exports.extractDeprecatedFields = exports.getHistogramFromConfig = exports.createCounter = exports.createSummary = exports.createHistogram = exports.createFillLabelFnParams = exports.shouldTraceFieldResolver = void 0;
+exports.instrumentRegistry = exports.filterFillParamsFnParams = exports.labelExists = exports.extractDeprecatedFields = exports.getHistogramFromConfig = exports.createCounter = exports.registerCounter = exports.createSummary = exports.registerSummary = exports.createHistogram = exports.registerHistogram = exports.createFillLabelFnParams = exports.shouldTraceFieldResolver = void 0;
 const graphql_1 = require("graphql");
 const prom_client_1 = require("prom-client");
+const histograms = new WeakMap();
+const summaries = new WeakMap();
+const counters = new WeakMap();
 function shouldTraceFieldResolver(info, whitelist) {
     if (!whitelist) {
         return true;
@@ -31,16 +34,62 @@ function createFillLabelFnParams(parseResult, context, filterParams) {
     });
 }
 exports.createFillLabelFnParams = createFillLabelFnParams;
+function registerHistogram(registry, conf) {
+    if (!histograms.has(registry)) {
+        histograms.set(registry, new Map());
+    }
+    const registryHistograms = histograms.get(registry);
+    if (!registryHistograms.has(conf.name)) {
+        conf.registers = [registry];
+        registryHistograms.set(conf.name, new prom_client_1.Histogram(conf));
+    }
+    return registryHistograms.get(conf.name);
+}
+exports.registerHistogram = registerHistogram;
 function createHistogram(options) {
-    return options;
+    return {
+        histogram: registerHistogram(options.registry, options.histogram),
+        // histogram: new Histogram(options.histogram),
+        fillLabelsFn: options.fillLabelsFn,
+    };
 }
 exports.createHistogram = createHistogram;
+function registerSummary(registry, conf) {
+    if (!summaries.has(registry)) {
+        summaries.set(registry, new Map());
+    }
+    const registrySummaries = summaries.get(registry);
+    if (!registrySummaries.has(conf.name)) {
+        conf.registers = [registry];
+        registrySummaries.set(conf.name, new prom_client_1.Summary(conf));
+    }
+    return registrySummaries.get(conf.name);
+}
+exports.registerSummary = registerSummary;
 function createSummary(options) {
-    return options;
+    return {
+        summary: registerSummary(options.registry, options.summary),
+        fillLabelsFn: options.fillLabelsFn,
+    };
 }
 exports.createSummary = createSummary;
+function registerCounter(registry, conf) {
+    if (!counters.has(registry)) {
+        counters.set(registry, new Map());
+    }
+    const registryCounters = counters.get(registry);
+    if (!registryCounters.has(conf.name)) {
+        conf.registers = [registry];
+        registryCounters.set(conf.name, new prom_client_1.Counter(conf));
+    }
+    return registryCounters.get(conf.name);
+}
+exports.registerCounter = registerCounter;
 function createCounter(options) {
-    return options;
+    return {
+        counter: registerCounter(options.registry, options.counter),
+        fillLabelsFn: options.fillLabelsFn,
+    };
 }
 exports.createCounter = createCounter;
 function getHistogramFromConfig(config, phase, name, help) {
@@ -48,12 +97,12 @@ function getHistogramFromConfig(config, phase, name, help) {
         ? config[phase]
         : config[phase] === true
             ? createHistogram({
-                histogram: new prom_client_1.Histogram({
+                registry: config.registry || prom_client_1.register,
+                histogram: {
                     name,
                     help,
                     labelNames: ['operationType', 'operationName'].filter(label => labelExists(config, label)),
-                    registers: [config.registry || prom_client_1.register],
-                }),
+                },
                 fillLabelsFn: params => filterFillParamsFnParams(config, {
                     operationName: params.operationName,
                     operationType: params.operationType,
@@ -104,3 +153,17 @@ function filterFillParamsFnParams(config, params) {
     return Object.fromEntries(Object.entries(params).filter(([key]) => labelExists(config, key)));
 }
 exports.filterFillParamsFnParams = filterFillParamsFnParams;
+const clearRegistry = new WeakMap();
+function instrumentRegistry(registry) {
+    if (!clearRegistry.has(registry)) {
+        clearRegistry.set(registry, registry.clear.bind(registry));
+    }
+    registry.clear = () => {
+        histograms.delete(registry);
+        summaries.delete(registry);
+        counters.delete(registry);
+        clearRegistry.get(registry)();
+    };
+    return registry;
+}
+exports.instrumentRegistry = instrumentRegistry;

package/esm/index.js

@@ -1,14 +1,15 @@
 /* eslint-disable @typescript-eslint/no-non-null-asserted-optional-chain */
 import { TypeInfo } from 'graphql';
-import { Counter, register as defaultRegistry, Histogram, Summary } from 'prom-client';
+import { register as defaultRegistry } from 'prom-client';
 import { isAsyncIterable, isIntrospectionOperationString, } from '@envelop/core';
 import { useOnResolve } from '@envelop/on-resolve';
-import { createCounter, createFillLabelFnParams, createHistogram, createSummary, extractDeprecatedFields, filterFillParamsFnParams, getHistogramFromConfig, labelExists, shouldTraceFieldResolver, } from './utils.js';
+import { createCounter, createFillLabelFnParams, createHistogram, createSummary, extractDeprecatedFields, filterFillParamsFnParams, getHistogramFromConfig, instrumentRegistry, labelExists, shouldTraceFieldResolver, } from './utils.js';
 export { createCounter, createHistogram, createSummary, };
 export const fillLabelsFnParamsMap = new WeakMap();
 export const execStartTimeMap = new WeakMap();
 export const usePrometheus = (config = {}) => {
     let typeInfo = null;
+    const registry = instrumentRegistry(config.registry || defaultRegistry);
     const parseHistogram = getHistogramFromConfig(config, 'parse', typeof config.parse === 'string' ? config.parse : 'graphql_envelop_phase_parse', 'Time spent on running GraphQL "parse" function');
     const validateHistogram = getHistogramFromConfig(config, 'validate', typeof config.validate === 'string' ? config.validate : 'graphql_envelop_phase_validate', 'Time spent on running GraphQL "validate" function');
     const contextBuildingHistogram = getHistogramFromConfig(config, 'contextBuilding', typeof config.contextBuilding === 'string'
@@ -20,7 +21,8 @@ export const usePrometheus = (config = {}) => {
         ? config.resolvers
         : config.resolvers === true || typeof config.resolvers === 'string'
             ? createHistogram({
-                histogram: new Histogram({
+                registry,
+                histogram: {
                     name: typeof config.resolvers === 'string'
                         ? config.resolvers
                         : 'graphql_envelop_execute_resolver',
@@ -32,8 +34,7 @@ export const usePrometheus = (config = {}) => {
                         'typeName',
                         'returnType',
                     ].filter(label => labelExists(config, label)),
-                    registers: [config.registry || defaultRegistry],
-                }),
+                },
                 fillLabelsFn: params => filterFillParamsFnParams(config, {
                     operationName: params.operationName,
                     operationType: params.operationType,
@@ -47,14 +48,14 @@ export const usePrometheus = (config = {}) => {
         ? config.requestTotalDuration
         : config.requestTotalDuration === true || typeof config.requestTotalDuration === 'string'
             ? createHistogram({
-                histogram: new Histogram({
+                registry,
+                histogram: {
                     name: typeof config.requestTotalDuration === 'string'
                         ? config.requestTotalDuration
                         : 'graphql_envelop_request_duration',
                     help: 'Time spent on running the GraphQL operation from parse to execute',
                     labelNames: ['operationType', 'operationName'].filter(label => labelExists(config, label)),
-                    registers: [config.registry || defaultRegistry],
-                }),
+                },
                 fillLabelsFn: params => filterFillParamsFnParams(config, {
                     operationName: params.operationName,
                     operationType: params.operationType,
@@ -65,14 +66,14 @@ export const usePrometheus = (config = {}) => {
         ? config.requestSummary
         : config.requestSummary === true || typeof config.requestSummary === 'string'
             ? createSummary({
-                summary: new Summary({
+                registry,
+                summary: {
                     name: typeof config.requestSummary === 'string'
                         ? config.requestSummary
                         : 'graphql_envelop_request_time_summary',
                     help: 'Summary to measure the time to complete GraphQL operations',
                     labelNames: ['operationType', 'operationName'].filter(label => labelExists(config, label)),
-                    registers: [config.registry || defaultRegistry],
-                }),
+                },
                 fillLabelsFn: params => filterFillParamsFnParams(config, {
                     operationName: params.operationName,
                     operationType: params.operationType,
@@ -83,12 +84,12 @@ export const usePrometheus = (config = {}) => {
         ? config.errors
         : config.errors === true || typeof config.errors === 'string'
             ? createCounter({
-                counter: new Counter({
+                registry,
+                counter: {
                     name: typeof config.errors === 'string' ? config.errors : 'graphql_envelop_error_result',
                     help: 'Counts the amount of errors reported from all phases',
                     labelNames: ['operationType', 'operationName', 'path', 'phase'].filter(label => labelExists(config, label)),
-                    registers: [config.registry || defaultRegistry],
-                }),
+                },
                 fillLabelsFn: params => filterFillParamsFnParams(config, {
                     operationName: params.operationName,
                     operationType: params.operationType,
@@ -101,14 +102,14 @@ export const usePrometheus = (config = {}) => {
         ? config.requestCount
         : config.requestCount === true || typeof config.requestCount === 'string'
             ? createCounter({
-                counter: new Counter({
+                registry,
+                counter: {
                     name: typeof config.requestCount === 'string'
                         ? config.requestCount
                         : 'graphql_envelop_request',
                     help: 'Counts the amount of GraphQL requests executed through Envelop',
                     labelNames: ['operationType', 'operationName'].filter(label => labelExists(config, label)),
-                    registers: [config.registry || defaultRegistry],
-                }),
+                },
                 fillLabelsFn: params => filterFillParamsFnParams(config, {
                     operationName: params.operationName,
                     operationType: params.operationType,
@@ -119,14 +120,14 @@ export const usePrometheus = (config = {}) => {
         ? config.deprecatedFields
         : config.deprecatedFields === true || typeof config.deprecatedFields === 'string'
             ? createCounter({
-                counter: new Counter({
+                registry,
+                counter: {
                     name: typeof config.deprecatedFields === 'string'
                         ? config.deprecatedFields
                         : 'graphql_envelop_deprecated_field',
                     help: 'Counts the amount of deprecated fields used in selection sets',
                     labelNames: ['operationType', 'operationName', 'fieldName', 'typeName'].filter(label => labelExists(config, label)),
-                    registers: [config.registry || defaultRegistry],
-                }),
+                },
                 fillLabelsFn: params => filterFillParamsFnParams(config, {
                     operationName: params.operationName,
                     operationType: params.operationType,
@@ -139,13 +140,13 @@ export const usePrometheus = (config = {}) => {
         ? config.schemaChangeCount
         : config.schemaChangeCount === true || typeof config.schemaChangeCount === 'string'
             ? createCounter({
-                counter: new Counter({
+                registry,
+                counter: {
                     name: typeof config.schemaChangeCount === 'string'
                         ? config.schemaChangeCount
                         : 'graphql_envelop_schema_change',
                     help: 'Counts the amount of schema changes',
-                    registers: [config.registry || defaultRegistry],
-                }),
+                },
                 fillLabelsFn: () => ({}),
             })
             : undefined;

package/esm/metrics.js

@@ -0,0 +1 @@
+"use strict";

package/esm/utils.js

@@ -1,5 +1,8 @@
 import { visit, visitWithTypeInfo, } from 'graphql';
-import { register as defaultRegistry, Histogram } from 'prom-client';
+import { Counter, register as defaultRegistry, Histogram, Summary, } from 'prom-client';
+const histograms = new WeakMap();
+const summaries = new WeakMap();
+const counters = new WeakMap();
 export function shouldTraceFieldResolver(info, whitelist) {
     if (!whitelist) {
         return true;
@@ -26,26 +29,69 @@ export function createFillLabelFnParams(parseResult, context, filterParams) {
         operationType: operation.operation,
     });
 }
+export function registerHistogram(registry, conf) {
+    if (!histograms.has(registry)) {
+        histograms.set(registry, new Map());
+    }
+    const registryHistograms = histograms.get(registry);
+    if (!registryHistograms.has(conf.name)) {
+        conf.registers = [registry];
+        registryHistograms.set(conf.name, new Histogram(conf));
+    }
+    return registryHistograms.get(conf.name);
+}
 export function createHistogram(options) {
-    return options;
+    return {
+        histogram: registerHistogram(options.registry, options.histogram),
+        // histogram: new Histogram(options.histogram),
+        fillLabelsFn: options.fillLabelsFn,
+    };
+}
+export function registerSummary(registry, conf) {
+    if (!summaries.has(registry)) {
+        summaries.set(registry, new Map());
+    }
+    const registrySummaries = summaries.get(registry);
+    if (!registrySummaries.has(conf.name)) {
+        conf.registers = [registry];
+        registrySummaries.set(conf.name, new Summary(conf));
+    }
+    return registrySummaries.get(conf.name);
 }
 export function createSummary(options) {
-    return options;
+    return {
+        summary: registerSummary(options.registry, options.summary),
+        fillLabelsFn: options.fillLabelsFn,
+    };
+}
+export function registerCounter(registry, conf) {
+    if (!counters.has(registry)) {
+        counters.set(registry, new Map());
+    }
+    const registryCounters = counters.get(registry);
+    if (!registryCounters.has(conf.name)) {
+        conf.registers = [registry];
+        registryCounters.set(conf.name, new Counter(conf));
+    }
+    return registryCounters.get(conf.name);
 }
 export function createCounter(options) {
-    return options;
+    return {
+        counter: registerCounter(options.registry, options.counter),
+        fillLabelsFn: options.fillLabelsFn,
+    };
 }
 export function getHistogramFromConfig(config, phase, name, help) {
     return typeof config[phase] === 'object'
         ? config[phase]
         : config[phase] === true
             ? createHistogram({
-                histogram: new Histogram({
+                registry: config.registry || defaultRegistry,
+                histogram: {
                     name,
                     help,
                     labelNames: ['operationType', 'operationName'].filter(label => labelExists(config, label)),
-                    registers: [config.registry || defaultRegistry],
-                }),
+                },
                 fillLabelsFn: params => filterFillParamsFnParams(config, {
                     operationName: params.operationName,
                     operationType: params.operationType,
@@ -92,3 +138,16 @@ export function labelExists(config, label) {
 export function filterFillParamsFnParams(config, params) {
     return Object.fromEntries(Object.entries(params).filter(([key]) => labelExists(config, key)));
 }
+const clearRegistry = new WeakMap();
+export function instrumentRegistry(registry) {
+    if (!clearRegistry.has(registry)) {
+        clearRegistry.set(registry, registry.clear.bind(registry));
+    }
+    registry.clear = () => {
+        histograms.delete(registry);
+        summaries.delete(registry);
+        counters.delete(registry);
+        clearRegistry.get(registry)();
+    };
+    return registry;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@envelop/prometheus",
-  "version": "9.4.0",
+  "version": "10.0.0-alpha-20240429133416-6ed19f38",
   "sideEffects": false,
   "peerDependencies": {
     "@envelop/core": "^5.0.0",

package/typings/index.d.cts

@@ -1,7 +1,7 @@
 import { Plugin } from '@envelop/core';
 import { PrometheusTracingPluginConfig } from './config.cjs';
 import { createCounter, createHistogram, createSummary, FillLabelsFnParams } from './utils.cjs';
-export { PrometheusTracingPluginConfig, createCounter, createHistogram, createSummary, FillLabelsFnParams, };
+export { FillLabelsFnParams, PrometheusTracingPluginConfig, createCounter, createHistogram, createSummary, };
 export declare const fillLabelsFnParamsMap: WeakMap<any, FillLabelsFnParams | null>;
 export declare const execStartTimeMap: WeakMap<any, number>;
 export declare const usePrometheus: (config?: PrometheusTracingPluginConfig) => Plugin;

package/typings/index.d.ts

@@ -1,7 +1,7 @@
 import { Plugin } from '@envelop/core';
 import { PrometheusTracingPluginConfig } from './config.js';
 import { createCounter, createHistogram, createSummary, FillLabelsFnParams } from './utils.js';
-export { PrometheusTracingPluginConfig, createCounter, createHistogram, createSummary, FillLabelsFnParams, };
+export { FillLabelsFnParams, PrometheusTracingPluginConfig, createCounter, createHistogram, createSummary, };
 export declare const fillLabelsFnParamsMap: WeakMap<any, FillLabelsFnParams | null>;
 export declare const execStartTimeMap: WeakMap<any, number>;
 export declare const usePrometheus: (config?: PrometheusTracingPluginConfig) => Plugin;

package/typings/utils.d.cts

@@ -1,5 +1,5 @@
 import { ASTNode, DocumentNode, GraphQLError, GraphQLResolveInfo, OperationDefinitionNode, TypeInfo } from 'graphql';
-import { Counter, Histogram, Summary } from 'prom-client';
+import { Counter, Histogram, Summary, type CounterConfiguration, type HistogramConfiguration, type Registry, type SummaryConfiguration } from 'prom-client';
 import { AfterParseEventPayload } from '@envelop/core';
 import { PrometheusTracingPluginConfig } from './config.cjs';
 export type DeprecatedFieldInfo = {
@@ -17,22 +17,41 @@ export type FillLabelsFnParams = {
 };
 export declare function shouldTraceFieldResolver(info: GraphQLResolveInfo, whitelist: string[] | undefined): boolean;
 export declare function createFillLabelFnParams(parseResult: AfterParseEventPayload<any>['result'], context: any, filterParams: (params: FillLabelsFnParams) => FillLabelsFnParams | null): FillLabelsFnParams | null;
-export type FillLabelsFn<LabelNames extends string> = (params: FillLabelsFnParams, rawContext: any) => Record<LabelNames, string>;
-export declare function createHistogram<LabelNames extends string>(options: {
+export type FillLabelsFn<LabelNames extends string, Params extends Record<string, any>> = (params: Params, rawContext: any) => Record<LabelNames, string | number>;
+export type HistogramAndLabels<LabelNames extends string, Params extends Record<string, any>> = {
     histogram: Histogram<LabelNames>;
-    fillLabelsFn: FillLabelsFn<LabelNames>;
-}): typeof options;
-export declare function createSummary<LabelNames extends string>(options: {
+    fillLabelsFn: FillLabelsFn<LabelNames, Params>;
+};
+export declare function registerHistogram<LabelNames extends string>(registry: Registry, conf: Omit<HistogramConfiguration<LabelNames>, 'registers'>): Histogram<LabelNames>;
+export declare function createHistogram<LabelNames extends string, Params extends Record<string, any> = FillLabelsFnParams>(options: {
+    registry: Registry;
+    histogram: Omit<HistogramConfiguration<LabelNames>, 'registers'>;
+    fillLabelsFn: FillLabelsFn<LabelNames, Params>;
+}): HistogramAndLabels<LabelNames, Params>;
+export type SummaryAndLabels<LabelNames extends string, Params extends Record<string, any>> = {
     summary: Summary<LabelNames>;
-    fillLabelsFn: FillLabelsFn<LabelNames>;
-}): typeof options;
-export declare function createCounter<LabelNames extends string>(options: {
+    fillLabelsFn: FillLabelsFn<LabelNames, Params>;
+};
+export declare function registerSummary<LabelNames extends string>(registry: Registry, conf: Omit<SummaryConfiguration<LabelNames>, 'registers'>): Summary<LabelNames>;
+export declare function createSummary<LabelNames extends string, Params extends Record<string, any> = FillLabelsFnParams>(options: {
+    registry: Registry;
+    summary: Omit<SummaryConfiguration<LabelNames>, 'registers'>;
+    fillLabelsFn: FillLabelsFn<LabelNames, Params>;
+}): SummaryAndLabels<LabelNames, Params>;
+export type CounterAndLabels<LabelNames extends string, Params extends Record<string, any>> = {
     counter: Counter<LabelNames>;
-    fillLabelsFn: FillLabelsFn<LabelNames>;
-}): typeof options;
+    fillLabelsFn: FillLabelsFn<LabelNames, Params>;
+};
+export declare function registerCounter<LabelNames extends string>(registry: Registry, conf: Omit<CounterConfiguration<LabelNames>, 'registers'>): Counter<LabelNames>;
+export declare function createCounter<LabelNames extends string, Params extends Record<string, any> = FillLabelsFnParams>(options: {
+    registry: Registry;
+    counter: Omit<CounterConfiguration<LabelNames>, 'registers'>;
+    fillLabelsFn: FillLabelsFn<LabelNames, Params>;
+}): CounterAndLabels<LabelNames, Params>;
 export declare function getHistogramFromConfig(config: PrometheusTracingPluginConfig, phase: keyof PrometheusTracingPluginConfig, name: string, help: string): ReturnType<typeof createHistogram> | undefined;
 export declare function extractDeprecatedFields(node: ASTNode, typeInfo: TypeInfo): DeprecatedFieldInfo[];
 export declare function labelExists(config: PrometheusTracingPluginConfig, label: string): any;
 export declare function filterFillParamsFnParams(config: PrometheusTracingPluginConfig, params: Record<string, any>): {
     [k: string]: any;
 };
+export declare function instrumentRegistry(registry: Registry): Registry<"text/plain; version=0.0.4; charset=utf-8">;

package/typings/utils.d.ts

@@ -1,5 +1,5 @@
 import { ASTNode, DocumentNode, GraphQLError, GraphQLResolveInfo, OperationDefinitionNode, TypeInfo } from 'graphql';
-import { Counter, Histogram, Summary } from 'prom-client';
+import { Counter, Histogram, Summary, type CounterConfiguration, type HistogramConfiguration, type Registry, type SummaryConfiguration } from 'prom-client';
 import { AfterParseEventPayload } from '@envelop/core';
 import { PrometheusTracingPluginConfig } from './config.js';
 export type DeprecatedFieldInfo = {
@@ -17,22 +17,41 @@ export type FillLabelsFnParams = {
 };
 export declare function shouldTraceFieldResolver(info: GraphQLResolveInfo, whitelist: string[] | undefined): boolean;
 export declare function createFillLabelFnParams(parseResult: AfterParseEventPayload<any>['result'], context: any, filterParams: (params: FillLabelsFnParams) => FillLabelsFnParams | null): FillLabelsFnParams | null;
-export type FillLabelsFn<LabelNames extends string> = (params: FillLabelsFnParams, rawContext: any) => Record<LabelNames, string>;
-export declare function createHistogram<LabelNames extends string>(options: {
+export type FillLabelsFn<LabelNames extends string, Params extends Record<string, any>> = (params: Params, rawContext: any) => Record<LabelNames, string | number>;
+export type HistogramAndLabels<LabelNames extends string, Params extends Record<string, any>> = {
     histogram: Histogram<LabelNames>;
-    fillLabelsFn: FillLabelsFn<LabelNames>;
-}): typeof options;
-export declare function createSummary<LabelNames extends string>(options: {
+    fillLabelsFn: FillLabelsFn<LabelNames, Params>;
+};
+export declare function registerHistogram<LabelNames extends string>(registry: Registry, conf: Omit<HistogramConfiguration<LabelNames>, 'registers'>): Histogram<LabelNames>;
+export declare function createHistogram<LabelNames extends string, Params extends Record<string, any> = FillLabelsFnParams>(options: {
+    registry: Registry;
+    histogram: Omit<HistogramConfiguration<LabelNames>, 'registers'>;
+    fillLabelsFn: FillLabelsFn<LabelNames, Params>;
+}): HistogramAndLabels<LabelNames, Params>;
+export type SummaryAndLabels<LabelNames extends string, Params extends Record<string, any>> = {
     summary: Summary<LabelNames>;
-    fillLabelsFn: FillLabelsFn<LabelNames>;
-}): typeof options;
-export declare function createCounter<LabelNames extends string>(options: {
+    fillLabelsFn: FillLabelsFn<LabelNames, Params>;
+};
+export declare function registerSummary<LabelNames extends string>(registry: Registry, conf: Omit<SummaryConfiguration<LabelNames>, 'registers'>): Summary<LabelNames>;
+export declare function createSummary<LabelNames extends string, Params extends Record<string, any> = FillLabelsFnParams>(options: {
+    registry: Registry;
+    summary: Omit<SummaryConfiguration<LabelNames>, 'registers'>;
+    fillLabelsFn: FillLabelsFn<LabelNames, Params>;
+}): SummaryAndLabels<LabelNames, Params>;
+export type CounterAndLabels<LabelNames extends string, Params extends Record<string, any>> = {
     counter: Counter<LabelNames>;
-    fillLabelsFn: FillLabelsFn<LabelNames>;
-}): typeof options;
+    fillLabelsFn: FillLabelsFn<LabelNames, Params>;
+};
+export declare function registerCounter<LabelNames extends string>(registry: Registry, conf: Omit<CounterConfiguration<LabelNames>, 'registers'>): Counter<LabelNames>;
+export declare function createCounter<LabelNames extends string, Params extends Record<string, any> = FillLabelsFnParams>(options: {
+    registry: Registry;
+    counter: Omit<CounterConfiguration<LabelNames>, 'registers'>;
+    fillLabelsFn: FillLabelsFn<LabelNames, Params>;
+}): CounterAndLabels<LabelNames, Params>;
 export declare function getHistogramFromConfig(config: PrometheusTracingPluginConfig, phase: keyof PrometheusTracingPluginConfig, name: string, help: string): ReturnType<typeof createHistogram> | undefined;
 export declare function extractDeprecatedFields(node: ASTNode, typeInfo: TypeInfo): DeprecatedFieldInfo[];
 export declare function labelExists(config: PrometheusTracingPluginConfig, label: string): any;
 export declare function filterFillParamsFnParams(config: PrometheusTracingPluginConfig, params: Record<string, any>): {
     [k: string]: any;
 };
+export declare function instrumentRegistry(registry: Registry): Registry<"text/plain; version=0.0.4; charset=utf-8">;