feat(crwa): OpenTelemetry

[Josh-Walker-GM]

WIP: This experimental and exploratory might be dropped.

Problem
We are investigating changing up our telemetry setup.

Changes

• Instruments the CRWA with tracing using OpenTelemetry.
  • The structure of CRWA has dictated the telemetry implementation a little. It tends to have an error and then immediately invoke process.exit(1) so not many opportunities to hook into process end.
• Removed the dependencies on the internal and telemetry packages.

Outstanding

1. Discussions
2. Redacting sensitive information
3. Getting a correct CRWA version to report back
4. Needs to point to the collector
5. Need to analyse the available analysis (internal)
6. This is all inside the CRWA package but some of it like building the resource information might be best placed within an updated telemetry package to be dryer.
7. Maybe more of the dependencies can be removed now?

Notes

1. The first couple of commits contain my experimenting in the CLI but those will be reverted.

[jtoar]

A couple quick comments:

[jtoar]

This comment is a little too long to be on the same line as the code:

Suggested change

	!process.argv.includes('--no-telemetry') && // Must include '--no-telemetry' exactly because we want to do this check before any yargs. TODO: Communicate this on cmd help
	// Must include '--no-telemetry' exactly because we want to do this check before any yargs.
	// TODO: Communicate this on cmd help
	!process.argv.includes('--no-telemetry') &&

[jtoar]

I had the same problem in the CLI's index.js file. I need the value of the cwd option before I invoke yargs. You should be able to use the same solution I did:

redwood/packages/cli/src/index.js

Line 60 in 8569f5f

let { cwd } = Parser(hideBin(process.argv))

So in your case...

import { hideBin, Parser } from 'yargs/helpers'

// ...

const { telemetry } = Parser(hideBin(process.argv))

Then check if telemetry is false later, no need to deal with the "no-" prefix, etc.

[Josh-Walker-GM]

Excellent I had a suspicion that it might have been a similar issue you'd dealt. I'll try out your solution for sure.

[jtoar]

Using the suggestion in another comment, you can leave this here. Solves the documentation problem!

[jtoar]

Removed the dependencies on the internal and telemetry packages.

Awesome!

[jtoar]

Any reason you can't just get it from this package's package.json? Like in create-redwood-app.js

redwood/packages/create-redwood-app/src/create-redwood-app.js

Line 22 in 8569f5f

import { name, version } from '../package'

[Josh-Walker-GM]

I'd been using that technique in my earlier experimenting and it worked fine. I only replaced it with a to-do because vscode was yelling at me. I'll happily add it back.

[jtoar]

Ah gotcha—yelling at you with red squiggles?

[Josh-Walker-GM]

Yeah but it's fine now. I must have been importing it with the extension or something before.

[jtoar]

@Josh-Walker-GM could you provide instructions on how you're testing this locally? I'd like to try it out if possible

[replay-io]

15 replays were recorded for 4a51129.

0 Failed

15 Passed

• useAuth hook, auth redirects checks
• Check that tags are rendering the correct dynamic data
• Check that a specific blog post is prerendered
• Check that about is prerendered
• Check that homepage is prerendered
• Check that you can navigate from home page to specific blog post
• Waterfall prerendering (nested cells)
• RBAC: Admin user should be able to delete contacts
• RBAC: Should not be able to delete contact as non-admin user
• Smoke test with dev server
• Smoke test with rw serve
• Loads Cell mocks when Cell is nested in another story
• Loads Cell Stories
• Loads MDX Stories
• Mocks current user, and updates UI while dev server is running

View test run on Replay ↗︎

[Josh-Walker-GM]

Closed as superseded by #8043