Skip to content

Commit eb9dd3c

Browse files
[DOC] Fix page weights for the table of contents (#3301)
1 parent 55bb0be commit eb9dd3c

File tree

10 files changed

+38
-26
lines changed

10 files changed

+38
-26
lines changed

docs/sources/configure-client/_index.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,45 @@ aliases:
33
- /docs/phlare/latest/operators-guide/configure-agent/
44
- /docs/phlare/latest/configure-client/
55
title: "Configure the client to send profiles"
6-
menuTitle: "Configure the client"
6+
menuTitle: "Configure the client to send profiles"
77
description: "Learn how to configure the client to send profiles from your application."
8-
weight: 35
8+
weight: 300
99
---
1010

1111
# Configure the client to send profiles
1212

1313
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.
1515

1616
This document explains these two techniques and guide you when to choose each one.
1717

1818
![Pyroscope agent server diagram](https://grafana.com/media/docs/pyroscope/pyroscope_client_server_diagram.png)
1919

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.
30+
New installations should use Alloy.
2131

2232
{{< docs/shared lookup="agent-deprecation.md" source="alloy" version="next" >}}
2333

24-
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.
2535
This method is suitable when you want to collect profiles from existing applications without modifying their source code.
2636
This approach is simplified with the eBPF profiling option that doesn't necessitate pull or push mechanisms.
2737

2838
Here's how it works:
2939

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.
3343

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.
3545

3646
## About instrumentation with Pyroscope SDKs
3747

@@ -40,15 +50,17 @@ Use the SDKs when you want complete control over the profiling process or when t
4050

4151
Here's how to use Pyroscope SDKs:
4252

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.
4656

4757
By using the Pyroscope SDKs, you have the flexibility to customize the profiling process according to your application's specific requirements.
4858
You can selectively profile specific sections of code or send profiles at different intervals, depending on your needs.
4959

5060
## Choose Grafana Agent or Pyroscope SDK to send profiles
5161

62+
{{< docs/shared lookup="agent-deprecation.md" source="alloy" version="next" >}}
63+
5264
You can use Grafana Agent for auto-instrumentation or the Pyroscope instrumentation SDKs.
5365
The method you choose depends on your specific use case and requirements.
5466

@@ -120,4 +132,4 @@ In Pyroscope, a period (`.`) is not a valid character inside of tags and labels.
120132

121133
## Assistance with Pyroscope
122134

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).

docs/sources/configure-client/grafana-agent/ebpf/setup-kubernetes.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ To set up eBPF profiling with Grafana Agent on Kubernetes, you need to:
2121

2222
Before you begin, you need:
2323

24-
- [helm][helm] and [kubectl][kubectl] installed with access to your Kubernetes cluster.
25-
- A Pyroscope server where the agent will send profiling data.
26-
- Access to Grafana with the [Grafana Pyroscope datasource][pyroscope-ds] provisioned.
24+
- [Helm][helm] and [kubectl][kubectl] installed with access to your Kubernetes cluster.
25+
- A Pyroscope server where the Agent will send profiling data.
26+
- Access to Grafana with the [Grafana Pyroscope data source][pyroscope-ds] provisioned.
2727

2828
{{< admonition type="note" >}}
2929
If you don't have a Grafana and/or a Pyroscope server, you can use the [Grafana Cloud][gcloud] free plan to get started.
@@ -52,7 +52,7 @@ helm repo add grafana https://grafana.github.io/helm-charts
5252
helm repo update
5353
```
5454

55-
You can verify that the repository was added successfully by running:
55+
Verify that the repository was added successfully by running:
5656

5757
```shell
5858
helm search repo grafana/grafana-agent
@@ -118,7 +118,7 @@ To install the Grafana Agent, run:
118118
helm install pyroscope-ebpf grafana/grafana-agent -f values.yaml
119119
```
120120

121-
Once configured, the Agent will start collecting eBPF profiles and send them to the Pyroscope server.
121+
Once configured, the Agent starts collecting eBPF profiles and send them to the Pyroscope server.
122122

123123
## Verify profiles are received
124124

docs/sources/configure-server/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ keywords:
88
- Pyroscope server configuration
99
menuTitle: Configure the server
1010
title: Configure the Pyroscope server
11-
weight: 40
11+
weight: 500
1212
---
1313

1414
# Configure the Pyroscope server

docs/sources/deploy-kubernetes/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ aliases:
55
description: Learn how to get started with Pyroscope on Kubernetes.
66
menuTitle: Deploy on Kubernetes
77
title: Deploy Pyroscope on Kubernetes
8-
weight: 45
8+
weight: 400
99
---
1010

1111
# Deploy Pyroscope on Kubernetes

docs/sources/get-started/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ aliases:
66
description: Learn how to get started with Pyroscope.
77
menuTitle: Get started
88
title: Get started with Pyroscope
9-
weight: 30
9+
weight: 250
1010
---
1111

1212
# Get started with Pyroscope

docs/sources/introduction/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Introduction
33
menuTitle: Introduction
44
description: Learn about Pyrsocope and profiling.
5-
weight: 10
5+
weight: 200
66
keywords:
77
- Pyroscope
88
- Profiling

docs/sources/reference-pyroscope-architecture/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Pyroscope architecture"
33
menuTitle: "Reference: Pyroscope Architecture"
44
description: "Learn about the Pyroscope architecture components and services."
5-
weight: 60
5+
weight: 600
66
---
77

88
# Pyroscope architecture

docs/sources/release-notes/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Release notes
33
description: Release notes for Grafana Pyroscope
4-
weight: 2
4+
weight: 100
55
---
66

77
# Release notes

docs/sources/upgrade-guide/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Upgrade your Grafana Pyroscope installation
33
menuTitle: Upgrade
44
description: Upgrade your Pyroscope installation to the latest version.
5-
weight: 10
5+
weight: 350
66
keywords:
77
- pyroscope
88
- phlare

docs/sources/view-and-analyze-profile-data/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ menuTitle: View and analyze profile data
44
description: How to use Pyroscope to view and analyze profile data.
55
aliases:
66
- ../ingest-and-analyze-profile-data/
7-
weight: 50
7+
weight: 500
88
keywords:
99
- pyroscope
1010
- UI

0 commit comments

Comments
 (0)