Welcome to Metrics Logger

Metrics Logger is an extremely powerful tool designed to track and log various metrics within your applications efficiently. Whether you’re a developer or a DevOps engineer, having detailed logs of metrics is crucial for ensuring optimal performance and debug potential issues.

API Overview

Below we describe some of the most important and useful API methods provided by Metrics Logger along with code snippets to help you integrate them seamlessly into your applications.

Initialization

Initialize the Metrics Logger in your application with the following code:

 
  const MetricsLogger = require('metrics-logger');
  const logger = new MetricsLogger();
 

Logging Custom Metrics

You can log custom metrics using the logCustomMetric method. Here is an example:

 
  logger.logCustomMetric('API_Response_Time', 200);
 

Logging Errors

To log errors within your application, use the logError method:

 
  try {
    // Your code here
  } catch (error) {
    logger.logError('Error_Occurred', error.message);
  }
 

Tracking Function Execution Time

Measure and log the execution time of functions with the timeFunction method:

 
  function exampleFunction() {
    // Your code here
  }
  logger.timeFunction('exampleFunction', exampleFunction);
 

Logging System Metrics

Metrics Logger provides methods to log various system metrics like memory usage, CPU load, etc.:

 
  logger.logMemoryUsage();
  logger.logCpuLoad();
 

Sending Metrics to Server

Batch and send the collected metrics to your server using sendMetrics:

 
  logger.sendMetrics('https://your-metrics-server.com/endpoint');
 

Application Example

Let’s see a full example integrating some of the APIs mentioned above into a Node.js application:

 
  const MetricsLogger = require('metrics-logger');
  const logger = new MetricsLogger();

  function fetchData() {
    // Simulate data fetching
    return new Promise((resolve, reject) => {
      setTimeout(() => {
        if (Math.random() > 0.5) {
          resolve('Data fetched successfully');
        } else {
          reject(new Error('Failed to fetch data'));
        }
      }, 1000);
    });
  }

  async function app() {
    logger.logMemoryUsage();
    
    try {
      const data = await logger.timeFunction('fetchData', fetchData);
      console.log(data);
      logger.logCustomMetric('Data_Fetch_Success', 1);
    } catch (error) {
      logger.logError('Data_Fetch_Error', error.message);
      logger.logCustomMetric('Data_Fetch_Failure', 1);
    }

    logger.logCpuLoad();
    logger.sendMetrics('https://your-metrics-server.com/endpoint');
  }

  app();
 

With Metrics Logger, you can easily track and analyze the performance and health of your applications. Start using Metrics Logger today to gain insightful metrics and maintain your applications effortlessly.

Hash: 33a351a7db0d0159fc9122a27eba3d29eb70296b0e8bd1a6a33e3c0be5d126df