Skip to main content
Sign in

Creating an extended integration for AWS EC2 Average CPU usage

  • November 10, 2024 13:08
  • Updated

Integrate Amazon EC2 with Oomnitza to gain visibility of the average CPU usage for your EC2 instances.

This integration offers the flexibility to specify multiple AWS regions, ensuring a comprehensive overview of your EC2 instances across different geographic areas. Additionally, it supports the use of AWS IAM roles, allowing for the collection of instance data across various AWS accounts and roles, thereby enhancing cross-account visibility and management.

Surface key information in operational dashboards and create scheduled reports to share knowledge with your colleagues

Before you start

When you create the integration, you can specify the following:

1. Multiple AWS Regions

Enter a space-separated list of AWS Regions, such as us-east-1 us-west-2. The data received from each region appears as a separate sync session in the Sync Sessions table.

AWS_integration_sync_sessions.PNG

To find your AWS region, refer to Regions, Availability Zones, and Local Zones.

2. Enable Cross-Account access

Select the IAM Roles checkbox to iterate over all AWS accounts with IAM roles. The data received from all iterated roles will be added as one sync session for each region in the Sync Sessions table.

Before you select this option, you must enable cross-account access in your AWS accounts. For further information see Create an IAM user to easily access all your accounts using the AWS console.

3. Run the standard AWS EC2 asset load

For optimal results, run the standard AWS EC2 asset load prior to running this integration. Doing so will enable the retrieval of comprehensive details about the instances, including their region, instance ID, current state, network and connectivity attributes, security features, resource allocation, and performance metrics. Subsequently, you can employ the EC2 CPU integration to synchronize based on Instance ID and incorporate CPU usage data.

Adding the credentials

When you create the integration, you need to add your AWS Access keys to Oomnitza. See Adding your AWS credentials to Oomnitza.

This integration imports data about EC2 instances (both running and stopped, but excluding terminated instances) into Oomnitza. It operates with 'ReadOnlyAccess' permissions. For information on the API used in this integration, refer to AWS API Documentation: DescribeInstances. 

Ensure that AWS CloudWatch is properly enabled and configured for your AWS resources, as this integration queries CloudWatch's monitoring API for specific Amazon EC2 instance metrics. It retrieves the average CPU utilization data for the past week, with the information aggregated at 30-minute periods. The average CPU utilization values are calculated from the periods and are stored in AWS CloudWatch, and not directly in your EC2 instance. Be aware that using AWS monitoring APIs in this integration could result in additional charges from AWS. For detailed information on potential costs, please contact AWS directly.

Tip
 For those requiring tailored monitoring periods for AWS EC2, different from the default settings of one week and 30 minutes in this integration, the 'Amazon AWS EC2 Get Average CPU Load' preset is a recommended alternative. This preset allows customization within a workflow for more precise monitoring needs.

Creating the asset integration

  1. In Oomnitza, click Configuration> Integrations> Overview.
  2. Click Block view block_view.PNG
  3. Scroll down to the Extended section for asset integrations.
  4. Click NEW INTEGRATION.
  5. Select the integration in the sidebar.
  6. Click ADD.

Integration details overview

More information is provided about the following fields to help you complete the integration:

Installation type

Select Cloud if you want to store credentials in the Oomnitza cloud.

Select Local if you want to store credentials locally. Local extended integrations do not support AWS and OAuth authentication. If you want to sync Oomnitza with vendor applications that require AWS or OAUTH authentication, select Cloud.

Integration preferences

By default, the option Create & Update option is selected. Select this option  when you want to edit records and add new records. If you want to edit records and not add new records, select Update Only. If you only want to add new records, select Create Only.

Integration details

To review or update the integrations details, click Edit edit_black_pencil_icon.svg.

  1. Update the integration name if necessary. 
  2. Select an installation type.
  3. For integration preferences, select an option.
  4. Enter the name of the integration user.

Credential details

If you selected Cloud as the installation type, choose one of the following options:

  • Select the credentials that were created for the integration.
  • Edit the credentials that were created for the integration.
  • Create new credentials

Schedule

By default, data is streamed to Oomnitza once every day.

You can configure the schedule to meet your needs such as changing the interval or changing the time so that the data is streamed when your system isn't busy.

  1. Click the Edit edit_black_pencil_icon.svg.
  2. Configure your schedule.
  3. Click Update.

Mappings

To map the fields to Oomnitza, click Edit edit_black_pencil_icon.svg.

TipBulb_Icon_small.svgYou can define rules for your integration by selecting Edit integration edit_integration.svg on the mapping page. For example, you may only want to run the integration if a certain contact or region exists. See Filtering integration results.  
You can add new fields to your integration by selecting Add new field  add_grey_rectangel_icon.svg on the mapping page. All you need to do is specify the property name. See Creating custom API fields. 

Creating custom mappings

Map AWS EC2 fields to Oomnitza fields to get the user information that you need. For the field mapping, it is recommended to follow these steps:

  1. Map the Instance ID to the Oomnitza Serial Number field, or a similar field. You can map the fields by:
    • Dragging the source field to the target field on the Oomnitza side 
    • Selecting the dropdown arrow on the source field and choosing an appropriate target field from the list.
  2. Create a custom mapping for the Max Avg CPU Load. To create a custom mapping, do the following:
    1. Click the down arrow on the Max Avg CPU Load field.
    2. Select Add new Oomnitza field.
    3. Change the name of the field to Max Avg CPU Load.
    4. Click CREATE. 
  3. Assign a sync key to the Serial Number field.
  4. Click UPDATE. 

Tracking information for asset loads 

When the integration is run, you can track the name of the credentials that were used and the source of the data. To do this, you map the following fields to Oomnitza:   

  • Connect: Credentials
  • Connect: Enable Cross-Account
  • Connect: Region

Custom mappings

Connector Sync Time
Max Avg CPU Load
Owner ID
Instance ID

Launching the integration

Your integration is in Draft mode until the required mandatory fields are added. When added, click Launch to activate your integration. 

small_blue_link.svg If you selected Cloud as the installation type when creating the integration, see Running an extended integration

small_blue_link.svg If you selected Local as the installation type when creating the integration, see Running an extended integration locally.

Viewing data ingested by Oomnitza

Viewing ingested asset data

For asset integrations, click Hardware. If the asset integration also ingests software data, click Software.

Viewing ingested user data

For user integrations, click People. If you chose the option to ingest User and SaaS user data, click Software > SaaS, click the SaaS app, and then click the Users tab. 

Related Links

Related articles

Comments

0 comments

Please sign in to leave a comment.