@chainlink/external-adapter-framework 0.0.6 → 0.0.8

package/package/config/provider-limits.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWSLimits = exports.getRateLimit = exports.getHTTPLimit = exports.DEFAULT_WS_SUBSCRIPTIONS = exports.DEFAULT_WS_CONNECTIONS = exports.BURST_UNDEFINED_QUOTA_MULTIPLE = exports.DEFAULT_MINUTE_RATE_LIMIT = void 0;
+const util_1 = require("../util");
+exports.DEFAULT_MINUTE_RATE_LIMIT = 60;
+exports.BURST_UNDEFINED_QUOTA_MULTIPLE = 2;
+exports.DEFAULT_WS_CONNECTIONS = 2;
+exports.DEFAULT_WS_SUBSCRIPTIONS = 10;
+const logger = (0, util_1.makeLogger)('ProviderLimits');
+const getHTTPLimit = (provider, limits, tier, timeframe) => {
+    const providerLimit = getProviderLimits(provider, limits, tier, 'http');
+    return providerLimit?.[timeframe] || 0;
+};
+exports.getHTTPLimit = getHTTPLimit;
+const getRateLimit = (provider, limits, tier) => {
+    const providerLimit = getProviderLimits(provider, limits, tier, 'http');
+    return calculateRateLimit(providerLimit);
+};
+exports.getRateLimit = getRateLimit;
+const getWSLimits = (provider, limits, tier) => {
+    const providerLimit = getProviderLimits(provider, limits, tier, 'ws');
+    return calculateWSLimits(providerLimit);
+};
+exports.getWSLimits = getWSLimits;
+const getProviderLimits = (provider, limits, tier, protocol) => {
+    const providerConfig = parseLimits(limits);
+    if (!providerConfig) {
+        throw new Error(`Rate Limit: Provider: "${provider}" doesn't match any provider spec in limits.json`);
+    }
+    const protocolConfig = providerConfig[protocol];
+    if (!protocolConfig) {
+        throw new Error(`Rate Limit: "${provider}" doesn't have any configuration for ${protocol} in limits.json`);
+    }
+    let limitsConfig = protocolConfig[tier.toLowerCase()];
+    if (!limitsConfig) {
+        logger.debug(`Rate Limit: "${provider} does not have tier ${tier} defined. Falling back to lowest tier"`);
+        limitsConfig = Object.values(protocolConfig)?.[0];
+    }
+    if (!limitsConfig) {
+        throw new Error(`Rate Limit: Provider: "${provider}" has no tiers defined for ${protocol} in limits.json`);
+    }
+    return limitsConfig;
+};
+const parseLimits = (limits) => {
+    const _mapObject = (fn) => (o) => Object.fromEntries(Object.entries(o).map(fn));
+    const _formatProtocol = _mapObject((entry) => {
+        const [tierName, rest] = entry;
+        return [tierName.toLowerCase(), { ...rest }];
+    });
+    const _formatProvider = (ls) => {
+        const http = _formatProtocol(ls.http);
+        const ws = _formatProtocol(ls?.ws);
+        return { http, ws };
+    };
+    return _formatProvider(limits);
+};
+const calculateWSLimits = (providerLimit) => {
+    return {
+        connections: providerLimit.connections,
+        subscriptions: providerLimit.subscriptions,
+    };
+};
+const calculateRateLimit = (providerLimit) => {
+    let quota = providerLimit.rateLimit1m;
+    if (!quota && providerLimit?.rateLimit1h) {
+        quota = providerLimit?.rateLimit1h / 60;
+    }
+    else if (!quota && providerLimit?.rateLimit1s) {
+        quota = providerLimit?.rateLimit1s * 60;
+    }
+    return {
+        second: providerLimit?.rateLimit1s || (quota / 60) * exports.BURST_UNDEFINED_QUOTA_MULTIPLE,
+        minute: quota,
+    };
+};

package/package/examples/coingecko/batch-warming.d.ts

@@ -0,0 +1,2 @@
+import { AdapterEndpoint } from '../../adapter';
+export declare const batchEndpoint: AdapterEndpoint;

