@digital-alchemy/core 24.7.1 → 24.8.1

package/dist/helpers/metrics.helper.js

@@ -1,132 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LOGGER_CONTEXT_ENTRIES_COUNT = exports.MEMORY_CACHE_ERROR_COUNT = exports.REDIS_OPERATION_LATENCY_MS = exports.REDIS_ERROR_COUNT = exports.FETCH_REQUESTS_FAILED = exports.FETCH_DOWNLOAD_REQUESTS_SUCCESSFUL = exports.FETCH_REQUESTS_SUCCESSFUL = exports.FETCH_REQUESTS_INITIATED = exports.CACHE_SET_OPERATIONS_TOTAL = exports.CACHE_DRIVER_ERROR_COUNT = exports.SCHEDULE_EXECUTION_TIME = exports.SCHEDULE_ERRORS = exports.SCHEDULE_EXECUTION_COUNT = exports.CACHE_GET_OPERATIONS_TOTAL = exports.CACHE_DELETE_OPERATIONS_TOTAL = void 0;
-/* eslint-disable @typescript-eslint/no-magic-numbers */
-const prom_client_1 = require("prom-client");
-/**
- * Cache delete operations counter
- */
-exports.CACHE_DELETE_OPERATIONS_TOTAL = new prom_client_1.Counter({
-    help: "Total number of cache delete operations",
-    labelNames: ["prefix", "key"],
-    name: "digital_alchemy_boilerplate_cache_delete_operations_total",
-});
-/**
- * Cache get operations counter
- */
-exports.CACHE_GET_OPERATIONS_TOTAL = new prom_client_1.Counter({
-    help: "Total number of cache get operations",
-    labelNames: ["prefix", "key", "hit_miss"],
-    name: "digital_alchemy_boilerplate_cache_get_operations_total",
-});
-/**
- * Tracks the number of times a scheduled task has been executed.
- * Labels:
- * - context: The broader category or module the schedule belongs to.
- * - label: A user-defined label to identify the specific schedule.
- */
-exports.SCHEDULE_EXECUTION_COUNT = new prom_client_1.Counter({
-    help: "Counts the number of times a scheduled task has been executed",
-    labelNames: ["context", "label"],
-    name: "digital_alchemy_boilerplate_schedule_execution_count",
-});
-/**
- * Counts the number of errors occurred during scheduled task executions.
- * Labels:
- * - context: The broader category or module the schedule belongs to.
- * - label: A user-defined label to identify the specific schedule where the error occurred.
- */
-exports.SCHEDULE_ERRORS = new prom_client_1.Counter({
-    help: "Counts the number of errors during scheduled task executions",
-    labelNames: ["context", "label"],
-    name: "digital_alchemy_boilerplate_schedule_errors",
-});
-/**
- * Summary for Execution Time
- */
-exports.SCHEDULE_EXECUTION_TIME = new prom_client_1.Summary({
-    help: "Measures the duration of each cron job or interval execution",
-    labelNames: ["context", "label"],
-    name: "digital_alchemy_boilerplate_schedule_execution_time",
-    // These percentiles are just examples; adjust them based on what's relevant for your analysis
-    percentiles: [0.5, 0.9, 0.99],
-});
-/**
- * Metric to count errors in cache driver
- */
-exports.CACHE_DRIVER_ERROR_COUNT = new prom_client_1.Counter({
-    help: "Counts the number of errors caught in the cache driver",
-    labelNames: ["methodName"],
-    name: "digital_alchemy_boilerplate_cache_driver_error_count",
-});
-/**
- * Cache set operations counter
- */
-exports.CACHE_SET_OPERATIONS_TOTAL = new prom_client_1.Counter({
-    help: "Total number of cache set operations",
-    labelNames: ["prefix", "key"],
-    name: "digital_alchemy_boilerplate_cache_set_operations_total",
-});
-/**
- * Counts the total number of initiated fetch requests.
- */
-exports.FETCH_REQUESTS_INITIATED = new prom_client_1.Counter({
-    help: "Total number of fetch requests that have been initiated",
-    name: "digital_alchemy_boilerplate_fetch_requests_initiated_total",
-});
-/**
- * Counts the total number of successfully completed fetch requests.
- */
-exports.FETCH_REQUESTS_SUCCESSFUL = new prom_client_1.Counter({
-    help: "Total number of fetch requests that have been successfully completed",
-    labelNames: ["context", "label"],
-    name: "digital_alchemy_boilerplate_fetch_requests_successful_total",
-});
-/**
- * Counts the total number of successfully completed fetch requests.
- */
-exports.FETCH_DOWNLOAD_REQUESTS_SUCCESSFUL = new prom_client_1.Counter({
-    help: "Total number of fetch download requests that have been successfully completed",
-    labelNames: ["context", "label"],
-    name: "digital_alchemy_boilerplate_fetch_download_requests_successful_total",
-});
-/**
- * Counts the total number of failed fetch requests.
- */
-exports.FETCH_REQUESTS_FAILED = new prom_client_1.Counter({
-    help: "Total number of fetch requests that have failed",
-    labelNames: ["context", "label"],
-    name: "digital_alchemy_boilerplate_fetch_requests_failed_total",
-});
-/**
- * Gauge to count the number of errors encountered in Redis operations.
- */
-exports.REDIS_ERROR_COUNT = new prom_client_1.Gauge({
-    help: "Counts the number of errors encountered in Redis operations",
-    name: "digital_alchemy_boilerplate_redis_error_count",
-});
-/**
- * Histogram to track the latency of Redis operations in milliseconds.
- * Buckets range from 0.1 ms to 1000 ms (1 second) for granular latency measurement.
- */
-exports.REDIS_OPERATION_LATENCY_MS = new prom_client_1.Histogram({
-    buckets: [0.1, 0.5, 1, 5, 10, 20, 50, 100, 200, 500, 1000],
-    help: "Histogram for tracking the latency of Redis operations in milliseconds",
-    name: "digital_alchemy_boilerplate_redis_operation_latency_ms",
-});
-/**
- * Counter to track the number of errors encountered in memory cache operations.
- */
-exports.MEMORY_CACHE_ERROR_COUNT = new prom_client_1.Counter({
-    help: "Counts the number of errors encountered in memory cache operations",
-    name: "digital_alchemy_boilerplate_memory_cache_error_count",
-});
-/**
- * A Prometheus gauge metric that tracks the number of unique context entries in the logger's context cache.
- * This helps in monitoring and managing the memory usage associated with the caching of logger contexts.
- */
-exports.LOGGER_CONTEXT_ENTRIES_COUNT = new prom_client_1.Gauge({
-    help: "Number of unique context entries in the logger context cache",
-    name: "digital_alchemy_boilerplate_logger_context_entries_count",
-});
-//# sourceMappingURL=metrics.helper.js.map

