Skip to content

Commit

Permalink
README: update section on how to enable Faro
Browse files Browse the repository at this point in the history
  • Loading branch information
roobre committed Aug 31, 2023
1 parent d31aae5 commit 13dce41
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,6 @@ If you are running the xk6-disruptor test, Kubernetes needs to be setup and `min

- [Minikube](https://minikube.sigs.k8s.io/docs/start/)

## Enable Grafana Faro

To enable Grafana Faro and monitor frontend observability, simply add the Grafana Faro SDK URL in your .env file

```
# copy to pkg/web .env file
PUBLIC_FARO_WEBSDK_URL=<your faro web URL>
```
## Run locally with Docker

To run the app locally with Docker, run the command:
Expand Down Expand Up @@ -127,6 +119,15 @@ docker run --rm -i -p 3333:3333 -e QUICKPIZZA_OTLP_ENDPOINT=http://grafana-agent

The `QUICKPIZZA_TRUST_CLIENT_TRACEID` environment variable instructs QuickPizza to trust client-provided Trace IDs, so all client-generated spans (if any) will show up in the trace.

## Enable Grafana Faro

To enable Grafana Faro and monitor frontend observability, stop the QuickPizza container if it's already running and set `QUICKPIZZA_CONF_FARO_URL` to your Faro web URL:

```bash
export QUICKPIZZA_CONF_FARO_URL="<your faro url>"
docker run --rm -it -p 3333:3333 -e QUICKPIZZA_CONF_FARO_URL ghcr.io/grafana/quickpizza-local:latest
```

## Deploy application to Kubernetes

If you want to run a test that uses xk6-disruptor, or want to experiment with distributed tracing, you will need to deploy QuickPizza to Kubernetes. This section explains how to deploy QuickPizza to a local Kubernetes cluster using minikube, which you can run on your own machine if you use Linux, MacOS, or Windows.
Expand Down

0 comments on commit 13dce41

Please sign in to comment.