This plugin collects metrics from MySQL database.
It's used in the Snap framework.
- golang 1.6+ - needed only for building
All OSs currently supported by snap:
- Linux/amd64
You can get the pre-built binaries for your OS and architecture from the plugin's GitHub Releases page.
Fork https://github.com/intelsdi-x/snap-plugin-collector-mysql
Clone repo into $GOPATH/src/github.com/intelsdi-x/
$ git clone https://github.com/<yourGithubID>/snap-plugin-collector-mysql.git
Build the plugin by running make within the cloned repo:
$ make
This builds the plugin in ./build
- Set up the Snap framework.
- Create Global Config, see description in [Global Config] (https://github.com/intelsdi-x/snap-plugin-collector-mysql/blob/master/README.md#global-config).
- Load the plugin and create a task, see example in Examples.
###Global config
Global configuration files are described in snap's documentation. You have to add "mysql"
section with following entries:
"mysql_connection_string"
- it's DSN with format described here. ex."root:r00tme@tcp(localhost:3306)/"
whereroot
is username andr00tme
is password,localhost
is host address and3306
is port where mysql is listening."mysql_use_innodb"
- possible values aretrue
andfalse
. Specifies if InnoDB statistics are collected. If you set this value to true and they are unavailable plugin will fail to start.
See exemplary Global configuration files in [examples/configs/] (https://github.com/intelsdi-x/snap-plugin-collector-mysql/blob/master/examples/configs/).
List of collected metrics is described in METRICS.md.
Example running mysql and writing data to a file using snap-plugin-publisher-file.
Create Global Config, see examples in [examples/configs/] (https://github.com/intelsdi-x/snap-plugin-collector-mysql/blob/master/examples/configs/).
Set up the Snap framework,
in one terminal window, run snapteld
(in this case with logging set to 1, trust disabled and global configuration saved in config.json):
$ snapteld -l 1 -t 0 --config config.json
In another terminal window:
Download and load Snap plugins:
$ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-publisher-file/latest/linux/x86_64/snap-plugin-publisher-file
$ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-collector-mysql/latest/linux/x86_64/snap-plugin-collector-mysql
$ snaptel plugin load snap-plugin-publisher-file
$ snaptel plugin load snap-plugin-collector-mysql
See available metrics for your system
$ snaptel metric list
Create a task manifest file (exemplary files in [examples/tasks/] (https://github.com/intelsdi-x/snap-plugin-collector-mysql/blob/master/examples/tasks/)):
{
"version": 1,
"schedule": {
"type": "simple",
"interval": "1s"
},
"workflow": {
"collect": {
"metrics": {
"/intel/mysql/*": {}
},
"publish": [
{
"plugin_name": "file",
"config": {
"file": "/tmp/published_mysql"
}
}
]
}
}
}
Create a task:
$ snaptel task create -t examples/tasks/task.json
Stop previously created task:
$ snaptel task stop <task_id>
There isn't a current roadmap for this plugin, but it is in active development. As we launch this plugin, we do not have any outstanding requirements for the next release. If you have a feature request, please add it as an issue and/or submit a pull request.
This repository is one of many plugins in Snap, a powerful telemetry framework. See the full project at http://github.com/intelsdi-x/snap.
To reach out to other users, head to the main framework.
We love contributions!
There's more than one way to give back, from examples to blogs to code updates. See our recommended process in CONTRIBUTING.md.
And thank you! Your contribution, through code and participation, is incredibly important to us.
Snap, along with this plugin, is an Open Source software released under the Apache 2.0 License.
- Author: @Lukasz Mroz