Introduce TelemetryOptions allowing telemetry endpoint to be specified

common/api-review/telemetry-react.api.md

@@ -4,13 +4,27 @@
 
 ```ts
 
+import { FirebaseApp } from '@firebase/app';
 import { FirebaseOptions } from '@firebase/app';
+import { LoggerProvider } from '@opentelemetry/sdk-logs';
 
 // @public
-export function FirebaseTelemetry({ firebaseOptions }: {
+export function FirebaseTelemetry({ firebaseOptions, telemetryOptions }: {
     firebaseOptions?: FirebaseOptions;
+    telemetryOptions?: TelemetryOptions;
 }): null;
 
+// @public
+export interface Telemetry {
+    app: FirebaseApp;
+    loggerProvider: LoggerProvider;
+}
+
+// @public
+export interface TelemetryOptions {
+    endpointUrl?: string;
+}
+
 
 // (No @packageDocumentation comment for this package)
 

common/api-review/telemetry.api.md

@@ -16,19 +16,24 @@ export function captureError(telemetry: Telemetry, error: unknown, attributes?:
 export function flush(telemetry: Telemetry): Promise<void>;
 
 // @public
-export function getTelemetry(app?: FirebaseApp): Telemetry;
+export function getTelemetry(app?: FirebaseApp, options?: TelemetryOptions): Telemetry;
 
 export { Instrumentation }
 
 // @public
-export const nextOnRequestError: Instrumentation.onRequestError;
+export function nextOnRequestError(telemetryOptions?: TelemetryOptions): Instrumentation.onRequestError;
 
 // @public
 export interface Telemetry {
     app: FirebaseApp;
     loggerProvider: LoggerProvider;
 }
 
+// @public
+export interface TelemetryOptions {
+    endpointUrl?: string;
+}
+
 
 // (No @packageDocumentation comment for this package)
 

docs-devsite/_toc.yaml

@@ -699,6 +699,12 @@ toc:
   section:
   - title: Telemetry
     path: /docs/reference/js/telemetry_.telemetry.md
+  - title: TelemetryOptions
+    path: /docs/reference/js/telemetry_.telemetryoptions.md
 - title: telemetry/react
   path: /docs/reference/js/telemetry_react.md
-  section: []
+  section:
+  - title: Telemetry
+    path: /docs/reference/js/telemetry_react.telemetry.md
+  - title: TelemetryOptions
+    path: /docs/reference/js/telemetry_react.telemetryoptions.md

docs-devsite/telemetry_.md

@@ -16,46 +16,44 @@ https://github.com/firebase/firebase-js-sdk
 |  Function | Description |
 |  --- | --- |
 |  <b>function(app, ...)</b> |
-|  [getTelemetry(app)](./telemetry_.md#gettelemetry_cf608e1) | Returns the default [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. If no instance exists, initializes a new instance with the default settings. |
+|  [getTelemetry(app, options)](./telemetry_.md#gettelemetry_448bdc6) | Returns the default [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. If no instance exists, initializes a new instance with the default settings. |
 |  <b>function(telemetry, ...)</b> |
 |  [captureError(telemetry, error, attributes)](./telemetry_.md#captureerror_862e6b3) | Enqueues an error to be uploaded to the Firebase Telemetry API. |
 |  [flush(telemetry)](./telemetry_.md#flush_8975134) | Flushes all enqueued telemetry data immediately, instead of waiting for default batching. |
+|  <b>function(telemetryOptions, ...)</b> |
+|  [nextOnRequestError(telemetryOptions)](./telemetry_.md#nextonrequesterror_3bd5542) | Automatically report uncaught errors from server routes to Firebase Telemetry. |
 
 ## Interfaces
 
 |  Interface | Description |
 |  --- | --- |
-|  [Telemetry](./telemetry_.telemetry.md#telemetry_interface) | An instance of the Firebase Telemetry SDK.<!-- -->Do not create this instance directly. Instead, use [getTelemetry()](./telemetry_.md#gettelemetry_cf608e1)<!-- -->. |
+|  [Telemetry](./telemetry_.telemetry.md#telemetry_interface) | An instance of the Firebase Telemetry SDK.<!-- -->Do not create this instance directly. Instead, use [getTelemetry()](./telemetry_.md#gettelemetry_448bdc6)<!-- -->. |
+|  [TelemetryOptions](./telemetry_.telemetryoptions.md#telemetryoptions_interface) | Options for initialized the Telemetry service using [getTelemetry()](./telemetry_.md#gettelemetry_448bdc6)<!-- -->. |
 
 ## Namespaces
 
 |  Namespace | Description |
 |  --- | --- |
 |  [Instrumentation](./telemetry_.instrumentation.md#instrumentation_namespace) |  |
 
-## Variables
-
-|  Variable | Description |
-|  --- | --- |
-|  [nextOnRequestError](./telemetry_.md#nextonrequesterror) | Automatically report uncaught errors from server routes to Firebase Telemetry. |
-
 ## function(app, ...)
 
-### getTelemetry(app) {:#gettelemetry_cf608e1}
+### getTelemetry(app, options) {:#gettelemetry_448bdc6}
 
 Returns the default [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. If no instance exists, initializes a new instance with the default settings.
 
 <b>Signature:</b>
 
 ```typescript
