https://github.com/lucid-services/serviser-cli

service inspection and integrity checkup plugin
https://github.com/lucid-services/serviser-cli

inspection integrity-monitoring microservice

Last synced: 6 months ago
JSON representation

service inspection and integrity checkup plugin

• Host: GitHub
• URL: https://github.com/lucid-services/serviser-cli
• Owner: lucid-services
• License: gpl-3.0
• Created: 2019-02-07T09:05:00.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-03-11T15:45:12.000Z (over 6 years ago)
• Last Synced: 2025-02-14T22:24:02.402Z (8 months ago)
• Topics: inspection, integrity-monitoring, microservice
• Language: JavaScript
• Homepage:
• Size: 132 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/lucid-services/serviser-cli.svg?branch=master)](https://travis-ci.org/lucid-services/serviser-cli)   

Implements `serviser` `http` & `REPL` `App` which spies on `AppManager`'s apps to provide

integrity status of the running service.

### Integration

```javascript

var Service = require('serviser').Service;

//your service definition

module.exports = new Service;

//hookup the plugin to the serviser

require('serviser-cli');

```

Require the plugin module preferably at the bottom of your index.js file of your project (aka. where your Service definition should be)

### serviser project config

Add the cli app

```javascript

{

    listen: {

        cli: {

            port: '3000'

        }

    },

    apps: {

        //It expects the app to be under "apps.cli" name

        cli: {

            baseUrl: {$join: [

                'http://127.0.0.1:',

                {$ref: '#listen/cli/port'}

            ]},

            listen: {$ref: '#listen/cli/port'},

            show: false //if true - attaches REPL node console to the service process

        }

    }

}

```

**TIP:** When you want to quickly show the REPL console and editing of the config file is not desirable, you can override the config option inline like so:

> node bin/www apps.cli.show 1  

### Using the console

After you are connected to the console. The `help` command is your friend.  

Use it to get an overview of available commands and their usage 

### REST API

GET `/api/v1.0/integrity` - responds with `409` status in case of integrity error or `200` signalizing all OK.