https://github.com/janajri/analytics-influxdb

Simple analytics logging for InfluxDB
https://github.com/janajri/analytics-influxdb

Last synced: about 1 month ago
JSON representation

Simple analytics logging for InfluxDB

• Host: GitHub
• URL: https://github.com/janajri/analytics-influxdb
• Owner: janajri
• License: mit
• Archived: true
• Created: 2015-04-24T01:40:53.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2021-08-24T13:56:23.000Z (over 3 years ago)
• Last Synced: 2024-09-19T16:35:11.550Z (3 months ago)
• Language: JavaScript
• Size: 9.77 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGE.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-kubernetes - Analytics InfluxDB - Simple analytics logging for InfluxDB, heavily inspired by analytics-node. (Performance)

README

        
[![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)

# DEPRECATED Analytics-InfluxDB

Simple analytics logging for InfluxDB, heavily inspired by [analytics-node](https://github.com/segmentio/analytics-node)

Instantiate a new series queue to begin recording json data

###Install: 

  

  - `npm install analytics-influxdb --save`

###Usage:

``` javascript

	var Analytics = require('analytics-influxdb');

	var Signups = new Analytics("foo", "bar", {

			host: "http://inflxudb.mydomain.com:8086",

			dbName: "production",

			series: "signups"

	});

	var data = {

		username: "greenbeans",

		subscription: "1-month",

		address: {

			street: "1 milky way",

			city: "New York City",

			zip: 10012,

			state: "NY"

		}

	}

	Signups.track(data);

```

Displayed in influxDB as:

| time | host | pid| username | subscription | address.street | address.city | address.zip | address.state |

| ---- | ---| ---- |------- | -----| ------------- | -------------| ------------- | -------------|

| 1429842043737 | api.mydomain.com | 4563 | "greenbeans" | "1-month" | "1 milky way" | "New York City" |  10012 | NY |

* * *

### Analytics(username, password, options) 

Initialize a new `Analytics` with user, pass and and

optional dictionary of `options` including host.

> Note: 

 - All messages being tracked will flatten all nested fields i.e. { top: { nested: 'hi' } } => { "top.nested" : "hi }

 - All messages append process's host, pid, and time upon tracking

**Parameters**

* username: `String`

* password: `String`

* options: `Object`, (optional)

### flush(fn) 

Flush the current queue and callback `fn(err, batch)`.

**Parameters**

* fn: `function`, (optional)

### track(message, fn) 

Add a `message` to the queue and check whether it should be

flushed.

**Parameters**

* message: `Object`, fields

* fn: `Function`, (optional)

* * *