Telemetry

This gem provides a wrapper around the Telemetry API (http://www.telemetryapp.com).

Installation

Install on your system:

$ gem install telemetry

Basic Usage

To use this gem you must require it in your file and specify your API Token that you can find on the Telemetry API Token page

Set a hash of values for the flow to update. Each hash must contain the tag of the flow that you want to update. 

require 'telemetry'

Telemetry.token = "test-api-token"

properties = {
    tag: "test-flow-value",
    value: 3434
}
Telemetry::Value.new(properties).emit

For documentation on flows and the properties they support please see the flow documentation pages.

Affiliates

This gem supports affiliate data sending. In order to use this capability call the Telemetry::Api.affiliate_send(flows, unique-identifier) method. You must have an enterprise account and get support to enable your account for affiliates first.

require 'telemetry'

Telemetry.token = "test-api-token"

# Construct a hash with the flow tags as keys and the values as the hash to use to update the data
flows = {
    value_tag: {
        value: 435
    }
}

# Send to the unique identifier for the affiliate as created by you on the affiliate page
Telemetry::Api.affiliate_send(flows, "unique-identifier")

For more information see the affiliate documentation.

Daemon

Telemetry also supports a daemon mode where a binary (telemetryd) runs indefintely and loops through a configuration file triggering updates to the API as it goes.

Create a config file on your disk (by default /etc/telemetryd_config.rb). This file may have ruby code in it, you may include your own gems, etc. The file supports three configuration directives "interval", "api_token" and "flows_expire_in". The interval is how frequently each flow block is executed with the results sent to the server. The flows_expire_in sets the expiry timout of the flows. If they do not get fresh data before that period of time the board will display and expired logo on their widgets. Please note if the result from a block is unchanged from the previous execution then it will be sent to the server only once per day when flows_expire_in is not set.

For more details please see our website.

Example simple config:

interval 5            
flows_expire_in 300
api_token "test-api-token"

gauge "test-flow-gauge" do
    set value: 45
    set max: 100
end

To start the daemon daemonized:

$ telemetryd.rb -d

To kill the daemon:

$ telemetryd.rb -k

Omitting the -d will start the process in the foreground and log to stdout. This is useful for debugging your config file. The daemon can be started with -o to run once and exit.

Custom update intervals are supported on a per flow basis. To configure the update interval append an integer with the number of seconds to update as per the following:

gauge "test-flow-gauge", 86400 do
    set value: 50
end

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request