@loopback/extension-metrics

v0.3.13

An extension exposes metrics for Prometheus with LoopBack 4 For more information about how to use this package see README

Latest version published 4 years ago

License: MIT

NPM

GitHub

Package Health Score

67 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Active

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.3.13	\|	08/2020	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.4	\|	04/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.6	\|	02/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (49)

GitHub Stars: 4.96K
Forks: 1.07K
Contributors: 220

Direct Usage Popularity

The npm package @loopback/extension-metrics receives a total of 49 downloads a week. As such, we scored @loopback/extension-metrics popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package @loopback/extension-metrics, we found that it has been starred 4,957 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 220
Funding: No

A good and healthy external contribution signal for @loopback/extension-metrics project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 230
Open PR: 74
Last Release: 4 years ago
Last Commit: 9 days ago

Further analysis of the maintenance status of @loopback/extension-metrics based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for @loopback/extension-metrics is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=10.16

Age: 5 years
Dependencies: 4 Direct
Versions: 27
Install Size: 49.2 kB
Dist-tags: 1
# of Files: 48
Maintainers: 4
TS Typings: Yes

@loopback/extension-metrics has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

@loopback/extension-metrics

This module contains a component that reports metrics of Node.js, LoopBack framework, and your application to Prometheus.

Stability: ⚠️Experimental⚠️

> Experimental packages provide early access to advanced or experimental > functionality to get community feedback. Such modules are published to npm > using 0.x.y versions. Their APIs and functionality may be subject to > breaking changes in future releases.

Installation

npm install --save @loopback/extension-metrics

Basic use

The component should be loaded in the constructor of your custom Application class.

Start by importing the component class:

import {MetricsComponent} from '@loopback/extension-metrics';

In the constructor, add the component to your application:

this.component(MetricsComponent);

By default, Metrics route is mounted at /metrics. This path can be customized via Metrics configuration as follows:

this.configure(MetricsBindings.COMPONENT).to({
  endpoint: {
    basePath: '/metrics',
  },
  defaultMetrics: {
    timeout: 5000,
  },
});

Metrics Collected

There are three types of metrics being collected by this component:

Node.js metrics - built-in by https://github.com/siimon/prom-client
LoopBack method invocations - built-in by this module using an interceptor
Metrics by the application code or other modules - instrumentations are required

Pull vs Push

Prometheus supports two modes to collect metrics:

pull - scraping from metrics http endpoint exposed by the system being monitored
push - pushing metrics from the system being monitored to a push gateway

See https://prometheus.io/docs/introduction/faq/#why-do-you-pull-rather-than-push

Try it out

git clone https://github.com/strongloop/loopback-next
npm install
npm run build
cd examples/metrics-prometheus
npm run demo

Open https://localhost:9090 to load Prometheus web UI.

/metrics endpoint

https://localhost:3000/metrics returns metrics in plain text format. It includes information for the Node.js process as well as LoopBack method invocations.

Example of plain text data

