Python Pickle
Intended for slightly more advanced users, the pickle protocol is a more efficient take on the plaintext protocol, and supports sending metrics to Hosted Graphite in batches.
Last updated
Intended for slightly more advanced users, the pickle protocol is a more efficient take on the plaintext protocol, and supports sending metrics to Hosted Graphite in batches.
Last updated
Pickled data forms a list of multi-level tuples:
You’ll need to pack your pickled data into a packet containing a simple header:
Once you’ve formed a list of sufficient size and pickled it, like message above, send the data over a TCP socket to carbon.hostedgraphite.com:2004.
Your API Key is prefixed to the metricname as per regular Python methods:
If you have any trouble or any questions, .
If you would prefer to use a carbon-relay daemon to send metric data to Hosted Graphite, just configure it to use carbon.hostedgraphite.com:2004 as a DESTINATION in your carbon.conf and relay-rules.conf files.
carbon.conf:
relay-rules.conf:
If you’re currently using the carbon-cache daemon and would like to utilize carbon-relay to send your metrics to us and also to your own carbon instance, you will have to send metrics to carbon-relay instead of carbon.
To do this, you have to configure carbon-relay to listen on the port that your current carbon-cache is listening. Then you will need to configure carbon-cache to listen on a new port.
You can then add your carbon-cache instance as a DESTINATION to have carbon-relay forward all metrics to Hosted Graphite AND your local carbon-cache
current carbon.conf:
This should be changed to:
new carbon.conf:
relay-rules.conf
If you want to encrypt the metric data from your Carbon Relay, you can use Stunnel. Carbon-Relay should be configured to send metrics to Stunnel over localhost
To install Stunnel:
Configuring Stunnel
Stunnel will need a configuration file. By default, Stunnel will look at /etc/stunnel/stunnel.conf. You may need to create this file yourself.
Put the following lines inside /etc/stunnel/stunnel.conf:
foreground = yes
This shows the degbug logs. You may want to remove this line once Stunnel is configured and running correctly.
accept = <port>
Carbon relay must be configured to send metrics to <port>.
connect = 72c4f55b.carbon.hostedgraphite.com:20040
Hosted Graphite will accept Stunnel connections on port 20040
CAfile / CApath
You only need one of these. You will need to provide a path to your ssl certificates.
CAfile expects a certificate file. Some of the default locations of these files are:
CApath expects a directory containing certificates named XXXXXXXX.0 where XXXXXXXX is the hash value of the DER encoded subject of the cert.
Reconfiguring Carbon-Relay
Carbon relay needs to send metrics to Stunnel now.
carbon.conf:
relay-rules.conf:
Now start Stunnel:
Note: If your package manager downloaded stunnel4, you may have to start stunnel with:
If you’re doing this and you’d like to avoid prefixing every metric with your API key, please , including IP whitelisting, reach out for our live chat support.
You can read more about Stunnel configuration options .