{"id":13410720,"url":"https://github.com/redclawtech/vmq_cloudwatch_metrics","last_synced_at":"2025-03-14T16:32:56.704Z","repository":{"id":140924774,"uuid":"135215695","full_name":"redclawtech/vmq_cloudwatch_metrics","owner":"redclawtech","description":"VerneMQ plugin to send broker metrics to Amazon CloudWatch.","archived":false,"fork":false,"pushed_at":"2019-03-21T16:03:52.000Z","size":74,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-05-20T03:18:57.258Z","etag":null,"topics":["aws","cloudwatch-metrics","erlang","monitoring-plugins","monitoring-tool","mqtt","vernemq"],"latest_commit_sha":null,"homepage":"","language":"Erlang","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/redclawtech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-28T22:43:39.000Z","updated_at":"2024-07-30T22:51:56.600Z","dependencies_parsed_at":"2023-07-04T03:02:51.100Z","dependency_job_id":null,"html_url":"https://github.com/redclawtech/vmq_cloudwatch_metrics","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redclawtech%2Fvmq_cloudwatch_metrics","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redclawtech%2Fvmq_cloudwatch_metrics/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redclawtech%2Fvmq_cloudwatch_metrics/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redclawtech%2Fvmq_cloudwatch_metrics/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/redclawtech","download_url":"https://codeload.github.com/redclawtech/vmq_cloudwatch_metrics/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243610422,"owners_count":20318959,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","cloudwatch-metrics","erlang","monitoring-plugins","monitoring-tool","mqtt","vernemq"],"created_at":"2024-07-30T20:01:08.648Z","updated_at":"2025-03-14T16:32:56.356Z","avatar_url":"https://github.com/redclawtech.png","language":"Erlang","funding_links":[],"categories":["Internet of Things (IoT)"],"sub_categories":["Telegram"],"readme":"# VerneMQ CloudWatch Metrics plugin\n\nThis is a [VerneMQ](https://vernemq.com/) plugin that will send broker metrics to Amazon CloudWatch.\n\n## Prerequisites\n\n* A recent version of Erlang/OTP(Not tested on versions previous to 19).\n* VerneMQ version *1.7.0* or superior.\n\n## How to compile this plugin\n\nThis project uses [Rebar3](https://www.rebar3.org) as a build tool and can be compiled running:\n\n```bash\nrebar3 compile\n```\n\n## How to enable the plugin on VerneMQ\n\n### Manually enable\n\n```console\nvmq-admin plugin enable --name=vmq_cloudwatch_metrics --path=\u003cPathToYourPlugin\u003e/_build/default/lib/vmq_cloudwatch_metrics\n```\n\n### Permanently enable (On VerneMQ start)\n\nAdd the following to the `vernemq.conf` file.\n\n```erlang\nplugins.vmq_cloudwatch_metrics = on\nplugins.vmq_cloudwatch_metrics.path = \u003cPathToYourPlugin\u003e/_build/default/lib/vmq_cloudwatch_metrics\n```\n\n## Configuration\n\nThe following settings are available for this plugin:\n\n- **vmq_cloudwatch_metrics.cloudwatch_enabled** Defines if the plugin will send the metrics to CloudWatch or not. Dafault \"off\".\n\n- **vmq_cloudwatch_metrics.interval** The publish interval in milliseconds. Defaults to 60000(1 minute).\n\n- **vmq_cloudwatch_metrics.namespace** CloudWatch namespaces are containers for metrics. Defaults to \"VerneMQ\".\n\n- **vmq_cloudwatch_metrics.aws_access_key_id** The AWS Key. See http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html.\n\n- **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.\n\n- **vmq_cloudwatch_metrics.aws_region** The AWS region. Defaults to \"us-east-1\".\n\nParameters can be defined in the `vernemq.conf` file.\n\n```erlang\nvmq_cloudwatch_metrics.cloudwatch_enabled = on\nvmq_cloudwatch_metrics.interval = 60000\nvmq_cloudwatch_metrics.namespace = \"VerneMQ\"\nvmq_cloudwatch_metrics.aws_access_key_id = \"MYACCESSKEY\"\nvmq_cloudwatch_metrics.aws_secret_access_key = \"MYSECRETACCESSKEY\"\nvmq_cloudwatch_metrics.aws_region = \"eu-west-1\"\n```\n\n*Tip:* Configuration parameters can also be changed at runtime using the `vmq-admin` script.\n\n## TODO\n\n- [ ] Add tests.\n- [ ] Add CI using Travis.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredclawtech%2Fvmq_cloudwatch_metrics","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredclawtech%2Fvmq_cloudwatch_metrics","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredclawtech%2Fvmq_cloudwatch_metrics/lists"}