github.com/grafana/pyroscope@v1.18.0/docs/sources/get-started/_index.md (about)

     1  ---
     2  aliases:
     3    - /docs/phlare/latest/operators-guide/getting-started/
     4    - /docs/phlare/latest/operators-guide/get-started/
     5    - /docs/phlare/latest/get-started/
     6  description: Learn how to get started with Pyroscope.
     7  menuTitle: Get started
     8  title: Get started with Pyroscope
     9  weight: 250
    10  ---
    11  
    12  # Get started with Pyroscope
    13  
    14  Choose one of the following options to get started with Pyroscope:
    15  
    16  The **written tutorial** below provides a series of imperative commands to start a single Pyroscope process, or [monolith](../reference-pyroscope-architecture/deployment-modes/#monolithic-mode), which is designed for users getting started with the project.
    17  
    18  You can also use [`multiple examples`](https://github.com/grafana/pyroscope/tree/main/examples) to help you quickly get started using Pyroscope and Grafana.
    19  
    20  Every example has a `docker-compose.yml` manifest that includes all of the options needed to explore profiling data in Grafana, including resource configuration and profiling data generation.
    21  
    22  For more information on the different ways to deploy Pyroscope, see [Pyroscope deployment modes](../reference-pyroscope-architecture/deployment-modes/).
    23  
    24  {{< youtube id="XL2yTCPy2e0" >}}
    25  
    26  ## Before you begin
    27  
    28  Verify that you have installed [Docker](https://docs.docker.com/engine/install/).
    29  
    30  {{< admonition type="note" >}}
    31  By default, Pyroscope reports anonymous, non-sensitive, non-personally identifiable information about the running cluster to a remote statistics server to help Pyroscope maintainers understand how the open source community runs Pyroscope.
    32  
    33  To opt out, refer to [Disable the anonymous usage statistics reporting](../configure-server/anonymous-usage-statistics-reporting#disable-the-anonymous-usage-statistics-reporting).
    34  {{< /admonition >}}
    35  
    36  ## Download and configure Pyroscope
    37  
    38  1. Download Pyroscope.
    39  
    40      You can use Docker or download a binary to install Pyroscope.
    41  
    42      - To install with Docker, run the following command:
    43  
    44        ```bash
    45        docker pull grafana/pyroscope:latest
    46          ```
    47  
    48      - To use a local binary:
    49  
    50        Download the appropriate [release asset](https://github.com/grafana/pyroscope/releases/latest) for your operating system and architecture and make it executable.
    51  
    52        For example, for Linux with the AMD64 architecture:
    53  
    54          ```bash
    55        # Download Pyroscope v1.0.0 and unpack it to the current folder
    56        curl -fL https://github.com/grafana/pyroscope/releases/download/v1.0.0/pyroscope_1.0.0_linux_amd64.tar.gz | tar xvz
    57        ```
    58  
    59  1. Run Pyroscope.
    60  
    61      In a terminal, run one of the following commands:
    62  
    63        - Using Docker:
    64  
    65          ```bash
    66          docker network create pyroscope-demo
    67          docker run --rm --name pyroscope --network=pyroscope-demo -p 4040:4040 grafana/pyroscope:latest
    68          ```
    69  
    70        - Using a local binary:
    71  
    72          ```bash
    73          ./pyroscope
    74          ```
    75  
    76  1. Verify that Pyroscope is ready. Pyroscope listens on port `4040`.
    77  
    78        ```bash
    79        curl localhost:4040/ready
    80        ```
    81  
    82  1. Configure Pyroscope to scrape profiles.
    83  
    84      By default, Pyroscope is configured to scrape itself.
    85      To collect more profiles, you must either instrument your application with an SDK or use Grafana Alloy.
    86  
    87      To learn more about language integrations and the Pyroscope agent, refer to [Pyroscope Agent](../configure-client/).
    88  
    89  ## Add a Pyroscope data source and query data
    90  
    91  1. In a terminal, run a local Grafana server using Docker:
    92  
    93      ```bash
    94      docker run --rm --name=grafana \
    95        --network=pyroscope-demo \
    96        -p 3000:3000 \
    97        -e "GF_PLUGINS_PREINSTALL_SYNC=grafana-pyroscope-app"\
    98        -e "GF_AUTH_ANONYMOUS_ENABLED=true" \
    99        -e "GF_AUTH_ANONYMOUS_ORG_ROLE=Admin" \
   100        -e "GF_AUTH_DISABLE_LOGIN_FORM=true" \
   101        grafana/grafana:main
   102      ```
   103  
   104  1. In a browser, go to the Grafana server at [http://localhost:3000/datasources](http://localhost:3000/datasources).
   105  
   106  1. Use the following settings to configure a Pyroscope data source to query the local Pyroscope server:
   107  
   108     | Field | Value                                                                |
   109     | ----- | -------------------------------------------------------------------- |
   110     | Name  | Pyroscope                                                            |
   111     | URL   | [http://pyroscope:4040/](http://pyroscope:4040/) OR [http://host.docker.internal:4040/](http://host.docker.internal:4040/) if using Docker  |
   112  
   113    To learn more about adding data sources, refer to [Add a data source](/docs/grafana/<GRAFANA_VERSION>/datasources/add-a-data-source/).
   114  
   115  1. In a browser, go to [Profiles Drilldown](/docs/grafana/<GRAFANA_VERSION>/explore/simplified-exploration/profiles/) in your Grafana instance at [https://localhost:3000/a/grafana-pyroscope-app/profiles-explorer](https://localhost:3000/a/grafana-pyroscope-app/profiles-explorer). This will let you use an intuitive interface for exploring your profile data.
   116  
   117  When you have completed the tasks in this getting started guide, you can create dashboard panels using the newly configured Pyroscope data source. For more information on working with dashboards with Grafana, refer to [Panels and visualizations](/docs/grafana/<GRAFANA_VERSION>/panels-visualizations/) in the Grafana documentation.