performanceplatform-collector 0.1.2

Using pip

$ pip install performanceplatform-collector

From source

$ git clone https://github.com/alphagov/performanceplatform-collector.git
$ cd performanceplatform-collector
$ virtualenv venv
$ source venv/bin/activate
$ python setup.py install

Configuration

There are four configuration files that get injected into pp-collector and are the four required parameters:

• Query, contains everything about what the collector will do during execution. It provides an entrypoint that pp-collector will execute and provide the query and options k-v pairs:

  {
    "entrypoint": "performanceplatform.collector.pingdom",
    "query": {
      "name": "govuk"
    },
    "options": { },
    "data-set": {
      "data-group": "my-data-group",
      "data-set": "my-data-set"
    }
  }

• Token, this holds the bearer token to be used by this collector when POSTing to the Performance Platform:

  {
    "token": "some long hex value"
  }

• Credentials, passes through any usernames, passwords, API keys etc… that are required to communicate to the third party service you desire.

• Backdrop, where backdrop lives:

  {
    "url": "https://www.performance.service.gov.uk/data"
  }

For our deployment of performanceplatform-collector we pull in deployment from performanceplatform-collector-config repo. You will find much more indepth information about the collector configuration in the repos README.