Remove loggerProvider from public telemetry interface

tonybaroneee · tonybaroneee · commit a333d479c238 · 2025-12-09T01:28:12.000Z
As per API design review feedback.
diff --git a/common/api-review/telemetry-angular.api.md b/common/api-review/telemetry-angular.api.md
@@ -6,7 +6,6 @@
 
 import { ErrorHandler } from '@angular/core';
 import { FirebaseApp } from '@firebase/app';
-import { LoggerProvider } from '@opentelemetry/sdk-logs';
 
 // @public
 export class FirebaseErrorHandler implements ErrorHandler {
@@ -18,7 +17,6 @@ export class FirebaseErrorHandler implements ErrorHandler {
 // @public
 export interface Telemetry {
     app: FirebaseApp;
-    loggerProvider: LoggerProvider;
 }
 
 // @public
diff --git a/common/api-review/telemetry-react.api.md b/common/api-review/telemetry-react.api.md
@@ -5,7 +5,6 @@
 ```ts
 
 import { FirebaseApp } from '@firebase/app';
-import { LoggerProvider } from '@opentelemetry/sdk-logs';
 
 // @public
 export function FirebaseTelemetry({ firebaseApp, telemetryOptions }: {
@@ -16,7 +15,6 @@ export function FirebaseTelemetry({ firebaseApp, telemetryOptions }: {
 // @public
 export interface Telemetry {
     app: FirebaseApp;
-    loggerProvider: LoggerProvider;
 }
 
 // @public
diff --git a/common/api-review/telemetry.api.md b/common/api-review/telemetry.api.md
@@ -7,7 +7,6 @@
 import { AnyValueMap } from '@opentelemetry/api-logs';
 import { FirebaseApp } from '@firebase/app';
 import { Instrumentation } from 'next';
-import { LoggerProvider } from '@opentelemetry/sdk-logs';
 
 // @public
 export function captureError(telemetry: Telemetry, error: unknown, attributes?: AnyValueMap): void;
@@ -26,7 +25,6 @@ export function nextOnRequestError(telemetryOptions?: TelemetryOptions): Instrum
 // @public
 export interface Telemetry {
     app: FirebaseApp;
-    loggerProvider: LoggerProvider;
 }
 
 // @public
diff --git a/docs-devsite/telemetry_.telemetry.md b/docs-devsite/telemetry_.telemetry.md
@@ -25,7 +25,6 @@ export interface Telemetry
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [app](./telemetry_.telemetry.md#telemetryapp) | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance is associated with. |
-|  [loggerProvider](./telemetry_.telemetry.md#telemetryloggerprovider) | LoggerProvider | The  this [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance uses. |
 
 ## Telemetry.app
 
@@ -36,13 +35,3 @@ The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Telemetry](.
 ```typescript
 app: FirebaseApp;
 ```
-
-## Telemetry.loggerProvider
-
-The  this [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance uses.
-
-<b>Signature:</b>
-
-```typescript
-loggerProvider: LoggerProvider;
-```
diff --git a/docs-devsite/telemetry_angular.telemetry.md b/docs-devsite/telemetry_angular.telemetry.md
@@ -25,7 +25,6 @@ export interface Telemetry
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [app](./telemetry_angular.telemetry.md#telemetryapp) | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance is associated with. |
-|  [loggerProvider](./telemetry_angular.telemetry.md#telemetryloggerprovider) | LoggerProvider | The  this [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance uses. |
 
 ## Telemetry.app
 
@@ -36,13 +35,3 @@ The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Telemetry](.
 ```typescript
 app: FirebaseApp;
 ```
-
-## Telemetry.loggerProvider
-
-The  this [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance uses.
-
-<b>Signature:</b>
-
-```typescript
-loggerProvider: LoggerProvider;
-```
diff --git a/docs-devsite/telemetry_react.telemetry.md b/docs-devsite/telemetry_react.telemetry.md
@@ -25,7 +25,6 @@ export interface Telemetry
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [app](./telemetry_react.telemetry.md#telemetryapp) | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance is associated with. |
-|  [loggerProvider](./telemetry_react.telemetry.md#telemetryloggerprovider) | LoggerProvider | The  this [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance uses. |
 
 ## Telemetry.app
 
@@ -36,13 +35,3 @@ The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Telemetry](.
 ```typescript
 app: FirebaseApp;
 ```
-
-## Telemetry.loggerProvider
-
-The  this [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance uses.
-
-<b>Signature:</b>
-
-```typescript
-loggerProvider: LoggerProvider;
-```
diff --git a/packages/telemetry/src/api.test.ts b/packages/telemetry/src/api.test.ts
@@ -17,7 +17,6 @@
 
 import { expect } from 'chai';
 import { LoggerProvider } from '@opentelemetry/sdk-logs';
-import { Telemetry } from './public-types';
 import { trace } from '@opentelemetry/api';
 import { Logger, LogRecord, SeverityNumber } from '@opentelemetry/api-logs';
 import {
@@ -43,6 +42,7 @@ import { TelemetryService } from './service';
 import { registerTelemetry } from './register';
 import { _FirebaseInstallationsInternal } from '@firebase/installations';
 import { AUTO_CONSTANTS } from './auto-constants';
+import { TelemetryInternal } from './types';
 
 const PROJECT_ID = 'my-project';
 const APP_ID = 'my-appid';
@@ -66,7 +66,7 @@ const fakeLoggerProvider = {
   shutdown: () => Promise.resolve()
 } as unknown as LoggerProvider;
 
-const fakeTelemetry: Telemetry = {
+const fakeTelemetry: TelemetryInternal = {
   app: {
     name: 'DEFAULT',
     automaticDataCollectionEnabled: true,
@@ -307,7 +307,7 @@ describe('Top level API', () => {
       AUTO_CONSTANTS.appVersion = '1.2.3'; // Unused
       const telemetry = new TelemetryService(
         fakeTelemetry.app,
-        fakeTelemetry.loggerProvider
+        fakeLoggerProvider
       );
       telemetry.options = {
         appVersion: '1.0.0'
diff --git a/packages/telemetry/src/api.ts b/packages/telemetry/src/api.ts
@@ -78,7 +78,9 @@ export function captureError(
   error: unknown,
   attributes?: AnyValueMap
 ): void {
-  const logger = telemetry.loggerProvider.getLogger('error-logger');
+  const logger = (telemetry as TelemetryService).loggerProvider.getLogger(
+    'error-logger'
+  );
   const customAttributes = attributes || {};
 
   // Add trace metadata
@@ -137,7 +139,9 @@ export function captureError(
  * @returns a promise which is resolved when all flushes are complete
  */
 export function flush(telemetry: Telemetry): Promise<void> {
-  return telemetry.loggerProvider.forceFlush().catch(err => {
-    console.error('Error flushing logs from Firebase Telemetry:', err);
-  });
+  return (telemetry as TelemetryService).loggerProvider
+    .forceFlush()
+    .catch(err => {
+      console.error('Error flushing logs from Firebase Telemetry:', err);
+    });
 }
diff --git a/packages/telemetry/src/helpers.test.ts b/packages/telemetry/src/helpers.test.ts
@@ -18,14 +18,14 @@
 import { expect } from 'chai';
 import { LoggerProvider } from '@opentelemetry/sdk-logs';
 import { Logger, LogRecord } from '@opentelemetry/api-logs';
-import { Telemetry } from './public-types';
 import { startNewSession } from './helpers';
 import {
   LOG_ENTRY_ATTRIBUTE_KEYS,
   TELEMETRY_SESSION_ID_KEY
 } from './constants';
 import { AUTO_CONSTANTS } from './auto-constants';
 import { TelemetryService } from './service';
+import { TelemetryInternal } from './types';
 
 const MOCK_SESSION_ID = '00000000-0000-0000-0000-000000000000';
 
@@ -47,7 +47,7 @@ describe('helpers', () => {
     shutdown: () => Promise.resolve()
   } as unknown as LoggerProvider;
 
-  const fakeTelemetry: Telemetry = {
+  const fakeTelemetry: TelemetryInternal = {
     app: {
       name: 'DEFAULT',
       automaticDataCollectionEnabled: true,
@@ -124,7 +124,7 @@ describe('helpers', () => {
     it('should log app version from telemetry options', () => {
       const telemetryWithVersion = new TelemetryService(
         fakeTelemetry.app,
-        fakeTelemetry.loggerProvider
+        fakeLoggerProvider
       );
       telemetryWithVersion.options = { appVersion: '9.9.9' };
 
diff --git a/packages/telemetry/src/helpers.ts b/packages/telemetry/src/helpers.ts
@@ -55,7 +55,7 @@ export function getSessionId(): string | undefined {
  * 2. In Cloud Logging as its own log entry
  */
 export function startNewSession(telemetry: Telemetry): void {
-  const { loggerProvider } = telemetry;
+  const { loggerProvider } = telemetry as TelemetryService;
   if (
     typeof sessionStorage !== 'undefined' &&
     typeof crypto?.randomUUID === 'function'
diff --git a/packages/telemetry/src/public-types.ts b/packages/telemetry/src/public-types.ts
@@ -16,7 +16,6 @@
  */
 
 import { FirebaseApp } from '@firebase/app';
-import { LoggerProvider } from '@opentelemetry/sdk-logs';
 
 /**
  * An instance of the Firebase Telemetry SDK.
@@ -30,9 +29,6 @@ export interface Telemetry {
    * The {@link @firebase/app#FirebaseApp} this {@link Telemetry} instance is associated with.
    */
   app: FirebaseApp;
-
-  /** The {@link LoggerProvider} this {@link Telemetry} instance uses. */
-  loggerProvider: LoggerProvider;
 }
 
 /**
diff --git a/packages/telemetry/src/types.ts b/packages/telemetry/src/types.ts
@@ -15,6 +15,18 @@
  * limitations under the License.
  */
 
+import { LoggerProvider } from '@opentelemetry/api-logs';
+import { Telemetry } from './public-types';
+
+/**
+ * An internal interface for the Telemetry service.
+ *
+ * @internal
+ */
+export interface TelemetryInternal extends Telemetry {
+  loggerProvider: LoggerProvider;
+}
+
 type KeyValuePair = [key: string, value: string];
 
 /**
