pod-monitoring v1.0.4

pod-monitoring

A React component for the Pod projects monitoring

Installation

Use npm to install the package:

npm i pod-monitoring

Usage

Summary

import MonitoringHealthCheck from 'pod-monitoring';

function MonitoringPage() {
  const yourApiAddress = 'https://your-project-api-address.ir/status';

  return (
    <MonitoringHealthCheck apiAddress={yourApiAddress}>
  );
}

Step By Step Guide

First, create a page as a monitoring

// ...
  <Route path="/monitoring" component={MonitoringPage} />
// ...

Second, in the MonitoringPage component, import MonitoringHealthCheck from pod-monitoring.

import MonitoringHealthCheck from 'pod-monitoring';

function MonitoringPage() {
  const yourApiAddress = 'https://your-project-api-address.ir/status';

  return (
    <MonitoringHealthCheck apiAddress={yourApiAddress}>
  );
}

That's it. It's all the things that you should be done.

Notice:

• Don't insert any content in the monitoring page.
• Use a public web service for monitoring.
• Use a public route in your front app.
• The maximum delay time for viewing content is 100 milliseconds.
• If your front app and backend service is up, you should see frontend:successed,backend:successed

LICENSE

MIT