Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luskhq/redux-keen
Redux middleware for sending analytics to Keen.
https://github.com/luskhq/redux-keen
Last synced: 13 days ago
JSON representation
Redux middleware for sending analytics to Keen.
- Host: GitHub
- URL: https://github.com/luskhq/redux-keen
- Owner: luskhq
- Created: 2015-09-20T17:43:22.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2015-10-29T11:35:14.000Z (about 9 years ago)
- Last Synced: 2024-10-02T10:15:32.807Z (about 2 months ago)
- Language: JavaScript
- Size: 174 KB
- Stars: 46
- Watchers: 3
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
redux-keen
==========
[](https://travis-ci.org/pavelvolek/redux-keen)
[](https://www.npmjs.com/package/redux-keen)
[Redux](http://rackt.github.io/redux) middleware for sending analytics to [Keen IO](https://keen.io/).
## Installation
```js
npm install --save redux-keen
```
## Usage
```js
import keenAnalytics from 'redux-keen';
import Keen from 'keen-js';
let keenClient = new Keen({ projectId: 'YOUR_PROJECT_ID', writeKey: 'YOUR_WRITE_KEY' });
let keenMiddleware = keenAnalytics(keenClient);
```
The default export is a function requiring [keen-js](https://github.com/keen/keen-js) client instance. This function returns a middleware function, that can be applied using `applyMiddleware` from [Redux](http://rackt.github.io/redux).
If it receives an action whose `meta` property contains an `analytics` property with non-empty `collection` property, it will record the event in the Keen IO analytics.
### Actions
An action that should be recorded to analytics MUST
- have an `analytics` property inside its `meta` property
- have a `collection` property inside its `analytics` property
and MAY
- have an `event` property inside its `analytics` property
#### `collection`
The required `collection` property inside the `analytics` specifies the Keen IO [event collection](https://keen.io/docs/api/#event-collections).
#### `event`
The optional `event` property inside the `analytics` contains the data of the Keen IO [event](https://keen.io/docs/api/#events).
#### An example of an action:
```js
{
type: ADD_TO_SHOPPING_CART,
payload: item,
meta: {
analytics: {
collection: "add_item_to_shopping_cart"
}
}
}
```
#### An example with optional property `event`:
```js
{
type: ADD_TO_SHOPPING_CART,
payload: item,
meta: {
analytics: {
collection: "add_item_to_shopping_cart",
event: {
item: {
title: item.title,
itemId: item.itemId
}
}
}
}
}
```
### Globals
When setting up analytics with Keen IO, we often want to send some common data (hereinafter referred to as `globals`) with each event (e.g. device information, geolocation, authenticated user, etc.).
The default function that creates keenMiddleware accepts an optional third parameter `getGlobals`.
If provided, `getGlobals` must be a function returning a javascript object. It is called everytime the middleware intercepts a an action with valid analytics property.
```js
let keenMiddleware = keenAnalytics(projectId, writeKey, getGlobals);
```
The redux state is passed as parameter to the provided function. You can use it for example for getting the authenticated user information (see the example bellow).
```js
function getLocationPayload() {
return {
ip_address: '${keen.ip}',
keen: {
addons: [
{
name: 'keen:ip_to_geo',
input: {
ip: 'ip_address'
},
output: 'ip_geo_info'
}
]
}
};
}
function getUserPayload(state) {
const { isSignedIn, user } = state.session;
if (!isSignedIn) {
return {};
}
let userGlobals = {
user: {
name: `${user.firstName} ${user.lastName}`,
userId: user.profileId
}
};
return userGlobals;
}
export default function getGlobals(state) {
const location = getLocationPayload();
const user = getUserPayload(state);
return {
...location,
...user
};
}
```
If `getGlobals` provided the globals are sent by the middleware with each event, even when the action has a valid `analytics` property with the `event` property omitted.