Add support for async attributes in temeletry otel logger #9373

tonybaroneee · 2025-11-11T19:12:31Z

Discussion

This PR add support for a new DynamicLogAttributeProvider (similar to DynamicHeaderProvider which allows us to resolve async attributes (i.e. installation id) during the background otel export. This lets us keep our captureError API synchronous. It's extensible enough to easily support more async attributes in the future.
I also added the first usage of this provider: InstallationIdProvider, which attaches the client's firebase installation id to each error log entry.

Testing

Added unit tests for InstallationIdProvider
Manually verified that the user.id attribute is set correctly in logs captured by a locally deployed test app.

API Changes

(None)

changeset-bot · 2025-11-11T19:12:35Z

⚠️ No Changeset found

Latest commit: 305d3ea

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

gemini-code-assist · 2025-11-11T19:12:47Z

Summary of Changes

Hello @tonybaroneee, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a significant enhancement to the telemetry system by integrating Firebase Installation IDs (FIDs) into error logging. By attaching a unique FID to each captured error, the system gains the ability to identify and correlate errors more effectively, providing a clearer picture of user-specific issues and improving error analysis capabilities.

Highlights

Firebase Installation ID (FID) Integration: The primary change is the integration of Firebase Installation IDs (FIDs) into the telemetry's captureError API.
User Identification for Errors: FIDs will be used as a proxy for user identifiers, enabling better correlation and analysis of errors at read-time.
Dependency Update: The @firebase/installations package has been added as a peer dependency to support FID retrieval.
Telemetry Service Enhancement: The TelemetryService now proactively fetches and stores the FID upon instantiation.
Comprehensive Testing: Unit tests have been updated to ensure the fid is correctly attached to error log entries, and manual verification was performed.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

yarn.lock

gemini-code-assist

Code Review

This pull request adds the Firebase Installation ID (fid) to error logs, which will serve as a user identifier. The changes are well-structured and the tests are updated accordingly. My main feedback is on the implementation of fid fetching in TelemetryService, which uses a fire-and-forget approach. This can lead to a race condition where early errors are logged without an fid, and the error handling for the fetch operation could be improved for better debuggability. I've left a specific comment with a suggestion.

packages/telemetry/src/service.ts

google-oss-bot · 2025-11-11T22:39:37Z

Size Report ¹

Affected Products

@firebase/telemetry
Type Base (836a427) Merge (35f425a) Diff
browser 6.84 kB 8.11 kB +1.27 kB (+18.6%)
main 6.94 kB 7.53 kB +588 B (+8.5%)
module 6.84 kB 8.11 kB +1.27 kB (+18.6%)
firebase
Type Base (836a427) Merge (35f425a) Diff
firebase-telemetry.js 73.8 kB 88.0 kB +14.1 kB (+19.1%)

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/wruvSgQC88.html

google-oss-bot · 2025-11-11T22:52:50Z

Size Analysis Report ¹

Affected Products

`@firebase/telemetry`

`captureError`

Size

Type	Base (`836a427`)	Merge (`35f425a`)	Diff
size	4.11 kB	4.89 kB	+780 B (+19.0%)
size-with-ext-deps	55.0 kB	64.3 kB	+9.29 kB (+16.9%)

Dependency

Type Base (836a427) Merge (35f425a) Diff

classes

AppCheckProvider
FetchTransport
OTLPLogExporter
TelemetryService

AppCheckProvider
AsyncAttributeLogExporter
FetchTransport
InstallationIdProvider
OTLPLogExporter
TelemetryService

+ AsyncAttributeLogExporter
+ InstallationIdProvider

`flush`

Size

Type	Base (`836a427`)	Merge (`35f425a`)	Diff
size	3.45 kB	4.23 kB	+780 B (+22.6%)
size-with-ext-deps	53.7 kB	63.0 kB	+9.29 kB (+17.3%)

Dependency

Type Base (836a427) Merge (35f425a) Diff

classes

AppCheckProvider
FetchTransport
OTLPLogExporter
TelemetryService

AppCheckProvider
AsyncAttributeLogExporter
FetchTransport
InstallationIdProvider
OTLPLogExporter
TelemetryService

+ AsyncAttributeLogExporter
+ InstallationIdProvider

`getTelemetry`

Size

Type	Base (`836a427`)	Merge (`35f425a`)	Diff
size	3.49 kB	4.27 kB	+780 B (+22.4%)
size-with-ext-deps	60.8 kB	69.9 kB	+9.14 kB (+15.0%)

Dependency

Type Base (836a427) Merge (35f425a) Diff

classes

AppCheckProvider
FetchTransport
OTLPLogExporter
TelemetryService

AppCheckProvider
AsyncAttributeLogExporter
FetchTransport
InstallationIdProvider
OTLPLogExporter
TelemetryService

+ AsyncAttributeLogExporter
+ InstallationIdProvider

`nextOnRequestError`

Size

Type	Base (`836a427`)	Merge (`35f425a`)	Diff
size	4.48 kB	5.26 kB	+780 B (+17.4%)
size-with-ext-deps	62.4 kB	71.6 kB	+9.14 kB (+14.6%)

Dependency

Type Base (836a427) Merge (35f425a) Diff

classes

AppCheckProvider
FetchTransport
OTLPLogExporter
TelemetryService

AppCheckProvider
AsyncAttributeLogExporter
FetchTransport
InstallationIdProvider
OTLPLogExporter
TelemetryService

+ AsyncAttributeLogExporter
+ InstallationIdProvider

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/xQIb34CKL0.html

packages/telemetry/src/register.ts

tonybaroneee requested review from andrewbrook and hsubox76 November 11, 2025 19:12

tonybaroneee requested a review from a team as a code owner November 11, 2025 19:12

tonybaroneee commented Nov 11, 2025

View reviewed changes

yarn.lock Outdated Show resolved Hide resolved

gemini-code-assist bot reviewed Nov 11, 2025

View reviewed changes

packages/telemetry/src/service.ts Outdated Show resolved Hide resolved

andrewbrook approved these changes Nov 11, 2025

View reviewed changes

tonybaroneee force-pushed the telemetry-capture-fid branch from ed5be99 to 2ee5e0f Compare November 11, 2025 19:36

tonybaroneee marked this pull request as draft November 11, 2025 20:42

tonybaroneee force-pushed the telemetry-capture-fid branch 4 times, most recently from d4dcfba to 740a83f Compare November 11, 2025 22:11

tonybaroneee marked this pull request as ready for review November 11, 2025 22:11

tonybaroneee commented Nov 11, 2025

View reviewed changes

packages/telemetry/src/service.ts Outdated Show resolved Hide resolved

tonybaroneee force-pushed the telemetry-capture-fid branch from 740a83f to 7ea2578 Compare November 11, 2025 22:21

tonybaroneee force-pushed the telemetry-capture-fid branch 2 times, most recently from a9e1ad8 to 6cbb429 Compare November 17, 2025 15:46

tonybaroneee requested a review from andrewbrook November 17, 2025 19:49

tonybaroneee force-pushed the telemetry-capture-fid branch 3 times, most recently from 1b2654c to e66c193 Compare November 17, 2025 20:06

tonybaroneee changed the title ~~Attach fid to captureError in telemetry~~ Add support for async attributes in temeletry otel logger Nov 17, 2025

tonybaroneee force-pushed the telemetry-capture-fid branch from d7e58db to af87ba0 Compare November 17, 2025 20:24

andrewbrook reviewed Nov 17, 2025

View reviewed changes

packages/telemetry/src/register.ts Outdated Show resolved Hide resolved

hsubox76 reviewed Nov 17, 2025

View reviewed changes

packages/telemetry/src/register.ts Outdated Show resolved Hide resolved

hsubox76 approved these changes Nov 17, 2025

View reviewed changes

andrewbrook reviewed Nov 17, 2025

View reviewed changes

packages/telemetry/src/register.ts Show resolved Hide resolved

andrewbrook approved these changes Nov 17, 2025

View reviewed changes

tonybaroneee added 10 commits November 17, 2025 21:23

Attach fid to captureError in telemetry

6b3125d

Update error message log in getFid() fetch

b53ab4c

Provide installations package via getProvider

f476c05

Refactor to create and use a DynamicLogAttributeProvider

31ebe3f

Fix tests

4377815

Use await for dynamic attribute resolution

16fdf3e

Cleaned up var naming

50ab9ad

Remove old code

9e455d8

Address pr feedback

91f8bbb

Make installation provider optional

8aa5d9f

tonybaroneee force-pushed the telemetry-capture-fid branch from 6d64a6b to 8aa5d9f Compare November 17, 2025 21:25

tonybaroneee added 2 commits November 17, 2025 21:26

Fix test

693d3ff

Formatting

305d3ea

tonybaroneee merged commit d24986a into telemetry Nov 17, 2025
21 checks passed

tonybaroneee deleted the telemetry-capture-fid branch November 17, 2025 21:50

Add support for async attributes in temeletry otel logger #9373

Add support for async attributes in temeletry otel logger #9373

Uh oh!

Conversation

tonybaroneee commented Nov 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Discussion

Testing

API Changes

Uh oh!

changeset-bot bot commented Nov 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

gemini-code-assist bot commented Nov 11, 2025

Summary of Changes

Highlights

Footnotes

Uh oh!

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

google-oss-bot commented Nov 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Report 1

Affected Products

@firebase/telemetry

firebase

Test Logs

Uh oh!

google-oss-bot commented Nov 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Analysis Report 1

Affected Products

@firebase/telemetry

captureError

flush

getTelemetry

nextOnRequestError

Test Logs

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tonybaroneee commented Nov 11, 2025 •

edited

Loading

changeset-bot bot commented Nov 11, 2025 •

edited

Loading

google-oss-bot commented Nov 11, 2025 •

edited

Loading

Size Report ¹

`@firebase/telemetry`

`firebase`

google-oss-bot commented Nov 11, 2025 •

edited

Loading

Size Analysis Report ¹

`@firebase/telemetry`

`captureError`

`flush`

`getTelemetry`

`nextOnRequestError`