CONTRIBUTING.md

Contributing Instructions

Setup

The dependencies are stored in the vendor folder, so no installation is needed.

Setup for updating dependencies

go install github.com/goware/modvendor@latest

Then, make sure Go package executables are on your $PATH. For Homebrew on macOS that is ~/go/bin. If it's working, which modvendor should return the path that modvendor is installed at.

make vendor

Updating dependencies

go get github.com/shirou/gopsutil@latest # updates the version requirement
make vendor                              # updates the vendored code

Compiling and running tests

To compile the collector and helper binaries:

make build

After building the collector you can find the binary in the repository folder:

./pganalyze-collector --help

To run the unit tests:

make test

To run the integration tests:

make integration_test

Note the integration tests require Docker, and will take a while to run through.