cMeter (Container Meter) provides container hosts with a container metering solution.
$ go get github.com/MustWin/cmeter
$ cmeter agent <config_path>
Example - with development config:
$ cmeter agent ./config.dev.yml
With Docker:
sudo docker run \
--volume=/:/rootfs:ro \
--volume=/var/run:/var/run:rw \
--volume=/sys:/sys:ro \
--volume=/var/lib/docker/:/var/lib/docker:ro \
--env CMETER_REPORTING=http \
--env CMETER_CONTAINERS=embedded \
--detach=true \
--name=cmeter \
containeropsco/cmeter:latest
A configuration file is required for cMeter but environment variables can be used to override configuration. A configuration file can be specified as a parameter or with the CMETER_CONFIG_PATH environment variable.
All configuration environment variables are prefixed by CMETER_
A development configuration file is included: /config.dev.yml and a /config.local.yml has already been added to gitignore to be used for local testing or development.
# configuration schema version number, only `1.0`
version: 1.0
# log stuff
log:
# minimum event level to log: `error`, `warn`, `info`, or `debug`
level: 'debug'
# log output format: `text` or `json`
formatter: 'text'
# custom fields to be added and displayed in the log
fields:
customfield1: 'value'
# tracking stuff
tracking:
# how to identify containers to track
marker:
# name of the an environment variable to look for
env: CMETER_TRACKING
# name of the container label to look for
label: cmeter.tracking
# usage collection stuff
collector:
# The rate at which the collector polls for container usage.
rate: 1800
# The reporting driver and driver parameters
# parameterless form
reporting: 'mock'
# or with driver parameters
reporting:
ctoll:
# default api key to use if label from `key_label` isn't present
apikey: '2390513a-870d-11e6-ae22-56b6b6499611'
endpoint: 'http://api.containerstuff.norg'
# the label with the api key for the container
key_label: 'ctoll_api_key'
# Similar to the reporting driver section
containers:
embedded:
# container label with the value to override the container cpu limit tracked by cmeter (in cpu cores, e.g: '0.002', '0.1', '2.0')
cpu_limit_label: 'cpulimit'
# whitelist of environment variables exposed to cmeter
envs: ['METER_TRACKING']
Both reporting and containers only allow specification of one driver per configuration. Anymore will cause a validation error when the application starts.
If you see a bug or have a suggestion, feel free to open an issue here.
PR's welcome! There are no strict style guidelines, just follow best practices and try to keep with the general look & feel of the code present. All submissions should at least be go fmt -s and have a test to verify (if applicable).
For details on how to extend and develop cSense, see the dev documentation.
The MIT License (MIT) Copyright (c) 2016 MustWin, LLC
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.