package/package/examples/coingecko/batch-warming.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.batchEndpoint = void 0;
+const batch_warming_1 = require("../../transports/batch-warming");
+const DEFAULT_URL = 'https://pro-api.coingecko.com/api/v3';
+const inputParameters = {
+    coinid: {
+        description: 'The CoinGecko id or array of ids of the coin(s) to query (Note: because of current limitations to use a dummy base will need to be supplied)',
+        required: false,
+    },
+    base: {
+        aliases: ['from', 'coin'],
+        description: 'The symbol or array of symbols of the currency to query',
+        required: true,
+    },
+    quote: {
+        aliases: ['to', 'market'],
+        description: 'The symbol of the currency to convert to',
+        required: true,
+    },
+};
+const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
+    prepareRequest: (params, context) => {
+        return {
+            baseURL: DEFAULT_URL,
+            url: '/simple/price',
+            method: 'GET',
+            params: {
+                ids: [...new Set(params.map((p) => p.base))].join(','),
+                vs_currencies: [...new Set(params.map((p) => p.quote))].join(','),
+                x_cg_pro_api_key: context.adapterConfig.API_KEY,
+            },
+        };
+    },
+    parseResponse: (res) => {
+        const entries = [];
+        for (const [base, entry] of Object.entries(res.data)) {
+            for (const [quote, price] of Object.entries(entry)) {
+                entries.push({
+                    params: { base, quote },
+                    value: price,
+                });
+            }
+        }
+        return entries;
+    },
+});
+exports.batchEndpoint = {
+    name: 'batch',
+    transport: batchEndpointTransport,
+    inputParameters,
+};

package/package/examples/coingecko/index.d.ts

@@ -0,0 +1,2 @@
+import { Adapter } from '../../adapter';
+export declare const adapter: Adapter;

package/package/examples/coingecko/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adapter = void 0;
+const batch_warming_1 = require("./batch-warming");
+const rest_1 = require("./rest");
+exports.adapter = {
+    name: 'coingecko',
+    defaultEndpoint: 'batch',
+    endpoints: [rest_1.restEndpoint, batch_warming_1.batchEndpoint],
+};

package/package/examples/coingecko/rest.d.ts

@@ -0,0 +1,2 @@
+import { AdapterEndpoint } from '../../adapter';
+export declare const restEndpoint: AdapterEndpoint;

package/package/examples/coingecko/rest.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.restEndpoint = void 0;
+const transports_1 = require("../../transports");
+const DEFAULT_URL = 'https://api.coingecko.com/api/v3';
+const inputParameters = {
+    coinid: {
+        description: 'The CoinGecko id or array of ids of the coin(s) to query (Note: because of current limitations to use a dummy base will need to be supplied)',
+        required: false,
+    },
+    base: {
+        aliases: ['from', 'coin'],
+        description: 'The symbol or array of symbols of the currency to query',
+        required: true,
+    },
+    quote: {
+        aliases: ['to', 'market'],
+        description: 'The symbol of the currency to convert to',
+        required: true,
+    },
+};
+const restEndpointTransport = new transports_1.RestTransport({
+    prepareRequest: (req) => {
+        return {
+            baseURL: DEFAULT_URL,
+            url: '/simple/price',
+            method: 'GET',
+            params: {
+                ids: req.requestContext.data.base,
+                vs_currencies: req.requestContext.data.quote,
+            },
+        };
+    },
+    parseResponse: (req, res) => {
+        return {
+            data: res.data,
+            statusCode: 200,
+            result: res.data[req.requestContext.data.base]?.[req.requestContext.data.quote],
+        };
+    },
+    options: {
+        coalescing: true,
+    },
+});
+exports.restEndpoint = {
+    name: 'rest',
+    aliases: ['qwe'],
+    transport: restEndpointTransport,
+    inputParameters,
+};

package/package/examples/ncfx/config/index.d.ts

@@ -0,0 +1,12 @@
+export declare const customSettings: {
+    readonly USERNAME: {
+        readonly description: "Username for the NCFX API";
+        readonly type: "string";
+        readonly required: true;
+    };
+    readonly PASSWORD: {
+        readonly description: "Password for the NCFX API";
+        readonly type: "string";
+        readonly required: true;
+    };
+};

