@adalo/metrics 0.1.0

package/.eslintignore

@@ -0,0 +1,3 @@
+/lib
+/node_modules
+babel.config.js

package/.eslintrc

@@ -0,0 +1,60 @@
+{
+  "extends": [
+    "airbnb-base",
+    "airbnb-typescript/base",
+    "prettier" // Prettier must always be last as it overrides all other configs (https://github.com/prettier/eslint-config-prettier)
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
+  "plugins": ["@typescript-eslint"],
+  "env": {
+    "browser": true,
+    "commonjs": true,
+    "es6": true,
+    "node": true
+  },
+  "settings": {
+    "import/resolver": {
+      "typescript": {} // this loads <rootdir>/tsconfig.json
+    }
+  },
+  "overrides": [
+    {
+      "files": ["**/*.test.js"],
+      "env": {
+        "jest": true
+      }
+    }
+  ],
+  "rules": {
+    "curly": ["error", "multi-line"],
+    "lines-between-class-members": [
+      "error",
+      "always",
+      {
+        "exceptAfterSingleLine": true
+      }
+    ],
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        "vars": "all",
+        "args": "none",
+        "ignoreRestSiblings": true
+      }
+    ],
+
+    // Disabled rules
+    "arrow-body-style": "off",
+    "import/prefer-default-export": "off",
+    "no-param-reassign": "off",
+    "no-restricted-syntax": "off",
+    "@typescript-eslint/no-shadow": "off",
+    "no-underscore-dangle": "off",
+    "class-methods-use-this": "off",
+    "no-await-in-loop": "off",
+    "no-console": "off"
+  }
+}

package/.github/pull_request_template.md

@@ -0,0 +1,14 @@
+## Problem
+*Describe the specific bug or product issue that's being fixed.*
+
+## Solution
+*What did you do to fix it? Remember gif's or video of frontend fixes.*
+
+## Additional Notes (optional)
+
+- Link to Tech Spec in Notion
+
+
+## Related PR's (optional)
+
+## New Packages, Environment Variables (optional)

package/.github/workflows/code-style.yml

@@ -0,0 +1,29 @@
+name: Check Prettier and ESLint conformance
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  prettier:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+
+      - name: Installing dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Run Prettier checks
+        run: yarn prettier:check
+
+      - name: Run ESLint checks
+        run: yarn lint:check

package/.github/workflows/deploy.yml

@@ -0,0 +1,29 @@
+name: Deploy Production
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    if: "!contains(github.event.head_commit.message, 'skip ci')"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # Fetch all commits across all branches. Default behaviour is efficient but breaks merge-release.
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Installing dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build lib
+        run: yarn run build
+      - name: Publish to NPM
+        uses: AdaloHQ/npm-publish@v1
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}

package/.github/workflows/tests.yml

@@ -0,0 +1,17 @@
+name: CI
+
+on: pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+      - name: Installing dependencies
+        run: yarn install --frozen-lockfile
+      - name: Running tests
+        run: yarn test

package/.idea/codeStyles/Project.xml

