feat: Add support for instrumentation version annotations (#1370)

* feat: Add support for instrumentation version annotations * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Fix tests * Add exclude to owlbot.py * Add newline Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
googleapis · Nov 4, 2022 · c039022 · c039022
1 parent bf4f824
commit c039022
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 5 deletions.
diff --git a/.github/release-please.yml b/.github/release-please.yml
@@ -1,2 +1,3 @@
 handleGHRelease: true
 releaseType: node
+extraFiles: ["src/utils/instrumentation.ts"]
diff --git a/owlbot.py b/owlbot.py
@@ -28,7 +28,8 @@
  ".eslintignore",
  ".prettierignore",
  "CONTRIBUTING.md",
- ".github/auto-label.yaml"
+ ".github/auto-label.yaml",
+ ".github/release-please.yml"
  ]
 )
 

diff --git a/src/utils/instrumentation.ts b/src/utils/instrumentation.ts
@@ -38,7 +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 NODEJS_DEFAULT_LIBRARY_VERSION = 'unknown';
+export const NODEJS_DEFAULT_LIBRARY_VERSION = '1.0.0'; // {x-release-please-version}
 export const MAX_INSTRUMENTATION_COUNT = 3;
 export type InstrumentationInfo = {name: string; version: string};
 
@@ -173,7 +173,7 @@ function truncateValue(value: object | string, maxLen: number) {
  // Ignore error since flow should continue
  }
  }
- // Return 'unknown' if version cannot be retrieved
+ // Return NODEJS_DEFAULT_LIBRARY_VERSION if version cannot be retrieved
  if (typeof value !== 'string') {
  return NODEJS_DEFAULT_LIBRARY_VERSION;
  }

diff --git a/test/instrumentation.ts b/test/instrumentation.ts
@@ -53,7 +53,7 @@ describe('instrumentation_info', () => {
  );
  });
 
- it('should set library version to unknown', () => {
+ it('should set library version to NODEJS_DEFAULT_LIBRARY_VERSION', () => {
  const data = {some: 'value'};
  const entry = instrumentation.createDiagnosticEntry(
  undefined,
@@ -70,7 +70,7 @@ describe('instrumentation_info', () => {
  entry.data?.[instrumentation.DIAGNOSTIC_INFO_KEY]?.[
  instrumentation.INSTRUMENTATION_SOURCE_KEY
  ]?.[0]?.[VERSION],
- 'unknown'
+ instrumentation.NODEJS_DEFAULT_LIBRARY_VERSION
  );
  });