Amazon CloudWatch Application Signals¶

Description¶

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.

Usage¶

cloudwatchapplicationsignals(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.
- credentials:
  - creds:
    - access_key_id: AWS access key ID
    - secret_access_key: AWS secret access key
    - session_token: AWS temporary session token
  - profile: The name of a profile to use. If not given, then the default profile is used.
  - anonymous: Set anonymous credentials.
- endpoint: The complete URL to use for the constructed client.
- region: The AWS Region used in instantiating the client.
- close_connection: Immediately close all HTTP connections.
- timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
- s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
- sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
- use_dual_stack: Set this to true to use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to the AWS_USE_DUALSTACK_ENDPOINT environment variable when unset.
credentials

Optional credentials shorthand for the config parameter
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint

Optional shorthand for complete URL to use for the constructed client.
region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- cloudwatchapplicationsignals(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string",
    use_dual_stack = "logical"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

`batch_delete_instrumentation_configurations`	Deletes multiple instrumentation configurations in a single request
`batch_get_service_level_objective_budget_report`	Use this operation to retrieve one or more service level objective (SLO) budget reports
`batch_update_exclusion_windows`	Add or remove time window exclusions for one or more Service Level Objectives (SLOs)
`create_instrumentation_configuration`	Creates a dynamic instrumentation configuration for a specific code or endpoint location within a service and environment
`create_service_level_objective`	Creates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations
`delete_grouping_configuration`	Deletes the grouping configuration for this account
`delete_instrumentation_configuration`	Deletes the specified instrumentation configuration
`delete_service_level_objective`	Deletes the specified service level objective
`get_instrumentation_configuration`	Returns the details of a single instrumentation configuration identified by service, environment, signal type, and location
`get_instrumentation_configuration_status`	Retrieves the status history for a single instrumentation configuration during a specified time range
`get_service`	Returns information about a service discovered by Application Signals
`get_service_level_objective`	Returns information about one SLO created in the account
`list_audit_findings`	Returns a list of audit findings that provide automated analysis of service behavior and root cause analysis
`list_entity_events`	Returns a list of change events for a specific entity, such as deployments, configuration changes, or other state-changing activities
`list_grouping_attribute_definitions`	Returns the current grouping configuration for this account, including all custom grouping attribute definitions that have been configured
`list_instrumentation_configurations`	Returns all active instrumentation configurations for a service and environment
`list_service_dependencies`	Returns a list of service dependencies of the service that you specify
`list_service_dependents`	Returns the list of dependents that invoked the specified service during the provided time range
`list_service_level_objective_exclusion_windows`	Retrieves all exclusion windows configured for a specific SLO
`list_service_level_objectives`	Returns a list of SLOs created in this account
`list_service_operations`	Returns a list of the operations of this service that have been discovered by Application Signals
`list_services`	Returns a list of services that have been discovered by Application Signals
`list_service_states`	Returns information about the last deployment and other change states of services
`list_tags_for_resource`	Displays the tags associated with a CloudWatch resource
`put_grouping_configuration`	Creates or updates the grouping configuration for this account
`report_instrumentation_configuration_status`	Reports the status of one or more instrumentation configurations from SDK instances
`start_discovery`	Enables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the AWSServiceRoleForCloudWatchApplicationSignals service-linked role
`tag_resource`	Assigns one or more tags (key-value pairs) to the specified CloudWatch resource, such as a service level objective
`untag_resource`	Removes one or more tags from the specified resource
`update_service_level_objective`	Updates an existing service level objective (SLO)

Examples¶

svc <- cloudwatchapplicationsignals()
svc$batch_delete_instrumentation_configurations(
  Foo = 123
)