Introduction to Gauge API

Gauge is a powerful tool for creating and managing performance metrics, essential for monitoring and improving the performance of your applications. In this guide, we will explore various APIs provided by Gauge along with code snippets and a practical app example to help you get started.

1. Creating a Gauge

  const gauge = new Gauge('cpu_usage', {
    description: 'CPU Usage Percentage',
    labels: ['environment']
  });

2. Setting Gauge Value

  gauge.set({ environment: 'production' }, 55.3);

3. Incrementing Gauge Value

  gauge.inc({ environment: 'production' });

4. Decrementing Gauge Value

  gauge.dec({ environment: 'development' });

5. Using Time Function

  const end = gauge.startTimer({ environment: 'staging' });
  // Perform some task
  end(); // Stops the timer and records the duration

6. Setting Labels

  gauge.setLabels({ environment: 'test' });

App Example with Gauge APIs

Below is a sample application that demonstrates how to use the aforementioned Gauge APIs to monitor CPU usage.

  const Gauge = require('gauge');

  // Initialize the gauge
  const cpuGauge = new Gauge('cpu_usage', {
    description: 'CPU Usage Percentage',
    labels: ['environment']
  });

  // Function to simulate CPU usage
  function simulateCpuUsage(env, usage) {
    cpuGauge.set({ environment: env }, usage);
  }

  // Simulate CPU usage data
  simulateCpuUsage('production', 70.5);
  simulateCpuUsage('development', 45.2);

  // Increment CPU usage in production environment
  cpuGauge.inc({ environment: 'production' });

  // Start and stop timer for staging environment
  const end = cpuGauge.startTimer({ environment: 'staging' });
  // Perform some task
  end(); // Stops the timer and records the duration

  // Decrement CPU usage in development environment
  cpuGauge.dec({ environment: 'development' });

  // Set label for test environment
  cpuGauge.setLabels({ environment: 'test' });

By integrating the Gauge APIs into your applications, you can effectively monitor and optimize performance, ensuring a better user experience. Start using Gauge today to gain insights into your application’s performance metrics!

Hash: a90fd9a9a1e66597ae124f542f73ac08d3112e7d6f5e1781163be07ccae5be0d