From 822139f9f7939ed88674684822108d0e5f49d65a Mon Sep 17 00:00:00 2001 From: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> Date: Mon, 8 Apr 2024 18:05:21 -0400 Subject: [PATCH] [DOC] Pyroscope landing page for doc (#3176) * Pyroscope landing page for doc * Apply suggestions from code review Co-authored-by: Christian Simon * Update docs/sources/_index.md * Update docs/sources/_index.md --------- Co-authored-by: Christian Simon (cherry picked from commit 71e2fbd5b2f8f1d54f4dc8e458f632b06060fe51) --- docs/sources/_index.md | 91 ++++++++++++++--------------- docs/sources/introduction/_index.md | 7 ++- 2 files changed, 49 insertions(+), 49 deletions(-) diff --git a/docs/sources/_index.md b/docs/sources/_index.md index 5d998e07e7..66bdb8ff23 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -1,8 +1,7 @@ --- -title: "Grafana Pyroscope documentation" -menuTitle: "Grafana Pyroscope" +title: "Grafana Pyroscope" weight: 1 -description: "Grafana Pyroscope documentation" +description: Grafana Pyroscope is an open source software project for aggregating continuous profiling data. keywords: - Grafana Pyroscope - Grafana profiles @@ -11,56 +10,56 @@ keywords: - profiles datastore - observability - continuous profiling +hero: + title: Grafana Pyroscope + level: 1 + image: /static/img/pyroscope-logo.svg + width: 110 + height: 110 + description: >- + Grafana Pyroscope is an open source software project for aggregating continuous profiling data. Continuous profiling is an observability signal that allows you to understand your workload's resources usage down to the source code line number. + Grafana Pyroscope is fully integrated with Grafana allowing you to correlate with other observability signals, like metrics, logs, and traces. +cards: + title_class: pt-0 lh-1 + items: + - title: Learn about profiling + href: /docs/pyroscope/latest/introduction/ + description: Learn about continuous profiling and how you identify performance bottlenecks and optimize your applications. After an application is profiled, you can start with system-wide observability and drill down to actionable code-level insights. + - title: Get started with Pyroscope + href: ./get-started/ + description: Learn how to install and configure Grafana Pyroscope with several examples. + - title: Instrument your app and configure the client + href: ./configure-client/ + description: When sending profiles to Pyroscope, you can choose between SDK instrumentation and auto-instrumentation using the Grafana Agent. This document explains these two techniques and guide you when to choose each one. + - title: Configure the server + href: ./configure-server/ + description: Configure your Pyroscope server to meet your needs by setting disk storage, tenant IDs, memberlist, proxies, shuffle sharding, and more. You can also use the server HTTP API. + - title: View and analyze profile data + href: ./view-and-analyze-profile-data/ + description: Profiling data can be presented in a variety of formats presents, including flame graphs, tables, as well as charts and graphs. Flame graphs visualize call relationships and identify hot spots. Tables let you view detailed statistics for specific functions or time periods. Charts and graphs help you analyze trends and compare performance across different metrics. + - title: Pyroscope architecture + href: ./reference-pyroscope-architecture/ + description: Take a deep-dive into the microservices-based architecture to learn about deployment modes, components (microservices), and more. The system has multiple horizontally scalable microservices that can run separately and in parallel. --- -# Grafana Pyroscope documentation -![Grafana Pyroscope](logo.png) +{{< docs/hero-simple key="hero" >}} -Grafana Pyroscope is an open source software project for aggregating continuous profiling data. -Continuous profiling is an observability signal that allows you to understand your workload's resources (CPU, memory, etc.) usage down to the line number. - -Grafana Pyroscope is fully integrated with Grafana allowing you to **correlate** with other observability signals, like metrics, logs, and traces. - -## Continuous profiling - -Continuous profiling is more than just a performance analysis tool. -It's a crucial component in modern software development and operations. -It goes past traditional profiling techniques by providing ongoing, in-depth insights into application performance. - -Continuous profiling goes past the ephemeral, localized nature of traditional profiling (which historically has been more similar to `console.log` or `print statement` debugging) to a structured, centralized approach allows for effective use in production environments. -Put more simply, Pyroscope takes you from a bunch of flamegraph files on your desktop to a database where you can query and analyze production data in a structured way. +--- -{{% admonition type="tip" %}} -To learn more about continuous profiling, read [the Introduction section]({{< relref "./introduction" >}}). -{{% /admonition %}} +## Overview -Pyroscope, in particular, offers the flexibility to either visualize more traditional adhoc data or evolve your applications observability tooling to include more modern continuous profiling capabilities. +Grafana Pyroscope is a multi-tenant, continuous profiling aggregation system, aligning its architectural design with Grafana Mimir, Grafana Loki, and Grafana Tempo. +This integration enables a cohesive correlation of profiling data with existing metrics, logs, and traces. +Explore continuous profiling data to gain insights into application performance. +You can query and analyze production data in a structure way. +Use the Pyroscope UI or Grafana to visualize the data. -