package/package/examples/ncfx/config/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.customSettings = void 0;
+exports.customSettings = {
+    USERNAME: {
+        description: 'Username for the NCFX API',
+        type: 'string',
+        required: true,
+    },
+    PASSWORD: {
+        description: 'Password for the NCFX API',
+        type: 'string',
+        required: true,
+    },
+};

package/package/examples/ncfx/index.d.ts

@@ -0,0 +1,2 @@
+import { Adapter } from '../../adapter';
+export declare const adapter: Adapter;

package/package/examples/ncfx/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adapter = void 0;
+const config_1 = require("./config");
+const websocket_1 = require("./websocket");
+exports.adapter = {
+    name: 'ncfx',
+    endpoints: [websocket_1.webSocketEndpoint],
+    customSettings: config_1.customSettings,
+};

package/package/examples/ncfx/websocket.d.ts

@@ -0,0 +1,36 @@
+import { AdapterEndpoint } from '../../adapter';
+import { WebSocketTransport } from '../../transports/websocket';
+import { InputParameters } from '../../validation';
+interface AdapterRequestParams {
+    base: string;
+    quote: string;
+}
+export declare const inputParameters: InputParameters;
+interface ProviderMessage {
+    timestamp: string;
+    currencyPair: string;
+    bid: number;
+    offer: number;
+    mid: number;
+    changes: [
+        {
+            period: string;
+            change: number;
+            percentage: number;
+        }
+    ];
+}
+export declare const websocketTransport: WebSocketTransport<AdapterRequestParams, ProviderMessage[], {
+    readonly USERNAME: {
+        readonly description: "Username for the NCFX API";
+        readonly type: "string";
+        readonly required: true;
+    };
+    readonly PASSWORD: {
+        readonly description: "Password for the NCFX API";
+        readonly type: "string";
+        readonly required: true;
+    };
+}>;
+export declare const webSocketEndpoint: AdapterEndpoint;
+export {};

package/package/examples/ncfx/websocket.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.webSocketEndpoint = exports.websocketTransport = exports.inputParameters = void 0;
+const websocket_1 = require("../../transports/websocket");
+const util_1 = require("../../util");
+exports.inputParameters = {
+    base: {
+        aliases: ['from', 'coin'],
+        description: 'The symbol of the currency to query',
+        required: true,
+    },
+    quote: {
+        aliases: ['to', 'market'],
+        description: 'The symbol of the currency to convert to',
+        required: true,
+    },
+};
+const logger = (0, util_1.makeLogger)('NcfxWebSocketTransport');
+exports.websocketTransport = new websocket_1.WebSocketTransport({
+    url: 'wss://feed.newchangefx.com/cryptodata',
+    handlers: {
+        open(connection, context) {
+            return new Promise((resolve, reject) => {
+                // Set up listener
+                connection.on('message', (data) => {
+                    const parsed = JSON.parse(data.toString());
+                    if (parsed.Message?.startsWith('Logged in as user')) {
+                        logger.info('Got logged in response, connection is ready');
+                        resolve();
+                    }
+                    else {
+                        reject(new Error('Unexpected message after WS connection open'));
+                    }
+                });
+                // Send login payload
+                connection.send(JSON.stringify({
+                    request: 'login',
+                    username: context.adapterConfig.USERNAME,
+                    password: context.adapterConfig.PASSWORD,
+                }));
+            });
+        },
+        message(message) {
+            if (!Array.isArray(message)) {
+                logger.debug('WS message is not array, skipping');
+                return [];
+            }
+            return message.map((m) => {
+                const [base, quote] = m.currencyPair.split('/');
+                return {
+                    params: { base, quote },
+                    value: m.offer,
+                };
+            });
+        },
+    },
+    builders: {
+        subscribeMessage: (params) => ({
+            request: 'subscribe',
+            ccy: `${params.base}/${params.quote}`,
+        }),
+        unsubscribeMessage: (params) => ({
+            request: 'unsubscribe',
+            ccy: `${params.base}/${params.quote}`,
+        }),
+    },
+});
+exports.webSocketEndpoint = {
+    name: 'websocket',
+    transport: exports.websocketTransport,
+    inputParameters: exports.inputParameters,
+};

package/package/index.d.ts