-export declare function getTelemetry(app?: FirebaseApp): Telemetry;
+export declare function getTelemetry(app?: FirebaseApp, options?: TelemetryOptions): Telemetry;
 ```
 
 #### Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  app | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) to use. |
+|  options | [TelemetryOptions](./telemetry_.telemetryoptions.md#telemetryoptions_interface) | [TelemetryOptions](./telemetry_.telemetryoptions.md#telemetryoptions_interface) that configure the Telemetry instance. |
 
 <b>Returns:</b>
 
@@ -117,22 +115,37 @@ Promise&lt;void&gt;
 
 a promise which is resolved when all flushes are complete
 
-## nextOnRequestError
+## function(telemetryOptions, ...)
+
+### nextOnRequestError(telemetryOptions) {:#nextonrequesterror_3bd5542}
 
 Automatically report uncaught errors from server routes to Firebase Telemetry.
 
 <b>Signature:</b>
 
 ```typescript
-nextOnRequestError: Instrumentation.onRequestError
+export declare function nextOnRequestError(telemetryOptions?: TelemetryOptions): Instrumentation.onRequestError;
 ```
 
+#### Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  telemetryOptions | [TelemetryOptions](./telemetry_.telemetryoptions.md#telemetryoptions_interface) | [TelemetryOptions](./telemetry_.telemetryoptions.md#telemetryoptions_interface) that configure the Telemetry instance. |
+
+<b>Returns:</b>
+
+[Instrumentation.onRequestError](./telemetry_.instrumentation.md#instrumentationonrequesterror)
+
+A request error handler for use in Next.js' instrumentation file
+
 ### Example
 
 
 ```javascript
 // In instrumentation.ts (https://nextjs.org/docs/app/guides/instrumentation):
-export { nextOnRequestError as onRequestError }  from 'firebase/telemetry'
+import { nextOnRequestError } from 'firebase/telemetry'
+export const onRequestError = nextOnRequestError();
 
 ```
 

docs-devsite/telemetry_.telemetry.md

@@ -12,7 +12,7 @@ https://github.com/firebase/firebase-js-sdk
 # Telemetry interface
 An instance of the Firebase Telemetry SDK.
 
-Do not create this instance directly. Instead, use [getTelemetry()](./telemetry_.md#gettelemetry_cf608e1)<!-- -->.
+Do not create this instance directly. Instead, use [getTelemetry()](./telemetry_.md#gettelemetry_448bdc6)<!-- -->.
 
 <b>Signature:</b>
 

docs-devsite/telemetry_.telemetryoptions.md

@@ -0,0 +1,35 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# TelemetryOptions interface
+Options for initialized the Telemetry service using [getTelemetry()](./telemetry_.md#gettelemetry_448bdc6)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export interface TelemetryOptions 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [endpointUrl](./telemetry_.telemetryoptions.md#telemetryoptionsendpointurl) | string | The URL for the endpoint to which telemetry data should be sent, in the Open Telemetry format. By default, data will be sent to Firebase. |
+
+## TelemetryOptions.endpointUrl
+
+The URL for the endpoint to which telemetry data should be sent, in the Open Telemetry format. By default, data will be sent to Firebase.
+
+<b>Signature:</b>
+
+```typescript
+endpointUrl?: string;
+```

docs-devsite/telemetry_react.md

@@ -15,11 +15,18 @@ https://github.com/firebase/firebase-js-sdk
 
 |  Function | Description |
 |  --- | --- |
-|  [FirebaseTelemetry({ firebaseOptions })](./telemetry_react.md#firebasetelemetry_537af3f) | Registers event listeners for uncaught errors.<!-- -->This should be installed near the root of your application. Caught errors, including those implicitly caught by Error Boundaries, will not be captured by this component. |
+|  [FirebaseTelemetry({ firebaseOptions, telemetryOptions })](./telemetry_react.md#firebasetelemetry_f37eb31) | Registers event listeners for uncaught errors.<!-- -->This should be installed near the root of your application. Caught errors, including those implicitly caught by Error Boundaries, will not be captured by this component. |
 
-## function({ firebaseOptions }, ...)
+## Interfaces
 
-### FirebaseTelemetry({ firebaseOptions }) {:#firebasetelemetry_537af3f}
+|  Interface | Description |
+|  --- | --- |
+|  [Telemetry](./telemetry_react.telemetry.md#telemetry_interface) | An instance of the Firebase Telemetry SDK.<!-- -->Do not create this instance directly. Instead, use [getTelemetry()](./telemetry_.md#gettelemetry_448bdc6)<!-- -->. |
+|  [TelemetryOptions](./telemetry_react.telemetryoptions.md#telemetryoptions_interface) | Options for initialized the Telemetry service using [getTelemetry()](./telemetry_.md#gettelemetry_448bdc6)<!-- -->. |
+
+## function({ firebaseOptions, telemetryOptions }, ...)
+
+### FirebaseTelemetry({ firebaseOptions, telemetryOptions }) {:#firebasetelemetry_f37eb31}
 
 Registers event listeners for uncaught errors.
 
@@ -28,16 +35,17 @@ This should be installed near the root of your application. Caught errors, inclu
 <b>Signature:</b>
 
 ```typescript
-export declare function FirebaseTelemetry({ firebaseOptions }: {
+export declare function FirebaseTelemetry({ firebaseOptions, telemetryOptions }: {
     firebaseOptions?: FirebaseOptions;
+    telemetryOptions?: TelemetryOptions;
 }): null;
 ```
 
 #### Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  { firebaseOptions } | { firebaseOptions?: [FirebaseOptions](./app.firebaseoptions.md#firebaseoptions_interface)<!-- -->; } |  |
+|  { firebaseOptions, telemetryOptions } | { firebaseOptions?: [FirebaseOptions](./app.firebaseoptions.md#firebaseoptions_interface)<!-- -->; telemetryOptions?: [TelemetryOptions](./telemetry_.telemetryoptions.md#telemetryoptions_interface)<!-- -->; } |  |
 
 <b>Returns:</b>
 

docs-devsite/telemetry_react.telemetry.md

@@ -0,0 +1,48 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# Telemetry interface
+An instance of the Firebase Telemetry SDK.
+
+Do not create this instance directly. Instead, use [getTelemetry()](./telemetry_.md#gettelemetry_448bdc6)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export interface Telemetry 
+```
+
+## Properties
+
+|  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
+
+The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance is associated with.
+
+<b>Signature:</b>
+
+```typescript
+app: FirebaseApp;
+```
+
+## Telemetry.loggerProvider
+
+The  this [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance uses.
+
+<b>Signature:</b>
+
+```typescript
+loggerProvider: LoggerProvider;
+```

docs-devsite/telemetry_react.telemetryoptions.md

@@ -0,0 +1,35 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# TelemetryOptions interface
+Options for initialized the Telemetry service using [getTelemetry()](./telemetry_.md#gettelemetry_448bdc6)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export interface TelemetryOptions 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [endpointUrl](./telemetry_react.telemetryoptions.md#telemetryoptionsendpointurl) | string | The URL for the endpoint to which telemetry data should be sent, in the Open Telemetry format. By default, data will be sent to Firebase. |
+
+## TelemetryOptions.endpointUrl
+
+The URL for the endpoint to which telemetry data should be sent, in the Open Telemetry format. By default, data will be sent to Firebase.
+
+<b>Signature:</b>
+
+```typescript
+endpointUrl?: string;
+```

packages/telemetry/package.json

@@ -82,7 +82,7 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@firebase/app": "0.14.2",
+    "@firebase/app": "0.14.3",
     "@opentelemetry/sdk-trace-web": "2.1.0",
     "@rollup/plugin-json": "6.1.0",
     "@testing-library/dom": "10.4.1",

packages/telemetry/rollup.config.js

@@ -94,6 +94,10 @@ const reactBuilds = [
           {
             src: 'dist/src/react/index.d.ts',
             dest: 'dist/react'
+          },
+          {
+            src: 'dist/src/public-types.d.ts',
+            dest: 'dist'
           }
         ]
       })