https://github.com/d-gubert/apps-monitor
A monitor for a Rocket.Chat cluster that tries to ensure apps statuses are always consistent in volatile environments
https://github.com/d-gubert/apps-monitor
Last synced: 3 months ago
JSON representation
A monitor for a Rocket.Chat cluster that tries to ensure apps statuses are always consistent in volatile environments
- Host: GitHub
- URL: https://github.com/d-gubert/apps-monitor
- Owner: d-gubert
- Created: 2024-10-28T23:51:24.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-10-29T00:09:55.000Z (7 months ago)
- Last Synced: 2025-01-19T08:29:28.329Z (4 months ago)
- Language: TypeScript
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Apps Monitor
We're currently investigating an issue where some apps might show inconsistent status across the instances of a cluster. While we look for the root cause of this issue, this tool helps mitigate the impacts of the instability on environments.
This tool monitors via the network the Rocket.Chat apps that are installed in a given Rocket.Chat high-availability cluster, trying to keep their status as enabled whenever there is some inconsistency. If it is not possible to fix this automatically, a message can be sent to a provided room explaining the problem.
## Configuration
This tool requires a file `apps-monitor-config.json` to be in the same directory from where the tool is executed.
This is an example config for that file:
```json
{
"userPAT": "NonIfSuzWFzEPA2RB7slUGp-ubNtLGZy78aWwIWjWpt",
"userId": "YzrFwYjd7qDAhArBZ",
"serverURL": "http://172.19.0.5",
"interval": 30000,
"alertRoom": "671feba8af417d3edd6dbf30"
}
```
- `userPAT` - the personal access token (PAT) of a user with admin permissions. *This token needs to be created with the "Ignore two factor authentication" option selected*. To learn more about creating a PAT see the following page https://docs.rocket.chat/v1/docs/account#personal-access-tokens
- `userId` - the id of the user that created the PAT. This is provided during the PAT creation.
- `serverURL` - The base URL to access the workspace
- `interval` - Optional. Determines the interval between monitor checks to the cluster, in milliseconds (default: 30000 (5min))
- `alertRoom` - Optional. The room id to where the monitor will send a message in case of errors when trying to enable an app.
## Running
You can use deno to run this tool:
```sh
$ deno run main.ts
```
Deno will ask for some permissions that are required for it to interact with the environment. If you want to allow all those permissions, use the `-A` option
```sh
$ deno run -A main.ts
# or the following list of permissions if you don't want to provide ALL available
$ deno run --allow-env --allow-read --allow-sys --allow-net main.ts
```
The log level can be configured via the `LOG_LEVEL` environment variable.
```sh
$ LOG_LEVEL=trace deno run main.ts
```
### Server access
The tool needs to be able to reach the server address that has been configured *AND the IP addressess of each individual instance of the cluster as well* to fully work.