The Hosted Graphite Agent
Our agent is a simple way to get your metrics into Hosted Graphite. You install it on your machines, and it collects and forwards the system’s metrics for you.
Get started by pulling down our installer script.
For Debian-based systems, including Ubuntu:
or for RHEL-based systems:
We support the following stable OS releases on 64-bit machines:
- CentOS 7 forward (covering the RedHat family);
- Debian buster forward;
- Ubuntu 16.04 forward (LTS).
This should cover most installs on RHEL, CentOS, Amazon Linux, and Debian/Ubuntu family platforms.
- Faster submission of metric data from your application because it doesn’t have to do a DNS lookup, or connect out across the internet.
- More reliable delivery because the agent stores-and-forwards, buffering on disk when it can’t connect.
- Easier debugging for the “my metric is missing” problem because our UI can tell you that an agent has stopped responding.
- More secure: the agent uses HTTPS and while we offer TLS-wrapped carbon protocols, it’s more effort to use than the plaintext ones. Sending straight to the agent bypasses this and we take care of it for you.
- No need to prefix your metrics with an API key for HG’s authentication: it’s handled for you, using the API key in the agent config.
- No need to specify new firewall rules for carbon protocols and keep the rules updated - if you can already get HTTPS out of your network, even via a proxy, then it’ll work.
The colored circle representing the State can take 3 values:
- Green: The agent is reporting normally at the correct time.
- Yellow: Agent has not reported in over 20 minutes, or is reporting with the wrong time.
- Red: The agent has reported errors in recent log messages.
An agent’s Clock Offset is the difference between the time reported by the agent and the time recorded on our server. Incorrect time can produce anomalies in metric data so it is advised to keep the agent’s clock accurate.
Base system metrics dashboard
This dashboard can be located and uploaded from our Dashboard Library. It displays many of the metrics reported by the Hosted Graphite agent but can be customized further.
Agent configuration is minimal and done via
/etc/opt/hg-agent/hg-agent.conf.This is used to generate a more complete configuration for
hg-agent.confcontains only an
Note that the agent takes control of
diamondconfiguration: if you want more nuanced control, you can run a separate
diamondinstance or whatever metric collection system you wish. You can still take advantage of the agent’s authentication management and local buffering/forwarding facilities by configuring it to send Graphite data to
You can supply a custom prefix instead of
hg_agent, e.g. to specify a host environment:
If your system requires a proxy to get
HTTPSaccess to the Internet:
If you’d like to keep more spool data for buffering locally during network outages (defaults shown):
Large customers with dedicated Hosted Graphite environments may need to specify metric data and metadata endpoints, e.g. for a cluster
Logs are in
/var/log/hg-agent: you can see the metrics generated by
archive.log, as well as the various daemon logs
$ tail -f /var/log/hg-agent/forwarder.log
You can inspect the agent as a service like any other, e.g. on Ubuntu
$ sudo service hg-agent status
If you’d like to look at things from the agent’s
supervisorpoint of view:
$ sudo /opt/hg-agent/bin/supervisorctl --config=/etc/opt/hg-agent/supervisor.conf status
The sources used to build the agent can be followed at: