Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 17 additions & 0 deletions common/api-review/telemetry-react.api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## API Report File for "@firebase/telemetry-react"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

import { FirebaseOptions } from '@firebase/app';

// @public
export function FirebaseTelemetry({ firebaseOptions }: {
firebaseOptions?: FirebaseOptions;
}): null;


// (No @packageDocumentation comment for this package)

```
9 changes: 2 additions & 7 deletions common/api-review/telemetry.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

import { AnyValueMap } from '@opentelemetry/api-logs';
import { FirebaseApp } from '@firebase/app';
import { Instrumentation } from 'next';
import { LoggerProvider } from '@opentelemetry/sdk-logs';

// @public
Expand All @@ -17,13 +18,7 @@ export function flush(telemetry: Telemetry): Promise<void>;
// @public
export function getTelemetry(app?: FirebaseApp): Telemetry;

// @public (undocumented)
export namespace Instrumentation {
// Warning: (ae-forgotten-export) The symbol "InstrumentationOnRequestError" needs to be exported by the entry point index.d.ts
//
// (undocumented)
export type onRequestError = InstrumentationOnRequestError;
}
export { Instrumentation }

// @public
export const nextOnRequestError: Instrumentation.onRequestError;
Expand Down
17 changes: 17 additions & 0 deletions common/api-review/telemetry.react.api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## API Report File for "@firebase/telemetry/react"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

import { FirebaseOptions } from '@firebase/app';

// @public
export function FirebaseTelemetry({ firebaseOptions }: {
firebaseOptions?: FirebaseOptions;
}): null;


// (No @packageDocumentation comment for this package)

```
2 changes: 1 addition & 1 deletion config/webpack.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ module.exports = {
resolve: {
modules: ['node_modules', path.resolve(__dirname, '../../node_modules')],
mainFields: ['browser', 'module', 'main'],
extensions: ['.js', '.ts'],
extensions: ['.js', '.ts', '.tsx'],
symlinks: true
},
plugins: [
Expand Down
7 changes: 5 additions & 2 deletions docs-devsite/_toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -687,7 +687,10 @@ toc:
- title: UploadTaskSnapshot
path: /docs/reference/js/storage.uploadtasksnapshot.md
- title: telemetry
path: /docs/reference/js/telemetry.md
path: /docs/reference/js/telemetry_.md
section:
- title: Telemetry
path: /docs/reference/js/telemetry.telemetry.md
path: /docs/reference/js/telemetry_.telemetry.md
- title: telemetry/react
path: /docs/reference/js/telemetry_react.md
section: []
126 changes: 3 additions & 123 deletions docs-devsite/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,128 +11,8 @@ https://github.com/firebase/firebase-js-sdk

# telemetry package

## Functions

| 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. |
| <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. |

## 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)<!-- -->. |

## Namespaces

| Namespace | Description |
| Entry Point | 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}

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;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| app | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) to use. |

<b>Returns:</b>

[Telemetry](./telemetry.telemetry.md#telemetry_interface)

The default [Telemetry](./telemetry.telemetry.md#telemetry_interface) instance for the given [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->.

### Example


```javascript
const telemetry = getTelemetry(app);

```

## function(telemetry, ...)

### captureError(telemetry, error, attributes) {:#captureerror_862e6b3}

Enqueues an error to be uploaded to the Firebase Telemetry API.

<b>Signature:</b>

```typescript
export declare function captureError(telemetry: Telemetry, error: unknown, attributes?: AnyValueMap): void;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| telemetry | [Telemetry](./telemetry.telemetry.md#telemetry_interface) | The [Telemetry](./telemetry.telemetry.md#telemetry_interface) instance. |
| error | unknown | The caught exception, typically an |
| attributes | AnyValueMap | = Optional, arbitrary attributes to attach to the error log |

<b>Returns:</b>

void

### flush(telemetry) {:#flush_8975134}

Flushes all enqueued telemetry data immediately, instead of waiting for default batching.

<b>Signature:</b>

```typescript
export declare function flush(telemetry: Telemetry): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| telemetry | [Telemetry](./telemetry.telemetry.md#telemetry_interface) | The [Telemetry](./telemetry.telemetry.md#telemetry_interface) instance. |

<b>Returns:</b>

Promise&lt;void&gt;

a promise which is resolved when all flushes are complete

## nextOnRequestError

Automatically report uncaught errors from server routes to Firebase Telemetry.

<b>Signature:</b>

```typescript
nextOnRequestError: Instrumentation.onRequestError
```

### Example


```javascript
// In instrumentation.ts (https://nextjs.org/docs/app/guides/instrumentation):
export { nextOnRequestError as onRequestError } from 'firebase/telemetry'

```
| [/](./telemetry_.md#@firebase/telemetry) | |
| [/react](./telemetry_react.md#@firebase/telemetry/react) | |

Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export declare namespace Instrumentation

| Type Alias | Description |
| --- | --- |
| [onRequestError](./telemetry.instrumentation.md#instrumentationonrequesterror) | |
| [onRequestError](./telemetry_.instrumentation.md#instrumentationonrequesterror) | |

## Instrumentation.onRequestError

Expand Down
138 changes: 138 additions & 0 deletions docs-devsite/telemetry_.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
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 %}

# @firebase/telemetry

## Functions

| 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. |
| <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. |

## 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)<!-- -->. |

## 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}

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;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| app | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) to use. |

<b>Returns:</b>

[Telemetry](./telemetry_.telemetry.md#telemetry_interface)

The default [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance for the given [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->.

### Example


```javascript
const telemetry = getTelemetry(app);

```

## function(telemetry, ...)

### captureError(telemetry, error, attributes) {:#captureerror_862e6b3}

Enqueues an error to be uploaded to the Firebase Telemetry API.

<b>Signature:</b>

```typescript
export declare function captureError(telemetry: Telemetry, error: unknown, attributes?: AnyValueMap): void;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| telemetry | [Telemetry](./telemetry_.telemetry.md#telemetry_interface) | The [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance. |
| error | unknown | The caught exception, typically an |
| attributes | AnyValueMap | = Optional, arbitrary attributes to attach to the error log |

<b>Returns:</b>

void

### flush(telemetry) {:#flush_8975134}

Flushes all enqueued telemetry data immediately, instead of waiting for default batching.

<b>Signature:</b>

```typescript
export declare function flush(telemetry: Telemetry): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| telemetry | [Telemetry](./telemetry_.telemetry.md#telemetry_interface) | The [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance. |

<b>Returns:</b>

Promise&lt;void&gt;

a promise which is resolved when all flushes are complete

## nextOnRequestError

Automatically report uncaught errors from server routes to Firebase Telemetry.

<b>Signature:</b>

```typescript
nextOnRequestError: Instrumentation.onRequestError
```

### Example


```javascript
// In instrumentation.ts (https://nextjs.org/docs/app/guides/instrumentation):
export { nextOnRequestError as onRequestError } from 'firebase/telemetry'

```

Original file line number Diff line number Diff line change
Expand Up @@ -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_cf608e1)<!-- -->.

<b>Signature:</b>

Expand All @@ -24,12 +24,12 @@ 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. |
| [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

The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Telemetry](./telemetry.telemetry.md#telemetry_interface) instance is associated with.
The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance is associated with.

<b>Signature:</b>

Expand All @@ -39,7 +39,7 @@ app: FirebaseApp;

## Telemetry.loggerProvider

The this [Telemetry](./telemetry.telemetry.md#telemetry_interface) instance uses.
The this [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance uses.

<b>Signature:</b>

Expand Down
Loading
Loading