@@ -0,0 +1,12 @@
+import { Server } from 'http';
+import { Adapter } from './adapter';
+import { AdapterDependencies } from './transports';
+/**
+ * Main function for the framework.
+ * Initializes config and dependencies, uses those to initialize Transports, and starts listening for requests.
+ *
+ * @param adapter - an object describing an External Adapter
+ * @param dependencies - an optional object with adapter dependencies to inject
+ * @returns a Promise that resolves to the http.Server listening for connections
+ */
+export declare const expose: (adapter: Adapter, dependencies?: Partial<AdapterDependencies> | undefined) => Promise<Server | undefined>;

package/package/index.js

@@ -0,0 +1,92 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.expose = void 0;
+const fastify_1 = __importDefault(require("fastify"));
+const path_1 = require("path");
+const adapter_1 = require("./adapter");
+const background_executor_1 = require("./background-executor");
+const cache_1 = require("./cache");
+const config_1 = require("./config");
+const metrics_1 = require("./metrics");
+const transports_1 = require("./transports");
+const util_1 = require("./util");
+const validation_1 = require("./validation");
+const logger = (0, util_1.makeLogger)('Main');
+const VERSION = process.env['npm_package_version'];
+/**
+ * Main function for the framework.
+ * Initializes config and dependencies, uses those to initialize Transports, and starts listening for requests.
+ *
+ * @param adapter - an object describing an External Adapter
+ * @param dependencies - an optional object with adapter dependencies to inject
+ * @returns a Promise that resolves to the http.Server listening for connections
+ */
+const expose = async (adapter, dependencies) => {
+    const config = (0, config_1.buildAdapterConfig)({
+        overrides: adapter.envDefaultOverrides,
+        customSettings: adapter.customSettings,
+    });
+    // Initialize adapter (create dependencies, inject them, build endpoint map, etc.)
+    const initializedAdapter = await (0, adapter_1.initializeAdapter)(adapter, config, dependencies);
+    let server = undefined;
+    if (config.METRICS_ENABLED && config.EXPERIMENTAL_METRICS_ENABLED) {
+        (0, metrics_1.setupMetricsServer)(adapter.name, config);
+    }
+    if (config.EA_MODE === 'reader' || config.EA_MODE === 'reader-writer') {
+        // Main REST API server to handle incoming requests
+        const app = await buildRestApi(config, initializedAdapter);
+        // Start listening for incoming requests
+        try {
+            await app.listen(config.EA_PORT, config.EA_HOST);
+        }
+        catch (err) {
+            logger.fatal(`There was an error when starting the EA server: ${err}`);
+            process.exit();
+        }
+        logger.info(`Listening on port ${app.server.address().port}`);
+        server = app.server;
+    }
+    else {
+        logger.info('REST API is disabled; this instance will not process incoming requests.');
+    }
+    if (config.EA_MODE === 'writer' || config.EA_MODE === 'reader-writer') {
+        // Start background loop that will take care of calling any async Transports
+        logger.info('Starting background execution loop');
+        (0, background_executor_1.callBackgroundExecutes)(initializedAdapter, server);
+    }
+    else {
+        logger.info('Background executor is disabled; this instance will not perform async background executes.');
+    }
+    return server;
+};
+exports.expose = expose;
+async function buildRestApi(config, initializedAdapter) {
+    const app = (0, fastify_1.default)();
+    // Add healthcheck endpoint before middlewares to bypass them
+    app.get((0, path_1.join)(config.BASE_URL, 'health'), (req, res) => {
+        res.status(200).send({ message: 'OK', version: VERSION });
+    });
+    // Use global error handling
+    app.setErrorHandler(validation_1.errorCatchingMiddleware);
+    const transportHandler = await (0, transports_1.buildTransportHandler)(initializedAdapter);
+    app.register(async (router) => {
+        // Set up "middlewares" (hooks in fastify)
+        router.addHook('preHandler', (0, validation_1.validatorMiddleware)(initializedAdapter));
+        router.addHook('preHandler', (0, cache_1.buildCacheMiddleware)(initializedAdapter));
+        if (config['CORRELATION_ID_ENABLED']) {
+            router.addHook('onRequest', util_1.loggingContextMiddleware);
+        }
+        router.route({
+            url: config.BASE_URL,
+            method: 'POST',
+            handler: transportHandler,
+        }); // Pass config maybe? cleaner that multiple instances / dependencies
+        if (config.METRICS_ENABLED && config.EXPERIMENTAL_METRICS_ENABLED) {
+            router.addHook('onResponse', metrics_1.buildMetricsMiddleware);
+        }
+    });
+    return app;
+}

