Skip to content

Latest commit

 

History

History
35 lines (31 loc) · 3.49 KB

cdn_commands.md

File metadata and controls

35 lines (31 loc) · 3.49 KB

Executing Commands

Applications which install the web client using CDN must interact with the web client through its command queue. The command queue is a function which stores commands that will be executed asynchronously by the web client.

Commands

Commands may be sent to the web client after the snippet has executed. In the following example, the snippet has disabled automated page view recording and has not provided AWS credentials. Following the snippet, the application manually records a page view and forwards AWS credentials to the web client.

<script>
    (function(n,i,v,r,s,c,u,x,z){...})(
        'cwr',
        '00000000-0000-0000-0000-000000000000',
        '1.0.0',
        'us-west-2',
        'https://client.rum.us-east-1.amazonaws.com/1.0.2/cwr.js',
        {
            disableAutoPageView: true
        }
    );
    cwr('recordPageView', window.location.hash);
    const awsCreds = localStorage.getItem('customAwsCreds');
    if(awsCreds) cwr('setAwsCredentials', awsCreds)
</script>
Command Parameter Type Example
Description
allowCookies Boolean cwr('allowCookies', true); Enable the web client to set and read two cookies: a session cookie named cwr_s and a user cookie named cwr_u.

cwr_s stores session data including an anonymous session ID (uuid v4) created by the web client. This allows CloudWatch RUM to compute sessionized metrics like errors per session.

cwr_u stores an anonymous user ID (uuid v4) created by the web client. This allows CloudWatch RUM to count return visitors.

true: the web client will use cookies
false: the web client will not use cookies
disable None cwr('disable'); Stop recording and dispatching RUM events.
dispatch None cwr('dispatch'); Flush RUM events from the cache and dispatch them to CloudWatch RUM using fetch.
dispatchBeacon None cwr('dispatchBeacon'); Flush RUM events from the cache and dispatch them to CloudWatch RUM using sendBeacon.
enable None cwr('enable'); Start recording and dispatching RUM events.
recordPageView String cwr('recordPageView', '/home'); Record a page view event.

By default, the web client records page views when (1) the page first loads and (2) the browser's history API is called. The page ID is window.location.pathname.

In some cases, the web client's instrumentation will not record the desired page ID. In this case, the web client's page view automation must be disabled using the disableAutoPageView configuration, and the application must be instrumented to record page views using this command.
recordError Error | ErrorEvent | String try {...} catch(e) { cwr('recordError', e); } Record a caught error.
setAwsCredentials Credentials | CredentialProvider cwr('setAwsCredentials', cred); Forward AWS credentials to the web client. The web client requires AWS credentials with permission to call the PutRumEvents API. If you have not set identityPoolId and guestRoleArn in the web client configuration, you must forward AWS credentials to the web client using this command.