Application Insights

This page documents function available when using the Application_Insights module, created with @service Application_Insights.

Index

Documentation

Main.Application_Insights.create_applicationMethod
create_application()
create_application(params::Dict{String,<:Any})

Adds an application that is created from a resource group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AutoConfigEnabled": Indicates whether Application Insights automatically configures unmonitored resources in the resource group.
  • "AutoCreate": Configures all of the resources in the resource group by applying the recommended configurations.
  • "CWEMonitorEnabled": Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.
  • "GroupingType": Application Insights can create applications based on a resource group or on an account. To create an account-based application using all of the resources in the account, set this parameter to ACCOUNT_BASED.
  • "OpsCenterEnabled": When set to true, creates opsItems for any problems detected on an application.
  • "OpsItemSNSTopicArn": The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.
  • "ResourceGroupName": The name of the resource group.
  • "Tags": List of tags to add to the application. tag key (Key) and an associated tag value (Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
Main.Application_Insights.create_componentMethod
create_component(component_name, resource_group_name, resource_list)
create_component(component_name, resource_group_name, resource_list, params::Dict{String,<:Any})

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

Arguments

  • component_name: The name of the component.
  • resource_group_name: The name of the resource group.
  • resource_list: The list of resource ARNs that belong to the component.
Main.Application_Insights.create_log_patternMethod
create_log_pattern(pattern, pattern_name, pattern_set_name, rank, resource_group_name)
create_log_pattern(pattern, pattern_name, pattern_set_name, rank, resource_group_name, params::Dict{String,<:Any})

Adds an log pattern to a LogPatternSet.

Arguments

  • pattern: The log pattern. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
  • pattern_name: The name of the log pattern.
  • pattern_set_name: The name of the log pattern set.
  • rank: Rank of the log pattern. Must be a value between 1 and 1,000,000. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will be last to get matched. When you configure custom log patterns from the console, a Low severity pattern translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 rank. And a High severity pattern translates to a 250,000 rank. Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns.
  • resource_group_name: The name of the resource group.
Main.Application_Insights.delete_applicationMethod
delete_application(resource_group_name)
delete_application(resource_group_name, params::Dict{String,<:Any})

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

Arguments

  • resource_group_name: The name of the resource group.
Main.Application_Insights.delete_componentMethod
delete_component(component_name, resource_group_name)
delete_component(component_name, resource_group_name, params::Dict{String,<:Any})

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.

Arguments

  • component_name: The name of the component.
  • resource_group_name: The name of the resource group.
Main.Application_Insights.delete_log_patternMethod
delete_log_pattern(pattern_name, pattern_set_name, resource_group_name)
delete_log_pattern(pattern_name, pattern_set_name, resource_group_name, params::Dict{String,<:Any})

Removes the specified log pattern from a LogPatternSet.

Arguments

  • pattern_name: The name of the log pattern.
  • pattern_set_name: The name of the log pattern set.
  • resource_group_name: The name of the resource group.
Main.Application_Insights.describe_applicationMethod
describe_application(resource_group_name)
describe_application(resource_group_name, params::Dict{String,<:Any})

Describes the application.

Arguments

  • resource_group_name: The name of the resource group.
Main.Application_Insights.describe_componentMethod
describe_component(component_name, resource_group_name)
describe_component(component_name, resource_group_name, params::Dict{String,<:Any})

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

Arguments

  • component_name: The name of the component.
  • resource_group_name: The name of the resource group.
Main.Application_Insights.describe_component_configurationMethod
describe_component_configuration(component_name, resource_group_name)
describe_component_configuration(component_name, resource_group_name, params::Dict{String,<:Any})

Describes the monitoring configuration of the component.

Arguments

  • component_name: The name of the component.
  • resource_group_name: The name of the resource group.
Main.Application_Insights.describe_component_configuration_recommendationMethod
describe_component_configuration_recommendation(component_name, resource_group_name, tier)
describe_component_configuration_recommendation(component_name, resource_group_name, tier, params::Dict{String,<:Any})

Describes the recommended monitoring configuration of the component.

Arguments

  • component_name: The name of the component.
  • resource_group_name: The name of the resource group.
  • tier: The tier of the application component.
Main.Application_Insights.describe_log_patternMethod
describe_log_pattern(pattern_name, pattern_set_name, resource_group_name)
describe_log_pattern(pattern_name, pattern_set_name, resource_group_name, params::Dict{String,<:Any})

Describe a specific log pattern from a LogPatternSet.

Arguments

  • pattern_name: The name of the log pattern.
  • pattern_set_name: The name of the log pattern set.
  • resource_group_name: The name of the resource group.
Main.Application_Insights.describe_observationMethod
describe_observation(observation_id)
describe_observation(observation_id, params::Dict{String,<:Any})

Describes an anomaly or error with the application.

Arguments

  • observation_id: The ID of the observation.
Main.Application_Insights.describe_problemMethod
describe_problem(problem_id)
describe_problem(problem_id, params::Dict{String,<:Any})

Describes an application problem.

Arguments

  • problem_id: The ID of the problem.
Main.Application_Insights.describe_problem_observationsMethod
describe_problem_observations(problem_id)
describe_problem_observations(problem_id, params::Dict{String,<:Any})

Describes the anomalies or errors associated with the problem.

Arguments

  • problem_id: The ID of the problem.
Main.Application_Insights.list_applicationsMethod
list_applications()
list_applications(params::Dict{String,<:Any})

Lists the IDs of the applications that you are monitoring.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": 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": The token to request the next page of results.
Main.Application_Insights.list_componentsMethod
list_components(resource_group_name)
list_components(resource_group_name, params::Dict{String,<:Any})

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

Arguments

  • resource_group_name: The name of the resource group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": 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": The token to request the next page of results.
Main.Application_Insights.list_configuration_historyMethod
list_configuration_history()
list_configuration_history(params::Dict{String,<:Any})

Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are: INFO: creating a new alarm or updating an alarm threshold. WARN: alarm not created due to insufficient data points used to predict thresholds. ERROR: alarm not created due to permission errors or exceeding quotas.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EndTime": The end time of the event.
  • "EventStatus": The status of the configuration update event. Possible values include INFO, WARN, and ERROR.
  • "MaxResults": The maximum number of results returned by ListConfigurationHistory in paginated output. When this parameter is used, ListConfigurationHistory returns only MaxResults in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another ListConfigurationHistory request with the returned NextToken value. If this parameter is not used, then ListConfigurationHistory returns all results.
  • "NextToken": The NextToken value returned from a previous paginated ListConfigurationHistory request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
  • "ResourceGroupName": Resource group to which the application belongs.
  • "StartTime": The start time of the event.
Main.Application_Insights.list_log_pattern_setsMethod
list_log_pattern_sets(resource_group_name)
list_log_pattern_sets(resource_group_name, params::Dict{String,<:Any})

Lists the log pattern sets in the specific application.

Arguments

  • resource_group_name: The name of the resource group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": 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": The token to request the next page of results.
Main.Application_Insights.list_log_patternsMethod
list_log_patterns(resource_group_name)
list_log_patterns(resource_group_name, params::Dict{String,<:Any})

Lists the log patterns in the specific log LogPatternSet.

Arguments

  • resource_group_name: The name of the resource group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": 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": The token to request the next page of results.
  • "PatternSetName": The name of the log pattern set.
Main.Application_Insights.list_problemsMethod
list_problems()
list_problems(params::Dict{String,<:Any})

Lists the problems with your application.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ComponentName": The name of the component.
  • "EndTime": The time when the problem ended, in epoch seconds. If not specified, problems within the past seven days are returned.
  • "MaxResults": 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": The token to request the next page of results.
  • "ResourceGroupName": The name of the resource group.
  • "StartTime": 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.
Main.Application_Insights.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

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.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the application that you want to retrieve tag information for.
Main.Application_Insights.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

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.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the application that you want to add one or more tags to.
  • tags: A list of tags that to add to the application. A tag consists of a required tag key (Key) and an associated tag value (Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
Main.Application_Insights.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the application that you want to remove one or more tags from.
  • tag_keys: The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value. To remove more than one tag from the application, append the TagKeys parameter and argument for each additional tag to remove, separated by an ampersand.
Main.Application_Insights.update_applicationMethod
update_application(resource_group_name)
update_application(resource_group_name, params::Dict{String,<:Any})

Updates the application.

Arguments

  • resource_group_name: The name of the resource group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AutoConfigEnabled": Turns auto-configuration on or off.
  • "CWEMonitorEnabled": Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.
  • "OpsCenterEnabled": When set to true, creates opsItems for any problems detected on an application.
  • "OpsItemSNSTopicArn": 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": Disassociates the SNS topic from the opsItem created for detected problems.
Main.Application_Insights.update_componentMethod
update_component(component_name, resource_group_name)
update_component(component_name, resource_group_name, params::Dict{String,<:Any})

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

Arguments

  • component_name: The name of the component.
  • resource_group_name: The name of the resource group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NewComponentName": The new name of the component.
  • "ResourceList": The list of resource ARNs that belong to the component.
Main.Application_Insights.update_component_configurationMethod
update_component_configuration(component_name, resource_group_name)
update_component_configuration(component_name, resource_group_name, params::Dict{String,<:Any})

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.

Arguments

  • component_name: The name of the component.
  • resource_group_name: The name of the resource group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AutoConfigEnabled": Automatically configures the component by applying the recommended configurations.
  • "ComponentConfiguration": 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. For the complete format of the component configuration file, see Component Configuration.
  • "Monitor": Indicates whether the application component is monitored.
  • "Tier": The tier of the application component.
Main.Application_Insights.update_log_patternMethod
update_log_pattern(pattern_name, pattern_set_name, resource_group_name)
update_log_pattern(pattern_name, pattern_set_name, resource_group_name, params::Dict{String,<:Any})

Adds a log pattern to a LogPatternSet.

Arguments

  • pattern_name: The name of the log pattern.
  • pattern_set_name: The name of the log pattern set.
  • resource_group_name: The name of the resource group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Pattern": The log pattern. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
  • "Rank": Rank of the log pattern. Must be a value between 1 and 1,000,000. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will be last to get matched. When you configure custom log patterns from the console, a Low severity pattern translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 rank. And a High severity pattern translates to a 250,000 rank. Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns.