Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including @speedup/sysinfo-health with all npm packages installed. Try it out:

var sysinfoHealth = require("@speedup/sysinfo-health")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

@speedup/sysinfo-health v1.0.7

Shows current status of the service which can be used in health-check solutions

SpeedUP Health service

This module provides some information about your service health.

NPM version NPM downloads

Installation


# NPM
npm i @speedup/sysinfo-health --save

# Yarn
yarn install @speedup/sysinfo-health

Parts

This module consists of 3 main parts.

  1. HealthService (which is responsible for retrieving health information from the requested providers).
  2. InfoProvider (which is responsible for providing health information)
  3. WebFramework (which is responsible for integrating with the web frameworks).

Usage


const serviceHealth = require('@speedup/sysinfo-health');

const infoProvider = new serviceHealth.InfoProvider({
    loadDefaultProviders: true
});

const healthProvider = new serviceHealth.HealthProvider(config, infoProvider);

// inside your async function, try
const health = await healthProvider.retrieve();

// returns an object that contains the health information


// you can return only the information about specific parts of the hardware/software
// by providing the list of modules
// built-in info services: CPU, memory, OS, path, uptime, user
const health = await healthProvider.retrieve(['CPU', 'memoy']);

And you're good to go!

License

MIT

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free