Skip to content

Commit 36f9596

Browse files
committed
Update Grafana Cloud instructions on Readme
1 parent eb58d72 commit 36f9596

6 files changed

+32
-24
lines changed

README.md

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
You can run QuickPizza locally or deploy it to your own infrastructure. For demo purposes, QuickPizza is also publicly available at:
1111
1. [quickpizza.grafana.com](https://quickpizza.grafana.com/)— Use this environment to run small-scale performance tests like the ones in the [k6 folder](./k6/).
12-
2. [quickpizza-demo.grafana.fun](https://quickpizza.grafana.com/) — Install the [SRE Demo environment](https://grafana.com/docs/grafana-cloud/get-started/#install-demo-data-sources-and-dashboards) to observe this deployment, or explore it in [Grafana Play](https://play.grafana.org/d/d2e206e1-f72b-448c-83d8-657831c2ea6d/).
12+
2. [quickpizza-demo.grafana.fun](https://quickpizza-demo.grafana.fun/) — Install the [SRE Demo environment](https://grafana.com/docs/grafana-cloud/get-started/#install-demo-data-sources-and-dashboards) to observe this deployment, or explore it in [Grafana Play](https://play.grafana.org/d/d2e206e1-f72b-448c-83d8-657831c2ea6d/).
1313

1414
The QuickPizza tests showcase key k6 features, from basic usage to custom modules and extensions.
1515

@@ -147,7 +147,7 @@ You will need the following settings:
147147

148148
1. The name of the [Grafana Cloud Stack](https://grafana.com/docs/grafana-cloud/account-management/cloud-portal/#your-grafana-cloud-stack) where the telemetry data will be stored.
149149
2. An [Access Policy Token](https://grafana.com/docs/grafana-cloud/account-management/authentication-and-permissions/access-policies/) that includes the following scopes for the selected Grafana Cloud Stack: `stacks:read`, `metrics:write`, `logs:write`, `traces:write`, and `profiles:write`.
150-
3. The User ID and Endpoint to use for Grafana Cloud Profiles (Pyroscope) for your [Grafana Cloud Stack](https://grafana.com/docs/grafana-cloud/account-management/cloud-portal/#your-grafana-cloud-stack)
150+
3. To enable [Profiling](https://grafana.com/docs/grafana-cloud/monitor-applications/profiles/), go to the Pyroscope profiling service of your [Grafana Cloud Stack](https://grafana.com/docs/grafana-cloud/account-management/cloud-portal/#your-grafana-cloud-stack), and copy the URL, User, and Password.
151151

152152
Then, create an `.env` file with the following environment variables and the values of the previous settings:
153153

@@ -156,11 +156,13 @@ Then, create an `.env` file with the following environment variables and the val
156156
GRAFANA_CLOUD_STACK=name
157157
# Your Grafana Cloud Access Policy Token
158158
GRAFANA_CLOUD_TOKEN=
159-
# The Endpoint to use to send your Profiling Data too
159+
160+
# Optional - Profiling configuration for Grafana Cloud Profiles (Pyroscope)
161+
# Endpoint URL for your Grafana Cloud Stack
160162
QUICKPIZZA_PYROSCOPE_ENDPOINT=
161-
# Your Grafana Cloud Profiles Username for your Grafana Cloud Stack
163+
# Username for Profiles authentication
162164
QUICKPIZZA_GRAFANA_CLOUD_USER=
163-
# Your Grafana Cloud Profiles Password for your Grafana Cloud Stack (this is typically your Grafana Cloud Access Policy Token)
165+
# Password for Profiles authentication (typically your Grafana Cloud Access Policy Token)
164166
QUICKPIZZA_GRAFANA_CLOUD_PASSWORD=${GRAFANA_CLOUD_TOKEN}
165167
```
166168

@@ -172,34 +174,34 @@ docker compose -f docker-compose-cloud.yaml up -d
172174

173175
QuickPizza is available at [localhost:3333](http://localhost:3333). Click the `Pizza, Please!` button and discover some awesome pizzas!
174176

175-
Now, you can log in to [Grafana Cloud](https://grafana.com/products/cloud/) and explore QuickPizza's telemetry data on the Prometheus, Tempo, Loki, and Pyroscope instances of your Grafana Cloud Stack. Refer to [alloy-cloud.river](./contrib/alloy-cloud.river) and [docker-compose-cloud.yaml](./docker-compose-cloud.yaml) to find the labels applied to the telemetry data.
176-
177-
### Enable Profiling (Send profiles to Grafana Cloud Profiles / Pyroscope)
177+
Now, you can log in to [Grafana Cloud](https://grafana.com/products/cloud/) and use **Explore** or **Drilldown apps** to access QuickPizza's telemetry data.
178178

179-
Whenever there is a Pyroscope endpoint provided via the `QUICKPIZZA_PYROSCOPE_ENDPOINT` environment variable, as well as suitable Authentication Credentials, the QuickPizza app will emit and push profiling data to Grafana Cloud Profiles. You can visualize the profiling data with the Grafana Cloud Profiles data source in Grafana Cloud and the [Explore Profiles](https://grafana.com/docs/grafana/latest/explore/simplified-exploration/profiles/) feature.
179+
![Use Metrics Drilldown](./docs/images/grafana-cloud-drilldown-metrics.png)
180180

181-
To enable [Grafana Cloud Profiling](https://grafana.com/docs/grafana-cloud/monitor-applications/profiles/), ensure the following Environment Variables are set in the `.env` file, with values set to match your Grafana Cloud Stack:
181+
![Use Profiles Drilldown](./docs/images/grafana-cloud-drilldown-profiles.png)
182182

183-
- `QUICKPIZZA_PYROSCOPE_ENDPOINT` - The Endpoint to use to send your Profiling Data too for your Grafana Cloud Stack.
184-
- `QUICKPIZZA_GRAFANA_CLOUD_USER` and `QUICKPIZZA_GRAFANA_CLOUD_PASSWORD` are the Basic auth credentials to authenticate with the Grafana Cloud instance.
183+
To find the labels applied to the telemetry data, refer to [alloy-cloud.river](./contrib/alloy-cloud.river) and [docker-compose-cloud.yaml](./docker-compose-cloud.yaml) .
185184

186-
Additional variables are available to configure the Tags/Labels for the Profiles, and support some Grafana Cloud Profiling Integrations;
185+
### Monitor frontend with Grafana Cloud Frontend Observability
187186

188-
- `QUICKPIZZA_PYROSCOPE_NAME` - the value of the `service_name` Label in Grafana Cloud Profiles (uses `quickpizza` by default).
189-
- `QUICKPIZZA_PYROSCOPE_NAMESPACE` - the value of the `namespace` Label in Grafana Cloud Profiles (uses `quickpizza` by default).
190-
- `QUICKPIZZA_PYROSCOPE_SERVICE_GIT_REF` - This allows you to provide the Git Ref for the QuickPizza Source in GitHub, to use with the Go Profiles [GitHub Integration](https://grafana.com/docs/grafana-cloud/monitor-applications/profiles/pyroscope-github-integration/) in Grafana Cloud.
187+
To enable [Grafana Cloud Frontend Observability](https://grafana.com/docs/grafana-cloud/monitor-applications/frontend-observability/) for QuickPizza:
191188

192-
### Enable Frontend Observability (Grafana Faro)
189+
1. In Grafana Cloud, create a new Frontend Observability application and set the domain to `http://localhost:3333`.
190+
2. Copy the application's Faro web URL.
191+
3. In your `.env` file, add the `QUICKPIZZA_CONF_FARO_URL` variable and set its value to your Faro web URL:
193192

194-
Frontend Observability is available exclusively in Grafana Cloud. To enable [Grafana Cloud Frontend Observability](https://grafana.com/docs/grafana-cloud/monitor-applications/frontend-observability/) for QuickPizza, add the `QUICKPIZZA_CONF_FARO_URL` variable to the `.env` file, setting its value to your Faro web URL:
193+
```bash
194+
QUICKPIZZA_CONF_FARO_URL=
195+
```
195196

196-
```bash
197-
QUICKPIZZA_CONF_FARO_URL=
198-
```
197+
4. Restart the `docker-compose-cloud.yaml` environment:
199198

200-
Restart the `docker-compose-cloud.yaml` environment.
199+
```bash
200+
docker compose -f docker-compose-cloud.yaml down
201+
docker compose -f docker-compose-cloud.yaml up -d
202+
```
201203

202-
![Frontend Observability](./docs/images/grafana-cloud-frontend-observability.png)
204+
![Frontend Observability](./docs/images/grafana-cloud-frontend-observability-quickpizza.png)
203205

204206
### Send k6 test results to Grafana Cloud Prometheus and visualize them with prebuilt Grafana dashboards
205207

docker-compose-cloud.yaml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,15 @@ services:
1010
QUICKPIZZA_TRUST_CLIENT_TRACEID: 1
1111
# must be set with an .env file
1212
QUICKPIZZA_CONF_FARO_URL: "${QUICKPIZZA_CONF_FARO_URL}"
13-
QUICKPIZZA_PYROSCOPE_ENDPOINT: "${QUICKPIZZA_CONF_PYROSCOPE_ENDPOINT}"
13+
QUICKPIZZA_PYROSCOPE_ENDPOINT: "${QUICKPIZZA_PYROSCOPE_ENDPOINT}"
1414
QUICKPIZZA_GRAFANA_CLOUD_USER: "${QUICKPIZZA_GRAFANA_CLOUD_USER}"
1515
QUICKPIZZA_GRAFANA_CLOUD_PASSWORD: "${QUICKPIZZA_GRAFANA_CLOUD_PASSWORD}"
16+
# Enable logging. Possible values: error, warn, debug. Default: info
17+
# QUICKPIZZA_LOG_LEVEL: debug
18+
# Service name label in Pyroscope. Default: quickpizza
19+
# QUICKPIZZA_PYROSCOPE_NAME: quickpizza
20+
# Namespace label in Pyroscope. Default: quickpizza
21+
# QUICKPIZZA_PYROSCOPE_NAMESPACE: quickpizza
1622

1723
alloy:
1824
image: grafana/alloy:v1.9.1
286 KB
Loading
249 KB
Loading
164 KB
Loading
-177 KB
Binary file not shown.

0 commit comments

Comments
 (0)