Skip to content

Commit 72b0288

Browse files
tonybaroneeetonybaroneee
committed
Rename telemetry package to crashlytics 
1 parent 5c95051 commit 72b0288

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+847
-841
lines changed

common/api-review/telemetry-angular.api.md renamed to common/api-review/crashlytics-angular.api.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## API Report File for "@firebase/telemetry-angular"
1+
## API Report File for "@firebase/crashlytics-angular"
22

33
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
44
@@ -8,23 +8,23 @@ import { ErrorHandler } from '@angular/core';
88
import { FirebaseApp } from '@firebase/app';
99

1010
// @public
11-
export class FirebaseErrorHandler implements ErrorHandler {
12-
constructor(app: FirebaseApp, telemetryOptions?: TelemetryOptions);
13-
// (undocumented)
14-
handleError(error: unknown): void;
15-
}
16-
17-
// @public
18-
export interface Telemetry {
11+
export interface Crashlytics {
1912
app: FirebaseApp;
2013
}
2114

2215
// @public
23-
export interface TelemetryOptions {
16+
export interface CrashlyticsOptions {
2417
appVersion?: string;
2518
endpointUrl?: string;
2619
}
2720

21+
// @public
22+
export class FirebaseErrorHandler implements ErrorHandler {
23+
constructor(app: FirebaseApp, crashlyticsOptions?: CrashlyticsOptions);
24+
// (undocumented)
25+
handleError(error: unknown): void;
26+
}
27+
2828

2929
// (No @packageDocumentation comment for this package)
3030

common/api-review/telemetry-react.api.md renamed to common/api-review/crashlytics-react.api.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## API Report File for "@firebase/telemetry-react"
1+
## API Report File for "@firebase/crashlytics-react"
22

33
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
44
@@ -7,22 +7,22 @@
77
import { FirebaseApp } from '@firebase/app';
88

99
// @public
10-
export function FirebaseTelemetry({ firebaseApp, telemetryOptions }: {
11-
firebaseApp: FirebaseApp;
12-
telemetryOptions?: TelemetryOptions;
13-
}): null;
14-
15-
// @public
16-
export interface Telemetry {
10+
export interface Crashlytics {
1711
app: FirebaseApp;
1812
}
1913

2014
// @public
21-
export interface TelemetryOptions {
15+
export interface CrashlyticsOptions {
2216
appVersion?: string;
2317
endpointUrl?: string;
2418
}
2519

20+
// @public
21+
export function FirebaseCrashlytics({ firebaseApp, crashlyticsOptions }: {
22+
firebaseApp: FirebaseApp;
23+
crashlyticsOptions?: CrashlyticsOptions;
24+
}): null;
25+
2626

2727
// (No @packageDocumentation comment for this package)
2828

‎common/api-review/crashlytics.api.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## API Report File for "@firebase/crashlytics"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import { AnyValueMap } from '@opentelemetry/api-logs';
8+
import { FirebaseApp } from '@firebase/app';
9+
import { Instrumentation } from 'next';
10+
11+
// @public
12+
export function captureError(crashlytics: Crashlytics, error: unknown, attributes?: AnyValueMap): void;
13+
14+
// @public
15+
export interface Crashlytics {
16+
app: FirebaseApp;
17+
}
18+
19+
// @public
20+
export interface CrashlyticsOptions {
21+
appVersion?: string;
22+
endpointUrl?: string;
23+
}
24+
25+
// @public
26+
export function flush(crashlytics: Crashlytics): Promise<void>;
27+
28+
// @public
29+
export function getCrashlytics(app?: FirebaseApp, options?: CrashlyticsOptions): Crashlytics;
30+
31+
export { Instrumentation }
32+
33+
// @public
34+
export function nextOnRequestError(crashlyticsOptions?: CrashlyticsOptions): Instrumentation.onRequestError;
35+
36+
37+
// (No @packageDocumentation comment for this package)
38+
39+
```

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

Lines changed: 0 additions & 39 deletions
This file was deleted.

‎docs-devsite/_toc.yaml‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -402,6 +402,29 @@ toc:
402402
path: /docs/reference/js/auth.userinfo.md
403403
- title: UserMetadata
404404
path: /docs/reference/js/auth.usermetadata.md
405+
- title: crashlytics
406+
path: /docs/reference/js/crashlytics_.md
407+
section:
408+
- title: Crashlytics
409+
path: /docs/reference/js/crashlytics_.crashlytics.md
410+
- title: CrashlyticsOptions
411+
path: /docs/reference/js/crashlytics_.crashlyticsoptions.md
412+
- title: crashlytics/angular
413+
path: /docs/reference/js/crashlytics_angular.md
414+
section:
415+
- title: Crashlytics
416+
path: /docs/reference/js/crashlytics_angular.crashlytics.md
417+
- title: CrashlyticsOptions
418+
path: /docs/reference/js/crashlytics_angular.crashlyticsoptions.md
419+
- title: FirebaseErrorHandler
420+
path: /docs/reference/js/crashlytics_angular.firebaseerrorhandler.md
421+
- title: crashlytics/react
422+
path: /docs/reference/js/crashlytics_react.md
423+
section:
424+
- title: Crashlytics
425+
path: /docs/reference/js/crashlytics_react.crashlytics.md
426+
- title: CrashlyticsOptions
427+
path: /docs/reference/js/crashlytics_react.crashlyticsoptions.md
405428
- title: database
406429
path: /docs/reference/js/database.md
407430
section:
@@ -702,26 +725,3 @@ toc:
702725
path: /docs/reference/js/storage.uploadtask.md
703726
- title: UploadTaskSnapshot
704727
path: /docs/reference/js/storage.uploadtasksnapshot.md
705-
- title: telemetry
706-
path: /docs/reference/js/telemetry_.md
707-
section:
708-
- title: Telemetry
709-
path: /docs/reference/js/telemetry_.telemetry.md
710-
- title: TelemetryOptions
711-
path: /docs/reference/js/telemetry_.telemetryoptions.md
712-
- title: telemetry/angular
713-
path: /docs/reference/js/telemetry_angular.md
714-
section:
715-
- title: FirebaseErrorHandler
716-
path: /docs/reference/js/telemetry_angular.firebaseerrorhandler.md
717-
- title: Telemetry
718-
path: /docs/reference/js/telemetry_angular.telemetry.md
719-
- title: TelemetryOptions
720-
path: /docs/reference/js/telemetry_angular.telemetryoptions.md
721-
- title: telemetry/react
722-
path: /docs/reference/js/telemetry_react.md
723-
section:
724-
- title: Telemetry
725-
path: /docs/reference/js/telemetry_react.telemetry.md
726-
- title: TelemetryOptions
727-
path: /docs/reference/js/telemetry_react.telemetryoptions.md

docs-devsite/telemetry.md renamed to docs-devsite/crashlytics.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ overwritten. Changes should be made in the source code at
99
https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

12-
# telemetry package
12+
# crashlytics package
1313

1414
| Entry Point | Description |
1515
| --- | --- |
16-
| [/](./telemetry_.md#@firebase/telemetry) | |
17-
| [/angular](./telemetry_angular.md#@firebase/telemetry/angular) | |
18-
| [/react](./telemetry_react.md#@firebase/telemetry/react) | |
16+
| [/](./crashlytics_.md#@firebase/crashlytics) | |
17+
| [/angular](./crashlytics_angular.md#@firebase/crashlytics/angular) | |
18+
| [/react](./crashlytics_react.md#@firebase/crashlytics/react) | |
1919

‎docs-devsite/crashlytics_.crashlytics.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# Crashlytics interface
13+
An instance of the Firebase Crashlytics SDK.
14+
15+
Do not create this instance directly. Instead, use [getCrashlytics()](./crashlytics_.md#getcrashlytics_a9d22a1)<!-- -->.
16+
17+
<b>Signature:</b>
18+
19+
```typescript
20+
export interface Crashlytics
21+
```
22+
23+
## Properties
24+
25+
| Property | Type | Description |
26+
| --- | --- | --- |
27+
| [app](./crashlytics_.crashlytics.md#crashlyticsapp) | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Crashlytics](./crashlytics_.crashlytics.md#crashlytics_interface) instance is associated with. |
28+
29+
## Crashlytics.app
30+
31+
The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Crashlytics](./crashlytics_.crashlytics.md#crashlytics_interface) instance is associated with.
32+
33+
<b>Signature:</b>
34+
35+
```typescript
36+
app: FirebaseApp;
37+
```

‎docs-devsite/crashlytics_.crashlyticsoptions.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# CrashlyticsOptions interface
13+
Options for initialized the Telemetry service using [getCrashlytics()](./crashlytics_.md#getcrashlytics_a9d22a1)<!-- -->.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface CrashlyticsOptions
19+
```
20+
21+
## Properties
22+
23+
| Property | Type | Description |
24+
| --- | --- | --- |
25+
| [appVersion](./crashlytics_.crashlyticsoptions.md#crashlyticsoptionsappversion) | string | The version of the application. This should be a unique string that identifies the snapshot of code to be deployed, such as "1.0.2". If not specified, other default locations will be checked for an identifier. Setting a value here takes precedence over any other values. |
26+
| [endpointUrl](./crashlytics_.crashlyticsoptions.md#crashlyticsoptionsendpointurl) | string | The URL for the endpoint to which Crashlytics data should be sent, in the OpenTelemetry format. By default, data will be sent to Firebase. |
27+
28+
## CrashlyticsOptions.appVersion
29+
30+
The version of the application. This should be a unique string that identifies the snapshot of code to be deployed, such as "1.0.2". If not specified, other default locations will be checked for an identifier. Setting a value here takes precedence over any other values.
31+
32+
<b>Signature:</b>
33+
34+
```typescript
35+
appVersion?: string;
36+
```
37+
38+
## CrashlyticsOptions.endpointUrl
39+
40+
The URL for the endpoint to which Crashlytics data should be sent, in the OpenTelemetry format. By default, data will be sent to Firebase.
41+
42+
<b>Signature:</b>
43+
44+
```typescript
45+
endpointUrl?: string;
46+
```

docs-devsite/telemetry_.instrumentation.md renamed to docs-devsite/crashlytics_.instrumentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export declare namespace Instrumentation
2020
2121
| Type Alias | Description |
2222
| --- | --- |
23-
| [onRequestError](./telemetry_.instrumentation.md#instrumentationonrequesterror) | |
23+
| [onRequestError](./crashlytics_.instrumentation.md#instrumentationonrequesterror) | |
2424
2525
## Instrumentation.onRequestError
2626

0 commit comments

Comments
 (0)