npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

yotam-js-metrics-test

v0.1.16

Published

Logz.io node.js metrics Exporter allows user to send collected metrics to the Logz.io using OpenTelemetry SDK

Downloads

7

Readme

This topic includes instructions on how to send custom metrics to Logz.io from your Node.js application.

The included example uses the OpenTelemetry JS SDK and its based on OpenTelemetry exporter collector proto.

Before you begin, you'll need: Node 8 or higher

Quick start

Set the variables in the following code snippet:

|Environment variable|Description| |---|---| |url| The Logz.io Listener URL for for your region, configured to use port 8052 for http traffic, or port 8053 for https traffic. | |token| Your Logz.io Prometheus Metrics account token. |

const { MeterProvider } = require('@opentelemetry/metrics');
const { RemoteWriteMetricExporter } =  require('yotam-js-metrics-test');

const collectorOptions = {
    url: '<<url>>',
    token: '<<token>>',
};
// Initialize the exporter
const metricExporter = new RemoteWriteMetricExporter(collectorOptions);

// Initialize the meter provider
const meter = new MeterProvider({
    exporter: metricExporter,
    interval: 15000, // Push interval in seconds
}).getMeter('example-exporter');

// Create your first counter metric
const requestCounter = meter.createCounter('Counter', {
    description: 'Example of a Counter', 
});
// Define some labels for your metrics
const labels = { environment: 'prod' };
// Record some value
requestCounter.bind(labels).add(1);
// In logzio Metrics you will see the following metric:
// Counter_total{environment: 'prod'} 1.0

Types of metric instruments

For more information, see the OpenTelemetry documentation.

| Name | Behavior | | ---- | ---------- | | Counter | Metric value can only go up or be reset to 0, calculated per counter.Add(context,value,labels) request. | | UpDownCounter | Metric value can arbitrarily increment or decrement, calculated per updowncounter.Add(context,value,labels) request. | | ValueRecorder | Metric values captured by the valuerecorder.Record(context,value,labels) function, calculated per request. | | SumObserver | Metric value can only go up or be reset to 0, calculated per push interval.| | UpDownSumObserver | Metric value can arbitrarily increment or decrement, calculated per push interval.| | ValueObserver | Metric values captured by the callback function, calculated per push interval.|

More examples

First Initialize the exporter and meter provider:

const { MeterProvider } = require('@opentelemetry/metrics');
const { RemoteWriteMetricExporter } =  require('yotam-js-metrics-test');

const collectorOptions = {
    url: '<<url>>',
    token: '<<token>>',
};
// Initialize the exporter
const metricExporter = new RemoteWriteMetricExporter(collectorOptions);

// Initialize the meter provider
const meter = new MeterProvider({
    exporter: metricExporter,
    interval: 15000, // Push interval in seconds
}).getMeter('example-exporter');

Then create different types of metrics

UpDownCounter:

// Create UpDownCounter metric
const upDownCounter = meter.createUpDownCounter('UpDownCounter', {
    description: 'Example of a UpDownCounter',
});
// Define some labels for your metrics
const labels = { environment: 'prod' };
// Record some values
upDownCounter.bind(labels);
upDownCounter.add(5);
upDownCounter.add(-1);
// In logzio you will see the following metric:
// UpDownCounter{environment: 'prod'} 4.0

ValueRecorder:

// Create ValueRecorder metric
const recorder = meter.createValueRecorder('test_value_recorder', {
    description: 'Example of a ValueRecorder',
});
// Define some labels for your metrics
const labels = { environment: 'prod' };
// Record some values
recorder.bind(labels);
recorder.record(30);
recorder.record(20);
// In logzio you will see the following metrics:
// test_value_recorder_sum{environment: 'prod'} 50.0
// test_value_recorder_count{environment: 'prod'} 2.0
// test_value_recorder_avg{environment: 'prod'} 25.0

SumObserver:

// Create SumObserver metric
meter.createSumObserver('SumObserver', {
    description: 'Example of a sync sum observer with callback',
}, (observerResult) => {
    const value = getMetrics(); // Calculte your metric value
    const labels = { environment: 'prod' }; // Define some labels
    observerResult.observe(value, labels);
});
// In logzio you will see the following metrics:
// SumObserver_total{environment: 'prod'}

UpDownSumObserver:

// This function will calculate your metric value
function getAsyncValue() {
    return new Promise((resolve) => {
        setTimeout(()=> {
            resolve(Math.random());
        }, 100);
    });
}
// Create UpDownSumObserver metric
meter.createUpDownSumObserver('UpDownSumObserver', {
    description: 'Example of an async observer with callback',
}, async (observerResult) => {
    const value = await getAsyncValue(); // Calculte your metric value
    const labels = { environment: 'prod' }; // Define some labels
    observerResult.observe(value, labels);
});
// In logzio you will see the following metrics:
// UpDownSumObserver{environment: 'prod'}

ValueObserver:

// This function will calculate your metric value
function getSomeAsyncMetrics() {
    return new Promise((resolve, reject) => {
        setTimeout(() => {
            resolve({
                value1: Math.random(),
                value2: Math.random(),
            });
        }, 100)
    });
}

// Create ValueObserver metrics
const valueObserver = meter.createValueObserver('value_observer', {
    description: 'Example of a value observer metric',
});
const anotherValueObserver = meter.createValueObserver('another_value_observer', {
    description: 'Example of a value observer metric',
});

meter.createBatchObserver((observerBatchResult) => {
    getSomeAsyncMetrics().then(metrics => {
        const labels = { environment: 'prod' }; // Define some labels
        observerBatchResult.observe(labels, [
            valueObserver.observation(metrics.value1),
            anotherValueObserver.observation(metrics.value2),
        ]);
    });
});

// In logzio you will see the following metrics:
// value_observer{environment: 'prod'}
// another_value_observer{environment: 'prod'}