change: [M3-8509] - Add Pendo documentation to our development guide #11122
Conversation
mjac0bs
added
the
Analytics
mjac0bs
requested review from
hana-akamai and
abailly-akamai
and removed request for
a team
| Important notes: | ||
|
|
||
| - Pendo is only loaded if a valid `PENDO_API_KEY` is configured as an environment variable. In our development, staging, and production environments, `PENDO_API_KEY` is available at build time. See **Locally Testing Page Views & Custom Events and/or Troubleshooting Pendo** for set up with local environments. | ||
| - We load the Pendo agent from the CDN, rather than [self-hosting](https://support.pendo.io/hc/en-us/articles/360038969692-Self-hosting-the-Pendo-agent). |
There was a problem hiding this comment.
@mjac0bs unrelated to the documentation itself, do you know if we can pin a version? Considering this integration is very loosely typed, I am wondering if there's a risk of potential breaking updates we wouldn't be aware of getting a bundle straight from the CDN
There was a problem hiding this comment.
@abailly-akamai We do have the ability to manually deploy a specific version of the agent in the Pendo settings - the drawback being that we'd need to monitor their releases (which seem to be weekly) for important security updates or bug fixes, and manually update to a new version.
There was a problem hiding this comment.
I am probably over-worrying - but hosting CDN libs is also sometimes considered a risk itself, so wondering about that in the case of Infosec. Pendo is an approved vendor so I am 99% this isn't an issue.
There was a problem hiding this comment.
For now, we haven't been told by InfoSec or ProdSec that we can't use the CDN. (If that changes, we can update the way we're selecting our agent to be more specific - either self-hosting or manually set.) This came up in discussion before and they are interested in documenting risks and additional safety checks we can include to help mitigate risks, even if they are low.
|
Updated the PR to add one additional bullet point about making use of |
|
Coverage Report: ✅ |
Cloud Manager E2E
|
||||||||||||||||||||||||||||
| Project |
Cloud Manager E2E
|
| Branch Review |
develop
|
| Run status |
|
| Run duration | 25m 40s |
| Commit |
|
| Committer | Mariah Jacobs |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
2
|
Pending
|
2
|
Skipped
|
0
|
Passing
|
438
|
| View all changes introduced in this branch ↗︎ | |
Description 📝
This PR creates some initial documentation for use of Pendo on Cloud Manager. See the internal doc for more details about access.
Changes 🔄
Preview 📷
How to test 🧪
Verification steps
(How to verify changes)
yarn docs, then go to http://localhost:5173/manager/tooling/analytics.html#pendoAs an Author I have considered 🤔
Check all that apply