[BACKPORT] [DOC} Doc update for v1.2.1 (#2862)

* Changes from 2855 intro doc * docs: update go-pull.md (#2844) * docs: update go-pull.md * fix links * rm comments * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * typo * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> --------- Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> Co-authored-by: Ryan Perry <Rperry2174@gmail.com> * Create release notes for v1.2.1 (#2860) * docs: Add sampling documentation (#2854) * Add sampling doc * Tweak wording and layout * Fix links * Fix absolute links * Variety of small tweaks in structure and wording * docs: Refactor ebpf installation (#2849) * docs: Refactor ebpf installation * docs: Refactor ebpf installation * Remove not useful sections. * review feedbac * remove absolute link to grafana.com * lint * review feedback * Add diagram for ebpf * linted * Update docs/sources/configure-client/grafana-agent/ebpf/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/configuration/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/configuration/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-docker.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-docker.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-kubernetes.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-kubernetes.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-linux.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-linux.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-linux.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/troubleshooting.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/troubleshooting.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/troubleshooting.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/troubleshooting.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-linux.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-linux.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-kubernetes.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> --------- Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> Co-authored-by: Ryan Perry <Rperry2174@gmail.com> * docs: language SDK page updates (#2851) * docs changes * improvements * wip * fixes * fixes * fixes * Update docs/sources/configure-client/language-sdks/go_push.md * Update docs/sources/configure-client/language-sdks/go_push.md * Apply suggestions from code review * Update Before you begin sections --------- Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> Co-authored-by: Kim Nylander <kim.nylander@grafana.com> * doc: Add sampling diagram (#2861) --------- Co-authored-by: Tolya Korniltsev <korniltsev.anatoly@gmail.com> Co-authored-by: Ryan Perry <Rperry2174@gmail.com> Co-authored-by: Bryan Huhta <32787160+bryanhuhta@users.noreply.github.com> Co-authored-by: Cyril Tovena <cyril.tovena@gmail.com> Co-authored-by: Dmitry Filimonov <dmitry.filimonov@grafana.com>
grafana · Dec 16, 2023 · aa6444a · aa6444a
1 parent 178e882
commit aa6444a
Show file tree

Hide file tree

Showing 33 changed files with 1,517 additions and 785 deletions.
diff --git a/docs/sources/configure-client/_index.md b/docs/sources/configure-client/_index.md
@@ -3,8 +3,8 @@ aliases:
   - /docs/phlare/latest/operators-guide/configure-agent/
   - /docs/phlare/latest/configure-client/
 title: "Sending profiles from your application"
-menuTitle: "Configure the Client"
-description: ""
+menuTitle: "Configure the client"
+description: "Learn how to configure the client to send profiles from your application."
 weight: 35
 ---
 

diff --git a/docs/sources/configure-client/grafana-agent/ebpf.md b/docs/sources/configure-client/grafana-agent/ebpf.md
diff --git a/docs/sources/configure-client/grafana-agent/ebpf/_index.md b/docs/sources/configure-client/grafana-agent/ebpf/_index.md
@@ -0,0 +1,35 @@
+---
+title: "Profiling with eBPF with Grafana Agent"
+menuTitle: "Profiling with eBPF"
+description: "Learn about using eBPF for continuous profiling for performance optimization."
+weight: 20
+aliases:
+  - /docs/phlare/latest/configure-client/language-sdks/ebpf/
+  - /docs/pyroscope/next/configure-client/language-sdks/ebpf
+---
+
+# Profiling with eBPF with Grafana Agent
+
+<img src="/media/docs/pyroscope/ebpf_logo_color_on_white.png" width="100px;" alt="eBPF"/>
+
+eBPF is an advanced technology embedded into the Linux kernel. It stands for enhanced [Berkeley Packet Filter](https://en.wikipedia.org/wiki/EBPF) and revolutionizes the capability to run sandboxed code safely within the kernel space. This technology serves multiple use cases, such as networking, security, and performance monitoring without the need to alter kernel code or load additional modules.
+
+## Benefits and tradeoffs of using eBPF for continuous profiling
+
+When it comes to application profiling, eBPF shines due to its high efficiency and minimal performance overhead.
+eBPF enables the dynamic insertion of powerful monitoring code into live production systems.
+By leveraging eBPF, developers can gain insights into application behavior, track resource usage, and detect bottlenecks in a way that traditional profiling tools cannot match.
+eBPF's low overhead and fine-grained data collection make it an ideal choice for continuous, real-time profiling in performance-sensitive environments.
+
+However, eBPF has some limitations that make it unsuitable for certain use cases:
+
+- It isn't a good fit for profiling applications that are not written in a supported language.
+- It can't be used to profile applications that are not running on Linux.
+- It does not support all profile types such as memory and contention/lock profiling.
+- eBPF requires root access to the host machine, which can be a problem in some environments.
+
+## eBPF via the Grafana Agent
+
+The Grafana Agent is a lightweight, all-in-one agent that can collect, transform, and ship observability data. For profiling, the Grafana Agent can be configured to collect eBPF profiles and send them to Pyroscope.
+
+This section contains instructions for installing and configuring the Grafana Agent to collect eBPF profiles. For more information about the Grafana Agent itself, see the [Grafana Agent documentation](/docs/agent/latest/flow/).