Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/redclawtech/vmq_cloudwatch_metrics
VerneMQ plugin to send broker metrics to Amazon CloudWatch.
https://github.com/redclawtech/vmq_cloudwatch_metrics
aws cloudwatch-metrics erlang monitoring-plugins monitoring-tool mqtt vernemq
Last synced: about 2 months ago
JSON representation
VerneMQ plugin to send broker metrics to Amazon CloudWatch.
- Host: GitHub
- URL: https://github.com/redclawtech/vmq_cloudwatch_metrics
- Owner: redclawtech
- License: apache-2.0
- Created: 2018-05-28T22:43:39.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-21T16:03:52.000Z (almost 6 years ago)
- Last Synced: 2024-05-20T03:18:57.258Z (7 months ago)
- Topics: aws, cloudwatch-metrics, erlang, monitoring-plugins, monitoring-tool, mqtt, vernemq
- Language: Erlang
- Homepage:
- Size: 72.3 KB
- Stars: 5
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- cuban-opensource - vmq_cloudwatch_metrics
README
# VerneMQ CloudWatch Metrics plugin
This is a [VerneMQ](https://vernemq.com/) plugin that will send broker metrics to Amazon CloudWatch.
## Prerequisites
* A recent version of Erlang/OTP(Not tested on versions previous to 19).
* VerneMQ version *1.7.0* or superior.
## How to compile this plugin
This project uses [Rebar3](https://www.rebar3.org) as a build tool and can be compiled running:
```bash
rebar3 compile
```
## How to enable the plugin on VerneMQ
### Manually enable
```console
vmq-admin plugin enable --name=vmq_cloudwatch_metrics --path=/_build/default/lib/vmq_cloudwatch_metrics
```
### Permanently enable (On VerneMQ start)
Add the following to the `vernemq.conf` file.
```erlang
plugins.vmq_cloudwatch_metrics = on
plugins.vmq_cloudwatch_metrics.path = /_build/default/lib/vmq_cloudwatch_metrics
```
## Configuration
The following settings are available for this plugin:
- **vmq_cloudwatch_metrics.cloudwatch_enabled** Defines if the plugin will send the metrics to CloudWatch or not. Dafault "off".
- **vmq_cloudwatch_metrics.interval** The publish interval in milliseconds. Defaults to 60000(1 minute).
- **vmq_cloudwatch_metrics.namespace** CloudWatch namespaces are containers for metrics. Defaults to "VerneMQ".
- **vmq_cloudwatch_metrics.aws_access_key_id** The AWS Key. See http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html.
- **vmq_cloudwatch_metrics.aws_secret_access_key** The AWS secret key for connecting to CloudWatch. See http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html.
- **vmq_cloudwatch_metrics.aws_region** The AWS region. Defaults to "us-east-1".
Parameters can be defined in the `vernemq.conf` file.
```erlang
vmq_cloudwatch_metrics.cloudwatch_enabled = on
vmq_cloudwatch_metrics.interval = 60000
vmq_cloudwatch_metrics.namespace = "VerneMQ"
vmq_cloudwatch_metrics.aws_access_key_id = "MYACCESSKEY"
vmq_cloudwatch_metrics.aws_secret_access_key = "MYSECRETACCESSKEY"
vmq_cloudwatch_metrics.aws_region = "eu-west-1"
```
*Tip:* Configuration parameters can also be changed at runtime using the `vmq-admin` script.
## TODO
- [ ] Add tests.
- [ ] Add CI using Travis.