Class WebappMonitor

A construct for creating a CloudWatch Real User Monitoring (RUM) App Monitor.

An app monitor allows you to centrally collect and view client-side data (JavaScript and HTTP errors, performance metrics, etc.) recorded from a web application.

NOTE: You'll need to add a JavaScript snippet to your web application and configure CloudWatch RUM using AWS's client-side SDK after deploying the construct to enable your web application to start collecting data. The App Monitor controls which CloudWatch RUM functionality the web application can use, and in order to leverage given functionality you'll need to configure it both in the App Monitor as well as in the configuration of the client-side SDK used by your web application.

Hierarchy

  • Construct
    • WebappMonitor

Constructors

constructor

Properties

appMonitor guestRole identityPool node

Methods

addErrorsAlarm configureEventsAlarm toString isConstruct

Constructors

constructor

  • new WebappMonitor(
        scope: Construct,
        id: string,
        props: WebappMonitorProps,
    ): WebappMonitor

  • Parameters

    • scope: Construct
    • id: string
    • props: WebappMonitorProps

    Returns WebappMonitor

Properties

ReadonlyappMonitor

appMonitor: CfnAppMonitor

ReadonlyguestRole

guestRole: IRole

ReadonlyidentityPool

identityPool: CfnIdentityPool

Readonlynode

node: Node

The tree node.

Methods

addErrorsAlarm

  • addErrorsAlarm(props?: ErrorsAlarm): void

  • Add an alarm that alerts on JavaScript errors sent to CloudWatch RUM.

    Parameters

    • Optionalprops: ErrorsAlarm

    Returns void

configureEventsAlarm

  • configureEventsAlarm(props?: EventsAlarm): void

  • Configure an alarm used to notify on an unexpectedly high number of CloudWatch RUM events being recorded.

    This alarm is required when using this construct.

    Parameters

    • Optionalprops: EventsAlarm

    Returns void

    Default

    - an alarm is created with sane defaults.

toString

  • toString(): string

  • Returns a string representation of this construct.

    Returns string

StaticisConstruct

  • isConstruct(x: any): x is Construct

  • Checks if x is a construct.

    Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

    Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

    Parameters

    • x: any

      Any object

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods