vossibility-collector
Vossibility-collector is the core component of vossibility,
a project providing better visibility for your open source project. The project was initially
started for Docker but is not tied to it in any way.
Overview
Vossibility-collector receives live GitHub data from a NSQ queue and the GitHub
API on one end, and feeds structured data to Elastic Search on
the other end. It provides:
- The power of Elastic Search to search into your repository (e.g., "give me all pull requests
comments from a user who's name is approximately ice and contains LGTM"). - The power of Kibana to build dashboards for your project: a basic example of what can be achieved
is shown below.
Usage
NAME:
vossibility-collector - collect GitHub repository data
USAGE:
vossibility-collector [global options] command [command options] [arguments...]
VERSION:
0.1.0
COMMANDS:
limits get information about your GitHub API rate limits
run listen and process GitHub events
sync sync storage with the GitHub repositories
sync_mapping sync the configuration definition with the store mappings
sync_users sync the user store with the information from a file
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
-c, --config "config.toml" configuration file
--debug enable debug output
--debug-es enable debug output for elasticsearch queries
--help, -h show help
--version, -v print the version
Documentation
Document, Description
-----------, --------------------------------------------------------------------------------------
installation.md, Installation guide
configuration.md, Configuring vossibility