OTEL Tracing Initial Explorations

[anitdas]

Adding exploratory code for instrumenting OTEL tracing. This is to be merged with Crashlytics branch and is not meant for broader consumption at this time.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 6f1d38e

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]

Summary of Changes

Hello @anitdas, 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 initiates the integration of OpenTelemetry tracing into the Crashlytics module. The changes primarily involve updating configuration options to support separate endpoints for logging and tracing, incorporating necessary OpenTelemetry dependencies, and modifying the core service to utilize a new tracing provider. This is an exploratory step, intended to be merged with a specific Crashlytics branch, and is not yet ready for general consumption.

Highlights

• OpenTelemetry Tracing Integration: Introduced initial exploratory code for instrumenting OpenTelemetry (OTEL) tracing within the Crashlytics module, laying the groundwork for distributed tracing capabilities.
• Configuration Updates: Modified the CrashlyticsOptions interface across various API review files and the public types definition to replace a single endpointUrl with distinct loggingUrl and tracingUrl properties, allowing separate configuration for logging and tracing endpoints.
• New Dependencies: Added several new OpenTelemetry instrumentation and SDK dependencies to the packages/crashlytics/package.json file, including @opentelemetry/instrumentation, @opentelemetry/instrumentation-document-load, @opentelemetry/instrumentation-fetch, @opentelemetry/instrumentation-user-interaction, and @opentelemetry/sdk-trace-web.
• Service Constructor Update: Updated the CrashlyticsService constructor to accept a new tracingProvider instance, alongside the existing loggerProvider, enabling the service to manage both logging and tracing functionalities.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• common/api-review/crashlytics-angular.api.md
  • Replaced endpointUrl with loggingUrl and tracingUrl in the CrashlyticsOptions interface.
• common/api-review/crashlytics-react-router.api.md
  • Replaced endpointUrl with loggingUrl and tracingUrl in the CrashlyticsOptions interface.
• common/api-review/crashlytics-react.api.md
  • Replaced endpointUrl with loggingUrl and tracingUrl in the CrashlyticsOptions interface.
• common/api-review/crashlytics.api.md
  • Replaced endpointUrl with loggingUrl and tracingUrl in the CrashlyticsOptions interface.
• packages/crashlytics/package.json
  • Added new OpenTelemetry instrumentation dependencies: @opentelemetry/instrumentation, @opentelemetry/instrumentation-document-load, @opentelemetry/instrumentation-fetch, @opentelemetry/instrumentation-user-interaction.
  • Added @opentelemetry/sdk-trace-web to production dependencies.
  • Removed @opentelemetry/sdk-trace-web from development dependencies.
• packages/crashlytics/src/public-types.ts
  • Replaced the endpointUrl property with loggingUrl and tracingUrl in the CrashlyticsOptions interface, along with updated JSDoc comments.
• packages/crashlytics/src/register.node.ts
  • Imported createTracingProvider.
  • Modified the endpointUrl variable to loggingUrl and introduced a new tracingUrl variable.
  • Instantiated a tracingProvider using createTracingProvider.
  • Updated the CrashlyticsService constructor call to include the new tracingProvider.
• packages/crashlytics/src/register.ts
  • Imported createTracingProvider.
  • Modified the endpointUrl variable to loggingUrl and introduced a new tracingUrl variable.
  • Instantiated a tracingProvider using createTracingProvider.
  • Updated the CrashlyticsService constructor call to include the new tracingProvider.
• packages/crashlytics/src/service.ts
  • Imported WebTracerProvider from @opentelemetry/sdk-trace-web.
  • Updated the CrashlyticsService constructor to accept a tracingProvider of type WebTracerProvider.

Activity

• No specific activity (comments, reviews, etc.) has been recorded for this pull request yet.

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.

Footnotes

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

[gemini-code-assist]

Code Review

This pull request introduces initial OpenTelemetry tracing capabilities to the Crashlytics service. Key changes include updating the CrashlyticsOptions interface to differentiate between logging and tracing endpoints, adding new OpenTelemetry dependencies, and implementing a createTracingProvider function along with a custom OTLP trace exporter. The changes are well-structured and integrate tracing functionality, but there are a few areas that could be improved for robustness and production readiness.

[tonybaroneee]

Keep in crashlytics-tracing branch (do not merge into crashlytics since we want to keep that purely logging for MVP)