Newborn Programming Monsters

    prometheus-plugin-meta
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.0 • Public • Published

    prometheus-plugin-meta

    Node.js prometheus meta (all-in-one) plugin that provides API for working with all plugins at once.

    build status coverage report

    Installation

    npm i -S prometheus-plugin-meta
    

    Requirements

    • >=prom-client-4.0.0 npm module (installed as peer dependency). If your project depends on previous version of client this plugin might not work.
    • >=node-4.0.0 because this module uses ES6 syntax
    • Valid package.json file in $PWD

    Plugin list

    Usage

    Simple

    const client = require('prom-client');
    const appInfoPlugin = require('prometheus-plugin-meta');
     
    // start metrics collection
    appInfoPlugin.init().start();
     
    // log metrics to console
    console.log(client.register.metrics());
     
    // stop metrics collection
    appInfoPlugin.stop();
     
    // stop and clear metrics register
    appInfoPlugin.reset();

    Override metric defaults

    const client = require('prom-client');
    const appInfoPlugin = require('prometheus-plugin-meta');
    const override = {
      'prometheus-plugin-pluginname': {
          'metric_name': { // provide default metric name to override it's params
            type: 'Counter', // could be changed, but it's not recommended
            name: 'my_metric_name', // name could be changed
            description: 'My custom description', // description could be changed
            labelValues: { // additional labels
              customLabel: 'hello', // custom labels could be added
              customFnLabel: () => { return new Date() } // if it's a function, it will be called to get label value in runtime
            }
          }
      }
    };
    // start metrics collection
    appInfoPlugin.init(override).start(); // pass override object to init function
     
    // log metrics to console
    console.log(client.register.metrics());
     
    // stop metrics collection
    appInfoPlugin.stop();
     
    // stop and clear metrics register
    appInfoPlugin.reset();

    Install

    npm i prometheus-plugin-meta

    DownloadsWeekly Downloads

    1

    Version

    2.0.0

    License

    UNLICENSE

    Last publish

    Collaborators

    • m03geek