package/package/metrics/constants.d.ts

@@ -0,0 +1,16 @@
+export declare enum HttpRequestType {
+    CACHE_HIT = "cacheHit",
+    DATA_PROVIDER_HIT = "dataProviderHit",
+    ADAPTER_ERROR = "adapterError",
+    INPUT_ERROR = "inputError",
+    RATE_LIMIT_ERROR = "rateLimitError",
+    DP_ERROR = "dataProviderError",
+    TIMEOUT_ERROR = "timeoutError",
+    CONNECTION_ERROR = "connectionError",
+    CUSTOM_ERROR = "customError"
+}
+/**
+ * Maxiumum number of characters that a feedId can contain.
+ */
+export declare const MAX_FEED_ID_LENGTH = 300;
+export declare const requestDurationBuckets: number[];

package/package/metrics/constants.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requestDurationBuckets = exports.MAX_FEED_ID_LENGTH = exports.HttpRequestType = void 0;
+var HttpRequestType;
+(function (HttpRequestType) {
+    HttpRequestType["CACHE_HIT"] = "cacheHit";
+    HttpRequestType["DATA_PROVIDER_HIT"] = "dataProviderHit";
+    HttpRequestType["ADAPTER_ERROR"] = "adapterError";
+    HttpRequestType["INPUT_ERROR"] = "inputError";
+    HttpRequestType["RATE_LIMIT_ERROR"] = "rateLimitError";
+    // BURST_LIMIT_ERROR = 'burstLimitError',
+    // BACKOFF_ERROR = 'backoffError',
+    HttpRequestType["DP_ERROR"] = "dataProviderError";
+    HttpRequestType["TIMEOUT_ERROR"] = "timeoutError";
+    HttpRequestType["CONNECTION_ERROR"] = "connectionError";
+    // RES_EMPTY_ERROR = 'responseEmptyError',
+    // RES_INVALID_ERROR = 'responseInvalidError',
+    HttpRequestType["CUSTOM_ERROR"] = "customError";
+})(HttpRequestType = exports.HttpRequestType || (exports.HttpRequestType = {}));
+/**
+ * Maxiumum number of characters that a feedId can contain.
+ */
+exports.MAX_FEED_ID_LENGTH = 300;
+// We should tune these as we collect data, this is the default bucket distribution that prom comes with
+exports.requestDurationBuckets = [0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10];

package/package/metrics/index.d.ts

@@ -0,0 +1,15 @@
+import * as client from 'prom-client';
+import { AdapterRequest } from '../util';
+import { AdapterConfig } from '../config';
+import { FastifyReply, HookHandlerDoneFunction } from 'fastify';
+export declare function setupMetricsServer(name: string, config: AdapterConfig): void;
+export declare const setupMetrics: (name: string, config: AdapterConfig) => void;
+/**
+ * Builds metrics middleware that records end to end EA response times
+ * and count of requests
+ *
+ * @returns the cache middleware function
+ */
+export declare const buildMetricsMiddleware: (req: AdapterRequest, res: FastifyReply, done: HookHandlerDoneFunction) => void;
+export declare const httpRequestsTotal: client.Counter<"type" | "method" | "feed_id" | "status_code" | "provider_status_code" | "retry" | "is_cache_warming">;
+export declare const httpRequestDurationSeconds: client.Histogram<string>;

package/package/metrics/index.js

