Skip to content

Commit

Permalink
feat(client-application-insights): Provide Account Level onboarding s…
Browse files Browse the repository at this point in the history
…upport through CFN/CLI
  • Loading branch information
awstools committed Jun 2, 2022
1 parent e10c8ed commit b70eff4
Show file tree
Hide file tree
Showing 13 changed files with 445 additions and 375 deletions.
21 changes: 10 additions & 11 deletions clients/client-application-insights/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,17 @@ AWS SDK for JavaScript ApplicationInsights Client for Node.js, Browser and React

<fullname>Amazon CloudWatch Application Insights</fullname>

<p> 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.</p>
<p> 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.</p>
<p>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. </p>
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. </p>

## Installing

Expand Down
62 changes: 32 additions & 30 deletions clients/client-application-insights/src/ApplicationInsights.ts
Original file line number Diff line number Diff line change
Expand Up @@ -136,18 +136,17 @@ import {

/**
* <fullname>Amazon CloudWatch Application Insights</fullname>
* <p> 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.</p>
* <p> 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.</p>
* <p>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. </p>
* 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. </p>
*/
export class ApplicationInsights extends ApplicationInsightsClient {
/**
Expand Down Expand Up @@ -247,7 +246,8 @@ export class ApplicationInsights extends ApplicationInsightsClient {
}

/**
* <p>Removes the specified application from monitoring. Does not delete the application.</p>
* <p>Removes the specified application from monitoring. Does not delete the
* application.</p>
*/
public deleteApplication(
args: DeleteApplicationCommandInput,
Expand Down Expand Up @@ -279,8 +279,9 @@ export class ApplicationInsights extends ApplicationInsightsClient {
}

/**
* <p>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.</p>
* <p>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.</p>
*/
public deleteComponent(
args: DeleteComponentCommandInput,
Expand Down Expand Up @@ -376,7 +377,8 @@ export class ApplicationInsights extends ApplicationInsightsClient {
}

/**
* <p>Describes a component and lists the resources that are grouped together in a component.</p>
* <p>Describes a component and lists the resources that are grouped together in a
* component.</p>
*/
public describeComponent(
args: DescribeComponentCommandInput,
Expand Down Expand Up @@ -666,15 +668,15 @@ export class ApplicationInsights extends ApplicationInsightsClient {
}

/**
* <p>
* Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are:
* </p>
* <p> Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by
* Application Insights. Examples of events represented are: </p>
* <ul>
* <li>
* <p>INFO: creating a new alarm or updating an alarm threshold.</p>
* </li>
* <li>
* <p>WARN: alarm not created due to insufficient data points used to predict thresholds.</p>
* <p>WARN: alarm not created due to insufficient data points used to predict
* thresholds.</p>
* </li>
* <li>
* <p>ERROR: alarm not created due to permission errors or exceeding quotas. </p>
Expand Down Expand Up @@ -807,9 +809,9 @@ export class ApplicationInsights extends ApplicationInsightsClient {
* <p>Retrieve a list of the tags (keys and values) that are associated with a specified
* application. A <i>tag</i> is a label that you optionally define and associate
* with an application. Each tag consists of a required <i>tag key</i> and an
* optional associated <i>tag value</i>. 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.</p>
* optional associated <i>tag value</i>. 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.</p>
*/
public listTagsForResource(
args: ListTagsForResourceCommandInput,
Expand Down Expand Up @@ -842,13 +844,13 @@ export class ApplicationInsights extends ApplicationInsightsClient {

/**
* <p>Add one or more tags (keys and values) to a specified application. A
* <i>tag</i> is a label that you optionally define and associate with an
* <i>tag</i> 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. </p>
* <p>Each tag consists of a required <i>tag key</i> and an
* associated <i>tag value</i>, 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.</p>
* <p>Each tag consists of a required <i>tag key</i> and an associated
* <i>tag value</i>, 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.</p>
*/
public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
Expand Down Expand Up @@ -971,9 +973,9 @@ export class ApplicationInsights extends ApplicationInsightsClient {
}

/**
* <p>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 <code>DescribeComponentConfigurationRecommendation</code>. </p>
* <p>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 <code>DescribeComponentConfigurationRecommendation</code>. </p>
*/
public updateComponentConfiguration(
args: UpdateComponentConfigurationCommandInput,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -318,18 +318,17 @@ export interface ApplicationInsightsClientResolvedConfig extends ApplicationInsi

/**
* <fullname>Amazon CloudWatch Application Insights</fullname>
* <p> 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.</p>
* <p> 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.</p>
* <p>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. </p>
* 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. </p>
*/
export class ApplicationInsightsClient extends __Client<
__HttpHandlerOptions,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ export interface DeleteApplicationCommandInput extends DeleteApplicationRequest
export interface DeleteApplicationCommandOutput extends DeleteApplicationResponse, __MetadataBearer {}

/**
* <p>Removes the specified application from monitoring. Does not delete the application.</p>
* <p>Removes the specified application from monitoring. Does not delete the
* application.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,9 @@ export interface DeleteComponentCommandInput extends DeleteComponentRequest {}
export interface DeleteComponentCommandOutput extends DeleteComponentResponse, __MetadataBearer {}

/**
* <p>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.</p>
* <p>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.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ export interface DescribeComponentCommandInput extends DescribeComponentRequest
export interface DescribeComponentCommandOutput extends DescribeComponentResponse, __MetadataBearer {}

/**
* <p>Describes a component and lists the resources that are grouped together in a component.</p>
* <p>Describes a component and lists the resources that are grouped together in a
* component.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ export interface ListConfigurationHistoryCommandInput extends ListConfigurationH
export interface ListConfigurationHistoryCommandOutput extends ListConfigurationHistoryResponse, __MetadataBearer {}

/**
* <p>
* Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are:
* </p>
* <p> Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by
* Application Insights. Examples of events represented are: </p>
* <ul>
* <li>
* <p>INFO: creating a new alarm or updating an alarm threshold.</p>
* </li>
* <li>
* <p>WARN: alarm not created due to insufficient data points used to predict thresholds.</p>
* <p>WARN: alarm not created due to insufficient data points used to predict
* thresholds.</p>
* </li>
* <li>
* <p>ERROR: alarm not created due to permission errors or exceeding quotas. </p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
* <p>Retrieve a list of the tags (keys and values) that are associated with a specified
* application. A <i>tag</i> is a label that you optionally define and associate
* with an application. Each tag consists of a required <i>tag key</i> and an
* optional associated <i>tag value</i>. 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.</p>
* optional associated <i>tag value</i>. 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.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat

/**
* <p>Add one or more tags (keys and values) to a specified application. A
* <i>tag</i> is a label that you optionally define and associate with an
* <i>tag</i> 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. </p>
* <p>Each tag consists of a required <i>tag key</i> and an
* associated <i>tag value</i>, 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.</p>
* <p>Each tag consists of a required <i>tag key</i> and an associated
* <i>tag value</i>, 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.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ export interface UpdateComponentConfigurationCommandOutput
__MetadataBearer {}

/**
* <p>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 <code>DescribeComponentConfigurationRecommendation</code>. </p>
* <p>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 <code>DescribeComponentConfigurationRecommendation</code>. </p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Loading

0 comments on commit b70eff4

Please sign in to comment.