Apply warm up runs plus hoist Attributes to inline

Author: odeke-em

observability-test/benchmark.ts

@@ -27,7 +27,8 @@ const lessComparator = (a, b) => {
  */
 export async function runBenchmarks(runners: Function[], done: Function) {
   const nRuns = 10000;
-  const benchmarkValues = {_totalRuns: nRuns};
+  const nWarmups = Math.round(nRuns / 8);
+  const benchmarkValues = {_totalRuns: nRuns, _warmRuns: nWarmups};
 
   let k = 0;
   for (k = 0; k < runners.length; k++) {
@@ -38,7 +39,7 @@ export async function runBenchmarks(runners: Function[], done: Function) {
     let i = 0;
 
     // Warm up runs to ensure stable behavior.
-    for (i = 0; i < 8; i++) {
+    for (i = 0; i < nWarmups; i++) {
       const value = await fn();
     }
 

observability-test/comparisons.ts

@@ -124,7 +124,7 @@ async function setup(
   });
 }
 
-describe('Benchmarking', () => {
+describe('Benchmarking Database', () => {
   if (!process.env.SPANNER_RUN_BENCHMARKS) {
     console.log(
       'Skipping micro-benchmarking because SPANNER_RUN_BENCHMARKS is not set'
@@ -289,7 +289,9 @@ describe('Benchmarking', () => {
     const untraced = await setItUp(false);
     const tracedWithOTELOn = await setItUp(true, true);
 
-    console.log(`Total Runs: ${traced['_totalRuns']}`);
+    console.log(
+      `Total Runs:   ${traced['_totalRuns']}\nWarm up runs: ${traced['_warmRuns']}`
+    );
     for (const tracedM in traced) {
       const tracedV = traced[tracedM];
       if (typeof tracedV !== 'object') {

package.json

@@ -33,7 +33,7 @@
     "samples-test-with-archived": "cd samples/ && npm link ../ && npm test-with-archived && cd ../",
     "samples-test": "cd samples/ && npm link ../ && npm test && cd ../",
     "system-test": "mocha build/system-test --timeout 1600000",
-    "observability-test": "mocha build/observability-test --timeout 1600000 -g 'Benchmarking'",
+    "observability-test": "mocha build/observability-test --timeout 1600000",
     "cleanup": "mocha scripts/cleanup.js --timeout 30000",
     "test": "mocha build/test build/test/common build/observability-test",
     "ycsb": "node ./benchmark/ycsb.js  run -P ./benchmark/workloada -p table=usertable -p cloudspanner.instance=ycsb-instance -p operationcount=100 -p cloudspanner.database=ycsb",

src/instrument.ts

@@ -24,6 +24,7 @@ import {
 } from '@opentelemetry/semantic-conventions';
 
 import {
+  Attributes,
   Span,
   SpanStatusCode,
   context,
@@ -136,33 +137,30 @@ export function startTrace<T>(
     config = {} as traceConfig;
   }
 
+  const spanAttributes: Attributes = {
+    SEMATTRS_DB_SYSTEM: 'spanner',
+    ATTR_OTEL_SCOPE_NAME: TRACER_NAME,
+    ATTR_OTEL_SCOPE_VERSION: TRACER_VERSION,
+    SEMATTRS_DB_SQL_TABLE: config.tableName,
+    SEMATTRS_DB_NAME: config.dbName,
+    kind: SpanKind.CLIENT,
+  };
+
+  const allowExtendedTracing = optedInPII || config.opts?.enableExtendedTracing;
+  if (config.sql && allowExtendedTracing) {
+    const sql = config.sql;
+    if (typeof sql === 'string') {
+      spanAttributes[SEMATTRS_DB_STATEMENT] = sql as string;
+    } else {
+      const stmt = sql as SQLStatement;
+      spanAttributes[SEMATTRS_DB_STATEMENT] = stmt.sql;
+    }
+  }
+
   return getTracer(config.opts?.tracerProvider).startActiveSpan(
     SPAN_NAMESPACE_PREFIX + '.' + spanNameSuffix,
-    {kind: SpanKind.CLIENT},
+    spanAttributes,
     span => {
-      span.setAttribute(SEMATTRS_DB_SYSTEM, 'spanner');
-      span.setAttribute(ATTR_OTEL_SCOPE_NAME, TRACER_NAME);
-      span.setAttribute(ATTR_OTEL_SCOPE_VERSION, TRACER_VERSION);
-
-      if (config.tableName) {
-        span.setAttribute(SEMATTRS_DB_SQL_TABLE, config.tableName);
-      }
-      if (config.dbName) {
-        span.setAttribute(SEMATTRS_DB_NAME, config.dbName);
-      }
-
-      const allowExtendedTracing =
-        optedInPII || config.opts?.enableExtendedTracing;
-      if (config.sql && allowExtendedTracing) {
-        const sql = config.sql;
-        if (typeof sql === 'string') {
-          span.setAttribute(SEMATTRS_DB_STATEMENT, sql as string);
-        } else {
-          const stmt = sql as SQLStatement;
-          span.setAttribute(SEMATTRS_DB_STATEMENT, stmt.sql);
-        }
-      }
-
       // If at all the invoked function throws an exception,
       // record the exception and then end this span.
       try {