@@ -0,0 +1,91 @@
+<component name="ProjectCodeStyleConfiguration">
+  <code_scheme name="Project" version="173">
+    <option name="OTHER_INDENT_OPTIONS">
+      <value>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="TAB_SIZE" value="2" />
+      </value>
+    </option>
+    <HTMLCodeStyleSettings>
+      <option name="HTML_SPACE_INSIDE_EMPTY_TAG" value="true" />
+    </HTMLCodeStyleSettings>
+    <JSCodeStyleSettings version="0">
+      <option name="USE_SEMICOLON_AFTER_STATEMENT" value="false" />
+      <option name="FORCE_SEMICOLON_STYLE" value="true" />
+      <option name="SPACE_WITHIN_ARRAY_INITIALIZER_BRACKETS" value="true" />
+      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
+      <option name="USE_DOUBLE_QUOTES" value="false" />
+      <option name="FORCE_QUOTE_STYlE" value="true" />
+      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
+      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
+      <option name="SPACES_WITHIN_IMPORTS" value="true" />
+      <option name="SPACES_WITHIN_INTERPOLATION_EXPRESSIONS" value="true" />
+    </JSCodeStyleSettings>
+    <TypeScriptCodeStyleSettings version="0">
+      <option name="USE_SEMICOLON_AFTER_STATEMENT" value="false" />
+      <option name="FORCE_SEMICOLON_STYLE" value="true" />
+      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
+      <option name="USE_DOUBLE_QUOTES" value="false" />
+      <option name="FORCE_QUOTE_STYlE" value="true" />
+      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
+      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
+      <option name="SPACES_WITHIN_IMPORTS" value="true" />
+    </TypeScriptCodeStyleSettings>
+    <VueCodeStyleSettings>
+      <option name="INTERPOLATION_NEW_LINE_AFTER_START_DELIMITER" value="false" />
+      <option name="INTERPOLATION_NEW_LINE_BEFORE_END_DELIMITER" value="false" />
+    </VueCodeStyleSettings>
+    <codeStyleSettings language="CSS">
+      <indentOptions>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="CONTINUATION_INDENT_SIZE" value="4" />
+        <option name="TAB_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="Gherkin">
+      <indentOptions>
+        <option name="TAB_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="HTML">
+      <option name="SOFT_MARGINS" value="80" />
+      <indentOptions>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+        <option name="TAB_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="JSON">
+      <indentOptions>
+        <option name="CONTINUATION_INDENT_SIZE" value="4" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="JavaScript">
+      <option name="SOFT_MARGINS" value="80" />
+      <indentOptions>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+        <option name="TAB_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="LESS">
+      <indentOptions>
+        <option name="TAB_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="TypeScript">
+      <option name="SOFT_MARGINS" value="80" />
+      <indentOptions>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+        <option name="TAB_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="Vue">
+      <option name="SOFT_MARGINS" value="80" />
+      <indentOptions>
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+  </code_scheme>
+</component>

package/.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
+  </state>
+</component>

package/.idea/git_toolbox_prj.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="GitToolBoxProjectSettings">
+    <option name="commitMessageIssueKeyValidationOverride">
+      <BoolValueOverride>
+        <option name="enabled" value="true" />
+      </BoolValueOverride>
+    </option>
+    <option name="commitMessageValidationEnabledOverride">
+      <BoolValueOverride>
+        <option name="enabled" value="true" />
+      </BoolValueOverride>
+    </option>
+  </component>
+</project>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+  </profile>
+</component>

package/.idea/jsLibraryMappings.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="JavaScriptLibraryMappings">
+    <includedPredefinedLibrary name="Node.js Core" />
+  </component>
+</project>

package/.idea/metriks-js.iml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/utils.iml" filepath="$PROJECT_DIR$/.idea/utils.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/prettier.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="PrettierConfiguration">
+    <option name="myConfigurationMode" value="AUTOMATIC" />
+  </component>
+</project>

package/.idea/utils.iml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

package/.prettierrc

@@ -0,0 +1,10 @@
+{
+  "printWidth": 80,
+  "tabWidth": 2,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "semi": false,
+  "bracketSpacing": true,
+  "bracketSameLine": false,
+  "arrowParens": "avoid"
+}

package/README.md