package/dist/helpers/metrics.helper.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"metrics.helper.js","sourceRoot":"","sources":["../../src/helpers/metrics.helper.ts"],"names":[],"mappings":";;;AAAA,wDAAwD;AACxD,6CAAiE;AAEjE;;GAEG;AACU,QAAA,6BAA6B,GAAG,IAAI,qBAAO,CAAC;IACvD,IAAI,EAAE,yCAAyC;IAC/C,UAAU,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAU;IACtC,IAAI,EAAE,2DAA2D;CAClE,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,0BAA0B,GAAG,IAAI,qBAAO,CAAC;IACpD,IAAI,EAAE,sCAAsC;IAC5C,UAAU,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,UAAU,CAAU;IAClD,IAAI,EAAE,wDAAwD;CAC/D,CAAC,CAAC;AAEH;;;;;GAKG;AACU,QAAA,wBAAwB,GAAG,IAAI,qBAAO,CAAC;IAClD,IAAI,EAAE,+DAA+D;IACrE,UAAU,EAAE,CAAC,SAAS,EAAE,OAAO,CAAU;IACzC,IAAI,EAAE,sDAAsD;CAC7D,CAAC,CAAC;AAEH;;;;;GAKG;AACU,QAAA,eAAe,GAAG,IAAI,qBAAO,CAAC;IACzC,IAAI,EAAE,8DAA8D;IACpE,UAAU,EAAE,CAAC,SAAS,EAAE,OAAO,CAAU;IACzC,IAAI,EAAE,6CAA6C;CACpD,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,uBAAuB,GAAG,IAAI,qBAAO,CAAC;IACjD,IAAI,EAAE,8DAA8D;IACpE,UAAU,EAAE,CAAC,SAAS,EAAE,OAAO,CAAU;IACzC,IAAI,EAAE,qDAAqD;IAC3D,8FAA8F;IAC9F,WAAW,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC;CAC9B,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,wBAAwB,GAAG,IAAI,qBAAO,CAAC;IAClD,IAAI,EAAE,wDAAwD;IAC9D,UAAU,EAAE,CAAC,YAAY,CAAU;IACnC,IAAI,EAAE,sDAAsD;CAC7D,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,0BAA0B,GAAG,IAAI,qBAAO,CAAC;IACpD,IAAI,EAAE,sCAAsC;IAC5C,UAAU,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAU;IACtC,IAAI,EAAE,wDAAwD;CAC/D,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,wBAAwB,GAAG,IAAI,qBAAO,CAAC;IAClD,IAAI,EAAE,yDAAyD;IAC/D,IAAI,EAAE,4DAA4D;CACnE,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,yBAAyB,GAAG,IAAI,qBAAO,CAAC;IACnD,IAAI,EAAE,sEAAsE;IAC5E,UAAU,EAAE,CAAC,SAAS,EAAE,OAAO,CAAU;IACzC,IAAI,EAAE,6DAA6D;CACpE,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,kCAAkC,GAAG,IAAI,qBAAO,CAAC;IAC5D,IAAI,EAAE,+EAA+E;IACrF,UAAU,EAAE,CAAC,SAAS,EAAE,OAAO,CAAU;IACzC,IAAI,EAAE,sEAAsE;CAC7E,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,qBAAqB,GAAG,IAAI,qBAAO,CAAC;IAC/C,IAAI,EAAE,iDAAiD;IACvD,UAAU,EAAE,CAAC,SAAS,EAAE,OAAO,CAAU;IACzC,IAAI,EAAE,yDAAyD;CAChE,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,iBAAiB,GAAG,IAAI,mBAAK,CAAC;IACzC,IAAI,EAAE,6DAA6D;IACnE,IAAI,EAAE,+CAA+C;CACtD,CAAC,CAAC;AAEH;;;GAGG;AACU,QAAA,0BAA0B,GAAG,IAAI,uBAAS,CAAC;IACtD,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC;IAC1D,IAAI,EAAE,wEAAwE;IAC9E,IAAI,EAAE,wDAAwD;CAC/D,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,wBAAwB,GAAG,IAAI,qBAAO,CAAC;IAClD,IAAI,EAAE,oEAAoE;IAC1E,IAAI,EAAE,sDAAsD;CAC7D,CAAC,CAAC;AAEH;;;GAGG;AACU,QAAA,4BAA4B,GAAG,IAAI,mBAAK,CAAC;IACpD,IAAI,EAAE,8DAA8D;IACpE,IAAI,EAAE,0DAA0D;CACjE,CAAC,CAAC"}