From 0513cd29631eb82334c27772ac79dcae93050bfd Mon Sep 17 00:00:00 2001 From: feywind <57276408+feywind@users.noreply.github.com> Date: Wed, 7 Aug 2024 17:53:18 -0400 Subject: [PATCH] samples: add the otel enable flag to new otel samples --- samples/listenWithOpenTelemetryTracing.js | 2 +- samples/openTelemetryTracing.js | 147 ------------------ samples/publishWithOpenTelemetryTracing.js | 2 +- .../listenWithOpenTelemetryTracing.ts | 2 +- .../publishWithOpenTelemetryTracing.ts | 2 +- 5 files changed, 4 insertions(+), 151 deletions(-) delete mode 100644 samples/openTelemetryTracing.js diff --git a/samples/listenWithOpenTelemetryTracing.js b/samples/listenWithOpenTelemetryTracing.js index 0981a8561..55178dde5 100644 --- a/samples/listenWithOpenTelemetryTracing.js +++ b/samples/listenWithOpenTelemetryTracing.js @@ -80,7 +80,7 @@ provider.addSpanProcessor(processor); provider.register(); // Creates a client; cache this for further use. -const pubSubClient = new PubSub(); +const pubSubClient = new PubSub({enableOpenTelemetryTracing: true}); async function subscriptionListen(subscriptionNameOrId) { const subscriber = pubSubClient.subscription(subscriptionNameOrId); diff --git a/samples/openTelemetryTracing.js b/samples/openTelemetryTracing.js deleted file mode 100644 index 7efd80cc9..000000000 --- a/samples/openTelemetryTracing.js +++ /dev/null @@ -1,147 +0,0 @@ -// Copyright 2020-2024 Google LLC -// -// 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. - -// This is a generated sample, using the typeless sample bot. Please -// look for the source TypeScript sample (.ts) for modifications. -'use strict'; - -/* eslint-disable n/no-process-exit */ - -/** - * This sample demonstrates how to add OpenTelemetry tracing to the - * Google Cloud Pub/Sub API. - * - * For more information, see the README.md under /pubsub and the documentation - * at https://cloud.google.com/pubsub/docs. - */ - -// sample-metadata: -// title: OpenTelemetry Tracing -// description: Demonstrates how to enable OpenTelemetry tracing in -// a publisher or subscriber. -// usage: node openTelemetryTracing.js - -const SUBSCRIBER_TIMEOUT = 10; - -// [START pubsub_publish_otel_tracing] -/** - * TODO(developer): Uncomment these variables before running the sample. - */ -// const topicNameOrId = 'YOUR_TOPIC_OR_ID'; -// const subscriptionNameOrId = 'YOUR_SUBSCRIPTION_OR_ID'; -// const data = 'Hello, world!"; - -// Imports the Google Cloud client library -const {PubSub} = require('@google-cloud/pubsub'); - -// Imports the OpenTelemetry API -const {NodeTracerProvider} = require('@opentelemetry/sdk-trace-node'); -const {diag, DiagConsoleLogger, DiagLogLevel} = require('@opentelemetry/api'); -const {SimpleSpanProcessor} = require('@opentelemetry/sdk-trace-base'); - -// To output to the console for testing, use the ConsoleSpanExporter. -// import {ConsoleSpanExporter} from '@opentelemetry/sdk-trace-base'; - -// To output to Cloud Trace, import the OpenTelemetry bridge library. -const { - TraceExporter, -} = require('@google-cloud/opentelemetry-cloud-trace-exporter'); - -const {Resource} = require('@opentelemetry/resources'); -const { - SEMRESATTRS_SERVICE_NAME, -} = require('@opentelemetry/semantic-conventions'); - -// Enable the diagnostic logger for OpenTelemetry -diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.DEBUG); - -// Log spans out to the console, for testing. -// const exporter = new ConsoleSpanExporter(); - -// Log spans out to Cloud Trace, for production. -const exporter = new TraceExporter(); - -// Build a tracer provider and a span processor to do -// something with the spans we're generating. -const provider = new NodeTracerProvider({ - resource: new Resource({ - [SEMRESATTRS_SERVICE_NAME]: 'otel example', - }), -}); -const processor = new SimpleSpanProcessor(exporter); -provider.addSpanProcessor(processor); -provider.register(); - -// Creates a client; cache this for further use. -const pubSubClient = new PubSub(); - -async function publishMessage(topicNameOrId, data) { - // Publishes the message as a string, e.g. "Hello, world!" - // or JSON.stringify(someObject) - const dataBuffer = Buffer.from(data); - const publisher = pubSubClient.topic(topicNameOrId); - const messageId = await publisher.publishMessage({data: dataBuffer}); - console.log(`Message ${messageId} published.`); -} - -async function subscriptionListen(subscriptionNameOrId) { - const subscriber = pubSubClient.subscription(subscriptionNameOrId); - - // Message handler for subscriber - const messageHandler = async message => { - console.log(`Message ${message.id} received.`); - message.ack(); - - // Ensure that all spans got flushed by the exporter. Note that - // this isn't required under normal circumstances; we're doing it - // here to ensure spans are flushed before closing the subscriber. - console.log('Cleaning up OpenTelemetry exporter...'); - await processor.forceFlush(); - await subscriber.close(); - }; - - const errorHandler = async error => { - console.log('Received error:', error); - - console.log('Cleaning up OpenTelemetry exporter...'); - await processor.forceFlush(); - await subscriber.close(); - }; - - // Listens for new messages from the topic - subscriber.on('message', messageHandler); - subscriber.on('error', errorHandler); - - // Wait a bit for the subscription to receive messages. - // For the sample only. - setTimeout(() => { - subscriber.removeAllListeners(); - }, SUBSCRIBER_TIMEOUT * 1000); -} -// [END pubsub_publish_otel_tracing] - -function main( - topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID', - subscriptionNameOrId = 'YOUR_SUBSCRIPTION_NAME_OR_ID', - data = 'Hello, world!' -) { - publishMessage(topicNameOrId, data) - .then(() => subscriptionListen(subscriptionNameOrId)) - .catch(err => { - console.error(err.message); - process.exitCode = 1; - }); -} - -main(...process.argv.slice(2)); diff --git a/samples/publishWithOpenTelemetryTracing.js b/samples/publishWithOpenTelemetryTracing.js index e2ee9bb90..42b529739 100644 --- a/samples/publishWithOpenTelemetryTracing.js +++ b/samples/publishWithOpenTelemetryTracing.js @@ -80,7 +80,7 @@ provider.addSpanProcessor(processor); provider.register(); // Creates a client; cache this for further use. -const pubSubClient = new PubSub(); +const pubSubClient = new PubSub({enableOpenTelemetryTracing: true}); async function publishMessage(topicNameOrId, data) { // Publishes the message as a string, e.g. "Hello, world!" diff --git a/samples/typescript/listenWithOpenTelemetryTracing.ts b/samples/typescript/listenWithOpenTelemetryTracing.ts index e75218284..198f51f8c 100644 --- a/samples/typescript/listenWithOpenTelemetryTracing.ts +++ b/samples/typescript/listenWithOpenTelemetryTracing.ts @@ -72,7 +72,7 @@ provider.addSpanProcessor(processor); provider.register(); // Creates a client; cache this for further use. -const pubSubClient = new PubSub(); +const pubSubClient = new PubSub({enableOpenTelemetryTracing: true}); async function subscriptionListen(subscriptionNameOrId: string) { const subscriber = pubSubClient.subscription(subscriptionNameOrId); diff --git a/samples/typescript/publishWithOpenTelemetryTracing.ts b/samples/typescript/publishWithOpenTelemetryTracing.ts index 1a4365d18..cd7a82b3a 100644 --- a/samples/typescript/publishWithOpenTelemetryTracing.ts +++ b/samples/typescript/publishWithOpenTelemetryTracing.ts @@ -72,7 +72,7 @@ provider.addSpanProcessor(processor); provider.register(); // Creates a client; cache this for further use. -const pubSubClient = new PubSub(); +const pubSubClient = new PubSub({enableOpenTelemetryTracing: true}); async function publishMessage(topicNameOrId: string, data: string) { // Publishes the message as a string, e.g. "Hello, world!"