@@ -0,0 +1,29 @@
+# @adalo/metrics-js
+Utility library for Prometheus metrics and HTTP request counting in Node.js applications.
+
+## Constructor
+```ts
+new MetricsClient({
+  appName,            // defaults: process.env.METRICS_APP_NAME || 'unknown-app'
+  dynoId,             // defaults: process.env.HOSTNAME || 'unknown-dyno'
+  processType,        // defaults: process.env.BUILD_DYNO_PROCESS_TYPE || 'undefined_build_dyno_type'
+  enabled,            // defaults: process.env.METRICS_ENABLED === 'true'
+  logValues,          // defaults: process.env.METRICS_LOG_VALUES === 'true'
+  pushgatewayUrl,     // defaults: process.env.METRICS_PUSHGATEWAY_URL || ''
+  pushgatewayUser,    // defaults: process.env.METRICS_PUSHGATEWAY_USER || ''
+  pushgatewayPassword,// defaults: process.env.METRICS_PUSHGATEWAY_PASSWORD || ''
+  intervalSec         // defaults: process.env.METRICS_INTERVAL_SEC || 15
+})
+```
+## Example Usage
+```ts
+import { MetricsClient } from '@adalo/metrics-js'
+
+const metrics = new MetricsClient({ appName: 'my-app', enabled: true })
+
+// Express middleware
+app.use(metrics.countHttpRequestMiddleware)
+
+
+// Start metrics push
+metrics.startPush()

package/babel.config.js

@@ -0,0 +1,20 @@
+const include = ['./src']
+const ignore = ['./lib']
+
+// This env var is set when running with jest
+if (process.env.NODE_ENV !== 'test') {
+  ignore.push('**/*.test.js', '**/*.test.ts', '**/__tests__/*')
+}
+
+const presets = [
+  [
+    '@babel/preset-env',
+    {
+      targets: { node: '22' },
+      useBuiltIns: 'usage',
+    },
+  ],
+  '@babel/preset-typescript',
+]
+
+module.exports = { include, ignore, presets }

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from './metricsClient';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA"}

package/lib/index.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _metricsClient = require("./metricsClient");
+Object.keys(_metricsClient).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _metricsClient[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _metricsClient[key];
+    }
+  });
+});
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["_metricsClient","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get"],"sources":["../src/index.ts"],"sourcesContent":["export * from './metricsClient'\n\n"],"mappings":";;;;;AAAA,IAAAA,cAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,cAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,cAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,cAAA,CAAAK,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}

package/lib/metricsClient.d.ts

@@ -0,0 +1,120 @@
+/**
+ * MetricsClient handles Prometheus metrics collection and push.
+ * Supports gauges, counters, default metrics, and custom metrics.
+ */
+export class MetricsClient {
+    /**
+     * @param {Object} config
+     * @param {string} [config.appName] Name of the application
+     * @param {string} [config.dynoId] Dyno/instance ID
+     * @param {string} [config.processType] Process type (web, worker, etc.)
+     * @param {boolean} [config.enabled] Enable metrics collection
+     * @param {boolean} [config.logValues] Log metrics values to console
+     * @param {string} [config.pushgatewayUrl] PushGateway URL
+     * @param {string} [config.pushgatewayUser] PushGateway username
+     * @param {string} [config.pushgatewayPassword] PushGateway password
+     * @param {number} [config.intervalSec] Interval in seconds for pushing metrics
+     */
+    constructor(config?: {
+        appName?: string | undefined;
+        dynoId?: string | undefined;
+        processType?: string | undefined;
+        enabled?: boolean | undefined;
+        logValues?: boolean | undefined;
+        pushgatewayUrl?: string | undefined;
+        pushgatewayUser?: string | undefined;
+        pushgatewayPassword?: string | undefined;
+        intervalSec?: number | undefined;
+    });
+    appName: string;
+    dynoId: string;
+    processType: string;
+    enabled: boolean;
+    logValues: boolean;
+    pushgatewayUrl: string;
+    pushgatewayUser: string;
+    pushgatewayPassword: string;
+    intervalSec: number;
+    prefixLogs: string;
+    registry: client.Registry<"text/plain; version=0.0.4; charset=utf-8">;
+    defaultLabels: {
+        app: string;
+        dyno_id: string;
+        process_type: string;
+    };
+    gateway: client.Pushgateway<"text/plain; version=0.0.4; charset=utf-8">;
+    gauges: {};
+    counters: {};
+    /** @type {Object<string, function(): number | Promise<number>>} */
+    gaugeUpdaters: {
+        [x: string]: () => number | Promise<number>;
+    };
+    /** @type {Object<string, function(data?: object, value?: number): void>} */
+    counterUpdaters: any;
+    _lastUsageMicros: number;
+    _lastCheckTime: number;
+    /**
+     * Register default gauges and counters.
+     * @private
+     */
+    private _initDefaultMetrics;
+    /**
+     * Create a gauge metric.
+     * @param {string} name
+     * @param {string} help
+     * @param {function(): number|Promise<number>} [updateFn] Optional function returning value
+     * @param {string[]} [labelNames]
+     * @returns {client.Gauge}
+     */
+    createGauge: (name: string, help: string, updateFn?: (() => number | Promise<number>) | undefined, labelNames?: string[] | undefined) => client.Gauge;
+    /**
+     * Create a counter metric.
+     * Returns a trigger function to increment the counter manually.
+     * @param {string} name
+     * @param {string} help
+     * @param {string[]} [labelNames]
+     * @returns {function(data?: object, value?: number): void} triggerFn
+     */
+    createCounter(name: string, help: string, labelNames?: string[] | undefined): (arg0: data | null, arg1: object, arg2: value | null, arg3: number) => void;
+    /**
+     * Get CPU usage percent (cgroup-aware)
+     * @returns {number}
+     */
+    getCpuUsagePercent: () => number;
+    /**
+     * Get available CPU cores.
+     * @returns {number}
+     */
+    getAvailableCPUs(): number;
+    /**
+     * Get container memory usage in bytes.
+     * @returns {number}
+     */
+    getContainerMemoryUsage(): number;
+    /**
+     * Get container memory limit in bytes.
+     * @returns {number}
+     */
+    getContainerMemoryLimit(): number;
+    /**
+     * Measure event loop lag in ms.
+     * @returns {Promise<number>}
+     */
+    measureLag(): Promise<number>;
+    /**
+     * Express middleware to count HTTP requests.
+     * Increments the `app_http_requests_total` counter.
+     */
+    countHttpRequestMiddleware: (req: any, res: any, next: any) => void;
+    /**
+     * Push all gauges and counters to PushGateway and optionally log.
+     */
+    pushMetrics: () => Promise<void>;
+    /**
+     * Start automatic periodic push of metrics.
+     * @param {number} [interval] Interval in seconds
+     */
+    startPush: (interval?: number | undefined) => void;
+}
+import client = require("prom-client");
+//# sourceMappingURL=metricsClient.d.ts.map

package/lib/metricsClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metricsClient.d.ts","sourceRoot":"","sources":["../src/metricsClient.js"],"names":[],"mappings":"AAOA;;;GAGG;AACH;IACE;;;;;;;;;;;OAWG;IACH;QAV2B,OAAO;QACP,MAAM;QACN,WAAW;QACV,OAAO;QACP,SAAS;QACV,cAAc;QACd,eAAe;QACf,mBAAmB;QACnB,WAAW;OA6DrC;IA1DC,gBACiE;IACjE,eAAqE;IACrE,oBAG6B;IAC7B,iBAAuE;IACvE,mBAC+D;IAC/D,uBACoE;IACpE,wBACsE;IACtE,4BAGI;IACJ,oBAGI;IAEJ,mBAAyF;IAEzF,sEAAqC;IAGrC;;;;MAIC;IAKD,wEAOC;IAED,WAAgB;IAChB,aAAkB;IAElB,mEAAmE;IACnE;YADkB,MAAM,SAAc,MAAM,GAAG,QAAQ,MAAM,CAAC;MACvC;IACvB,4EAA4E;IAC5E,qBAAyB;IAEzB,yBAAyB;IACzB,uBAAgC;IAKlC;;;OAGG;IACH,4BA8CC;IAED;;;;;;;OAOG;IACH,oBANW,MAAM,QACN,MAAM,oBACM,MAAM,GAAC,QAAQ,MAAM,CAAC,qDAEhC,OAAO,KAAK,CAqBxB;IAED;;;;;;;OAOG;IACH,oBALW,MAAM,QACN,MAAM,gEAEY,MAAM,4BAAU,MAAM,KAAG,IAAI,CAmBzD;IAED;;;OAGG;IACH,0BAFa,MAAM,CA2BlB;IAED;;;OAGG;IACH,oBAFa,MAAM,CAiBlB;IAED;;;OAGG;IACH,2BAFa,MAAM,CAWlB;IAED;;;OAGG;IACH,2BAFa,MAAM,CAgBlB;IAED;;;OAGG;IACH,cAFa,QAAQ,MAAM,CAAC,CAO3B;IAED;;;OAGG;IACH,oEA0BC;IAED;;OAEG;IACH,iCAgCC;IAED;;;OAGG;IACH,mDAYC;CACF"}