Analysis: AWS Analyze
Analysis: AWS Analyze
#340460
Description
The /analysis/cloud/aws/analyze resource is used to collect AWS CloudWatch data and initiate optimization analysis with the cloud infrastructure collected. Below are the series of processes that occur when the initial /analysis/cloud/aws/analyze request is triggered:
- Set up and initiate data collection of the specified AWS account and schedule it to run automatically on a nightly basis.
- Initiate analysis on the data collected using the default policy.
- Subsequent analysis is scheduled to run on a nightly basis after the completion of data collection.
- Optionally, you can configure the results to be sent to a webhook URI upon analysis completion. See Add webhook to an analysis for details.
-
While data collection or analysis is in progress, you can check the status (using /analysis/AWS/<subscriptionId>/status resource) or wait for the results to be published to an optional webhook URI.
-
The reporting database update is scheduled to run automatically on a nightly basis after the completion of the analysis. This process produces reports for each instance recommendation, which is useful for analysts or application owners. These reports are only created after the scheduled analysis is completed, and may therefore only be available on the following day for a new analysis. Exact timing depends on the size of your environment.
Ad-Hoc Tasks
Generally you do not need to run once-off tasks as both data collection and analysis tasks are scheduled automatically. In cases where you need make an ad-hoc request in addition to the scheduled job, the functionality exists for this endpoint.
Historical Data Collection
When Densify initiates data collection, normally audits collect only the last 24 hours of data. You can optionally collect up to 60 days of historical data. The historical data provides a more representative set of data on which to base resizing and optimization recommendations. You can run an ad-hoc task to collect the historical data.
Note: Collection of historical data can take a significant amount of time, depending on the number of instances from which Densifyis collecting data. Contact [email protected] to enable historical data collection and details of the performance impact.
A connection to the specified cloud account must already exist before you can run an ad hoc audit. When you execute an ad hoc refresh an audit task will be configured but a new connection will not be created. If the cloud connection does not already exist and the API POST contains triggerAdhocAudit=true, then you will get an error message.
If there is more than one account associated with the specified account ID (i.e. a payer account with many linked accounts), the Densify API handles it in the same way that analyses are currently rerun using the POST operation.
Once the audit is complete you need to rerun the associated analyses as indicated below or you can wait for the next scheduled execution of the analyses and RDB populate.
Analysis Update
You can make an ad-hoc request to refresh an existing analysis, outside of the scheduled nightly run using /analysis/cloud/<aws|azure|gcp>/analyze. This manual, ad hoc analysis request does not perform data collection or reporting database (RDB) updates. It only runs the analysis on the existing data collected with the following behavior:
- The analysis uses the policy that is configured for the analysis. Contact [email protected] to change the configured policy.
- If a new webhook is provided, the analysis will send results to the new webhook URI. If no webhook is provided, the analysis will send results to the existing webhook, if configured.
- If the same analysis is already running, the request does not proceed and an appropriate message is returned.
- If the specified analysis has data collection scheduled within 30 minutes, the request does not proceed and an appropriate message is returned. For example, if data collection is scheduled to run at 12:05 AM, and you initiate a manual, ad hoc analyze request at 11:45 PM, then the analysis will not proceed and an error message is returned.
Prerequisite Configuration
Before you can collect AWS CloudWatch data, you need to create an IAM role for Densify to have a trust relationship with your AWS account that contains data. See
Resource
Supported Operations
Table: AWS Analyze Supported Operations
|
Operation |
HTTP Method |
Input |
Output |
Description |
|
POST /analysis/cloud/aws/analyze |
Request Body Parameter:
|
This resource operation is used to:
|
||
|
POST /analysis/cloud/aws/analyze |
Request Body Parameter:
|
This resource operation is used to re-run an analysis that already exists. You can specify an updated policy and/or webhook to use for the analysis. Data collection is not run. Data collection only occurs during the first /analyze request, and is then scheduled to run nightly The updated webhook is saved and will be used in the next scheduled analyses. You cannot initiate a request if data collection or the analyses are in progress or within 30 minutes of the time that these tasks are scheduled to run. |
||
|
List all generated analyses |
GET /analysis/cloud/aws/ |
Path Parameter:
Request Body Parameter:
|
Lists all analyses that have been created with details. |
This resource operation is used to obtain the analysis ID that is required for other operations. |
|
POST /analysis/cloud/aws/analyze |
Request Body Parameter: |
This resource operation is used to re-run an audit for which a connection and daily, scheduled audit already exists. You can optionally specify the number of days of historical data to collect. If not specified the previous 60 days from yesterday's date are collected. If you initiate an audit request when data collection or analysis is already running or within 30 minutes of the time that these tasks are scheduled to run, then the request will fail and an error message is returned. |
Table: AWS Analysis Path Parameters
|
Parameter Name |
Type |
Description |
|
string |
The unique referenced ID of the AWS analysis. |
Table: AWS Analysis Request Body Parameters
|
Parameter Name |
Type |
Description |
|
string |
The AWS account ID with the CloudWatch data to collect. See |
|
|
(optional) |
string |
Use the connection name to clearly identify this connection within Densify. This name will appear in the Saved Connections list in theDensify UI. By default, the connection name is set to the Subscription ID. The connection name must be unique within the Azure connection type section, so if the name is already in use, the request fails with an error message. This connection name can be used for filtering. Note: The Connection Name is limited to 32-characters. |
|
string |
The Amazon Resource Name (ARN) for the IAM role that you created in AWS to collect data. See To update the ARN, refer to Analysis: AWS Analyze. |
|
|
string |
The external ID specified for Densify when the IAM role was created. See To update the external ID, refer to Analysis: AWS Analyze. |
|
|
(optional) |
string |
The flag to trigger an ad-hoc 60-day historical audit. This parameter is optional and used to run the 60-day historical audit immediately and once only. Typically the 60-day historical audit is run first, when data collection is initiated for the specified AWS account. If this audit has been disabled for performance reasons, it can be run to collect the historical data as compute resources are available. A connection to the specified AWS account must already exist before you can use this flag. A once-off task will be configured and a new connection will not be created, if the connection does not already exist. If there is no existing connection AND the API post contains ad hoc=true, then you will see an error message. |
|
(optional) |
|
The webhook definition to an external application. Optimization results are sent to the webhook-defined application when analysis is complete. See Parameters for details of each parameter in the webhook definition. |
Table: AWS Analysis Response Schema
|
Element |
Type |
Filter/Sort |
Description |
|
string |
|
The referenced resource to the analysis entity. See Analysis: Entity for details of the analysis entity resource. When a new analysis is requested from the /analyze resource, the entity ID will not be available until after data collection completes and the analysis entity is created. |
|
|
string |
|
The message for the status response is returned. |
|
|
number |
|
The HTTP response code of the request. Possible status values include:
|
Examples
Example: Running AWS Data Collection and Analysis
The following example shows you how to initiate AWS data collection and analysis, and send the results to a WebHook.
Example: Running AWS Data Collection and Analysis
Request:
POST /analysis/cloud/aws/analyze
{
"accountId": "188665225420",
"roleArnName": "arn:aws:iam::188665225420:role/ReadOnlyAccess",
"roleExternalId": "password",
"webHook": {
"uri": "http://mywebhookserver/webhook/results",
"authType": "basic",
"authValue": "tester:testerpassword"
}
}Response:
{
"href": "Not available",
"message": "OK",
"status": 200
}Example: Running the 60-Day Historical Audit
The following example shows you how to run an audit to collect 60 days of historical data.
Example: Running 60-Day Historical Audit
Request:
POST /analysis/cloud/aws/analyze
{
"accountId": "188665225420",
"roleArnName": "arn:aws:iam::188665225420:role/ReadOnlyAccess",
"roleExternalId": "password",
"triggerAdhocAudit": "Yes",
"startDayOffset":"20" ,
"endDayOffset":"10"
}Response:
{
"href": "/analysis/aws/209726931496/status",
"message": "Analysis in progress",
"status": 200
}