https://github.com/zodern/mup-netdata
Meteor Up plugin to setup Netdata
https://github.com/zodern/mup-netdata
Last synced: about 1 year ago
JSON representation
Meteor Up plugin to setup Netdata
- Host: GitHub
- URL: https://github.com/zodern/mup-netdata
- Owner: zodern
- License: mit
- Created: 2020-04-24T01:44:29.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-03-28T16:04:25.000Z (about 4 years ago)
- Last Synced: 2024-10-30T01:43:35.648Z (over 1 year ago)
- Language: JavaScript
- Size: 37.1 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# mup-netdata
Plugin for Meteor Up to setup [Netdata](https://www.netdata.cloud/).
This is a very early version of the plugin and is missing some basic features.
## Use
Install with `npm i -g mup-netdata`.
Then, add `mup-netdata` to the `plugins` array in your mup config, and add a `netdata` object.
```js
module.exports = {
// rest of config
plugins: ['netdata'],
netdata: {
servers: {
netdataMaster: {
// One server must be a master. All other servers send their metrics
// to this one.
master: true
},
one: {},
two: {
// Send alerts about this server to Slack
// Default is true
alarms: false,
},
},
// Key used for authentication with the master instance in the GUID format.
// Run `mup netdata generate-api-key` to get a random key
// This option is Required
apiKey: '630eb68f-e0fa-5ecc-887a-7c7a62614681',
// The rest of the options are optional
// Receive alerts in slack
slack: {
// Create an incoming webhook using the "Incoming Webhooks" App: https://slack.com/apps/A0F7XDUAZ-incoming-webhooks
webhookUrl: 'https://hooks.slack.com/services/example/example',
// Set to where the slack messages are sent:
// - '#channel'
// - '@user'
recipient: '#system-status'
},
// How often metrics are collected, in seconds. Default is 1
updateEvery: 1,
// Disk space used to store metrics, in megabytes. Defaults to 512
dbEngineDiskSpace: 512,
}
}
```
This plugin only supports the configuration where there is a single master that stores the metrics, and all other instances are headless collectors that send the metrics to the master. If you need a different configuration, please create an issue or submit a pull request.
Next, run
```bash
mup setup
```
After it is setup, you can visit port `19999` on the server that is the master instance.
This plugin currently does not setup any authentication or access control. Netdata does not allow modifying data, but it does show information that could be helpful to a hacker. More information is available in the Netdata [docs](https://learn.netdata.cloud/docs/agent/netdata-security/#netdata-viewers-authentication). The master netdata instance must be accessible to the other instances, but you can use a firewall or reverse proxy to block access from the internet.
If you have more than a couple of instances, you will probably need to increase the [file descriptor limit](https://learn.netdata.cloud/docs/agent/database/engine/#file-descriptor-requirements).
All of the [python](https://learn.netdata.cloud/docs/agent/collectors/collectors/#python-pythond) collectors are disabled since on some servers these collectors use a large amount of CPU. If a specific python collector is useful to you, you can create a PR to enable it.