Skip to content

feat(o11y): introduce observability flags needed within the generator #9052

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shivanee-p wants to merge 6 commits into from
Open

feat(o11y): introduce observability flags needed within the generator #9052

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e3cda93
feat(generator): add enable_telemetry_tracing option and client inter…
shivanee-p Jul 31, 2026
7879f5a
test(generator): add unit tests for enableTelemetryTracing option
shivanee-p Jul 31, 2026
4159976
fix: update readEnableTelemetryTracing to read enable-telemetry-traci…
shivanee-p Aug 4, 2026
58025e6
test: add unit tests for Generator class in gapic-generator-typescript
shivanee-p Aug 4, 2026
fbe0432
refactor: rename helper to getTestGenerator in generator unit tests
shivanee-p Aug 4, 2026
77b4eaf
refactor: update type assertions in generator unit tests
shivanee-p Aug 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions core/generator/gapic-generator-typescript/typescript/src/generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ export class Generator {
restNumericEnums?: boolean;
mixinsOverride?: string[];
format?: string | string[];
enableTelemetryTracing?: boolean;

private root: protobuf.Root;

Expand Down Expand Up @@ -227,6 +228,12 @@ export class Generator {
}
}

private readEnableTelemetryTracing() {
if (this.paramMap['enable-telemetry-tracing'] === 'true') {
this.enableTelemetryTracing = true;
}
}
Comment thread
shivanee-p marked this conversation as resolved.

private readLegacyProtoLoad() {
if (this.paramMap['legacy-proto-load'] === 'true') {
this.legacyProtoLoad = true;
Expand Down Expand Up @@ -274,6 +281,7 @@ export class Generator {
this.readLegacyProtoLoad();
this.readRestNumericEnums();
this.readFormat();
this.readEnableTelemetryTracing();
}
}

Expand Down Expand Up @@ -334,6 +342,7 @@ export class Generator {
legacyProtoLoad: this.legacyProtoLoad,
restNumericEnums: this.restNumericEnums,
mixinsOverridden: this.mixinsOverride !== undefined,
enableTelemetryTracing: this.enableTelemetryTracing,
});
return api;
}
Expand Down
2 changes: 2 additions & 0 deletions core/generator/gapic-generator-typescript/typescript/src/schema/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ export class API {
restNumericEnums: boolean;
documentationUri: any;
newIssueUri: string;
enableTelemetryTracing?: boolean;
title?: string;

static isIgnoredService(
Expand Down Expand Up @@ -112,6 +113,7 @@ export class API {
this.documentationUri =
options.serviceYaml?.publishing?.documentation_uri ?? '';
this.newIssueUri = options.serviceYaml?.publishing?.new_issue_uri ?? '';
this.enableTelemetryTracing = options.enableTelemetryTracing ?? false;
this.title = options.serviceYaml?.title;

const [allResourceDatabase, resourceDatabase] =
Expand Down
1 change: 1 addition & 0 deletions core/generator/gapic-generator-typescript/typescript/src/schema/naming.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ export interface Options {
legacyProtoLoad?: boolean;
restNumericEnums?: boolean;
mixinsOverridden?: boolean;
enableTelemetryTracing?: boolean;
}

export class Naming {
Expand Down
21 changes: 21 additions & 0 deletions core/generator/gapic-generator-typescript/typescript/test/unit/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,4 +325,25 @@ describe('src/schema/api.ts', () => {
assert('.google.cloud.example.v1.MessageB' in secondCallMessages);
});
});

it('should set enableTelemetryTracing option', () => {
const fd = {} as protos.google.protobuf.FileDescriptorProto;
fd.name = 'google/cloud/test/v1/test.proto';
fd.package = 'google.cloud.test.v1';
fd.service = [{} as protos.google.protobuf.ServiceDescriptorProto];
fd.service[0].name = 'ZService';
fd.service[0].options = {
'.google.api.defaultHost': 'hostname.example.com:443',
};
const apiWithTracing = new API([fd], 'google.cloud.test.v1', {
grpcServiceConfig: {} as protos.grpc.service_config.ServiceConfig,
enableTelemetryTracing: true,
});
assert.strictEqual(apiWithTracing.enableTelemetryTracing, true);

const apiWithoutTracing = new API([fd], 'google.cloud.test.v1', {
grpcServiceConfig: {} as protos.grpc.service_config.ServiceConfig,
});
assert.strictEqual(apiWithoutTracing.enableTelemetryTracing, false);
});
});
Loading
Loading