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
menuTitle: "Configure the client to send profiles"
7
7
description: "Learn how to configure the client to send profiles from your application."
8
-
weight: 35
8
+
weight: 300
9
9
---
10
10
11
11
# Configure the client to send profiles
12
12
13
13
Pyroscope is a continuous profiling database that allows you to analyze the performance of your applications.
14
-
When sending profiles to Pyroscope, you can choose between two primary methods: SDK Instrumentation and auto-instrumentation using the Grafana Agent.
14
+
When sending profiles to Pyroscope, you can choose between two primary methods: SDK instrumentation and auto-instrumentation using Grafana Alloy or Grafana Agent.
15
15
16
16
This document explains these two techniques and guide you when to choose each one.
17
17
18
18

19
19
20
-
## About auto-instrumentation with Grafana Agent
20
+
## About auto-instrumentation with Grafana Alloy or Agent collectors
21
+
22
+
You can send data from your application using Grafana Alloy or Grafana Agent collectors.
23
+
Both collectors support profiling with eBPF, Java, and Golang in pull mode.
24
+
25
+
[Grafana Alloy](https://grafana.com/docs/alloy/latest/) is a vendor-neutral distribution of the OpenTelemetry (OTel) Collector.
26
+
Alloy uniquely combines the very best OSS observability signals in the community.
27
+
Grafana Alloy uses configuration file written using River.
28
+
29
+
Alloy is the recommended collector instead of Grafana Agent.
The Grafana Agent is a component that runs alongside your application and periodically gathers profiling data from it.
34
+
The Grafana collectors is a component that runs alongside your application and periodically gathers profiling data from it.
25
35
This method is suitable when you want to collect profiles from existing applications without modifying their source code.
26
36
This approach is simplified with the eBPF profiling option that doesn't necessitate pull or push mechanisms.
27
37
28
38
Here's how it works:
29
39
30
-
1. Install and configure Grafana Agent on the same machine or container where your application is running
31
-
2. The Agent periodically retrieves your application's performance profiling data, regardless of the language or technology stack your application is using
32
-
3. The captured profiles are then sent to the Pyroscope server for storage and analysis
40
+
1. Install and configure the collector on the same machine or container where your application is running.
41
+
2. The collector periodically retrieves your application's performance profiling data, regardless of the language or technology stack your application is using.
42
+
3. The captured profiles are then sent to the Pyroscope server for storage and analysis.
33
43
34
-
Using Grafana Agent provides a hassle-free option, especially when dealing with multiple applications or microservices, allowing you to centralize the profiling process without changing your application's codebase.
44
+
Using a collector provides a hassle-free option, especially when dealing with multiple applications or microservices, allowing you to centralize the profiling process without changing your application's codebase.
35
45
36
46
## About instrumentation with Pyroscope SDKs
37
47
@@ -40,15 +50,17 @@ Use the SDKs when you want complete control over the profiling process or when t
40
50
41
51
Here's how to use Pyroscope SDKs:
42
52
43
-
1. Install the relevant Pyroscope SDK for your application's programming language (for example, pip package, npm package, Ruby gem).
44
-
2. Instrument your application's code using the SDK to capture the necessary profiling data
45
-
3. SDK automatically periodically push the captured profiles to the Pyroscope server for storage and analysis
53
+
1. Install the relevant Pyroscope SDK for your application's programming language (for example, `pip` package, `npm` package, Ruby gem).
54
+
2. Instrument your application's code using the SDK to capture the necessary profiling data.
55
+
3. SDK automatically periodically pushes the captured profiles to the Pyroscope server for storage and analysis.
46
56
47
57
By using the Pyroscope SDKs, you have the flexibility to customize the profiling process according to your application's specific requirements.
48
58
You can selectively profile specific sections of code or send profiles at different intervals, depending on your needs.
49
59
50
60
## Choose Grafana Agent or Pyroscope SDK to send profiles
You can use Grafana Agent for auto-instrumentation or the Pyroscope instrumentation SDKs.
53
65
The method you choose depends on your specific use case and requirements.
54
66
@@ -120,4 +132,4 @@ In Pyroscope, a period (`.`) is not a valid character inside of tags and labels.
120
132
121
133
## Assistance with Pyroscope
122
134
123
-
If you have more questions, feel free to reach out in [our Slack channel](https://grafana.slack.com/) or create an [issue on GitHub](https://github.com/grafana/pyroscope) and the Pyroscope team will help!
135
+
If you have more questions, feel free to reach out in [the community Slack channel](https://grafana.slack.com/) or create an [issue on GitHub](https://github.com/grafana/pyroscope).
0 commit comments