https://github.com/lariel/api-health-monitor

CLI para monitoramento de APIs
https://github.com/lariel/api-health-monitor

api cli health-check nodejs npmjs

Last synced: 25 days ago
JSON representation

CLI para monitoramento de APIs

• Host: GitHub
• URL: https://github.com/lariel/api-health-monitor
• Owner: Lariel
• Created: 2023-07-11T02:24:59.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-26T00:53:01.000Z (about 1 year ago)
• Last Synced: 2024-04-29T08:21:09.214Z (6 months ago)
• Topics: api, cli, health-check, nodejs, npmjs
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/api-health-monitor
• Size: 18.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# CLI para monitoramento de APIs

### Configs pré instalação

- Criar uma pasta onde será guardado o arquivo de configuração. Sugestão `api-mon`

- Dentro desta pasta, criar um arquivo `configs.js` com o seguinte conteúdo:

    ```js

        const ENVS = [

            {

                alias: 'alias', // Parâmetro usado para chamada dos serviços do ambiente

                envName: 'Ex de nome do ambiente',

                baseUrl: 'https://...',

                monitorPath: 'path-monitoramento' //ex: actuator/health, management/health

            },

            {

                alias: 'alias',

                envName: 'Ex de nome do ambiente',

                baseUrl: 'https://...',

                monitorPath: 'path-monitoramento' //ex: actuator/health, management/health

            }

        ];

        const TAGS = [

            {

                name: 'tag-A',

                services: [

                    'web-service-a-tag-a', 

                    'web-service-b-tag-a',

                    'web-service-c-tag-a',

                ]

            },

            {

                name: 'tag-B',

                services: [

                    'web-service-a-tag-b', 

                    'web-service-b-tag-b',

                ]

            },

            

        ];

        module.exports = { TAGS, ENVS };

    ```

- Configurar uma variável de ambiente com o nome `API_MON` apontando para a pasta onde o arquivo `configs.js` foi criado.

### Instalação global

Executar `npm i -g api-health-monitor` para instalar o projeto.

### Execução

Após a instalação global, executar `mon -help` em qualquer local, e seguir os passos descritos no helper.