https://github.com/venkatperi/json2graphite
Command-line tool to send JSON metrics data to Graphite/Carbon.
https://github.com/venkatperi/json2graphite
command-line-tool graphite graphite-carbon json metrics
Last synced: 2 months ago
JSON representation
Command-line tool to send JSON metrics data to Graphite/Carbon.
- Host: GitHub
- URL: https://github.com/venkatperi/json2graphite
- Owner: venkatperi
- Created: 2018-07-19T23:00:06.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-07-24T01:26:07.000Z (almost 7 years ago)
- Last Synced: 2025-03-13T00:32:39.513Z (3 months ago)
- Topics: command-line-tool, graphite, graphite-carbon, json, metrics
- Language: JavaScript
- Homepage:
- Size: 31.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# json2graphite
### Send JSON metrics to Graphite
`json2Graphite` is a command line utility that sends metrics data in `JSON` format to a `Graphite`/`Carbon` server.
By default, `json2Graphite` reads metrics data from `stdin`.
# Installation
Install with npm
```shell
npm install -g json2graphite
```
# Usage
```bash
$ json2graphite
Options:
--help Show help [boolean]
--version Show version number [boolean]
--prefix, -x Prefix added to each key. Can be nested (e.g. system.values)
--host, -h Graphite host. [required]
--port, -p Graphite port. [default: 2003]
--metrics, -m JSON metrics to send to graphite. Reads from STDIN by
default. [default: "-"]
--timestamp, -t Timestamp
```
Send JSON metrics
```bash
$ json2graphite --host 127.0.0.1 --metrics '{"cpu": "0.25", "memory":"2GB"}'
# plaintext metrics sent to graphite ==>
cpu 0.25 1532384798
memory 2GB 1532384798
```
Read JSON from STDIN
```bash
$ echo '{"cpu": "0.25", "memory":"2GB"}' | json2graphite --host 127.0.0.1
# plaintext metrics sent to graphite ==>
cpu 0.25 1532384798
memory 2GB 1532384798
```
Specify a timestamp
```bash
$ json2graphite --host 127.0.0.1 --metrics '{"cpu": "0.25", "memory":"2GB"}' --timestamp 1532384500000
# plaintext metrics sent to graphite ==>
cpu 0.25 1532384500
memory 2GB 1532384500
```
Specify a prefix for metrics
```bash
$ json2graphite --host 127.0.0.1 --metrics '{"cpu": "0.25", "memory":"2GB"}' --prefix "servers.host1"
# plaintext metrics sent to graphite ==>
servers.host1.cpu 0.25 1532385129
servers.host1.memory 2GB 1532385129
```
# API
## Install via NPM
Add `json2graphite` to your project:
```bash
npm install --save json2Graphite
```
Require it:
```javascript
const json2Graphite = require('json2Graphite')
```
### json2Graphite(opts)
`opts` `{Object}` can be:
* `host` - `{String}` IP or address of the Graphite host. Required.
* `port` - `{Number}` Graphite server port. Default `2003`.
* `metrics` - `Object` The metrics to send to Graphite. Required.
* `prefix` - `{String}` Prefix in dot notation prepended to each metric's path.
* `timestamp` - `{Number}` Timestamp to use. Default `Date.now()` .
Returns a `Promise` which resolves on success or rejects with the `Error` on failure.