AWS.ApplicationInsights — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Inherits:

AWS.Service

Identifier:

applicationinsights

API Version:

2018-11-25

Defined in:

(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service 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.

Sending a Request Using ApplicationInsights

var applicationinsights = new AWS.ApplicationInsights();
applicationinsights.addWorkload(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ApplicationInsights object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var applicationinsights = new AWS.ApplicationInsights({apiVersion: '2018-11-25'});

You can also set the API version globally in AWS.config.apiVersions using the applicationinsights service identifier:

AWS.config.apiVersions = {
  applicationinsights: '2018-11-25',
  // other service API versions
};

var applicationinsights = new AWS.ApplicationInsights();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.ApplicationInsights(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

addWorkload(params = {}, callback) ⇒ AWS.Request

Adds a workload to a component. Each component can have at most five workloads.

createApplication(params = {}, callback) ⇒ AWS.Request

Adds an application that is created from a resource group.

createComponent(params = {}, callback) ⇒ AWS.Request

Creates a custom component by grouping similar standalone instances to monitor.

createLogPattern(params = {}, callback) ⇒ AWS.Request

Adds an log pattern to a LogPatternSet.

deleteApplication(params = {}, callback) ⇒ AWS.Request

Removes the specified application from monitoring. Does not delete the application.

deleteComponent(params = {}, callback) ⇒ AWS.Request

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.

deleteLogPattern(params = {}, callback) ⇒ AWS.Request

Removes the specified log pattern from a LogPatternSet.

describeApplication(params = {}, callback) ⇒ AWS.Request

Describes the application.

describeComponent(params = {}, callback) ⇒ AWS.Request

Describes a component and lists the resources that are grouped together in a component.

describeComponentConfiguration(params = {}, callback) ⇒ AWS.Request

Describes the monitoring configuration of the component.

describeComponentConfigurationRecommendation(params = {}, callback) ⇒ AWS.Request

Describes the recommended monitoring configuration of the component.

describeLogPattern(params = {}, callback) ⇒ AWS.Request

Describe a specific log pattern from a LogPatternSet.

describeObservation(params = {}, callback) ⇒ AWS.Request

Describes an anomaly or error with the application.

describeProblem(params = {}, callback) ⇒ AWS.Request

Describes an application problem.

describeProblemObservations(params = {}, callback) ⇒ AWS.Request

Describes the anomalies or errors associated with the problem.

describeWorkload(params = {}, callback) ⇒ AWS.Request

Describes a workload and its configuration.

listApplications(params = {}, callback) ⇒ AWS.Request

Lists the IDs of the applications that you are monitoring.

listComponents(params = {}, callback) ⇒ AWS.Request

Lists the auto-grouped, standalone, and custom components of the application.

listConfigurationHistory(params = {}, callback) ⇒ AWS.Request

Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are:

listLogPatterns(params = {}, callback) ⇒ AWS.Request

Lists the log patterns in the specific log LogPatternSet.

listLogPatternSets(params = {}, callback) ⇒ AWS.Request

Lists the log pattern sets in the specific application.

listProblems(params = {}, callback) ⇒ AWS.Request

Lists the problems with your application.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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.

listWorkloads(params = {}, callback) ⇒ AWS.Request

Lists the workloads that are configured on a given component.

removeWorkload(params = {}, callback) ⇒ AWS.Request

Remove workload from a component.

tagResource(params = {}, callback) ⇒ AWS.Request

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.

untagResource(params = {}, callback) ⇒ AWS.Request

Remove one or more tags (keys and values) from a specified application.

updateApplication(params = {}, callback) ⇒ AWS.Request

updateComponent(params = {}, callback) ⇒ AWS.Request

Updates the custom component name and/or the list of resources that make up the component.

updateComponentConfiguration(params = {}, callback) ⇒ AWS.Request

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 DescribeComponentConfigurationRecommendation.

updateLogPattern(params = {}, callback) ⇒ AWS.Request

Adds a log pattern to a LogPatternSet.

updateProblem(params = {}, callback) ⇒ AWS.Request

Updates the visibility of the problem or specifies the problem as RESOLVED.

updateWorkload(params = {}, callback) ⇒ AWS.Request

Adds a workload to a component. Each component can have at most five workloads.