Class: AWS.ApplicationInsights

Inherits:
AWS.Service show all
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 for .NET and SQL Server is a service that helps you detect common problems with your .NET and SQL Server-based 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 for .NET and SQL Server 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.createApplication(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();

Version:

  • 2018-11-25

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a ApplicationInsights object

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

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.ApplicationInsights.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.ApplicationInsights.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.ApplicationInsights.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Adds an application that is created from a resource group.

Service Reference:

Examples:

Calling the createApplication operation

var params = {
  ResourceGroupName: 'STRING_VALUE', /* required */
  OpsCenterEnabled: true || false,
  OpsItemSNSTopicArn: 'STRING_VALUE'
};
applicationinsights.createApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • OpsCenterEnabled — (Boolean)

      When set to true, creates opsItems for any problems detected on an application.

    • OpsItemSNSTopicArn — (String)

      The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationInfo — (map)

        Information about the application.

        • ResourceGroupName — (String)

          The name of the resource group used for the application.

        • LifeCycle — (String)

          The lifecycle of the application.

        • OpsItemSNSTopicArn — (String)

          The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.

        • OpsCenterEnabled — (Boolean)

          Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.

        • Remarks — (String)

          The issues on the user side that block Application Insights from successfully monitoring an application.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the createComponent operation

var params = {
  ComponentName: 'STRING_VALUE', /* required */
  ResourceGroupName: 'STRING_VALUE', /* required */
  ResourceList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
applicationinsights.createComponent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • ComponentName — (String)

      The name of the component.

    • ResourceList — (Array<String>)

      The list of resource ARNs that belong to the component.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the deleteApplication operation

var params = {
  ResourceGroupName: 'STRING_VALUE' /* required */
};
applicationinsights.deleteApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceGroupName — (String)

      The name of the resource group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the deleteComponent operation

var params = {
  ComponentName: 'STRING_VALUE', /* required */
  ResourceGroupName: 'STRING_VALUE' /* required */
};
applicationinsights.deleteComponent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • ComponentName — (String)

      The name of the component.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Describes the application.

Service Reference:

Examples:

Calling the describeApplication operation

var params = {
  ResourceGroupName: 'STRING_VALUE' /* required */
};
applicationinsights.describeApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceGroupName — (String)

      The name of the resource group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationInfo — (map)

        Information about the application.

        • ResourceGroupName — (String)

          The name of the resource group used for the application.

        • LifeCycle — (String)

          The lifecycle of the application.

        • OpsItemSNSTopicArn — (String)

          The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.

        • OpsCenterEnabled — (Boolean)

          Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.

        • Remarks — (String)

          The issues on the user side that block Application Insights from successfully monitoring an application.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the describeComponent operation

var params = {
  ComponentName: 'STRING_VALUE', /* required */
  ResourceGroupName: 'STRING_VALUE' /* required */
};
applicationinsights.describeComponent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • ComponentName — (String)

      The name of the component.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationComponent — (map)

        Describes a standalone resource or similarly grouped resources that the application is made up of.

        • ComponentName — (String)

          The name of the component.

        • ResourceType — (String)

          The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.

        • Tier — (String)

          The stack tier of the application component.

        • Monitor — (Boolean)

          Indicates whether the application component is monitored.

      • ResourceList — (Array<String>)

        The list of resource ARNs that belong to the component.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Describes the monitoring configuration of the component.

Service Reference:

Examples:

Calling the describeComponentConfiguration operation

var params = {
  ComponentName: 'STRING_VALUE', /* required */
  ResourceGroupName: 'STRING_VALUE' /* required */
};
applicationinsights.describeComponentConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • ComponentName — (String)

      The name of the component.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Monitor — (Boolean)

        Indicates whether the application component is monitored.

      • Tier — (String)

        The tier of the application component. Supported tiers include DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT

      • ComponentConfiguration — (String)

        The configuration settings of the component. The value is the escaped JSON of the configuration.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Describes the recommended monitoring configuration of the component.

Examples:

Calling the describeComponentConfigurationRecommendation operation

var params = {
  ComponentName: 'STRING_VALUE', /* required */
  ResourceGroupName: 'STRING_VALUE', /* required */
  Tier: 'STRING_VALUE' /* required */
};
applicationinsights.describeComponentConfigurationRecommendation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • ComponentName — (String)

      The name of the component.

    • Tier — (String)

      The tier of the application component. Supported tiers include DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ComponentConfiguration — (String)

        The recommended configuration settings of the component. The value is the escaped JSON of the configuration.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Describes an anomaly or error with the application.

Service Reference:

Examples:

Calling the describeObservation operation

var params = {
  ObservationId: 'STRING_VALUE' /* required */
};
applicationinsights.describeObservation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ObservationId — (String)

      The ID of the observation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Observation — (map)

        Information about the observation.

        • Id — (String)

          The ID of the observation type.

        • StartTime — (Date)

          The time when the observation was first detected, in epoch seconds.

        • EndTime — (Date)

          The time when the observation ended, in epoch seconds.

        • SourceType — (String)

          The source type of the observation.

        • SourceARN — (String)

          The source resource ARN of the observation.

        • LogGroup — (String)

          The log group name.

        • LineTime — (Date)

          The timestamp in the CloudWatch Logs that specifies when the matched line occurred.

        • LogText — (String)

          The log text of the observation.

        • LogFilter — (String)

          The log filter of the observation.

          Possible values include:
          • "ERROR"
          • "WARN"
          • "INFO"
        • MetricNamespace — (String)

          The namespace of the observation metric.

        • MetricName — (String)

          The name of the observation metric.

        • Unit — (String)

          The unit of the source observation metric.

        • Value — (Float)

          The value of the source observation metric.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Describes an application problem.

Service Reference:

Examples:

Calling the describeProblem operation

var params = {
  ProblemId: 'STRING_VALUE' /* required */
};
applicationinsights.describeProblem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ProblemId — (String)

      The ID of the problem.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Problem — (map)

        Information about the problem.

        • Id — (String)

          The ID of the problem.

        • Title — (String)

          The name of the problem.

        • Insights — (String)

          A detailed analysis of the problem using machine learning.

        • Status — (String)

          The status of the problem.

          Possible values include:
          • "IGNORE"
          • "RESOLVED"
          • "PENDING"
        • AffectedResource — (String)

          The resource affected by the problem.

        • StartTime — (Date)

          The time when the problem started, in epoch seconds.

        • EndTime — (Date)

          The time when the problem ended, in epoch seconds.

        • SeverityLevel — (String)

          A measure of the level of impact of the problem.

          Possible values include:
          • "LOW"
          • "MEDIUM"
          • "HIGH"
        • ResourceGroupName — (String)

          The name of the resource group affected by the problem.

        • Feedback — (map<String>)

          Feedback provided by the user about the problem.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Describes the anomalies or errors associated with the problem.

Service Reference:

Examples:

Calling the describeProblemObservations operation

var params = {
  ProblemId: 'STRING_VALUE' /* required */
};
applicationinsights.describeProblemObservations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ProblemId — (String)

      The ID of the problem.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RelatedObservations — (map)

        Observations related to the problem.

        • ObservationList — (Array<map>)

          The list of observations related to the problem.

          • Id — (String)

            The ID of the observation type.

          • StartTime — (Date)

            The time when the observation was first detected, in epoch seconds.

          • EndTime — (Date)

            The time when the observation ended, in epoch seconds.

          • SourceType — (String)

            The source type of the observation.

          • SourceARN — (String)

            The source resource ARN of the observation.

          • LogGroup — (String)

            The log group name.

          • LineTime — (Date)

            The timestamp in the CloudWatch Logs that specifies when the matched line occurred.

          • LogText — (String)

            The log text of the observation.

          • LogFilter — (String)

            The log filter of the observation.

            Possible values include:
            • "ERROR"
            • "WARN"
            • "INFO"
          • MetricNamespace — (String)

            The namespace of the observation metric.

          • MetricName — (String)

            The name of the observation metric.

          • Unit — (String)

            The unit of the source observation metric.

          • Value — (Float)

            The value of the source observation metric.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists the IDs of the applications that you are monitoring.

Service Reference:

Examples:

Calling the listApplications operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
applicationinsights.listApplications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

    • NextToken — (String)

      The token to request the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationInfoList — (Array<map>)

        The list of applications.

        • ResourceGroupName — (String)

          The name of the resource group used for the application.

        • LifeCycle — (String)

          The lifecycle of the application.

        • OpsItemSNSTopicArn — (String)

          The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.

        • OpsCenterEnabled — (Boolean)

          Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.

        • Remarks — (String)

          The issues on the user side that block Application Insights from successfully monitoring an application.

      • NextToken — (String)

        The token used to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the listComponents operation

var params = {
  ResourceGroupName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
applicationinsights.listComponents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

    • NextToken — (String)

      The token to request the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationComponentList — (Array<map>)

        The list of application components.

        • ComponentName — (String)

          The name of the component.

        • ResourceType — (String)

          The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.

        • Tier — (String)

          The stack tier of the application component.

        • Monitor — (Boolean)

          Indicates whether the application component is monitored.

      • NextToken — (String)

        The token to request the next page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists the problems with your application.

Service Reference:

Examples:

Calling the listProblems operation

var params = {
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceGroupName: 'STRING_VALUE',
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
applicationinsights.listProblems(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • StartTime — (Date)

      The time when the problem was detected, in epoch seconds. If you don't specify a time frame for the request, problems within the past seven days are returned.

    • EndTime — (Date)

      The time when the problem ended, in epoch seconds. If not specified, problems within the past seven days are returned.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

    • NextToken — (String)

      The token to request the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProblemList — (Array<map>)

        The list of problems.

        • Id — (String)

          The ID of the problem.

        • Title — (String)

          The name of the problem.

        • Insights — (String)

          A detailed analysis of the problem using machine learning.

        • Status — (String)

          The status of the problem.

          Possible values include:
          • "IGNORE"
          • "RESOLVED"
          • "PENDING"
        • AffectedResource — (String)

          The resource affected by the problem.

        • StartTime — (Date)

          The time when the problem started, in epoch seconds.

        • EndTime — (Date)

          The time when the problem ended, in epoch seconds.

        • SeverityLevel — (String)

          A measure of the level of impact of the problem.

          Possible values include:
          • "LOW"
          • "MEDIUM"
          • "HIGH"
        • ResourceGroupName — (String)

          The name of the resource group affected by the problem.

        • Feedback — (map<String>)

          Feedback provided by the user about the problem.

      • NextToken — (String)

        The token used to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates the application.

Service Reference:

Examples:

Calling the updateApplication operation

var params = {
  ResourceGroupName: 'STRING_VALUE', /* required */
  OpsCenterEnabled: true || false,
  OpsItemSNSTopicArn: 'STRING_VALUE',
  RemoveSNSTopic: true || false
};
applicationinsights.updateApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • OpsCenterEnabled — (Boolean)

      When set to true, creates opsItems for any problems detected on an application.

    • OpsItemSNSTopicArn — (String)

      The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.

    • RemoveSNSTopic — (Boolean)

      Disassociates the SNS topic from the opsItem created for detected problems.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationInfo — (map)

        Information about the application.

        • ResourceGroupName — (String)

          The name of the resource group used for the application.

        • LifeCycle — (String)

          The lifecycle of the application.

        • OpsItemSNSTopicArn — (String)

          The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.

        • OpsCenterEnabled — (Boolean)

          Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.

        • Remarks — (String)

          The issues on the user side that block Application Insights from successfully monitoring an application.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the updateComponent operation

var params = {
  ComponentName: 'STRING_VALUE', /* required */
  ResourceGroupName: 'STRING_VALUE', /* required */
  NewComponentName: 'STRING_VALUE',
  ResourceList: [
    'STRING_VALUE',
    /* more items */
  ]
};
applicationinsights.updateComponent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • ComponentName — (String)

      The name of the component.

    • NewComponentName — (String)

      The new name of the component.

    • ResourceList — (Array<String>)

      The list of resource ARNs that belong to the component.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the updateComponentConfiguration operation

var params = {
  ComponentName: 'STRING_VALUE', /* required */
  ResourceGroupName: 'STRING_VALUE', /* required */
  ComponentConfiguration: 'STRING_VALUE',
  Monitor: true || false,
  Tier: 'STRING_VALUE'
};
applicationinsights.updateComponentConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • ComponentName — (String)

      The name of the component.

    • Monitor — (Boolean)

      Indicates whether the application component is monitored.

    • Tier — (String)

      The tier of the application component. Supported tiers include DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT.

    • ComponentConfiguration — (String)

      The configuration settings of the component. The value is the escaped JSON of the configuration. For more information about the JSON format, see Working with JSON. You can send a request to DescribeComponentConfigurationRecommendation to see the recommended configuration for a component.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.