README.md

Apillon Logging, Monitoring & Alerting Service - LMAS

LMAS service provides endpoint for logging system messages, events, dev console and API requests to Mongo database and to notify administrators of system events via various channels (currently slack). Service supposed to be called asynchronously and should not be awaited for response (non blocking actions).

Table of Contents

1. Getting Started
2. Configuration
3. Deployment
4. License

Getting Started

Please read Development and Debug and Test documentation. These instructions will help you set up the development environment and run the microservice locally.

Configuration

Environment variables that have to be set:

 /************************************************************
   * LMAS -  Apillon Logging, Monitoring & Alerting Service
   ************************************************************/
  /**
   *  function name
   */
  MONITORING_FUNCTION_NAME: string;
  MONITORING_FUNCTION_NAME_TEST: string;
  /**
   * LMAS dev server port
   */
  MONITORING_SOCKET_PORT: number;
  MONITORING_SOCKET_PORT_TEST: number;
  /**
   * LMAS MongoDB connection string
   */
  MONITORING_MONGO_SRV: string;
  MONITORING_MONGO_DATABASE: string;
  MONITORING_MONGO_SRV_TEST: string;
  MONITORING_MONGO_DATABASE_TEST: string;

  /**
   * SLACK ALERTS
   */
  SLACK_TOKEN: string;
  SLACK_CHANNEL: string;

Deployment

Please read Deployment documentation.

License

Copyright (c) Apillon - all rights reserved