Skip to content

Commit

Permalink
docs: Added RUM to Honeycomb guide
Browse files Browse the repository at this point in the history
  • Loading branch information
patricklafrance committed Nov 12, 2024
1 parent 2a13fa4 commit 44c988e
Show file tree
Hide file tree
Showing 35 changed files with 58 additions and 29 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ To deploy the sample application, open a terminal at the root of the repository
deploy-basic
```

A prompt with a few questions will appear and then the sits will automatically be deployed to production.
A prompt with a few questions will appear and then the site will automatically be deployed to production.

### The sample application with "endpoints"

Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ A modular web application shell built on top of [Module Federation](https://mod
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](./LICENSE)
[![CI](https://github.com/gsoft-inc/wl-squide/actions/workflows/ci.yml/badge.svg)](https://github.com/gsoft-inc/wl-squide/actions/workflows/ci.yml)

### Packages

| Name | NPM |
| --- | --- |
| [@squide/core](packages/core/README.md) | [![npm version](https://img.shields.io/npm/v/@squide/core)](https://www.npmjs.com/package/@squide/core) |
Expand Down
14 changes: 14 additions & 0 deletions docs/guides/setup-honeycomb.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,20 @@ When an unmanaged error occurs, it's automatically recorded:
![Recorded error](../static/honeycomb-failing-http-request.png)
:::

### Real User Monitoring (RUM)

The default instrumentation will automatically track the appropriate metrics to display RUM information:

:::align-image-left
![Largest Contentful Paint](../static/honeycomb-lcp.png){width=536 height=378}
:::
:::align-image-left
![Cumulative Layout Shift](../static/honeycomb-cls.png){width=536 height=378}
:::
:::align-image-left
![Interaction to Next Paint](../static/honeycomb-inp.png){width=532 height=358}
:::

## Set custom user attributes

Most application needs to set custom attributes on traces about the current user environment. To help with that, Squide expose the [setGlobalSpanAttributes](../reference/honeycomb/setGlobalSpanAttributes.md) function.
Expand Down
Binary file added docs/static/honeycomb-cls.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/honeycomb-inp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/honeycomb-lcp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@
},
"sideEffects": false,
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion packages/env-vars/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,6 @@
},
"sideEffects": false,
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion packages/fakes/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,6 @@
},
"sideEffects": false,
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
13 changes: 13 additions & 0 deletions packages/firefly-honeycomb/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# @squide/firefly-honeycomb

## Usage

View the [user's documentation](https://gsoft-inc.github.io/wl-squide/).

## 🤝 Contributing

View the [contributor's documentation](../../CONTRIBUTING.md).

## License

Copyright © 2024, Workleap. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/gsoft-inc/workleap-license/blob/master/LICENSE.
2 changes: 1 addition & 1 deletion packages/firefly-honeycomb/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,6 @@
},
"sideEffects": false,
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion packages/firefly-webpack-configs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,6 @@
"@workleap/webpack-configs": "1.5.1"
},
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion packages/firefly/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,6 @@
},
"sideEffects": false,
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion packages/i18next/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,6 @@
},
"sideEffects": false,
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion packages/module-federation/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,6 @@
},
"sideEffects": false,
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion packages/msw/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,6 @@
},
"sideEffects": false,
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion packages/react-router/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,6 @@
},
"sideEffects": false,
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion packages/webpack-configs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,6 @@
"semver": "7.6.3"
},
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion samples/basic/another-remote-module/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,6 @@
"useless-lib": "3.0.0"
},
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion samples/basic/host/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,6 @@
"useless-lib": "^2.0.0"
},
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion samples/basic/local-module/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,6 @@
"react-router-dom": "6.27.0"
},
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion samples/basic/remote-module/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,6 @@
"useless-lib": "^2.1.0"
},
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion samples/basic/shared/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,6 @@
"typescript": "5.5.4"
},
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion samples/basic/shell/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,6 @@
"typescript": "5.5.4"
},
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion samples/endpoints/express-server/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@
"typescript": "5.5.4"
},
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion samples/endpoints/host/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,6 @@
"workerDirectory": "public"
},
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion samples/endpoints/i18next/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,6 @@
"typescript": "5.5.4"
},
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion samples/endpoints/layouts/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,6 @@
"typescript": "5.5.4"
},
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion samples/endpoints/local-module/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,6 @@
"workerDirectory": "public"
},
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion samples/endpoints/remote-module/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,6 @@
"workerDirectory": "public"
},
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion samples/endpoints/shared/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@
"uuid": "11.0.2"
},
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion samples/endpoints/shell/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,6 @@
"typescript": "5.5.4"
},
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion templates/getting-started/apps/host/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@
"react-router-dom": "6.26.1"
},
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion templates/getting-started/apps/local-module/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@
"react-router-dom": "6.26.1"
},
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}
2 changes: 1 addition & 1 deletion templates/getting-started/apps/remote-module/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@
"react-router-dom": "6.26.1"
},
"engines": {
"node": ">=20.0.0"
"node": ">=21.1.0"
}
}

0 comments on commit 44c988e

Please sign in to comment.