Skip to content

Commit 037d7fc

Browse files
knylander-grafanabryanhuhta
knylander-grafana
and
bryanhuhta
authored
[DOC] Add doc for finding URL, password, and user in Cloud Profiles (#4352)
* Add doc for finding URL, pw, user in Cloud Profiles * Apply suggestions from code review Co-authored-by: Bryan Huhta <[email protected]> --------- Co-authored-by: Bryan Huhta <[email protected]>
1 parent 0b02657 commit 037d7fc

File tree

8 files changed

+79
-3
lines changed

8 files changed

+79
-3
lines changed

‎docs/sources/configure-client/language-sdks/dotnet.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,3 +204,10 @@ To configure the .NET SDK to send data to Grafana Cloud Profiles or Pyroscope, r
204204
If you need to send data to Grafana Cloud, you'll have to configure HTTP Basic authentication. Replace `<User>` with your Grafana Cloud stack user and `<Password>` with your Grafana Cloud API key.
205205

206206
If your open source Pyroscope server has multi-tenancy enabled, you'll need to specify a tenant ID. Replace `<TenantID>` with your Pyroscope tenant ID.
207+
208+
### Locate the URL, user, and password in Grafana Cloud Profiles
209+
210+
[//]: # 'Shared content for URl location in Grafana Cloud Profiles'
211+
[//]: # 'This content is located in /pyroscope/docs/sources/shared/locate-url-pw-user-cloud-profiles.md'
212+
213+
{{< docs/shared source="pyroscope" lookup="locate-url-pw-user-cloud-profiles.md" version="latest" >}}

‎docs/sources/configure-client/language-sdks/go_push.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Alternatively, if you want more control over the profiling process, you can manu
8989

9090
```go
9191
profiler, err := pyroscope.Start(pyroscope.Config{
92-
// omitted for brevity
92+
// omitted for brevity
9393
})
9494
if err != nil {
9595
// the only reason this would fail is if the configuration is not valid
@@ -178,6 +178,13 @@ pyroscope.Start(pyroscope.Config{
178178
})
179179
```
180180

181+
### Locate the URL, user, and password in Grafana Cloud Profiles
182+
183+
[//]: # 'Shared content for URl location in Grafana Cloud Profiles'
184+
[//]: # 'This content is located in /pyroscope/docs/sources/shared/locate-url-pw-user-cloud-profiles.md'
185+
186+
{{< docs/shared source="pyroscope" lookup="locate-url-pw-user-cloud-profiles.md" version="latest" >}}
187+
181188
### Option: Use `DisableGCRuns` for handling increased memory usage
182189

183190
Pyroscope may require additional resources when tracking a lot of objects. For example, a Go service that indexes large amounts of data requires more memory.

‎docs/sources/configure-client/language-sdks/java.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ The Java integration supports JFR format to be able to support multiple events (
178178
| `PYROSCOPE_PROFILER_LOCK` | Sets the threshold to register lock events, in nanoseconds (equivalent to `--lock=` in `async-profiler`). The default value is `""` - empty string, which means that lock profiling is disabled. Setting it to `0` will register every event, causing significant CPU and network overhead, making it not suitable for production environments. We recommend setting a starting value of 10ms and adjusting it as needed. |
179179
| `PYROSCOPE_UPLOAD_INTERVAL` | Sets the interval for uploading profiling data. The default is `10s`. |
180180
| `PYROSCOPE_JAVA_STACK_DEPTH_MAX` | Sets the maximum stack depth. The default is `2048`. |
181-
| `PYROSCOPE_SERVER_ADDRESS` | Address of the Pyroscope server. The default is `http://localhost:4040` |
181+
| `PYROSCOPE_SERVER_ADDRESS` | Address of the Pyroscope server. The default is `http://localhost:4040` |
182182
| `PYROSCOPE_CONFIGURATION_FILE` | Sets an additional properties configuration file. The default value is `pyroscope.properties`. |
183183
| `PYROSCOPE_BASIC_AUTH_USER` | HTTP Basic authentication username. The default value is `""` - empty string, no authentication. |
184184
| `PYROSCOPE_BASIC_AUTH_PASSWORD` | HTTP Basic authentication password. The default value is `""` - empty string, no authentication. |
@@ -218,7 +218,14 @@ If you need to send data to Grafana Cloud, you'll have to configure HTTP Basic a
218218

219219
If your Pyroscope server has multi-tenancy enabled, you'll need to configure a tenant ID. Replace `<TenantID>` with your Pyroscope tenant ID.
220220

221-
#### Example configurations
221+
### Locate the URL, user, and password in Grafana Cloud Profiles
222+
223+
[//]: # 'Shared content for URl location in Grafana Cloud Profiles'
224+
[//]: # 'This content is located in /pyroscope/docs/sources/shared/locate-url-pw-user-cloud-profiles.md'
225+
226+
{{< docs/shared source="pyroscope" lookup="locate-url-pw-user-cloud-profiles.md" version="latest" >}}
227+
228+
### Example configurations
222229

223230
The following configuration sets application name, Pyroscope format, profiling interval, event, and lock.
224231
This example is an excerpt from the [`rideshare` Dockerfile](https://github.com/grafana/pyroscope/blob/main/examples/language-sdk-instrumentation/java/rideshare/Dockerfile#L24-L34) available in the Pyroscope repository.

‎docs/sources/configure-client/language-sdks/nodejs.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,13 @@ If you need to send data to Grafana Cloud, you’ll have to configure HTTP Basic
137137

138138
If your Pyroscope server has multi-tenancy enabled, you’ll need to configure a tenant ID. Replace `tenantID` with your Pyroscope tenant ID.
139139

140+
### Locate the URL, user, and password in Grafana Cloud Profiles
141+
142+
[//]: # 'Shared content for URl location in Grafana Cloud Profiles'
143+
[//]: # 'This content is located in /pyroscope/docs/sources/shared/locate-url-pw-user-cloud-profiles.md'
144+
145+
{{< docs/shared source="pyroscope" lookup="locate-url-pw-user-cloud-profiles.md" version="latest" >}}
146+
140147
## Troubleshoot
141148

142149
Setting `DEBUG` env to `pyroscope` provides additional debugging information.

‎docs/sources/configure-client/language-sdks/python.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,13 @@ If you need to send data to Grafana Cloud, you'll have to configure HTTP Basic a
115115

116116
If your Pyroscope server has multi-tenancy enabled, you'll need to configure a tenant ID. Replace `<TenantID>` with your Pyroscope tenant ID.
117117

118+
### Locate the URL, user, and password in Grafana Cloud Profiles
119+
120+
[//]: # 'Shared content for URl location in Grafana Cloud Profiles'
121+
[//]: # 'This content is located in /pyroscope/docs/sources/shared/locate-url-pw-user-cloud-profiles.md'
122+
123+
{{< docs/shared source="pyroscope" lookup="locate-url-pw-user-cloud-profiles.md" version="latest" >}}
124+
118125
## Python profiling examples
119126

120127
Check out the following resources to learn more about Python profiling:

‎docs/sources/configure-client/language-sdks/ruby.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,13 @@ If you need to send data to Grafana Cloud, you'll have to configure HTTP Basic a
102102

103103
If your Pyroscope server has multi-tenancy enabled, you'll need to configure a tenant ID. Replace `<TenantID>` with your Pyroscope tenant ID.
104104

105+
### Locate the URL, user, and password in Grafana Cloud Profiles
106+
107+
[//]: # 'Shared content for URl location in Grafana Cloud Profiles'
108+
[//]: # 'This content is located in /pyroscope/docs/sources/shared/locate-url-pw-user-cloud-profiles.md'
109+
110+
{{< docs/shared source="pyroscope" lookup="locate-url-pw-user-cloud-profiles.md" version="latest" >}}
111+
105112
## Ruby profiling examples
106113

107114
Check out the following resources to learn more about Ruby profiling:

‎docs/sources/configure-client/language-sdks/rust.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,13 @@ request to the server might be missed if the agent is not shutdown properly.
8686
agent_ready.shutdown();
8787
```
8888

89+
### Locate the URL, user, and password in Grafana Cloud Profiles
90+
91+
[//]: # 'Shared content for URl location in Grafana Cloud Profiles'
92+
[//]: # 'This content is located in /pyroscope/docs/sources/shared/locate-url-pw-user-cloud-profiles.md'
93+
94+
{{< docs/shared source="pyroscope" lookup="locate-url-pw-user-cloud-profiles.md" version="latest" >}}
95+
8996
## Add profiling labels to Rust applications
9097

9198
Tags can be added or removed after the agent is started. As of 0.5.0, the

‎docs/sources/shared/locate-url-pw-user-cloud-profiles.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
headless: true
3+
description: Shared file for available profile types.
4+
---
5+
6+
[//]: # 'This file where to locate the username, password, and URL in Cloud Profiles.'
7+
[//]: # 'This shared file is included in these locations:'
8+
[//]: # '/website/docs/grafana-cloud/monitor-applications/profiles/send-profile-data.md'
9+
[//]: #
10+
[//]: #
11+
[//]: # 'If you make changes to this file, verify that the meaning and content are not changed in any place where the file is included.'
12+
[//]: # 'Any links should be fully qualified and not relative: /docs/grafana/ instead of ../grafana/.'
13+
14+
<!-- Locate your stack's URL, user, and password -->
15+
16+
When you configure Alloy or your SDK, you need to provide the URL, user, and password for your Grafana Cloud stack.
17+
This information is located in the **Pyroscope** section of your Grafana Cloud stack.
18+
19+
1. Navigate to your Grafana Cloud stack.
20+
1. Select **Details** next to your stack.
21+
1. Locate the **Pyroscope** section and select **Details**.
22+
1. Copy the **URL**, **User**, and **Password** values in the **Configure the client and data source using Grafana credentials** section.
23+
![Locate the SDK or Grafana Alloy configuration values](/media/docs/pyroscope/cloud-profiles-url-user-password.png)
24+
1. Use these values to complete the configuration.
25+
26+
As an alternative, you can also create a Cloud Access Policy and generate a token to use instead of the user and password.
27+
For more information, refer to [Create a Cloud Access Policy](https://grafana.com/docs/grafana-cloud/security-and-account-management/authentication-and-permissions/access-policies/create-access-policies/).

0 commit comments

Comments
 (0)