You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/internal/RELEASE.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -18,9 +18,9 @@ To release a new version of the project you need to follow the following steps:
18
18
>
19
19
> ⚠️ Incorrect: `release/v1.3.0`
20
20
21
-
The CI will automatically handle the build and create a draft github release.
21
+
The CI will automatically handle the build and create a draft GitHub release.
22
22
23
-
Once ready, you can edit and publish the draft release on Github. You will need to take the release notes and append them to the `CHANGELOG.md` file in the root of the repository.
23
+
Once ready, you can edit and publish the draft release on GitHub. You will need to take the release notes and append them to the `CHANGELOG.md` file in the root of the repository.
24
24
25
25
The list of changes from the CHANGELOG.md file form the basis of the public-facing release notes. Release notes are added to the [public Pyroscope documentation](https://grafana.com/docs/pyroscope/latest/release-notes/). These release notes follow the same pattern for each release:
26
26
@@ -50,7 +50,7 @@ To create a new release first prepare the release using:
50
50
make release/prepare
51
51
```
52
52
53
-
This will build and packages all artifacts without pushing or creating the github release.
53
+
This will build and packages all artifacts without pushing or creating the GitHub release.
54
54
55
55
Once you're ready you can then tag your release.
56
56
@@ -64,6 +64,6 @@ And finally push the release using:
64
64
make release
65
65
```
66
66
67
-
> Make sure to have a [Github Token](https://goreleaser.com/scm/github/?h=github#github)`GITHUB_TOKEN` correctly set.
67
+
> Make sure to have a [GitHub Token](https://goreleaser.com/scm/github/?h=github#github)`GITHUB_TOKEN` correctly set.
68
68
69
69
Make sure to create the release notes and CHANGELOG for any manual release.
Copy file name to clipboardexpand all lines: docs/internal/contributing/README.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ To build:
41
41
make go/bin
42
42
```
43
43
44
-
To run the unit tests suite:
44
+
To run the unit test suite:
45
45
46
46
```
47
47
make go/test
@@ -124,7 +124,7 @@ will be able to interact with it.
124
124
### Dependency management
125
125
126
126
We use [Go modules](https://golang.org/cmd/go/#hdr-Modules__module_versions__and_more) to manage dependencies on external packages.
127
-
However we don't commit the `vendor/` folder.
127
+
However, we don't commit the `vendor/` folder.
128
128
129
129
To add or update a new dependency, use the `go get` command:
130
130
@@ -150,4 +150,4 @@ The Grafana Pyroscope documentation is compiled into a website published at [gra
150
150
151
151
To start the website locally you can use `make docs/docs` and follow console instructions to access the website.
152
152
153
-
Note: if you attempt to view pages on Github, it's likely that you might find broken links or pages. That is expected and should not be addressed unless it is causing issues with the site that occur as part of the build.
153
+
Note: if you attempt to view pages on GitHub, it's likely that you might find broken links or pages. That is expected and should not be addressed unless it is causing issues with the site that occur as part of the build.
Copy file name to clipboardexpand all lines: docs/sources/configure-client/grafana-agent/sampling.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ weight: 30
9
9
10
10
Applications often have many instances deployed. While Pyroscope is designed to handle large amounts of profiling data, you may want only a subset of the application's instances to be scraped.
11
11
12
-
For example, the volume of profiling data your application generates may make it unreasonable to profile every instance or you might be targeting cost-reduction.
12
+
For example, the volume of profiling data your application generates may make it unreasonable to profile every instance, or you might be targeting cost-reduction.
13
13
14
14
Through configuration of the Grafana Agent, Pyroscope can sample scrape targets.
Copy file name to clipboardexpand all lines: docs/sources/configure-client/language-sdks/dotnet.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ Our .NET profiler works with the following .NET versions:
31
31
32
32
## Before you begin
33
33
34
-
To capture and analyze profiling data, you need either a hosted Pyroscope OSS server or a hosted [Pryoscope instance with Grafana Cloud Profiles](/products/cloud/profiles-for-continuous-profiling/) (requires a free Grafana Cloud account).
34
+
To capture and analyze profiling data, you need either a hosted Pyroscope OSS server or a hosted [Pyroscope instance with Grafana Cloud Profiles](/products/cloud/profiles-for-continuous-profiling/) (requires a free Grafana Cloud account).
35
35
36
36
The Pyroscope server can be a local server for development or a remote server for production use.
37
37
@@ -143,7 +143,7 @@ It is possible to dynamically change authorization credentials:
Here is a simple [example](https://github.com/grafana/pyroscope/blob/main/examples/language-sdk-instrumentation/dotnet/rideshare/example/Program.cs) exposing this APIs as an http endpoint.
146
+
Here is a simple [example](https://github.com/grafana/pyroscope/blob/main/examples/language-sdk-instrumentation/dotnet/rideshare/example/Program.cs) exposing these APIs as HTTP endpoints.
Copy file name to clipboardexpand all lines: docs/sources/configure-client/language-sdks/go_push.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -97,7 +97,7 @@ pprof.Do(context.Background(), pprof.Labels("controller", "slow_controller"), fu
97
97
98
98
### Mutex profiling
99
99
100
-
Mutex profiling is useful for finding sources of contention within your application. It helps you to find out which mutexes are being held by which goroutines.
100
+
Mutex profiling is useful for finding sources of contention within your application. It helps you find out which mutexes are being held by which goroutines.
101
101
102
102
To enable mutex profiling, you need to add the following code to your application:
Enhance your Node.js application's performance with our Node.js Profiler. Seamlessly integrated with Pyroscope, it provides real-time insights into your application’s operation, helping you identify and resolve performance bottlenecks. This integration is key for Node.js developers aiming to boost efficiency, reduce latency, and maintain optimal application performance.
13
13
14
14
## Before you begin
15
15
16
-
To capture and analyze profiling data, you need either a hosted Pyroscope OSS server or a hosted [Pryoscope instance with Grafana Cloud Profiles](/products/cloud/profiles-for-continuous-profiling/) (requires a free Grafana Cloud account).
16
+
To capture and analyze profiling data, you need either a hosted Pyroscope OSS server or a hosted [Pyroscope instance with Grafana Cloud Profiles](/products/cloud/profiles-for-continuous-profiling/) (requires a free Grafana Cloud account).
17
17
18
18
The Pyroscope server can be a local server for development or a remote server for production use.
19
19
20
-
## Add NodeJS profiling to your application
20
+
## Add Node.js profiling to your application
21
21
22
-
To start profiling a NodeJS application, you need to include the npm module in your app:
22
+
To start profiling a Node.js application, you need to include the npm module in your app:
23
23
24
24
```
25
25
npm install @pyroscope/nodejs
@@ -28,7 +28,7 @@ npm install @pyroscope/nodejs
28
28
yarn add @pyroscope/nodejs
29
29
```
30
30
31
-
## Configure the NodeJS client
31
+
## Configure the Node.js client
32
32
33
33
Add the following code to your application:
34
34
@@ -45,7 +45,7 @@ Pyroscope.start()
45
45
46
46
Note: If you'd prefer to use Pull mode you can do so using the [Grafana Agent]({{< relref "../grafana-agent" >}}).
47
47
48
-
### Add profiling labels to NodeJS applications
48
+
### Add profiling labels to Node.js applications
49
49
50
50
It is possible to add tags (labels) to the profiling data. These tags can be used to filter the data in the UI. Dynamic tagging isn't supported yet.
51
51
@@ -79,7 +79,7 @@ Pyroscope.init({
79
79
Pyroscope.start()
80
80
```
81
81
82
-
To configure the NodeJS SDK to send data to Pyroscope, replace the `serverAddress` placeholder with the appropriate server URL. This could be the Grafana Cloud Pyroscope URL or your own custom Pyroscope server URL.
82
+
To configure the Node.js SDK to send data to Pyroscope, replace the `serverAddress` placeholder with the appropriate server URL. This could be the Grafana Cloud Pyroscope URL or your own custom Pyroscope server URL.
83
83
84
84
If you need to send data to Grafana Cloud, you’ll have to configure HTTP Basic authentication. Replace `basicAuthUser` with your Grafana Cloud stack user ID and `basicAuthPassword` with your Grafana Cloud API key.
Copy file name to clipboardexpand all lines: docs/sources/configure-client/language-sdks/python.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ Our Python Profiler, when integrated with Pyroscope, transforms the way you anal
13
13
14
14
## Before you begin
15
15
16
-
To capture and analyze profiling data, you need either a hosted Pyroscope OSS server or a hosted [Pryoscope instance with Grafana Cloud Profiles](/products/cloud/profiles-for-continuous-profiling/) (requires a free Grafana Cloud account).
16
+
To capture and analyze profiling data, you need either a hosted Pyroscope OSS server or a hosted [Pyroscope instance with Grafana Cloud Profiles](/products/cloud/profiles-for-continuous-profiling/) (requires a free Grafana Cloud account).
17
17
18
18
The Pyroscope server can be a local server for development or a remote server for production use.
Copy file name to clipboardexpand all lines: docs/sources/configure-client/language-sdks/ruby.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ The Ruby Profiler revolutionizes performance tuning in Ruby applications. Integr
13
13
14
14
## Before you begin
15
15
16
-
To capture and analyze profiling data, you need either a hosted Pyroscope OSS server or a hosted [Pryoscope instance with Grafana Cloud Profiles](/products/cloud/profiles-for-continuous-profiling/) (requires a free Grafana Cloud account).
16
+
To capture and analyze profiling data, you need either a hosted Pyroscope OSS server or a hosted [Pyroscope instance with Grafana Cloud Profiles](/products/cloud/profiles-for-continuous-profiling/) (requires a free Grafana Cloud account).
17
17
18
18
The Pyroscope server can be a local server for development or a remote server for production use.
Copy file name to clipboardexpand all lines: docs/sources/configure-client/language-sdks/rust.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ Optimize your Rust applications with our advanced Rust Profiler. In collaboratio
13
13
14
14
## Before you begin
15
15
16
-
To capture and analyze profiling data, you need either a hosted Pyroscope OSS server or a hosted [Pryoscope instance with Grafana Cloud Profiles](/products/cloud/profiles-for-continuous-profiling/) (requires a free Grafana Cloud account).
16
+
To capture and analyze profiling data, you need either a hosted Pyroscope OSS server or a hosted [Pyroscope instance with Grafana Cloud Profiles](/products/cloud/profiles-for-continuous-profiling/) (requires a free Grafana Cloud account).
17
17
18
18
The Pyroscope server can be a local server for development or a remote server for production use.
19
19
@@ -73,7 +73,7 @@ The agent can be stopped at any point, and it'll send a last report to the serve
73
73
letagent_ready=agent.stop().unwrap();
74
74
```
75
75
76
-
It's recommended to shutdown the agent before exiting the application. A last
76
+
It's recommended to shut down the agent before exiting the application. A last
77
77
request to the server might be missed if the agent is not shutdown properly.
-**Backend**: The Pyroscope Agent uses [pprof-rs](https://github.com/tikv/pprof-rs) as a backend. As a result, the [limitations](https://github.com/tikv/pprof-rs#why-not-) for pprof-rs also applies.
143
143
As of 0.5.0, the Pyroscope Agent supports tagging within threads. Check the [tags](https://github.com/pyroscope-io/pyroscope-rs/blob/main/examples/tags.rs) and [multi-thread](https://github.com/pyroscope-io/pyroscope-rs/blob/main/examples/multi-thread.rs) examples for usage.
144
144
-**Timer**: epoll (for Linux) and kqueue (for macOS) are required for a more precise timer.
145
-
-**Shutdown**: The Pyroscope Agent might take some time (usually less than 10 seconds) to shutdown properly and drop its threads. For a proper shutdown, it's recommended that you run the `shutdown` function before dropping the agent.
145
+
-**Shutdown**: The Pyroscope Agent might take some time (usually less than 10 seconds) to shut down properly and drop its threads. For a proper shutdown, it's recommended that you run the `shutdown` function before dropping the agent.
Copy file name to clipboardexpand all lines: docs/sources/configure-client/trace-span-profiles/go-span-profiles.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ To use Span Profiles, you need to:
30
30
31
31
Your applications must be instrumented for profiling and tracing before you can use span profiles.
32
32
33
-
* Profiling: Your application must be instrumented with Pyroscopes Go SDK. If you haven't done this yet, please refer to the [Go (push mode)]({{< relref "../language-sdks/go_push" >}}) guide.
33
+
* Profiling: Your application must be instrumented with Pyroscope's Go SDK. If you haven't done this yet, please refer to the [Go (push mode)]({{< relref "../language-sdks/go_push" >}}) guide.
34
34
* Tracing: Your application must be instrumented with OpenTelemetry traces. If you haven't done this yet, please refer to the [OpenTelemetry](https://opentelemetry.io/docs/go/getting-started/) guide.
35
35
36
36
### OpenTelemetry support
@@ -103,11 +103,11 @@ Check out the [examples](https://github.com/grafana/pyroscope/tree/main/examples
103
103
104
104
<!-- ## Using tracing exemplars manually
105
105
106
-
If you're not using open telemetry integration you can still use exemplars storage to store profiles associated with some execution context (e.g individual HTTP / GRPC request). To create exemplars you need to tag specific parts of your code with a special `profile_id` tag, for example, in golang you could do this:
106
+
If you're not using open telemetry integration you can still use exemplars storage to store profiles associated with some execution context (e.g. individual HTTP / GRPC request). To create exemplars you need to tag specific parts of your code with a special `profile_id` tag, for example, in golang you could do this:
0 commit comments