Skip to content

Commit

Permalink
Update contribution guide to mention embedded Grafana
Browse files Browse the repository at this point in the history
  • Loading branch information
simonswine committed Aug 21, 2024
1 parent e261781 commit 8e06fb4
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/internal/contributing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ a piece of work is finished it should:

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

- [Go](https://go.dev/doc/install) (> 1.19)
- [Go](https://go.dev/doc/install) (>= 1.21)
- [Docker](https://docs.docker.com/engine/install/)

All other required tools will be automatically downloaded `$(pwd)/.tmp/bin`.
Expand Down Expand Up @@ -86,6 +86,16 @@ replace `image: grafana/pyroscope` with the local tag name you got from docker-i
- '4040:4040'
```

#### Run with Pyroscope with embedded Grafana + Explore Profiles

In order to quickly test the whole stack it is possible to run an embedded Grafana by using target parameter:

```
go run ./cmd/pyroscope --target all,embedded-grafana
```

This will start additional to Pyroscope on `:4040`, the embedded Grafana on port `:4041`.

#### Front end development

**Versions for development tools**:
Expand Down

0 comments on commit 8e06fb4

Please sign in to comment.