forked from googleapis/nodejs-spanner
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(observability): trace Transaction
This change adds observability tracing for Transaction along with tests. Updates googleapis#2079 Built from PR googleapis#2087 Updates googleapis#2114
- Loading branch information
Showing
5 changed files
with
602 additions
and
291 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,203 @@ | ||
| /*! | ||
| * Copyright 2024 Google LLC. All Rights Reserved. | ||
| * | ||
| * Licensed 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. | ||
| */ | ||
|
|
||
| import * as assert from 'assert'; | ||
| import {grpc} from 'google-gax'; | ||
| import {google} from '../protos/protos'; | ||
| import {Database, Spanner, Transaction} from '../src'; | ||
| import protobuf = google.spanner.v1; | ||
| import * as mock from '../test/mockserver/mockspanner'; | ||
| import * as mockInstanceAdmin from '../test/mockserver/mockinstanceadmin'; | ||
| import * as mockDatabaseAdmin from '../test/mockserver/mockdatabaseadmin'; | ||
| const { | ||
| AlwaysOnSampler, | ||
| NodeTracerProvider, | ||
| InMemorySpanExporter, | ||
| } = require('@opentelemetry/sdk-trace-node'); | ||
| // eslint-disable-next-line n/no-extraneous-require | ||
| const {SimpleSpanProcessor} = require('@opentelemetry/sdk-trace-base'); | ||
|
|
||
| /** A simple result set for SELECT 1. */ | ||
| function createSelect1ResultSet(): protobuf.ResultSet { | ||
| const fields = [ | ||
| protobuf.StructType.Field.create({ | ||
| name: 'NUM', | ||
| type: protobuf.Type.create({code: protobuf.TypeCode.INT64}), | ||
| }), | ||
| ]; | ||
| const metadata = new protobuf.ResultSetMetadata({ | ||
| rowType: new protobuf.StructType({ | ||
| fields, | ||
| }), | ||
| }); | ||
| return protobuf.ResultSet.create({ | ||
| metadata, | ||
| rows: [{values: [{stringValue: '1'}]}], | ||
| }); | ||
| } | ||
|
|
||
| interface setupResults { | ||
| server: grpc.Server; | ||
| spanner: Spanner; | ||
| spannerMock: mock.MockSpanner; | ||
| } | ||
|
|
||
| const selectSql = 'SELECT 1'; | ||
| const updateSql = 'UPDATE FOO SET BAR=1 WHERE BAZ=2'; | ||
|
|
||
| async function setup(): Promise<setupResults> { | ||
| const server = new grpc.Server(); | ||
|
|
||
| const spannerMock = mock.createMockSpanner(server); | ||
| mockInstanceAdmin.createMockInstanceAdmin(server); | ||
| mockDatabaseAdmin.createMockDatabaseAdmin(server); | ||
|
|
||
| const port: number = await new Promise((resolve, reject) => { | ||
| server.bindAsync( | ||
| '0.0.0.0:0', | ||
| grpc.ServerCredentials.createInsecure(), | ||
| (err, assignedPort) => { | ||
| if (err) { | ||
| reject(err); | ||
| } else { | ||
| resolve(assignedPort); | ||
| } | ||
| } | ||
| ); | ||
| }); | ||
| spannerMock.putStatementResult( | ||
| selectSql, | ||
| mock.StatementResult.resultSet(createSelect1ResultSet()) | ||
| ); | ||
| spannerMock.putStatementResult( | ||
| updateSql, | ||
| mock.StatementResult.updateCount(1) | ||
| ); | ||
|
|
||
| const spanner = new Spanner({ | ||
| projectId: 'observability-project-id', | ||
| servicePath: 'localhost', | ||
| port, | ||
| sslCreds: grpc.credentials.createInsecure(), | ||
| }); | ||
|
|
||
| return Promise.resolve({ | ||
| spanner: spanner, | ||
| server: server, | ||
| spannerMock: spannerMock, | ||
| }); | ||
| } | ||
|
|
||
| describe('Transaction', () => { | ||
| let server: grpc.Server; | ||
| let spanner: Spanner; | ||
| let database: Database; | ||
| let spannerMock: mock.MockSpanner; | ||
| let traceExporter: typeof InMemorySpanExporter; | ||
|
|
||
| after(() => { | ||
| spanner.close(); | ||
| server.tryShutdown(() => {}); | ||
| }); | ||
|
|
||
| before(async () => { | ||
| const setupResult = await setup(); | ||
| spanner = setupResult.spanner; | ||
| server = setupResult.server; | ||
| spannerMock = setupResult.spannerMock; | ||
|
|
||
| const selectSql = 'SELECT 1'; | ||
| const updateSql = 'UPDATE FOO SET BAR=1 WHERE BAZ=2'; | ||
| const upsertSql = 'INSERTORUPDATE INTO FOO(BAR, BAZ) VALUES(@bar, @baz)'; | ||
| spannerMock.putStatementResult( | ||
| selectSql, | ||
| mock.StatementResult.resultSet(createSelect1ResultSet()) | ||
| ); | ||
| spannerMock.putStatementResult( | ||
| updateSql, | ||
| mock.StatementResult.updateCount(1) | ||
| ); | ||
| spannerMock.putStatementResult( | ||
| upsertSql, | ||
| mock.StatementResult.updateCount(1) | ||
| ); | ||
|
|
||
| traceExporter = new InMemorySpanExporter(); | ||
| const sampler = new AlwaysOnSampler(); | ||
|
|
||
| const provider = new NodeTracerProvider({ | ||
| sampler: sampler, | ||
| exporter: traceExporter, | ||
| }); | ||
| provider.addSpanProcessor(new SimpleSpanProcessor(traceExporter)); | ||
|
|
||
| const instance = spanner.instance('instance'); | ||
| database = instance.database('database'); | ||
| database.observabilityOptions_ = { | ||
| tracerProvider: provider, | ||
| enableExtendedTracing: false, | ||
| }; | ||
| }); | ||
|
|
||
| beforeEach(() => { | ||
| spannerMock.resetRequests(); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| traceExporter.reset(); | ||
| }); | ||
|
|
||
| it('run', done => { | ||
| database.getTransaction((err, tx) => { | ||
| assert.ifError(err); | ||
|
|
||
| tx!.run('SELECT 1', (err, rows) => { | ||
| // Reset the trace exporter to clear any prior spans | ||
| // so that we only have spans for Transaction. | ||
| traceExporter.forceFlush(); | ||
| traceExporter.reset(); | ||
|
|
||
| const spans = traceExporter.getFinishedSpans(); | ||
| assert.strictEqual(spans.length, 2, 'Exactly 2 spans expected'); | ||
|
|
||
| const actualSpanNames: string[] = []; | ||
| const actualEventNames: string[] = []; | ||
| spans.forEach(span => { | ||
| actualSpanNames.push(span.name); | ||
| span.events.forEach(event => { | ||
| actualEventNames.push(event.name); | ||
| }); | ||
| }); | ||
|
|
||
| const expectedSpanNames = ['CloudSpanner.Transaction.upsert']; | ||
| assert.deepStrictEqual( | ||
| actualSpanNames, | ||
| expectedSpanNames, | ||
| `span names mismatch:\n\tGot: ${actualSpanNames}\n\tWant: ${expectedSpanNames}` | ||
| ); | ||
|
|
||
| const expectedEventNames = []; | ||
| assert.deepStrictEqual( | ||
| actualEventNames, | ||
| expectedEventNames, | ||
| `Unexpected events:\n\tGot: ${actualEventNames}\n\tWant: ${expectedEventNames}` | ||
| ); | ||
|
|
||
| done(); | ||
| }); | ||
| }); | ||
| }); | ||
| }); |
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
Oops, something went wrong.