https://github.com/instrumental/instrumental_pubnub_example
Example PubNub relay to Instrumental
https://github.com/instrumental/instrumental_pubnub_example
Last synced: 11 months ago
JSON representation
Example PubNub relay to Instrumental
- Host: GitHub
- URL: https://github.com/instrumental/instrumental_pubnub_example
- Owner: Instrumental
- Created: 2014-12-30T15:50:36.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2014-12-30T16:09:47.000Z (over 11 years ago)
- Last Synced: 2025-07-11T16:19:06.659Z (12 months ago)
- Language: Ruby
- Size: 156 KB
- Stars: 1
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
An example Instrumental relay using data received via PubNub. Run via command line, `instrumental_pubnub_relay`.
Will receive messages from your PubNub channel and try to coerce them to Instrumental measurements. By default, each metric
will be prefixed by the hostname of the machine you are running the relay on. You can specify a different prefix via the `-p`
command.
Metrics will be suffixed with the index that they appear in if they are in a Hash or Array. That is to say, if your PubNub message looks like this:
```
{ "foo": 20.0, "baz": [10.0, 5.0] }
```
the metrics sent will look like this:
```
hostname.foo
hostname.baz.0
hostname.baz.1
```
## Command line usage
From help:
```sh
Usage: instrumental_pubnub_relay [options]
-k, --pubnub-subscribe-key KEY Your PubNub subscribe key
-c, --pubnub-channel CHANNEL Your PubNub channel
-i API_KEY, Your Instrumental API key
--instrumental-api-key
-p, --key-prefix PREFIX String to prefix all received metrics with (default: my.hostname)
-l, --log-level LEVEL Log level for output, valid values are: ["debug", "warn", "info", "fatal"]
-v, --version Print version and exit
```