View Source AWS.ApplicationSignals (aws-elixir v1.0.4)
Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications.
It enables real-time service health dashboards and helps you track long-term performance trends against your business goals. The application-centric view provides you with unified visibility across your applications, services, and dependencies, so you can proactively monitor and efficiently triage any issues that may arise, ensuring optimal customer experience.
Application Signals provides the following benefits:
* Automatically collect metrics and traces from your applications, and display key metrics such as call volume, availability, latency, faults, and errors.
* Create and monitor service level objectives (SLOs).
* See a map of your application topology that Application Signals automatically discovers, that gives you a visual representation of your applications, dependencies, and their connectivity.
Application Signals works with CloudWatch RUM, CloudWatch Synthetics canaries, and Amazon Web Services Service Catalog AppRegistry, to display your client pages, Synthetics canaries, and application names within dashboards and maps.
Link to this section Summary
Functions
Use this operation to retrieve one or more service level objective (SLO) budget reports.
Creates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations.
Deletes the specified service level objective.
Returns information about a service discovered by Application Signals.
Returns information about one SLO created in the account.
Returns a list of service dependencies of the service that you specify.
Returns the list of dependents that invoked the specified service during the provided time range.
Returns a list of SLOs created in this account.
Returns a list of the operations of this service that have been discovered by Application Signals.
Returns a list of services that have been discovered by Application Signals.
Displays the tags associated with a CloudWatch resource.
Enables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the AWSServiceRoleForCloudWatchApplicationSignals service-linked role.
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource, such as a service level objective.
Removes one or more tags from the specified resource.
Updates an existing service level objective (SLO).
Link to this section Functions
batch_get_service_level_objective_budget_report(client, input, options \\ [])
View SourceUse this operation to retrieve one or more service level objective (SLO) budget reports.
An error budget is the amount of time or requests in an unhealthy state that your service can accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be unmet. For example, an SLO with a threshold of 99.95% and a monthly interval translates to an error budget of 21.9 minutes of downtime in a 30-day month.
Budget reports include a health indicator, the attainment value, and remaining budget.
For more information about SLO error budgets, see SLO concepts.
Creates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations.
Use SLOs to set and track specific target levels for the reliability and availability of your applications and services. SLOs use service level indicators (SLIs) to calculate whether the application is performing at the level that you want.
Create an SLO to set a target for a service or operation’s availability or latency. CloudWatch measures this target frequently you can find whether it has been breached.
The target performance quality that is defined for an SLO is the attainment goal.
You can set SLO targets for your applications that are discovered by Application Signals, using critical metrics such as latency and availability. You can also set SLOs against any CloudWatch metric or math expression that produces a time series.
When you create an SLO, you specify whether it is a period-based SLO or a request-based SLO. Each type of SLO has a different way of evaluating your application's performance against its attainment goal.
A period-based SLO uses defined periods* of time within
a specified total time interval. For each period of time, Application Signals
determines whether the
application met its goal. The attainment rate is calculated as the number of good periods/number of total periods.
For example, for a period-based SLO, meeting an attainment goal of 99.9% means that within your interval, your application must meet its performance goal during at least 99.9% of the time periods.
A request-based SLO* doesn't use pre-defined periods of time. Instead,
the SLO measures number of good requests/number of total requests during the
interval. At any time, you can find the ratio of
good requests to total requests for the interval up to the time stamp that you
specify, and measure that ratio against the goal set in your SLO.
After you have created an SLO, you can retrieve error budget reports for it. An error budget is the amount of time or amount of requests that your application can be non-compliant with the SLO's goal, and still have your application meet the goal.
For a period-based SLO, the error budget starts at a number defined by the highest number of periods that can fail to meet the threshold, while still meeting the overall goal. The remaining error budget* decreases with every failed period that is recorded. The error budget within one interval can never increase.
For example, an SLO with a threshold that 99.95% of requests must be completed under 2000ms every month translates to an error budget of 21.9 minutes of downtime per month.
* For a request-based SLO, the remaining error budget is dynamic and can increase or decrease, depending on the ratio of good requests to total requests.
For more information about SLOs, see Service level objectives (SLOs).
When you perform a CreateServiceLevelObjective operation, Application Signals
creates the AWSServiceRoleForCloudWatchApplicationSignals service-linked role,
if it doesn't already exist in your account. This service-
linked role has the following permissions:
*
xray:GetServiceGraph
*
logs:StartQuery
*
logs:GetQueryResults
*
cloudwatch:GetMetricData
*
cloudwatch:ListMetrics
*
tag:GetResources
*
autoscaling:DescribeAutoScalingGroups
Deletes the specified service level objective.
Returns information about a service discovered by Application Signals.
Returns information about one SLO created in the account.
Returns a list of service dependencies of the service that you specify.
A dependency is an infrastructure component that an operation of this service connects with. Dependencies can include Amazon Web Services services, Amazon Web Services resources, and third-party services.
Returns the list of dependents that invoked the specified service during the provided time range.
Dependents include other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.
Returns a list of SLOs created in this account.
Returns a list of the operations of this service that have been discovered by Application Signals.
Only the operations that were invoked during the specified time range are returned.
list_services(client, end_time, max_results \\ nil, next_token \\ nil, start_time, options \\ [])
View SourceReturns a list of services that have been discovered by Application Signals.
A service represents a minimum logical and transactional unit that completes a business function. Services are discovered through Application Signals instrumentation.
Displays the tags associated with a CloudWatch resource.
Tags can be assigned to service level objectives.
Enables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the AWSServiceRoleForCloudWatchApplicationSignals service-linked role.
This service- linked role has the following permissions:
*
xray:GetServiceGraph
*
logs:StartQuery
*
logs:GetQueryResults
*
cloudwatch:GetMetricData
*
cloudwatch:ListMetrics
*
tag:GetResources
*
autoscaling:DescribeAutoScalingGroups
After completing this step, you still need to instrument your Java and Python applications to send data to Application Signals. For more information, see Enabling Application Signals.
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource, such as a service level objective.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with an alarm that already has tags. If you
specify a new tag key for the alarm,
this tag is appended to the list of tags associated
with the alarm. If you specify a tag key that is already associated with the
alarm, the new tag value that you specify replaces
the previous value for that tag.
You can associate as many as 50 tags with a CloudWatch resource.
Removes one or more tags from the specified resource.
Updates an existing service level objective (SLO).
If you omit parameters, the previous values of those parameters are retained.
You cannot change from a period-based SLO to a request-based SLO, or change from a request-based SLO to a period-based SLO.