feat(crwa): OpenTelemetry #7455
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,21 +6,8 @@ | |
| // Usage: | ||
| // `$ yarn create redwood-app ./path/to/new-project` | ||
|
|
||
| import path from 'path' | ||
|
|
||
| /** | ||
| * To keep a consistent color/style palette between cli packages, such as | ||
| * @redwood/create-redwood-app and @redwood/cli, please keep them compatible | ||
|
|
@@ -33,7 +20,31 @@ import { name, version } from '../package' | |
| * - packages/create-redwood-app/src/create-redwood-app.js (this file) | ||
| * | ||
| */ | ||
| import chalk from 'chalk' | ||
| import checkNodeVersion from 'check-node-version' | ||
| import { prompt } from 'enquirer' | ||
| import execa from 'execa' | ||
| import fs from 'fs-extra' | ||
| import { Listr, figures } from 'listr2' | ||
| import terminalLink from 'terminal-link' | ||
| import { hideBin } from 'yargs/helpers' | ||
| import yargs from 'yargs/yargs' | ||
|
|
||
| import { name, version } from '../package' | ||
|
|
||
| import { startTelemetry, shutdownTelemetry } from './telemetry' | ||
| ;(async () => { | ||
| // | ||
|
|
||
| // Telemetry | ||
| if ( | ||
| !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 | ||
|
There was a problem hiding this comment. I had the same problem in the CLI's index.js file. I need the value of the redwood/packages/cli/src/index.js Line 60 in 8569f5f So in your case... import { hideBin, Parser } from 'yargs/helpers'
// ...
const { telemetry } = Parser(hideBin(process.argv))Then check if There was a problem hiding this comment. Excellent I had a suspicion that it might have been a similar issue you'd dealt. I'll try out your solution for sure. |
||
| !process.env.REDWOOD_DISABLE_TELEMETRY // We should use the same condition as in full projects here too | ||
| ) { | ||
| // Setup and start root span | ||
| await startTelemetry() | ||
| } | ||
|
|
||
| // Styles for terminal | ||
| const style = { | ||
| error: chalk.bold.red, | ||
|
|
@@ -68,7 +79,6 @@ import { name, version } from '../package' | |
| 'yarn-install': yarnInstall, | ||
| typescript, | ||
| overwrite, | ||
| yarn1, | ||
| 'git-init': gitInit, | ||
| } = yargs(hideBin(process.argv)) | ||
|
|
@@ -92,12 +102,6 @@ import { name, version } from '../package' | |
| type: 'boolean', | ||
| describe: "Create even if target directory isn't empty", | ||
| }) | ||
|
Comment on lines
-95
to
-100
There was a problem hiding this comment. Using the suggestion in another comment, you can leave this here. Solves the documentation problem! |
||
| .option('yarn1', { | ||
| default: false, | ||
| type: 'boolean', | ||
|
|
@@ -130,6 +134,9 @@ import { name, version } from '../package' | |
| 'my-redwood-app' | ||
| )}` | ||
| ) | ||
| await shutdownTelemetry({ | ||
| exception: new Error('no target directory specified'), | ||
| }) | ||
| process.exit(1) | ||
| } | ||
|
|
||
|
|
@@ -152,7 +159,9 @@ import { name, version } from '../package' | |
| `\n'${newAppDir}' already exists and is not empty\n` | ||
| ) | ||
| ) | ||
| shutdownTelemetry({ | ||
| exception: new Error('target directory not empty'), | ||
| }).finally(() => process.exit(1)) | ||
| } | ||
| } else { | ||
| fs.ensureDirSync(path.dirname(newAppDir)) | ||
|
|
@@ -220,42 +229,6 @@ import { name, version } from '../package' | |
| ] | ||
| } | ||
|
|
||
| // Engine check Listr. Separate Listr to avoid https://github.com/cenk1cenk2/listr2/issues/296 | ||
| // Boolean flag | ||
| let hasPassedEngineCheck = null | ||
|
|
@@ -327,10 +300,18 @@ import { name, version } from '../package' | |
| message: 'How would you like to proceed?', | ||
| choices: ['Override error and continue install', 'Quit install'], | ||
| initial: 0, | ||
| onCancel: async () => { | ||
| await shutdownTelemetry({ | ||
| exception: new Error('cancelled engine override'), | ||
| }) | ||
| process.exit(1) | ||
| }, | ||
| }) | ||
| // Quit the install if user selects this option, otherwise it will proceed | ||
| if (response['override-engine-error'] === 'Quit install') { | ||
| await shutdownTelemetry({ | ||
| exception: new Error('quit install at engine override'), | ||
| }) | ||
| process.exit(1) | ||
| } | ||
| } | ||
|
|
@@ -430,8 +411,6 @@ import { name, version } from '../package' | |
| ) | ||
| .run() | ||
| .then(() => { | ||
| // zOMG the semicolon below is a real Prettier thing. What?? | ||
| // https://prettier.io/docs/en/rationale.html#semicolons | ||
| ;[ | ||
|
|
@@ -482,11 +461,13 @@ import { name, version } from '../package' | |
| `${style.redwood(` > ${style.green(`yarn rw dev`)}`)}`, | ||
| '', | ||
| ].map((item) => console.log(item)) | ||
| shutdownTelemetry().then(() => { | ||
| process.exit(0) | ||
| }) | ||
| }) | ||
| .catch((e) => { | ||
| console.log() | ||
| console.log(e) | ||
|
|
||
| if (fs.existsSync(newAppDir)) { | ||
| console.log( | ||
|
|
@@ -497,6 +478,6 @@ import { name, version } from '../package' | |
| ) | ||
| ) | ||
| } | ||
| shutdownTelemetry({ exception: e }).finally(() => process.exit(1)) | ||
| }) | ||
| })() | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,115 @@ | ||
| import { diag, DiagConsoleLogger, DiagLogLevel } from '@opentelemetry/api' | ||
| import opentelemetry, { SpanStatusCode } from '@opentelemetry/api' | ||
| import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http' | ||
| import { Resource } from '@opentelemetry/resources' | ||
| import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-base' | ||
| import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node' | ||
| import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions' | ||
| import envinfo from 'envinfo' | ||
| import system from 'systeminformation' | ||
|
|
||
| /** | ||
| * @type NodeTracerProvider | ||
| */ | ||
| let traceProvider | ||
|
|
||
| /** | ||
| * @type BatchSpanProcessor | ||
| */ | ||
| let traceProcessor | ||
|
|
||
| /** | ||
| * @type OTLPTraceExporter | ||
| */ | ||
| let traceExporter | ||
|
|
||
| /** | ||
| * @type Span | ||
| */ | ||
| let rootSpan | ||
|
|
||
| export async function startTelemetry() { | ||
| // Logger | ||
| // TODO: This line should be removed or at least the log level raised after experimentation | ||
| diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.INFO) | ||
|
|
||
| // Resources | ||
| const info = JSON.parse( | ||
| await envinfo.run( | ||
| { | ||
| System: ['OS', 'Shell'], | ||
| Binaries: ['Node', 'Yarn', 'npm'], | ||
| npmPackages: '@redwoodjs/*', | ||
| IDEs: ['VSCode'], | ||
| }, | ||
| { json: true } | ||
| ) | ||
| ) | ||
|
|
||
| // get shell name instead of path | ||
| const shell = info.System?.Shell // Windows doesn't always provide shell info, I guess | ||
| if (shell?.path?.match('/')) { | ||
| info.System.Shell.name = info.System.Shell.path.split('/').pop() | ||
| } else if (shell?.path.match('\\')) { | ||
| info.System.Shell.name = info.System.Shell.path.split('\\').pop() | ||
| } | ||
| const cpu = await system.cpu() | ||
| const mem = await system.mem() | ||
|
|
||
| const resource = Resource.default().merge( | ||
| new Resource({ | ||
| [SemanticResourceAttributes.SERVICE_NAME]: 'create-redwood-app', | ||
| // TODO: Get a better way of recording what version of CRWA is running because this is just null... | ||
| [SemanticResourceAttributes.SERVICE_VERSION]: | ||
| info.npmPackages != null | ||
| ? info.npmPackages['@redwoodjs/core']?.installed | ||
| : undefined, | ||
|
There was a problem hiding this comment. Any reason you can't just get it from this package's There was a problem hiding this comment. 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. There was a problem hiding this comment. Ah gotcha—yelling at you with red squiggles? There was a problem hiding this comment. Yeah but it's fine now. I must have been importing it with the extension or something before. |
||
| [SemanticResourceAttributes.OS_TYPE]: info.System?.OS?.split(' ')[0], | ||
| [SemanticResourceAttributes.OS_VERSION]: info.System?.OS?.split(' ')[1], | ||
| 'shell.name': info.System?.Shell?.name, | ||
| 'node.version': info.Binaries?.Node?.version, | ||
| 'yarn.version': info.Binaries?.Yarn?.version, | ||
| 'npm.version': info.Binaries?.npm?.version, | ||
| 'vscode.version': info.IDEs?.VSCode?.version, | ||
| 'cpu.count': cpu.physicalCores, | ||
| 'memory.gb': Math.round(mem.total / 1073741824), | ||
| }) | ||
| ) | ||
|
|
||
| // Tracing | ||
| traceProvider = new NodeTracerProvider({ | ||
| resource: resource, | ||
| }) | ||
| traceExporter = new OTLPTraceExporter({ | ||
| // TODO: Point this to somewhere permanent | ||
| }) | ||
| traceProcessor = new BatchSpanProcessor(traceExporter) | ||
| traceProvider.addSpanProcessor(traceProcessor) | ||
| traceProvider.register() | ||
|
|
||
| // Start root span | ||
| const tracer = opentelemetry.trace.getTracer('crwa-tracer') | ||
| rootSpan = tracer.startSpan('root', undefined, opentelemetry.context.active()) | ||
| } | ||
|
|
||
| export async function shutdownTelemetry({ exception } = {}) { | ||
| if (rootSpan?.isRecording()) { | ||
| if (exception !== undefined) { | ||
| // TODO: Think about how best to redact this exception information | ||
| rootSpan.recordException(exception) | ||
| rootSpan.setStatus({ | ||
| code: SpanStatusCode.ERROR, | ||
| message: exception.message, | ||
| }) | ||
| } | ||
| rootSpan.end() | ||
| } | ||
| try { | ||
| await traceProvider?.shutdown() | ||
| await traceProcessor?.shutdown() | ||
| await traceExporter?.shutdown() | ||
| } catch (error) { | ||
| console.error('Telemetry error') | ||
| console.error(error) | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This comment is a little too long to be on the same line as the code: