/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.
- Once data collection succeeds and an
analysisIdis created for the account, you can check progress with/analysis/cloud/aws/<analysisId>/statusor wait for the results to be published to an optional webhook URI. Accounts that have not produced ananalysisId(for example, due to unsupported resources or insufficient data) cannot use the status endpoint until an analysis run begins. - 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.
When onboarding an account using the
/analysis/cloud/aws/analyze endpoint, receiving a 200 status code signals that the onboarding was successful.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 support@kubex.ai 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.