@@ -0,0 +1,123 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.httpRequestDurationSeconds = exports.httpRequestsTotal = exports.buildMetricsMiddleware = exports.setupMetrics = exports.setupMetricsServer = void 0;
+const client = __importStar(require("prom-client"));
+const constants_1 = require("./constants");
+const util_1 = require("../util");
+const fastify_1 = __importDefault(require("fastify"));
+const path_1 = require("path");
+const error_1 = require("../validation/error");
+const logger = (0, util_1.makeLogger)('Metrics');
+function setupMetricsServer(name, config) {
+    const metricsApp = (0, fastify_1.default)({
+        logger: false,
+    });
+    const metricsPort = config.METRICS_PORT;
+    const endpoint = config.METRICS_USE_BASE_URL ? (0, path_1.join)(config.BASE_URL, 'metrics') : '/metrics';
+    const eaHost = config.EA_HOST;
+    (0, exports.setupMetrics)(name, config);
+    metricsApp.get(endpoint, async (_, res) => {
+        res.type('txt');
+        res.send(await client.register.metrics());
+    });
+    metricsApp.listen(metricsPort, eaHost, () => logger.info(`Monitoring listening on port ${metricsPort}!`));
+}
+exports.setupMetricsServer = setupMetricsServer;
+const setupMetrics = (name, config) => {
+    client.collectDefaultMetrics();
+    client.register.setDefaultLabels({
+        app_name: config.METRICS_NAME || name || 'N/A',
+        app_version: config['npm_package_version'],
+    });
+};
+exports.setupMetrics = setupMetrics;
+/**
+ * Builds metrics middleware that records end to end EA response times
+ * and count of requests
+ *
+ * @returns the cache middleware function
+ */
+const buildMetricsMiddleware = (req, res, done) => {
+    const feedId = req.requestContext.meta?.metrics?.feedId || 'N/A';
+    const labels = buildHttpRequestMetricsLabel(feedId, req.requestContext.meta?.error, req.requestContext.meta?.metrics?.cacheHit);
+    // Record number of requests sent to EA
+    exports.httpRequestsTotal.labels(labels).inc();
+    // Record response time of request through entire EA
+    exports.httpRequestDurationSeconds.observe(res.getResponseTime());
+    logger.debug(`Response time for ${feedId}: ${res.getResponseTime()}ms`);
+    done();
+};
+exports.buildMetricsMiddleware = buildMetricsMiddleware;
+const buildHttpRequestMetricsLabel = (feedId, error, cacheHit) => {
+    const labels = {};
+    labels.method = 'POST';
+    labels.feed_id = feedId;
+    if (error instanceof error_1.AdapterError) {
+        // If error present and an instace of AdapterError, build label from error info
+        labels.type = error?.metricsLabel || constants_1.HttpRequestType.ADAPTER_ERROR;
+        labels.status_code = error?.statusCode;
+        labels.provider_status_code = error?.providerStatusCode;
+    }
+    else if (error instanceof Error) {
+        // If error present and not instance of generic Error, unexpected failure occurred
+        // TODO: Build label with 500 error and withold dp status? Status sent as 200 in error handler
+        labels.type = constants_1.HttpRequestType.ADAPTER_ERROR;
+        labels.status_code = 500;
+    }
+    else {
+        // If no error present, request went as expected
+        labels.status_code = 200;
+        if (cacheHit) {
+            labels.type = constants_1.HttpRequestType.CACHE_HIT;
+        }
+        else {
+            labels.type = constants_1.HttpRequestType.DATA_PROVIDER_HIT;
+            labels.provider_status_code = 200;
+        }
+    }
+    return labels;
+};
+exports.httpRequestsTotal = new client.Counter({
+    name: 'http_requests_total',
+    help: 'The number of http requests this external adapter has serviced for its entire uptime',
+    labelNames: [
+        'method',
+        'status_code',
+        'retry',
+        'type',
+        'is_cache_warming',
+        'feed_id',
+        'provider_status_code',
+    ],
+});
+exports.httpRequestDurationSeconds = new client.Histogram({
+    name: 'http_request_duration_seconds',
+    help: 'A histogram bucket of the distribution of http request durations',
+    buckets: constants_1.requestDurationBuckets,
+});

package/package/metrics/util.d.ts

@@ -0,0 +1,3 @@
+import { AdapterMetricsMeta, AdapterRequestData } from '../util';
+import { AdapterEndpoint } from '../adapter';
+export declare const getMetricsMeta: (endpoint: AdapterEndpoint, data: AdapterRequestData) => AdapterMetricsMeta;

package/package/metrics/util.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMetricsMeta = void 0;
+const cache_1 = require("../cache");
+const getMetricsMeta = (endpoint, data) => {
+    const feedId = (0, cache_1.calculateFeedId)(endpoint, data);
+    return { feedId };
+};
+exports.getMetricsMeta = getMetricsMeta;