jagoda / lurker

Workflow analytics

lurker

Workflow analytics.

Overview

Prerequisites:

• influxdb

lurker collects metrics about process workflows and facilitates the creation of reports based on these metrics. Assuming the prerequisites are installed, the server can be setup using the following:

git clone https://github.com/jagoda/lurker.git /opt/lurker
cd /opt/lurker
npm install
export INFLUXDB_URL="<your influxdb database>"
export GITHUB_ORGANIZATION="GitHub organization"
export GITHUB_SECRET="a shared secret"
npm start

The GITHUB_SECRET environment variable is required in order for lurker to verify webhook requests. The GITHUB_ORGANIZATION environment variable specifies which GitHub organization's members will be allowed to access the status UI. The port that the server listens on can also be configured using the PORT environment variable.

Supported Webhooks

Hook	Endpoint
GitHub	/github

lurker's Issues

Use GitHub OAuth web flow for web UI auth

The Lurker web UI should allow logging in via GitHub. Any REST APIs should use a token scheme.

Rework server load to use the programmatic approach instead of a manifest.

lurker currently does not take advantage of multi-server packs. Furthermore, the maintainers of the hapi project are considering removing multi-pack support. Server configuration is more flexible when using the programmatic approach. This change may be sufficient to address #4 as well.

Jira webhook

Need to collect Jira events similar to how GitHub events are being collected.

Set content type for config.js

config.js is currently being served as text/html. This should be text/javascript.

Migrate from Cube to Grafana for UI reporting

The original approach for Lurker was to use Cube for the time series database. Cube had a built-in reporting interface that was insecure. The Lurker UI provides a secure wrapper around this interface. Now that Influx is being adopted, the UI should package Grafana instead.

Make all configuration parameters optional.

All configuration is done via environment variables. Having required environment variables is not ideal for development and simple deployments.

Admin UI

Currently, a webhook configuration needs to be manually added to projects in GitHub for metrics to be collected. This is tedious and difficult to keep track of. Lurker should provide a web UI that allows managing metric collection settings from a centralized and easy to use dashboard.