- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
ApplicationInsightsClient
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.
Installation
npm install @aws-sdk/client-application-insights
yarn add @aws-sdk/client-application-insights
pnpm add @aws-sdk/client-application-insights
ApplicationInsightsClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
AddWorkloadCommand | Adds a workload to a component. Each component can have at most five workloads. |
CreateApplicationCommand | Adds an application that is created from a resource group. |
CreateComponentCommand | Creates a custom component by grouping similar standalone instances to monitor. |
CreateLogPatternCommand | Adds an log pattern to a |
DeleteApplicationCommand | Removes the specified application from monitoring. Does not delete the application. |
DeleteComponentCommand | Ungroups a custom component. When you ungroup custom components, all applicable monitors that are set up for the component are removed and the instances revert to their standalone status. |
DeleteLogPatternCommand | Removes the specified log pattern from a |
DescribeApplicationCommand | Describes the application. |
DescribeComponentCommand | Describes a component and lists the resources that are grouped together in a component. |
DescribeComponentConfigurationCommand | Describes the monitoring configuration of the component. |
DescribeComponentConfigurationRecommendationCommand | Describes the recommended monitoring configuration of the component. |
DescribeLogPatternCommand | Describe a specific log pattern from a |
DescribeObservationCommand | Describes an anomaly or error with the application. |
DescribeProblemCommand | Describes an application problem. |
DescribeProblemObservationsCommand | Describes the anomalies or errors associated with the problem. |
DescribeWorkloadCommand | Describes a workload and its configuration. |
ListApplicationsCommand | Lists the IDs of the applications that you are monitoring. |
ListComponentsCommand | Lists the auto-grouped, standalone, and custom components of the application. |
ListConfigurationHistoryCommand | Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are:
|
ListLogPatternSetsCommand | Lists the log pattern sets in the specific application. |
ListLogPatternsCommand | Lists the log patterns in the specific log |
ListProblemsCommand | Lists the problems with your application. |
ListTagsForResourceCommand | Retrieve a list of the tags (keys and values) that are associated with a specified application. A tag is a label that you optionally define and associate with an application. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key. |
ListWorkloadsCommand | Lists the workloads that are configured on a given component. |
RemoveWorkloadCommand | Remove workload from a component. |
TagResourceCommand | Add one or more tags (keys and values) to a specified application. A tag is a label that you optionally define and associate with an application. Tags can help you categorize and manage application in different ways, such as by purpose, owner, environment, or other criteria. Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key. |
UntagResourceCommand | Remove one or more tags (keys and values) from a specified application. |
UpdateApplicationCommand | Updates the application. |
UpdateComponentCommand | Updates the custom component name and/or the list of resources that make up the component. |
UpdateComponentConfigurationCommand | Updates the monitoring configurations for the component. The configuration input parameter is an escaped JSON of the configuration and should match the schema of what is returned by |
UpdateLogPatternCommand | Adds a log pattern to a |
UpdateProblemCommand | Updates the visibility of the problem or specifies the problem as |
UpdateWorkloadCommand | Adds a workload to a component. Each component can have at most five workloads. |
ApplicationInsightsClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: ApplicationInsightsClientConfig