# Setting up CodeGuru Profiler
An Amazon CodeGuru Profiler profiling group is a group of applications for which data is meant to be aggregated and analyzed together. To create a profiling group, sign in to the AWS Management Console and set permissions for the CodeGuru Profiler profiling agent.
The profiling agent collects runtime data from your applications. Data that the agent collects is analyzed to provide flame graphs and hourly reports with recommendations for how you can optimize your applications.
You can create a profiling group using your own application or the demo application. For more information about using the demo application, see [Getting started with CodeGuru Profiler](getting-started.md).
Before you can start using CodeGuru Profiler, you must complete setup. If your application runs on AWS Lambda, then you can enable profiling from the Lambda console. If your application runs on a platform other than Lambda, then you can complete the setup process in the CodeGuru Profiler console.
**Topics**
+ [
# Set up in the Lambda console
](setting-up-short.md)
+ [
# Set up in the CodeGuru Profiler console
](setting-up-long.md)
# Set up in the Lambda console
You can use the following method to create a profiling group with your Lambda function. This method automatically creates a profiling group when a profile is available to submit. This method is applicable for runtimes Python 3.8, Python 3.9, Java 8 on Amazon Linux 2 and Java 11 and Java 17 (Corretto). Alternatively, you can create a profiling group by following the instructions in [Setting up in the CodeGuru Profiler console](setting-up-long.md).
If you want to integrate with Lambda for an application with a different runtime, see [Profiling your Java applications that run on AWS Lambda](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/integrating-with-java.html#setting-up-lambda) or [Profiling your Python applications that run on AWS Lambda.](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/integrating-with-python.html#python-lambda).
## Step 1: Sign up for AWS
When you sign up for Amazon Web Services (AWS), your AWS account is automatically signed up for all services in AWS, including CodeGuru Profiler. You're charged only for the services that you use.
If you have an AWS account already, move on to the next task. If you don't have an AWS account, use the following procedure to create one.
**To create an AWS account**
1. Open [https://portal.aws.amazon.com/billing/signup](https://portal.aws.amazon.com/billing/signup).
1. Follow the online instructions.
Part of the sign-up procedure involves receiving a phone call or text message and entering a verification code on the phone keypad.
When you sign up for an AWS account, an *AWS account root user* is created. The root user has access to all AWS services and resources in the account. As a security best practice, assign administrative access to a user, and use only the root user to perform [tasks that require root user access](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html#root-user-tasks).
## Step 2: Enable CodeGuru Profiler
A profiling group can profile one or more applications. Data is aggregated and displayed based on the whole profiling group.
For example, if you have a collection of microservices that handle restaurant recommendations, you can collect profile data and identify performance issues across all these microservices in a single profiling group named "Restaurant-Recommendations".
**To enable profiling from the Lambda console**
1. Sign in to the AWS Management Console, and then open the Lambda console.
1. Choose your Lambda function. In the **Configuration** tab, choose **Monitoring and operation tools**. Choose **Edit**.
1. Enable **Code profiling** in the **Amazon CodeGuru Profiler** section. This creates a profiling group when a profile is available to submit.
**Note**
If you want to delete your profiling group, visit the CodeGuru Profiler console. If you disable **Code profiling** in the Lambda console, your profiling group still exists.
If the execution role of your Lambda function doesn’t have the required CodeGuru Profiler permissions such as [AmazonCodeGuruProfilerAgentAccess](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/security-iam-awsmanpol.html#security-iam-awsmanpol-amazoncodeguruprofileragentaccess) or your function doesn’t have the required environment variables, the Lambda console attempts to add them.
# Set up in the CodeGuru Profiler console
## Step 1: Sign up for AWS
When you sign up for Amazon Web Services (AWS), your AWS account is automatically signed up for all services in AWS, including CodeGuru Profiler. You're charged only for the services that you use.
If you have an AWS account already, move on to the next task. If you don't have an AWS account, use the following procedure to create one.
**To create an AWS account**
1. Open [https://portal.aws.amazon.com/billing/signup](https://portal.aws.amazon.com/billing/signup).
1. Follow the online instructions.
Part of the sign-up procedure involves receiving a phone call or text message and entering a verification code on the phone keypad.
When you sign up for an AWS account, an *AWS account root user* is created. The root user has access to all AWS services and resources in the account. As a security best practice, assign administrative access to a user, and use only the root user to perform [tasks that require root user access](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html#root-user-tasks).
## Step 2: Create a CodeGuru Profiler profiling group
A profiling group can profile one or more applications. Data is aggregated and displayed based on the whole profiling group.
For example, if you have a collection of microservices that handle restaurant recommendations, you can collect profile data and identify performance issues across all these microservices in a single profiling group named "Restaurant-Recommendations".
**To create a profiling group from the CodeGuru Profiler console**
1. Sign in to the AWS Management Console, and then open the CodeGuru Profiler console at [https://console.aws.amazon.com/codeguru/profiler](https://console.aws.amazon.com/codeguru/profiler).
1. In the navigation pane on the left, choose **Profiler**, and then choose **Profiling groups**.
1. On the **Profiling groups** page, choose **Create profiling group**.
1. Provide a **Name** for the new profiling group. Choose the compute platform that on which your applications are running. If your applications run on AWS Lambda, choose the **AWS Lambda** option. Choose **Other** if your applications run on a compute platform other than AWS Lambda, such as Amazon EC2, on-premises servers, or a different platform.
1. Choose **Create profiling group**.
## Step 3: Set permissions
The CodeGuru Profiler profiling agent needs permissions to write data to the profiling group.
You can add the necessary permissions by adding the following policy.
```
arn:aws:iam::aws:policy/AmazonCodeGuruProfilerAgentAccess
```
**To set permissions for the new CodeGuru Profiler agent:**
1. Start by choosing **Give access to users and roles**. Choose the IAM users and roles that can submit profiling data and configure the agent.
1. If your applications run on AWS Lambda, choose the role that your AWS Lambda function uses.
1. After you grant permissions for a user or role, you don't need to attach IAM policies for agent permissions.
![\[Image: Manage user and role permissions to submit profiling data.\]](http://docs.aws.amazon.com/codeguru/latest/profiler-ug/images/manage-permissions.png)
Use `IAM:ListUsers` and `IAM:ListRoles` permissions to see your users and roles. Otherwise, you can add a user or Amazon Resource Name (ARN) role. You'll see the following message.
![\[Image: Error message on the manage permissions section. Cannot list users and roles.\]](http://docs.aws.amazon.com/codeguru/latest/profiler-ug/images/manage-permissions-error.png)
Alternatively, you can add a policy like the following to the role that your application uses. For more information about roles, see [Modifying a role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html).
```
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"codeguru-profiler:ConfigureAgent",
"codeguru-profiler:PostAgentProfile"
],
"Resource": "arn:aws:codeguru-profiler:::profilingGroup/"
}
]
}
```
If your application is running in a Region that CodeGuru Profiler doesn't support and if you have the appropriate permissions, you can submit profiling data to one of the supported Regions. For more information about using CodeGuru Profiler in a Region it doesn't support, see [Working with unsupported Regions](working-with-unsupported-regions.md).
## Step 4: Start CodeGuru Profiler in your application
### Run your application with the profiling agent
Run your application with the CodeGuru Profiler profiling agent. You can use CodeGuru Profiler on your Python or Java virtual machine (JVM)-based applications.
For your JVM-based application, you can either start the agent as a JVM agent, or start it manually with a code change in your application. To start profiling your application, see [Integrating with JVM](integrating-with-java.md).
To start profiling your Python application, see [Integrating with Python](integrating-with-python.md).
### Enable data collection for the heap summary visualization
The CodeGuru Profiler heap summary shows your application's heap usage over time. This feature is available for JVM applications. For more information on the heap summary, see [Understanding the heap summary](working-with-visualizations-heap-summary.md).
Heap summary collection requires Java agent version 1.2.4 or greater. Opt in to heap summary data collection by completing the onboarding method used to enable the agent. The following are the onboarding methods from which you can choose.
#### Command line (-javaagent)
Add `heapSummaryEnabled:true`. The following example shows how to enable heap summary collection.
```
-javaagent:/path/to/codeguru-profiler-java-agent-standalone-1.2.4.jar="profilingGroupName:myProfilingGroup,heapSummaryEnabled:true"
```
#### Update your code
Set `.withHeapSummary` to `true`. The following is an example of what your code might look like.
```
class MyClass {
public static void main(String[] args) {
Profiler.builder()
.profilingGroupName("MyProfilingGroup")
.withHeapSummary(true) // optional - to start without heap profiling set to false or remove line
.build()
.start();
...
}
```
#### Environment variables
Set `AWS_CODEGURU_PROFILER_HEAP_SUMMARY_ENABLED` to `true`.