From 2322f8a695ec2b603aa3050318946f8b95c1a1da Mon Sep 17 00:00:00 2001 From: Bryan Huhta Date: Wed, 28 Aug 2024 16:02:24 -0700 Subject: [PATCH 1/3] A caution admontion about which url to use --- .../sources/view-and-analyze-profile-data/profile-cli.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/sources/view-and-analyze-profile-data/profile-cli.md b/docs/sources/view-and-analyze-profile-data/profile-cli.md index 74912c5a3e..e1d82d47cb 100644 --- a/docs/sources/view-and-analyze-profile-data/profile-cli.md +++ b/docs/sources/view-and-analyze-profile-data/profile-cli.md @@ -109,6 +109,9 @@ export PROFILECLI_PASSWORD= profilecli ``` +{{< admonition type="caution" >}} +If you're querying data from Grafana Cloud Profiles, be sure to use the url of your Grafana Cloud Pyroscope server in `PROFILECLI_URL` (e.g. `https://profiles-prod-001.grafana.net`) and **not** the url of your Grafana Cloud tenant (e.g. `.grafana.net`). +{{< /admonition >}} ## Uploading a profile to a Pyroscope server using `profilecli` @@ -285,8 +288,8 @@ By default, it looks for samples within the last hour, though this can be contro - You can provide a label selector using the `--query` flag, for example, `--query='{service_name="my_application_name"}'`. - You can provide a custom time range using the `--from` and `--to` flags, for example, `--from="now-3h" --to="now"`. - You can specify the profile type via the `--profile-type` flag. The available profile types are listed in the output of the `profilecli query series` command. - - You can specify the number of leaf locations to keep via the `--keep-locations` flag. The default value is `5`. Go compiler does not use the full stack trace. Reducing the number helps to minimize the profile size. - - You can specify whether the callee aggregation should be used via the `--aggregate-callees` flag. By default, samples are aggregated by the leaf location, ignoring callee line number. Go compiler ignores this information. + - You can specify the number of leaf locations to keep via the `--keep-locations` flag. The default value is `5`. Go compiler does not use the full stack trace. Reducing the number helps to minimize the profile size. + - You can specify whether the callee aggregation should be used via the `--aggregate-callees` flag. By default, samples are aggregated by the leaf location, ignoring callee line number. Go compiler ignores this information. 2. Construct and execute the command. @@ -295,7 +298,7 @@ By default, it looks for samples within the last hour, though this can be contro export PROFILECLI_URL=https://profiles-prod-001.grafana.net export PROFILECLI_USERNAME=my_username export PROFILECLI_PASSWORD=my_password - + profilecli query go-pgo \ --query='{service_name="my_service"}' \ --from="now-1h" --to="now" From e142c493fd9070f7d5971cf590e4d939184ac53b Mon Sep 17 00:00:00 2001 From: Bryan Huhta <32787160+bryanhuhta@users.noreply.github.com> Date: Wed, 28 Aug 2024 18:38:42 -0500 Subject: [PATCH 2/3] Fix grammar Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> --- docs/sources/view-and-analyze-profile-data/profile-cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/view-and-analyze-profile-data/profile-cli.md b/docs/sources/view-and-analyze-profile-data/profile-cli.md index e1d82d47cb..538c3aac01 100644 --- a/docs/sources/view-and-analyze-profile-data/profile-cli.md +++ b/docs/sources/view-and-analyze-profile-data/profile-cli.md @@ -288,7 +288,7 @@ By default, it looks for samples within the last hour, though this can be contro - You can provide a label selector using the `--query` flag, for example, `--query='{service_name="my_application_name"}'`. - You can provide a custom time range using the `--from` and `--to` flags, for example, `--from="now-3h" --to="now"`. - You can specify the profile type via the `--profile-type` flag. The available profile types are listed in the output of the `profilecli query series` command. - - You can specify the number of leaf locations to keep via the `--keep-locations` flag. The default value is `5`. Go compiler does not use the full stack trace. Reducing the number helps to minimize the profile size. + - You can specify the number of leaf locations to keep via the `--keep-locations` flag. The default value is `5`. The Go compiler does not use the full stack trace. Reducing the number helps to minimize the profile size. - You can specify whether the callee aggregation should be used via the `--aggregate-callees` flag. By default, samples are aggregated by the leaf location, ignoring callee line number. Go compiler ignores this information. 2. Construct and execute the command. From d41c898149507c24a1d5fe55f3a23435bdb27376 Mon Sep 17 00:00:00 2001 From: Bryan Huhta Date: Wed, 28 Aug 2024 16:40:46 -0700 Subject: [PATCH 3/3] Use Cloud Profiles and not Grafana Cloud Pyroscope --- docs/sources/view-and-analyze-profile-data/profile-cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/view-and-analyze-profile-data/profile-cli.md b/docs/sources/view-and-analyze-profile-data/profile-cli.md index 538c3aac01..440be9f9a1 100644 --- a/docs/sources/view-and-analyze-profile-data/profile-cli.md +++ b/docs/sources/view-and-analyze-profile-data/profile-cli.md @@ -110,7 +110,7 @@ profilecli ``` {{< admonition type="caution" >}} -If you're querying data from Grafana Cloud Profiles, be sure to use the url of your Grafana Cloud Pyroscope server in `PROFILECLI_URL` (e.g. `https://profiles-prod-001.grafana.net`) and **not** the url of your Grafana Cloud tenant (e.g. `.grafana.net`). +If you're querying data from Cloud Profiles, be sure to use the url of your Cloud Profiles server in `PROFILECLI_URL` (e.g. `https://profiles-prod-001.grafana.net`) and **not** the url of your Grafana Cloud tenant (e.g. `.grafana.net`). {{< /admonition >}} ## Uploading a profile to a Pyroscope server using `profilecli`