Skip to content
AWS for Query.Farm

aws.rum.get_app_monitor

Example SQL Queries

SELECT * FROM
aws.rum.get_app_monitor
WHERE
"name" = 'VALUE';

Description

Retrieves the complete configuration information for one app monitor.

Table Definition

Column NameColumn Data Type
name Required Input Column

The app monitor to retrieve information for.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
app_monitor

A structure containing all the configuration information for the app monitor.

STRUCT(
    "app_monitor_configuration" STRUCT(
        "allow_cookies" BOOLEAN,
        "enable_x_ray" BOOLEAN,
        "excluded_pages" VARCHAR[],
        "favorite_pages" VARCHAR[],
        "guest_role_arn" VARCHAR,
        "identity_pool_id" VARCHAR,
        "included_pages" VARCHAR[],
        "session_sample_rate" DOUBLE,
        "telemetries" VARCHAR[]
    ),
    "created" VARCHAR,
    "custom_events" STRUCT(
        "status" VARCHAR
    ),
    "data_storage" STRUCT(
        "cw_log" STRUCT(
            "cw_log_enabled" BOOLEAN,
            "cw_log_group" VARCHAR
        )
    ),
    "domain" VARCHAR,
    "id" VARCHAR,
    "last_modified" VARCHAR,
    "name" VARCHAR,
    "state" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR)
)
Show child fields
app_monitor.app_monitor_configuration

A structure that contains much of the configuration data for the app monitor.

Show child fields
app_monitor.app_monitor_configuration.allow_cookies

If you set this to true, the RUM web client sets two cookies, a session cookie and a user cookie. The cookies allow the RUM web client to collect data relating to the number of users an application has and the behavior of the application across a sequence of events. Cookies are stored in the top-level domain of the current page.

app_monitor.app_monitor_configuration.enable_x_ray

If you set this to true, RUM enables X-Ray tracing for the user sessions that RUM samples. RUM adds an X-Ray trace header to allowed HTTP requests. It also records an X-Ray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the X-Ray console and the CloudWatch ServiceLens console. For more information, see What is X-Ray?

app_monitor.app_monitor_configuration.excluded_pages[]
app_monitor.app_monitor_configuration.favorite_pages[]
app_monitor.app_monitor_configuration.guest_role_arn

The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.

It is possible that an app monitor does not have a value for GuestRoleArn. For example, this can happen when you use the console to create an app monitor and you allow CloudWatch RUM to create a new identity pool for Authorization. In this case, GuestRoleArn is not present in the GetAppMonitor response because it is not stored by the service.

If this issue affects you, you can take one of the following steps:

  • Use the Cloud Development Kit (CDK) to create an identity pool and the associated IAM role, and use that for your app monitor.

  • Make a separate GetIdentityPoolRoles call to Amazon Cognito to retrieve the GuestRoleArn.

app_monitor.app_monitor_configuration.identity_pool_id

The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.

app_monitor.app_monitor_configuration.included_pages[]
app_monitor.app_monitor_configuration.session_sample_rate

Specifies the portion of user sessions to use for RUM data collection. Choosing a higher portion gives you more data but also incurs more costs.

The range for this value is 0 to 1 inclusive. Setting this to 1 means that 100% of user sessions are sampled, and setting it to 0.1 means that 10% of user sessions are sampled.

If you omit this parameter, the default of 0.1 is used, and 10% of sessions will be sampled.

app_monitor.app_monitor_configuration.telemetries[]
app_monitor.created

The date and time that this app monitor was created.

app_monitor.custom_events

Specifies whether this app monitor allows the web client to define and send custom events.

For more information about custom events, see Send custom events.

Show child fields
app_monitor.custom_events.status

Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be DISABLED.

app_monitor.data_storage

A structure that contains information about whether this app monitor stores a copy of the telemetry data that RUM collects using CloudWatch Logs.

Show child fields
app_monitor.data_storage.cw_log

A structure that contains the information about whether the app monitor stores copies of the data that RUM collects in CloudWatch Logs. If it does, this structure also contains the name of the log group.

Show child fields
app_monitor.data_storage.cw_log.cw_log_enabled

Indicated whether the app monitor stores copies of the data that RUM collects in CloudWatch Logs.

app_monitor.data_storage.cw_log.cw_log_group

The name of the log group where the copies are stored.

app_monitor.domain

The top-level internet domain name for which your application has administrative authority.

app_monitor.id

The unique ID of this app monitor.

app_monitor.last_modified

The date and time of the most recent changes to this app monitor's configuration.

app_monitor.name

The name of the app monitor.

app_monitor.state

The current state of the app monitor.

app_monitor.tags

The list of tag keys and values associated with this app monitor.