# HELP process_cpu_user_seconds_total Total user CPU time spent in seconds.
# TYPE process_cpu_user_seconds_total counter
process_cpu_user_seconds_total 0.132181 1564508354524
# HELP process_cpu_system_seconds_total Total system CPU time spent in seconds.
# TYPE process_cpu_system_seconds_total counter
process_cpu_system_seconds_total 0.023608999999999998 1564508354524
# HELP process_cpu_seconds_total Total user and system CPU time spent in seconds.
# TYPE process_cpu_seconds_total counter
process_cpu_seconds_total 0.15578999999999998 1564508354524
# HELP process_start_time_seconds Start time of the process since unix epoch in seconds.
# TYPE process_start_time_seconds gauge
process_start_time_seconds 1564508343
# HELP process_resident_memory_bytes Resident memory size in bytes.
# TYPE process_resident_memory_bytes gauge
process_resident_memory_bytes 61800448 1564508354524
# HELP nodejs_eventloop_lag_seconds Lag of event loop in seconds.
# TYPE nodejs_eventloop_lag_seconds gauge
nodejs_eventloop_lag_seconds 0.002172946 1564508354526
# HELP nodejs_active_handles Number of active libuv handles grouped by handle type. Every handle type is C++ class name.
# TYPE nodejs_active_handles gauge
nodejs_active_handles{type="WriteStream"} 2 1564508354524
nodejs_active_handles{type="Server"} 1 1564508354524
nodejs_active_handles{type="Socket"} 2 1564508354524
# HELP nodejs_active_handles_total Total number of active handles.
# TYPE nodejs_active_handles_total gauge
nodejs_active_handles_total 5 1564508354526
# HELP nodejs_active_requests Number of active libuv requests grouped by request type. Every request type is C++ class name.
# TYPE nodejs_active_requests gauge
# HELP nodejs_active_requests_total Total number of active requests.
# TYPE nodejs_active_requests_total gauge
nodejs_active_requests_total 0 1564508354526
# HELP nodejs_heap_size_total_bytes Process heap size from node.js in bytes.
# TYPE nodejs_heap_size_total_bytes gauge
nodejs_heap_size_total_bytes 27545600 1564508354526
# HELP nodejs_heap_size_used_bytes Process heap size used from node.js in bytes.
# TYPE nodejs_heap_size_used_bytes gauge
nodejs_heap_size_used_bytes 23788272 1564508354526
# HELP nodejs_external_memory_bytes Nodejs external memory size in bytes.
# TYPE nodejs_external_memory_bytes gauge
nodejs_external_memory_bytes 1234918 1564508354526
# HELP nodejs_heap_space_size_total_bytes Process heap space size total from node.js in bytes.
# TYPE nodejs_heap_space_size_total_bytes gauge
nodejs_heap_space_size_total_bytes{space="read_only"} 524288 1564508354526
nodejs_heap_space_size_total_bytes{space="new"} 1048576 1564508354526
nodejs_heap_space_size_total_bytes{space="old"} 16900096 1564508354526
nodejs_heap_space_size_total_bytes{space="code"} 688128 1564508354526
nodejs_heap_space_size_total_bytes{space="map"} 1576960 1564508354526
nodejs_heap_space_size_total_bytes{space="large_object"} 6758400 1564508354526
nodejs_heap_space_size_total_bytes{space="code_large_object"} 49152 1564508354526
nodejs_heap_space_size_total_bytes{space="new_large_object"} 0 1564508354526
# HELP nodejs_heap_space_size_used_bytes Process heap space size used from node.js in bytes.
# TYPE nodejs_heap_space_size_used_bytes gauge
nodejs_heap_space_size_used_bytes{space="read_only"} 31712 1564508354526
nodejs_heap_space_size_used_bytes{space="new"} 9584 1564508354526
nodejs_heap_space_size_used_bytes{space="old"} 15723128 1564508354526
nodejs_heap_space_size_used_bytes{space="code"} 377600 1564508354526
nodejs_heap_space_size_used_bytes{space="map"} 918480 1564508354526
nodejs_heap_space_size_used_bytes{space="large_object"} 6726408 1564508354526
nodejs_heap_space_size_used_bytes{space="code_large_object"} 3456 1564508354526
nodejs_heap_space_size_used_bytes{space="new_large_object"} 0 1564508354526
# HELP nodejs_heap_space_size_available_bytes Process heap space size available from node.js in bytes.
# TYPE nodejs_heap_space_size_available_bytes gauge
nodejs_heap_space_size_available_bytes{space="read_only"} 492264 1564508354526
nodejs_heap_space_size_available_bytes{space="new"} 1038368 1564508354526
nodejs_heap_space_size_available_bytes{space="old"} 1105240 1564508354526
nodejs_heap_space_size_available_bytes{space="code"} 285952 1564508354526
nodejs_heap_space_size_available_bytes{space="map"} 657072 1564508354526
nodejs_heap_space_size_available_bytes{space="large_object"} 0 1564508354526
nodejs_heap_space_size_available_bytes{space="code_large_object"} 0 1564508354526
nodejs_heap_space_size_available_bytes{space="new_large_object"} 1047952 1564508354526
# HELP nodejs_version_info Node.js version info.
# TYPE nodejs_version_info gauge
nodejs_version_info{version="v12.4.0",major="12",minor="4",patch="0"} 1
# HELP loopback_invocation_duration_seconds method invocation
# TYPE loopback_invocation_duration_seconds gauge
# HELP loopback_invocation_duration_histogram method invocation histogram
# TYPE loopback_invocation_duration_histogram histogram
# HELP loopback_invocation_total method invocation counts
# TYPE loopback_invocation_total counter
loopback_invocation_total 1
# HELP loopback_invocation_duration_summary method invocation summary
# TYPE loopback_invocation_duration_summary summary

Contributions

Tests

Run npm test from the root folder.

Contributors

See all contributors.

License

MIT

@loopback/extension-metrics dependencies

tslib prom-client @loopback/core @loopback/rest

@loopback/extension-metrics development dependencies

express @types/node @types/express @loopback/build @loopback/testlab @loopback/eslint-config

FAQs

What is @loopback/extension-metrics?

An extension exposes metrics for Prometheus with LoopBack 4. Visit Snyk Advisor to see a full health score report for @loopback/extension-metrics, including popularity, security, maintenance & community analysis.

Is @loopback/extension-metrics popular?

The npm package @loopback/extension-metrics receives a total of 49 weekly downloads. As such, @loopback/extension-metrics popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @loopback/extension-metrics well maintained?

We found indications that @loopback/extension-metrics is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @loopback/extension-metrics safe to use?

While scanning the latest version of @loopback/extension-metrics, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 19 November-2024, at 16:28 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (49)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

@loopback/extension-metrics

Stability: ⚠️Experimental⚠️

Installation

Basic use

Metrics Collected

Pull vs Push

Try it out

/metrics endpoint

Contributions

Tests

Contributors

License

@loopback/extension-metrics dependencies

@loopback/extension-metrics development dependencies

FAQs

What is @loopback/extension-metrics?

Is @loopback/extension-metrics popular?

Is @loopback/extension-metrics well maintained?

Is @loopback/extension-metrics safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues