Client
applicationinsights | R Documentation |
Amazon CloudWatch Application Insights¶
Description¶
Amazon CloudWatch Application Insights is a service that helps you detect common problems with your applications. It enables you to pinpoint the source of issues in your applications (built with technologies such as Microsoft IIS, .NET, and Microsoft SQL Server), by providing key insights into detected problems.
After you onboard your application, CloudWatch Application Insights identifies, recommends, and sets up metrics and logs. It continuously analyzes and correlates your metrics and logs for unusual behavior to surface actionable problems with your application. For example, if your application is slow and unresponsive and leading to HTTP 500 errors in your Application Load Balancer (ALB), Application Insights informs you that a memory pressure problem with your SQL Server database is occurring. It bases this analysis on impactful metrics and log errors.
Usage¶
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
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 <- applicationinsights(
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"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations¶
- add_workload
- Adds a workload to a component
- create_application
- Adds an application that is created from a resource group
- create_component
- Creates a custom component by grouping similar standalone instances to monitor
- create_log_pattern
- Adds an log pattern to a LogPatternSet
- delete_application
- Removes the specified application from monitoring
- delete_component
- Ungroups a custom component
- delete_log_pattern
- Removes the specified log pattern from a LogPatternSet
- describe_application
- Describes the application
- describe_component
- Describes a component and lists the resources that are grouped together in a component
- describe_component_configuration
- Describes the monitoring configuration of the component
- Describes the recommended monitoring configuration of the component
- describe_log_pattern
- Describe a specific log pattern from a LogPatternSet
- describe_observation
- Describes an anomaly or error with the application
- describe_problem
- Describes an application problem
- describe_problem_observations
- Describes the anomalies or errors associated with the problem
- describe_workload
- Describes a workload and its configuration
- list_applications
- Lists the IDs of the applications that you are monitoring
- list_components
- Lists the auto-grouped, standalone, and custom components of the application
- list_configuration_history
- Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights
- list_log_patterns
- Lists the log patterns in the specific log LogPatternSet
- list_log_pattern_sets
- Lists the log pattern sets in the specific application
- list_problems
- Lists the problems with your application
- list_tags_for_resource
- Retrieve a list of the tags (keys and values) that are associated with a specified application
- list_workloads
- Lists the workloads that are configured on a given component
- remove_workload
- Remove workload from a component
- tag_resource
- Add one or more tags (keys and values) to a specified application
- untag_resource
- Remove one or more tags (keys and values) from a specified application
- update_application
- Updates the application
- update_component
- Updates the custom component name and/or the list of resources that make up the component
- update_component_configuration
- Updates the monitoring configurations for the component
- update_log_pattern
- Adds a log pattern to a LogPatternSet
- update_problem
- Updates the visibility of the problem or specifies the problem as RESOLVED
- update_workload
- Adds a workload to a component