Skip to content

Latest commit

 

History

History
153 lines (104 loc) · 5.08 KB

README.md

File metadata and controls

153 lines (104 loc) · 5.08 KB
Raw

Contributing

Welcome! We're excited that you're interested in contributing. Below are some basic guidelines.

Workflow

Grafana Pyroscope follows a standard GitHub pull request workflow. If you're unfamiliar with this workflow, read the very helpful Understanding the GitHub flow guide from GitHub.

You are welcome to create draft PRs at any stage of readiness - this can be helpful to ask for assistance or to develop an idea. But before a piece of work is finished it should:

  • Be organised into one or more commits, each of which has a commit message that describes all changes made in that commit ('why' more than 'what' - we can read the diffs to see the code that changed).
  • Each commit should build towards the whole - don't leave in back-tracks and mistakes that you later corrected.
  • Have unit for new functionality or tests that would have caught the bug being fixed.
  • If you have made any changes to flags, configs and/or protobuf definitions, run make generate and commit the changed files.

Requirement

To be able to run make targets you'll need to install:

All other required tools will be automatically downloaded $(pwd)/.tmp/bin.

If you need a new CLI, we recommend you follow the same pattern and downloads requirement from the makefile.

Formatting

Grafana Pyroscope uses golang-ci-lint tool to format the Go files, and sort imports. We use goimports with -local github.com/grafana/pyroscope parameter, to put Grafana Pyroscope internal imports into a separate group. We try to keep imports sorted into three groups: imports from standard library, imports of 3rd party packages and internal Grafana Pyroscope imports. Goimports will fix the order, but will keep existing newlines between imports in the groups. Avoid introducing newlines there.

Use make lint to ensure formatting is correct.

Building Grafana Pyroscope

To build:

make go/bin

To run the unit tests suite:

make go/test

To build the docker image use:

make docker-image/pyroscope/build

This target uses the go/bin target to first build binaries to include in the image. Make sure to pass the correct GOOS and GOARCH env variables.

amd64 builds

make GOOS=linux GOARCH=amd64 docker-image/pyroscope/build

arm64 builds

make IMAGE_PLATFORM=linux/arm64 GOOS=linux GOARCH=arm64 docker-image/pyroscope/build

Apple arm64 builds (M1/M2 chips)

If you encounter errors during the installation of the node packages due to missing arm64 build of canvas:

brew install pkg-config cairo pango libpng jpeg giflib librsvg

See Automattic/node-canvas#1662

Running examples locally

replace image: grafana/pyroscope with the local tag name you got from docker-image/pyroscope/build (i.e):

  pyroscope:
    image: us.gcr.io/kubernetes-dev/pyroscope:main-470125e1-WIP
    ports:
      - '4040:4040'

Front end development

Versions for development tools:

  • Node v18
  • Yarn v1.22

The front end code is all located in the public/app directory, although its plugin.json file exists at the repository root.

To run the local front end source code:

yarn 
yarn dev

This will install / update front end dependencies and launch a process that will build the front end code, launch a pyroscope web app service at http://localhost:4041, and keep that web app updated any time you save the front end source code. The resulting web app will not initially be connected to a pyroscope server, so all attempts to fetch data will fail.

To launch a pyroscope server for development purposes:

yarn backend:dev

This yarn script actually runs the following:

make build run 'PARAMS=--config.file ./cmd/pyroscope/pyroscope.yaml'

It will take a while for this process to build and start serving pyroscope data, but once it is fully active, the pyroscope web app service at http://localhost:4041 will be able to interact with it.

Dependency management

We use Go modules to manage dependencies on external packages. However we don't commit the vendor/ folder.

To add or update a new dependency, use the go get command:

# Pick the latest tagged release.
go get example.com/some/module/pkg

# Pick a specific version.
go get example.com/some/module/pkg@vX.Y.Z

Tidy up the go.mod and go.sum files:

make go/mod

Commit the changes to go.mod and go.sum before submitting your pull request.

Documentation

The Grafana Pyroscope documentation is compiled into a website published at grafana.com.

To start the website locally you can use make docs/docs and follow console instructions to access the website.

Note: if you attempt to view pages on Github, it's likely that you might find broken links or pages. That is expected and should not be addressed unless it is causing issues with the site that occur as part of the build.