micro-analytics / adapter-redis

Redis adapter for micro-analytics

micro-analytics 📈

Public analytics as a Node.js microservice, no sysadmin experience required.

A tiny analytics server, easy to run and hack around on. It does one thing, and it does it well: count the views of something and making the views publicly accessible via an API. It supports custom database adapters so you can use your storage engine of choice.

(there is currently no frontend to display pretty graphs, feel free to build one yourself!)

This is a lerna repo with several packages in the same repository. There is more info in on each package in their subfolder:

micro-analytics-cli

The main package used to run micro-analytics.

npm install -g micro-analytics-cli
micro-analytics --help

micro-analytics-adapter-utils

A package that contains several useful utilities and tests that will make it easier to create storage adapters.

micro-analytics-adapter-flat-file-db

The default storage adapter. It stores the data in a single file. This adapter is automatically installed by micro-analytics-cli.

micro-analytics-adapter-memory

A storage adapter that keeps everything in memory, when using this all data will be lost when the app restarts.

Community adapters

• micro-analytics-adapter-redis
• micro-analytics-adapter-mongodb
• micro-analytics-adapter-postgres

Demo

We have a demo instance on demo.micro-analytics.io automatically deploys the master branch from this repository. Feel free to use it to test your clients.

License

Copyright ©️ 2017 Maximilian Stoiber & Rolf Erik Lekang, licensed under the MIT License. See license.md for more information.

adapter-redis's Issues

Add support for cli options

Transfer to micro-analytics organization

Since this project is getting more attention than I expected, I've created the @micro-analytics organization on GitHub and invited you as a collaborator. (and @sean-roberts)

We should transfer this repo over and then rename it to "adapter-redis"!

Syntax error 😢

Running against the current master branch of micro-analytics:

❯ DB_ADAPTER=redis ./cli.js       

> [email protected] start /path/micro-analytics
> micro dist/index.js "/usr/bin/node" "/path/micro-analytics/cli.js"

micro: Error when importing /path/micro-analytics/dist/index.js: /path/micro-analytics/node_modules/micro-analytics-adapter-redis/index.js:24

          ),
          ^
SyntaxError: Unexpected token )

Add configuring of the redis connection

Environment variable MAA_REDIS_DB_CONFIG that contains a json string wich is parsed and sent to ioredis.

uhm, tests? 🤔

Should write some tests ✌️

Setup Travis CI

Add support for `subscribe`

From micro-analytics documentation:

subscribe(pathname?: string): Observable

Should return an Observable (based on the proposed ECMAScript spec) which pings micro-
analytics whenever a key changes.

If a pathname is passed it should have the same behaviour as getAll, where it listens to all keys that start with the passed pathname.

Usage

const subscription = adapter.subscribe('/hello')({
 next(val) {/* Send new value */},
 error(err) {/* Send error */},
 complete() {/* Cleanup after unsubscription */},
})

// At any time

subscription.unsubscribe()

Add configuring of the hash key

Environment variable: MAA_REDIS_HASH_KEY

Support before and after options

Adapter should react on before and after options like adapter-flat-file-db.

Wanna send PR on this week.

Add documentation in the readme

PORT env variable

It would be sweet to be able to specify the port the database is running at, right?