docker-mackerel-agent
Docker image for mackerel-agent
Usage
Basic usage
To launch mackerel-agent image, run this command. Replace <APIKEY>
to your own apikey.
docker run -h `hostname` \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /var/lib/mackerel-agent/:/var/lib/mackerel-agent/ \
-e 'apikey=<APIKEY>' \
-e 'enable_docker_plugin=1' \
--name mackerel-agent \
-d \
mackerel/mackerel-agent
Assign a role
To assign a role, add -role=<SERVICE:ROLE>
to opts
environment variable.
docker run -h `hostname` \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /var/lib/mackerel-agent/:/var/lib/mackerel-agent/ \
-e 'apikey=<APIKEY>' \
-e 'opts=-v -role=<SERVICE:ROLE>' \
--name mackerel-agent \
-d \
mackerel/mackerel-agent
Monitor processes in other containers
If you want to monitor processes on other containers, link
option can be used.
Here is an example for memcached.
- Launch memcached container, which named
memcached
docker run -d -P \
--name memcached -p 11211:11211 \
sylvainlasnier/memcached
- Prepare a configuration file for a memcached plugin, which specifies the host address. This file should be put on the host.
% cat /etc/mackerel-agent/conf.d/memcached.conf
[plugin.metrics.memcached]
command = "/usr/local/bin/mackerel-plugin-memcached -host=$MEMCACHED_PORT_11211_TCP_ADDR"
- Launch mackerel-agent container linking to the memcached container.
-v
andinclude
is to include other configuration files.
docker run -h `hostname` \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /var/lib/mackerel-agent/:/var/lib/mackerel-agent/ \
-e 'apikey=<APIKEY>' \
-e 'enable_docker_plugin=1 \
--link memcached:memcached \
-v /etc/mackerel-agent/conf.d:/etc/mackerel-agent/conf.d:ro \
-e 'include=/etc/mackerel-agent/conf.d/*.conf' \
--name mackerel-agent \
-d \
mackerel/mackerel-agent
Retire the host automatically
If you want to retire a host of a mackerel-agent container on Mackerel when the container stops,
you should set auto_retirement=1
as an environment variable.
If the variable is set, the retirement API is called while terminate process of the containter. See the entry about auto retirement in detail: http://blog.mackerel.io/entry/2015/08/03/142244 .
docker run -h `hostname` \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /var/lib/mackerel-agent/:/var/lib/mackerel-agent/ \
-e 'apikey=<APIKEY>' \
-e 'auto_retirement=1 \
-e 'enable_docker_plugin=1 \
-d \
mackerel/mackerel-agent
Note: replace <APIKEY>
to your own apikey.
"False" value in boolean environmental variables
Boolean environmental variables (auto_retirement
and enable_docker_plugin
) treats empty string and 0
as false, otherwise true.
If you'd like to set false for them, pass 0
like -e 'auto_retirement=0'
or just omit the -e
option for them.