fix: Correct an order of instrumentation entries (#1362)

* fix: Correct an order of instrumentation entries * Add MAX_INSTRUMENTATION_COUNT constant
googleapis · Oct 28, 2022 · c6b11e3 · c6b11e3
1 parent 90bb09f
commit c6b11e3
Show file tree

Hide file tree

Showing 2 changed files with 69 additions and 14 deletions.
diff --git a/src/utils/instrumentation.ts b/src/utils/instrumentation.ts
@@ -38,6 +38,7 @@ 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';
+export const MAX_INSTRUMENTATION_COUNT = 3;
 export type InstrumentationInfo = {name: string; version: string};
 
 /**
@@ -131,23 +132,23 @@ function validateAndUpdateInstrumentation(
  infoList: InstrumentationInfo[]
 ): InstrumentationInfo[] {
  const finalInfo: InstrumentationInfo[] = [];
- // First, add current library information
- finalInfo.push({
- name: NODEJS_LIBRARY_NAME_PREFIX,
- version: getNodejsLibraryVersion(),
- });
- // Iterate through given list of libraries and for each entry perform validations and transformations
- // Limit amount of entries to be up to 3
+ // First, iterate through given list of libraries and for each entry perform validations and transformations.
+ // Limit amount of entries to be up to MAX_INSTRUMENTATION_COUNT
  let count = 1;
  for (const info of infoList) {
  if (isValidInfo(info)) {
  finalInfo.push({
  name: truncateValue(info.name, maxDiagnosticValueLen),
  version: truncateValue(info.version, maxDiagnosticValueLen),
  });
+ if (++count === MAX_INSTRUMENTATION_COUNT) break;
  }
- if (++count === 3) break;
  }
+ // Finally, add current library information to be the last entry added
+ finalInfo.push({
+ name: NODEJS_LIBRARY_NAME_PREFIX,
+ version: getNodejsLibraryVersion(),
+ });
  return finalInfo;
 }
 

diff --git a/test/instrumentation.ts b/test/instrumentation.ts
@@ -88,7 +88,7 @@ describe('instrumentation_info', () => {
  );
  });
 
- it('should add instrumentation info to existing list', () => {
+ it('should add instrumentation info to existing list in right order', () => {
  const dummyEntry = createEntry(NODEJS_TEST, VERSION_TEST);
  const entries = instrumentation.populateInstrumentationInfo(dummyEntry);
  assert.equal(entries[0].length, 1);
@@ -102,19 +102,19 @@ describe('instrumentation_info', () => {
  assert.equal(
  entries[0][0].data?.[instrumentation.DIAGNOSTIC_INFO_KEY]?.[
  instrumentation.INSTRUMENTATION_SOURCE_KEY
- ]?.[0]?.[NAME],
+ ]?.[1]?.[NAME],
  instrumentation.NODEJS_LIBRARY_NAME_PREFIX
  );
  assert.equal(
  entries[0][0].data?.[instrumentation.DIAGNOSTIC_INFO_KEY]?.[
  instrumentation.INSTRUMENTATION_SOURCE_KEY
- ]?.[1]?.[NAME],
+ ]?.[0]?.[NAME],
  NODEJS_TEST
  );
  assert.equal(
  entries[0][0].data?.[instrumentation.DIAGNOSTIC_INFO_KEY]?.[
  instrumentation.INSTRUMENTATION_SOURCE_KEY
- ]?.[1]?.[VERSION],
+ ]?.[0]?.[VERSION],
  VERSION_TEST
  );
  });
@@ -147,13 +147,13 @@ describe('instrumentation_info', () => {
  assert.equal(
  entries[0][0].data?.[instrumentation.DIAGNOSTIC_INFO_KEY]?.[
  instrumentation.INSTRUMENTATION_SOURCE_KEY
- ]?.[1]?.[NAME],
+ ]?.[0]?.[NAME],
  NODEJS_TEST + '-oo*'
  );
  assert.equal(
  entries[0][0].data?.[instrumentation.DIAGNOSTIC_INFO_KEY]?.[
  instrumentation.INSTRUMENTATION_SOURCE_KEY
- ]?.[1]?.[VERSION],
+ ]?.[0]?.[VERSION],
  VERSION_TEST + '.0.0.0.0.*'
  );
  });
@@ -174,6 +174,60 @@ describe('instrumentation_info', () => {
  assert.equal(entries[0].length, 1);
  assert.deepEqual(dummyEntry, entries[0][0]);
  });
+
+ it('should discard extra instrumentation records', () => {
+ // Add 4 library versions and make sure that last 2 are discarded and the "nodejs" base
+ // library version is always added as a third one
+ const dummy = createEntry(
+ instrumentation.NODEJS_LIBRARY_NAME_PREFIX + '-one',
+ 'v1'
+ );
+ dummy.data?.[instrumentation.DIAGNOSTIC_INFO_KEY][
+ instrumentation.INSTRUMENTATION_SOURCE_KEY
+ ].push({
+ name: instrumentation.NODEJS_LIBRARY_NAME_PREFIX + '-two',
+ version: 'v2',
+ });
+ dummy.data?.[instrumentation.DIAGNOSTIC_INFO_KEY][
+ instrumentation.INSTRUMENTATION_SOURCE_KEY
+ ].push({
+ name: NODEJS_TEST,
+ version: VERSION_TEST,
+ });
+ dummy.data?.[instrumentation.DIAGNOSTIC_INFO_KEY][
+ instrumentation.INSTRUMENTATION_SOURCE_KEY
+ ].push({
+ name: LONG_NODEJS_TEST,
+ version: LONG_VERSION_TEST,
+ });
+ const entries = instrumentation.populateInstrumentationInfo(dummy);
+ assert.equal(entries[0].length, 1);
+ assert.equal(
+ entries[0][0].data?.[instrumentation.DIAGNOSTIC_INFO_KEY]?.[
+ instrumentation.INSTRUMENTATION_SOURCE_KEY
+ ]?.length,
+ 3
+ );
+ assert.equal(true, entries[1]);
+ assert.equal(
+ entries[0][0].data?.[instrumentation.DIAGNOSTIC_INFO_KEY]?.[
+ instrumentation.INSTRUMENTATION_SOURCE_KEY
+ ]?.[0]?.[NAME],
+ instrumentation.NODEJS_LIBRARY_NAME_PREFIX + '-one'
+ );
+ assert.equal(
+ entries[0][0].data?.[instrumentation.DIAGNOSTIC_INFO_KEY]?.[
+ instrumentation.INSTRUMENTATION_SOURCE_KEY
+ ]?.[1]?.[NAME],
+ instrumentation.NODEJS_LIBRARY_NAME_PREFIX + '-two'
+ );
+ assert.equal(
+ entries[0][0].data?.[instrumentation.DIAGNOSTIC_INFO_KEY]?.[
+ instrumentation.INSTRUMENTATION_SOURCE_KEY
+ ]?.[2]?.[NAME],
+ instrumentation.NODEJS_LIBRARY_NAME_PREFIX
+ );
+ });
 });
 
 function createEntry(name: string | undefined, version: string | undefined) {