Skip to content

fix: Switch instrumentation code to work with NODEJS_DEFAULT_LIBRARY_VERSION only #1373

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 7, 2022
Merged

fix: Switch instrumentation code to work with NODEJS_DEFAULT_LIBRARY_VERSION only #1373

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
89c04c1
fix: Switch instrumentation code to work with NODEJS_DEFAULT_LIBRARY_…
losalex Nov 4, 2022
b238710
Merge branch 'main' into losalex/fix-switch-to-annotations
losalex Nov 4, 2022
e01a671
Fix comment
losalex Nov 7, 2022
299582d
Merge branch 'losalex/fix-switch-to-annotations' of https://github.co…
losalex Nov 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 7 additions & 19 deletions src/utils/instrumentation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
*/

import arrify = require('arrify');
import path = require('path');
import {Entry} from '../entry';

// eslint-disable-next-line @typescript-eslint/no-explicit-any
Expand All @@ -29,15 +28,17 @@ global.instrumentationAdded = false;
// The global variable to avoid records inspection once instrumentation already written to prevent perf impact
global.shouldSkipInstrumentationCheck = false;

// The variable to hold cached library version
let libraryVersion: string;

// Max length for instrumentation library name and version values
const maxDiagnosticValueLen = 14;

export const DIAGNOSTIC_INFO_KEY = 'logging.googleapis.com/diagnostic';
export const INSTRUMENTATION_SOURCE_KEY = 'instrumentation_source';
export const NODEJS_LIBRARY_NAME_PREFIX = 'nodejs';
/**
* Default library version to be used
* Using release-please annotations to update DEFAULT_INSTRUMENTATION_VERSION with latest version.
* See https://github.com/googleapis/release-please/blob/main/docs/customizing.md#updating-arbitrary-files
*/
export const NODEJS_DEFAULT_LIBRARY_VERSION = '10.3.0'; // {x-release-please-version}
export const MAX_INSTRUMENTATION_COUNT = 3;
export type InstrumentationInfo = {name: string; version: string};
Expand Down Expand Up @@ -184,24 +185,11 @@ function truncateValue(value: object | string, maxLen: number) {
}

/**
* The helper function to retrieve current library version from 'package.json' file. Note that
* since we use {path.resolve}, the search for 'package.json' could be impacted by current working directory.
* The helper function to retrieve current library version from annotated NODEJS_DEFAULT_LIBRARY_VERSION
* @returns {string} A current library version.
*/
export function getNodejsLibraryVersion() {
if (libraryVersion) {
return libraryVersion;
}
try {
libraryVersion = require(path.resolve(
__dirname,
'../../../',
'package.json'
)).version;
} catch (err) {
libraryVersion = NODEJS_DEFAULT_LIBRARY_VERSION;
}
return libraryVersion;
return NODEJS_DEFAULT_LIBRARY_VERSION;
}

/**
Expand Down