Overview

@supertenant/supermeter is an innovative monitoring and tenant management package designed for Node.js applications. It enables measurement collection and automatic tracing as well as measurement and trace reporting for Supertenant.

In addition, it integrates advanced features such as Quality of Service (QoS), rate limiting, and multi-tenant environment support. This document provides a comprehensive guide for integrating and using the @supertenant/supermeter package in your Node.js applications.

Features

• Advanced Monitoring: Tracks and monitors application performance, resource usage, and system behavior in real-time.
• Multi-Tenant Management: Efficiently handles multiple tenant environments, ensuring isolated and secure data handling for each tenant.
• Quality of Service (QoS): Manages and optimizes the service quality, ensuring consistent performance across different environments.
• Rate Limiting: Controls the rate of requests to prevent overloading of services, ensuring stable and reliable application performance.

Prerequisites

Before you begin, ensure that your development environment meets the following requirements:

• Node.js version compatible with @supertenant/supermeter (refer to the Supported Modules section below).
• NPM or Yarn package manager installed.

Installation

Using NPM

To install @supertenant/supermeter using NPM, run the following command in your project directory:

npm install @supertenant/supermeter --save

Using Yarn

For Yarn users, install the package by running:

yarn add @supertenant/supermeter

Usage

To integrate the @supertenant/supermeter package into your Node.js application, include it at the beginning of your application's entry point:

node -r @supertenant/supermeter <your_app>

Supported Modules

Node.js Version Support

| Node.js Version | Collector Versions | | --------------- | ------------- | | >=16.20.1 | 0.7.9 -latest | | >=16.20 | 0.6.8 -0.7.9 | | <8.0.0 | Not supported |

Supported Libraries

HTTP Libraries

| Library | Supported Versions | | --- | --- | | Express | >2.1.0 | | Fastify | >=3.0.0 <4 | | Redis | >=2.0.0 <5.0.0 |

Databases

| Library | Supported Versions | | --- | --- | | MySQL | >2.1.0 | | MySQL2 | >=3.0.0 <4 | | MongoDB | >=5 <6 (Node >=14.20.1) | | | >=4 <5 (Node >=12.9.0) | | | >=3.5 <4 (Node >=10.0.0) |

Ensure that your application dependencies align with these supported versions for optimal compatibility and performance.

Additional Compatibility

Please note that additional compatible versions and packages can be made available by request. For inquiries about specific versions or packages, please contact us at [email protected].

Configuration

To configure the @supertenant/supermeter package, you can set environment variables or use configuration files specific to your application's requirements. For detailed configuration options, refer to the official @supertenant/supermeter documentation.

Troubleshooting

If you encounter issues while using @supertenant/supermeter, consult the documentation or reach out to the support team for assistance. Common issues may include compatibility problems with certain Node.js or library versions, which can often be resolved by adjusting your project's dependencies.

Contributing

Contributions to the @supertenant/supermeter project are welcome. If you have suggestions or improvements, please submit a pull request or open an issue in the project's repository.