﻿---
title: Get started with Universal Profiling
description: This page shows you how to configure and use Universal Profiling on an Elastic Cloud deployment. To set up a self-hosted deployment of Elastic Stack,...
url: https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/4409/solutions/observability/infra-and-hosts/get-started-with-universal-profiling
products:
  - Elastic Observability
---

# Get started with Universal Profiling
This page shows you how to configure and use Universal Profiling on an Elastic Cloud deployment. To set up a self-hosted deployment of Elastic Stack, refer to [Run Universal Profiling on self-hosted Elastic stack ](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/4409/solutions/observability/infra-and-hosts/run-universal-profiling-on-self-hosted-elastic-stack).
This page covers:
- Prerequisites to setting up Universal Profiling on Elastic Cloud
- Setting up Universal Profiling in your Elastic Cloud deployment
- Installing the Universal Profiling Agent
- Installing the Universal Profiling Agent integration

We would appreciate feedback on your experience with this product and any other profiling pain points you may have. See the [send feedback](/elastic/docs-content/pull/4409/troubleshoot/observability/troubleshoot-your-universal-profiling-agent-deployment#profiling-send-feedback) section of the troubleshooting documentation for more information.

## Prerequisites

Before setting up Universal Profiling, make sure you meet the following requirements:
- An Elastic Stack deployment on [Elastic Cloud](http://cloud.elastic.co). To set up a self-hosted deployment of Elastic Stack, refer to [Run Universal Profiling on self-hosted Elastic stack ](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/4409/solutions/observability/infra-and-hosts/run-universal-profiling-on-self-hosted-elastic-stack).
- The workloads you’re profiling must be running on Linux machines with x86_64 or ARM64 CPUs.
- The minimum supported kernel version is either 4.19 for x86_64 or 5.5 for ARM64 machines.
- The Integrations Server must be enabled on your Elastic Cloud deployment.
- Credentials (username and password) for the `superuser` Elasticsearch role (typically, the `elastic` user).


### Interpreters

Universal Profiling is a system-wide profiling solution with additional support for PHP, Python, Java (or any JVM language), Go, Rust, C/C++, Node.js/V8, Ruby, .Net, and Perl.
The minimum supported versions of each interpreter are:
- JVM/JDK: 7
- Python: 3.6
- V8: 8.1.0
- Perl: 5.28
- PHP: 7.3
- Ruby: 2.5
- .Net: 6


### Deployment configuration example

The following deployment configuration example was tested to support profiling data from a fleet of up to 500 hosts, each with 8 or 16 CPU cores, for a total of roughly 6000 cores:

| Component           | Size per zone (memory) | Zones |
|---------------------|------------------------|-------|
| Elasticsearch       | 64 GB                  | 2     |
| Kibana              | 8 GB                   | 1     |
| Integrations Server | 8 GB                   | 1     |

Even if you’re profiling a smaller fleet, we recommend configuring at least two zones for Elasticsearch and 4 GB of memory each for the Integrations Server and Kibana.

## Set up Universal Profiling on an Elastic Cloud deployment

To set up Universal Profiling on your Elastic Cloud deployment, you need to [configure data ingestion](#profiling-configure-data-ingestion) first.

### Configure data ingestion

After enabling Universal Profiling on your deployment for the first time, select any subheading under **Universal Profiling** in the navigation menu to open the following page:
![profiling setup popup](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/4409/solutions/images/observability-profiling-setup-popup.png)

Click **Set up Universal Profiling** to configure data ingestion.
<note>
  To configure data ingestion, you need elevated privileges, typically the `elastic` user.
</note>

If you’re upgrading from a previous version with Universal Profiling enabled, see the [upgrade guide](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/4409/solutions/observability/infra-and-hosts/upgrade-universal-profiling).

### Programmatic configuration

```
stack: ga 9.2
```

If you prefer to configure data ingestion programmatically, you can use a Kibana API call. This call can be made either through the "Dev Tools" console in Kibana or with any standalone HTTP client (such as `curl` or `wget`). In both cases, the API call must be executed using the `elastic` user credentials to ensure the necessary permissions.
A successful API call will return a `202 Accepted` response with an empty body.
To configure data ingestion from the console, go to **Dev Tools** in the navigation menu and run the following command:
```json

{}
```

To configure data ingestion programmatically using a standalone HTTP client (e.g., `curl`), run the following command:
```json
curl -u elastic:<PASSWORD> -H "kbn-xsrf: true" -H "Content-Type: application/json" \
    --data "{}" "https://<kibana-host>:<kibana-port>/api/profiling/setup/es_resources"
```


## Install the Universal Profiling Agent

You have the following options when installing the Universal Profiling Agent:
1. [Install the Universal Profiling Agent using the Elastic Agent](#profiling-install-agent-elastic-agent)
2. [Install the Universal Profiling Agent in standalone mode](#profiling-install-agent-standalone)


### Install the Universal Profiling Agent using the Elastic Agent

To install the Universal Profiling Agent using the Elastic Agent and the Universal Profiling Agent integration, complete the following steps:
1. Copy the `secret token` and `Universal Profiling Collector url` from the Elastic Agent Integration
   ![profiling elastic agent](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/4409/solutions/images/observability-profiling-elastic-agent.png)
2. Click `Manage Universal Profiling Agent in Fleet` to complete the integration.
3. On the Integrations page, click **Add Universal Profiling Agent**.
4. In **Universal Profiling Agent → Settings**, add the information you copied from the **Add profiling data** page:
   1. Add the Universal Profiling collector URL to the **Universal Profiling collector endpoint** field.
2. Add the secret token to the **Authorization** field.
   ![profililing elastic agent creds](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/4409/solutions/images/observability-profililing-elastic-agent-creds.png)
5. Click **Save and continue**.


#### Deploy Elastic Agent using `Kubernetes` with the Universal Profiling Agent integration

To deploy Elastic Agent with the Universal Profiling Agent integration using Kubernetes,
make sure that the following options are set in the manifest.
```json
hostPID: true
securityContext:
  readOnlyRootFilesystem: true
  privileged: true
  runAsUser: 0
  runAsGroup: 0
  capabilities:
    add:
      - SYS_ADMIN
```


## Install the Universal Profiling Agent in standalone mode

The Universal Profiling Agent profiles your fleet. You need to install and configure it on every machine that you want to profile. The Universal Profiling Agent needs  `root` / `CAP_SYS_ADMIN` privileges to run.
After clicking **Set up Universal Profiling** in the previous step, you’ll see the instructions for installing the Universal Profiling Agent. You can also find these instructions by clicking the **Add data** button in the top-right corner of the page.
The following is an example of the provided instructions for Kubernetes:
![profiling k8s hostagent](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/4409/solutions/images/observability-profiling-k8s-hostagent.png)


### Universal Profiling Agent configuration notes

Consider the following when configuring your Universal Profiling Agent:
- The instructions in Kibana work well for testing environments. For production environments, we recommend setting an immutable version.
- Before Elastic Stack version 8.9 the Universal Profiling Agent versioning scheme was **not aligned with the Elastic Stack version scheme**.
- You can find a list of container image versions in the [Elastic container library repository](https://container-library.elastic.co/r/observability/profiling-agent).
- For Kubernetes deployments, the Helm chart version is already used to configure the same container image, unless overwritten with the `version` parameter in the Helm values file.
- For Elastic Stack version 8.8, use `v3` host agents. For version 8.7, use `v2`. `v3` host agents are incompatible with 8.7 Elastic Stack versions.