# Enabling Elastic Beanstalk enhanced health reporting
<a name="health-enhanced-enable"></a>

This topic explains how enhanced health reporting is enabled. It provides procedures for you to enable the enhanced health feature for your environment with the Elastic Beanstalk console, the EB CLI, and with an .ebextensions configuration.

New environments created with the latest [platform versions](concepts.platforms.md) include the AWS Elastic Beanstalk [health agent](health-enhanced.md#health-enhanced-agent), which supports enhanced health reporting. If you create your environment in the Elastic Beanstalk console or with the EB CLI, enhanced health is enabled by default. You can also set your health reporting preference in your application's source code using [configuration files](ebextensions.md).

Enhanced health reporting requires an [instance profile](concepts-roles-instance.md) and [service role](concepts-roles-service.md) with the standard set of permissions. When you create an environment in the Elastic Beanstalk console, Elastic Beanstalk creates the required roles automatically. See [Learn how to get started with Elastic Beanstalk](GettingStarted.md) for instructions on creating your first environment.

**Topics**
+ [Enabling enhanced health reporting using the Elastic Beanstalk console](#health-enhanced-enable-console)
+ [Enabling enhanced health reporting using the EB CLI](#health-enhanced-enable-ebcli)
+ [Enabling enhanced health reporting using a configuration file](#health-enhanced-enable-config)

## Enabling enhanced health reporting using the Elastic Beanstalk console
<a name="health-enhanced-enable-console"></a>

**To enable enhanced health reporting in a running environment using the Elastic Beanstalk console**

1. Open the [Elastic Beanstalk console](https://console.aws.amazon.com/elasticbeanstalk), and in the **Regions** list, select your AWS Region.

1. In the navigation pane, choose **Environments**, and then choose the name of your environment from the list.

1. In the navigation pane, choose **Configuration**.

1. In the **Monitoring** configuration category, choose **Edit**.

1. Under **Health reporting**, for **System**, choose **Enhanced**.
**Note**  
The options for enhanced health reporting don't appear if you are using an [unsupported platform or version](health-enhanced.md).

1. To save the changes choose **Apply** at the bottom of the page.

The Elastic Beanstalk console defaults to enhanced health reporting when you create a new environment with a version 2 (v2) platform version. You can disable enhanced health reporting by changing the health reporting option during environment creation.

**To disable enhanced health reporting when creating an environment using the Elastic Beanstalk console**

1. Open the [Elastic Beanstalk console](https://console.aws.amazon.com/elasticbeanstalk), and in the **Regions** list, select your AWS Region.

1. [Create an application](applications.md) or select an existing one.

1. [Create an environment](using-features.environments.md). On the **Create a new environment** page, before choosing **Create environment**, choose **Configure more options**.

1. In the **Monitoring** configuration category, choose **Edit**.

1. Under **Health reporting**, for **System**, choose **Basic**.

1. Choose **Save**.

## Enabling enhanced health reporting using the EB CLI
<a name="health-enhanced-enable-ebcli"></a>

When you create a new environment with the **eb create** command, the EB CLI enables enhanced health reporting by default and applies the default instance profile and service role.

You can specify a different service role by name by using the `--service-role` option.

If you have an environment running with basic health reporting on a v2 platform version and you want to switch to enhanced health, follow these steps.

**To enable enhanced health on a running environment using the [EB CLI](eb-cli3.md)**

1. Use the **eb config** command to open the configuration file in the default text editor.

   ```
   ~/project$ eb config
   ```

1. Locate the `aws:elasticbeanstalk:environment` namespace in the settings section. Ensure that the value of `ServiceRole` is not null and that it matches the name of your [service role](concepts-roles-service.md).

   ```
     aws:elasticbeanstalk:environment:
       EnvironmentType: LoadBalanced
       ServiceRole: aws-elasticbeanstalk-service-role
   ```

1. Under the `aws:elasticbeanstalk:healthreporting:system:` namespace, change the value of `SystemType` to **enhanced**.

   ```
     aws:elasticbeanstalk:healthreporting:system:
       SystemType: enhanced
   ```

1. Save the configuration file and close the text editor.

1. The EB CLI starts an environment update to apply your configuration changes. Wait for the operation to complete or press **Ctrl\$1C** to exit safely.

   ```
   ~/project$ eb config
   Printing Status:
   INFO: Environment update is starting.
   INFO: Health reporting type changed to ENHANCED.
   INFO: Updating environment no-role-test's configuration settings.
   ```

## Enabling enhanced health reporting using a configuration file
<a name="health-enhanced-enable-config"></a>

You can enable enhanced health reporting by including a [configuration file](ebextensions.md) in your source bundle. The following example shows a configuration file that enables enhanced health reporting and assigns the default service and instance profile to the environment:

**Example .ebextensions/enhanced-health.config**  

```
option_settings:
  aws:elasticbeanstalk:healthreporting:system:
    SystemType: enhanced
  aws:autoscaling:launchconfiguration:
    IamInstanceProfile: aws-elasticbeanstalk-ec2-role
  aws:elasticbeanstalk:environment:
    ServiceRole: aws-elasticbeanstalk-service-role
```

If you created your own instance profile or service role, replace the highlighted text with the names of those roles.