-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(otel-node): add fs instrumentation (#601)
- Loading branch information
1 parent
697f766
commit acdcab5
Showing
7 changed files
with
171 additions
and
6 deletions.
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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 |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch B.V. licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| // Usage: node -r @elastic/opentelemetry-node use-fs.js | ||
|
|
||
| const {join} = require('path'); | ||
| const {stat} = require('fs'); | ||
| const {trace} = require('@opentelemetry/api'); | ||
|
|
||
| const path = join(__dirname, 'use-fs.js'); | ||
|
|
||
| async function main() { | ||
| await new Promise((resolve, reject) => { | ||
| stat(path, (err, st) => { | ||
| if (err) { | ||
| reject(err); | ||
| } else { | ||
| resolve(st); | ||
| } | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| const tracer = trace.getTracer('test'); | ||
| tracer.startActiveSpan('manual-span', async (span) => { | ||
| await main(); | ||
| span.end(); | ||
| }); |
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 |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch B.V. licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| // Test that 'express' instrumentation generates the telemetry we expect. | ||
|
|
||
| const test = require('tape'); | ||
| const {runTestFixtures} = require('./testutils'); | ||
|
|
||
| /** @type {import('./testutils').TestFixture[]} */ | ||
| const testFixtures = [ | ||
| { | ||
| name: 'use-fs (default disabled)', | ||
| args: ['./fixtures/use-fs.js'], | ||
| cwd: __dirname, | ||
| env: { | ||
| NODE_OPTIONS: '--require=@elastic/opentelemetry-node', | ||
| }, | ||
| // verbose: true, | ||
| checkTelemetry: (t, col) => { | ||
| // We expect spans like this | ||
| // ------ trace 6dc0c7 (2 spans) ------ | ||
| // span 3d5f2a "manual-span" (1.2ms, SPAN_KIND_INTERNAL) | ||
| const spans = col.sortedSpans; | ||
| t.equal(spans.length, 1); | ||
|
|
||
| t.equal(spans[0].name, 'manual-span'); | ||
| t.equal(spans[0].kind, 'SPAN_KIND_INTERNAL'); | ||
| }, | ||
| }, | ||
| { | ||
| name: 'use-fs (enabled via env var)', | ||
| args: ['./fixtures/use-fs.js'], | ||
| cwd: __dirname, | ||
| env: { | ||
| NODE_OPTIONS: '--require=@elastic/opentelemetry-node', | ||
| OTEL_NODE_ENABLED_INSTRUMENTATIONS: 'fs', | ||
| }, | ||
| // verbose: true, | ||
| checkTelemetry: (t, col) => { | ||
| // We expect spans like this | ||
| // ------ trace 7c87d0 (1 span) ------ | ||
| // span 1ecc98 "fs statSync" (0.0ms, SPAN_KIND_INTERNAL) | ||
| // ------ trace 281967 (1 span) ------ | ||
| // span 7bab63 "fs statSync" (0.0ms, SPAN_KIND_INTERNAL) | ||
| // ------ trace 8b214a (1 span) ------ | ||
| // span 417068 "fs readFileSync" (0.1ms, SPAN_KIND_INTERNAL) | ||
| // ------ trace d61bc6 (1 span) ------ | ||
| // span a6f9cc "fs statSync" (0.1ms, SPAN_KIND_INTERNAL) | ||
| // ------ trace 292114 (2 spans) ------ | ||
| // span c66b96 "manual-span" (6.6ms, SPAN_KIND_INTERNAL) | ||
| // +1ms `- span 5b7d1c "fs stat" (6.3ms, SPAN_KIND_INTERNAL) | ||
| const spans = col.sortedSpans; | ||
| t.equal(spans.length, 18); | ||
|
|
||
| t.strictEqual( | ||
| spans.filter( | ||
| (s) => s.scope.name === '@opentelemetry/instrumentation-fs' | ||
| ).length, | ||
| 17 | ||
| ); | ||
| t.ok(spans.every((s) => s.kind === 'SPAN_KIND_INTERNAL')); | ||
| }, | ||
| }, | ||
| ]; | ||
|
|
||
| test('fs instrumentation', (suite) => { | ||
| runTestFixtures(suite, testFixtures); | ||
| suite.end(); | ||
| }); |
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