Skip to content

Commit

Permalink
doc: use CDN version 1.x (#591)
Browse files Browse the repository at this point in the history
  • Loading branch information
williazz authored Oct 31, 2024
1 parent f99498c commit 032a9f5
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/cdn_angular.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To install the web client in an Angular application, add the snippet inside the
'00000000-0000-0000-0000-000000000000',
'1.0.0',
'us-west-2',
'https://client.rum.us-east-1.amazonaws.com/1.0.2/cwr.js',
'https://client.rum.us-east-1.amazonaws.com/1.x/cwr.js',
{
sessionSampleRate: 1,
identityPoolId:
Expand Down
2 changes: 1 addition & 1 deletion docs/cdn_commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ In the following example, the snippet has disabled automated page view recording
'00000000-0000-0000-0000-000000000000',
'1.0.0',
'us-west-2',
'https://client.rum.us-east-1.amazonaws.com/1.0.2/cwr.js',
'https://client.rum.us-east-1.amazonaws.com/1.x/cwr.js',
{
disableAutoPageView: true
}
Expand Down
8 changes: 4 additions & 4 deletions docs/cdn_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The snippet will look similar to the following:
'00000000-0000-0000-0000-000000000000',
'1.0.0',
'us-west-2',
'https://client.rum.us-east-1.amazonaws.com/1.0.2/cwr.js',
'https://client.rum.us-east-1.amazonaws.com/1.x/cwr.js',
{
sessionSampleRate: 1,
identityPoolId: 'us-west-2:00000000-0000-0000-0000-000000000000',
Expand Down Expand Up @@ -67,7 +67,7 @@ The code snippet accepts six arguments. The snippet below shows these arguments
'00000000-0000-0000-0000-000000000000',
'1.0.0',
'us-west-2',
'https://client.rum.us-east-1.amazonaws.com/1.0.2/cwr.js',
'https://client.rum.us-east-1.amazonaws.com/1.x/cwr.js',
{ /* configuration */ }
);
</script>
Expand All @@ -79,7 +79,7 @@ The code snippet accepts six arguments. The snippet below shows these arguments
| 2 | AppMonitor ID | String | A globally unique identifier for the CloudWatch RUM AppMonitor which monitors your application. |
| 3 | Application Version | String | Your application's semantic version. If you do not wish to use this field then add any placeholder, such as `'0.0.0'`. |
| 4 | Region | String | The AWS region of the AppMonitor. For example, `'us-east-1'` or '`eu-west-2'`. |
| 5 | Web Client URL | String | The URL of the web client bundle. For example, `'https://client.rum.us-east-1.amazonaws.com/1.0.2/cwr.js'` |
| 5 | Web Client URL | String | The URL of the web client bundle. For example, `'https://client.rum.us-east-1.amazonaws.com/1.x/cwr.js'` |
| 6 | Configuration | [Configuration](configuration.md) | An application-specific configuration for the web client. |

## Configuring the CloudWatch RUM web client
Expand All @@ -95,7 +95,7 @@ The snippet below shows several configuration options with the body of the snipp
'00000000-0000-0000-0000-000000000000',
'1.0.0',
'us-west-2',
'https://client.rum.us-east-1.amazonaws.com/1.0.2/cwr.js',
'https://client.rum.us-east-1.amazonaws.com/1.x/cwr.js',
{
sessionSampleRate:1,
identityPoolId:'us-west-2:00000000-0000-0000-0000-000000000000',
Expand Down
2 changes: 1 addition & 1 deletion docs/cdn_react.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To install the web client in a React application, add the snippet inside the \<h
'00000000-0000-0000-0000-000000000000',
'1.0.0',
'us-west-2',
'https://client.rum.us-east-1.amazonaws.com/1.0.2/cwr.js',
'https://client.rum.us-east-1.amazonaws.com/1.x/cwr.js',
{
sessionSampleRate: 1,
identityPoolId:
Expand Down
4 changes: 2 additions & 2 deletions docs/cdn_troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ The hash method is the recommended method for adding the RUM web client installa
A hash of the snippet can be generated from the command line using openssl:

```bash
SNIPPET='(function(n,i,v,r,s,c,u,x,z){x=window.AwsRumClient={q:[],n:n,i:i,v:v,r:r,c:c,u:u};window[n]=function(c,p){x.q.push({c:c,p:p});};z=document.createElement('script');z.async=true;z.src=s;document.head.insertBefore(z,document.getElementsByTagName('script')[0]);})('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',{sessionSampleRate:1,identityPoolId:'us-west-2:00000000-0000-0000-0000-000000000000',endpoint:'https://dataplane.rum.us-west-2.amazonaws.com',telemetries:['errors','http','performance'],allowCookies:true});'
SNIPPET='(function(n,i,v,r,s,c,u,x,z){x=window.AwsRumClient={q:[],n:n,i:i,v:v,r:r,c:c,u:u};window[n]=function(c,p){x.q.push({c:c,p:p});};z=document.createElement('script');z.async=true;z.src=s;document.head.insertBefore(z,document.getElementsByTagName('script')[0]);})('cwr','00000000-0000-0000-0000-000000000000','1.0.0','us-west-2','https://client.rum.us-east-1.amazonaws.com/1.x/cwr.js',{sessionSampleRate:1,identityPoolId:'us-west-2:00000000-0000-0000-0000-000000000000',endpoint:'https://dataplane.rum.us-west-2.amazonaws.com',telemetries:['errors','http','performance'],allowCookies:true});'
echo $SNIPPET | openssl sha256 -binary | openssl base64
```

Expand Down Expand Up @@ -174,7 +174,7 @@ To connect client-side and server-side traces, you must set the `addXRayTraceIdH
'00000000-0000-0000-0000-000000000000',
'1.0.0',
'us-west-2',
'https://client.rum.us-east-1.amazonaws.com/1.0.2/cwr.js',
'https://client.rum.us-east-1.amazonaws.com/1.x/cwr.js',
{
enableXRay: true,
telemetries: [
Expand Down

0 comments on commit 032a9f5

Please sign in to comment.