Introduce client performance observability to the Sourcegraph application: Tracking issue

[valerybugakov]

Problem to solve

The client's observability is lacking. We use Sentry for error tracking but do not have client RUM and performance monitoring instrumentations. It means that we do not understand how real users use our client application in terms of performance/interactions. It limits our ability to assess and prioritize areas for improvement. We are forced to do it based on limited customer development sessions, anecdotal evidence, or one-time testing without the ability to monitor trends and proactively jump on the most impactful issues. Instrumenting our client application can reveal user issues that couldn't be observed or diagnosed any other way.

Measure of success

• [ ] We have a robust process for client performance observability on the client, and it's documented in the handbook.
• [ ] Relevant services and tools are configured to enable the client performance observability.
• [ ] Auto instrumentations for client performance monitoring are configured.
• [ ] The collected amount of app telemetry data is sufficient for running queries, visualizing traces, and asking questions about specific user interactions.

Solution Summary

• [x] Evaluate the relative advantages and disadvantages of available performance monitoring tooling and determine the best path forward
• [ ] Enable continuous web application bundlesize monitoring.
  • [x] #39736
  • [x] #39735
  • [x] #39737
  • [ ] #39738
• [ ] Basic OpenTelemetry integration to enable gathering performance metrics immediately so that we can identify bottlenecks across the application and make targeted improvements that improve core workflow.
  • [x] #39273
  • [ ] #39276
  • [x] #39274
• [ ] Integrate client OpenTelemetry data with backend OpenTelemetry collector
  • [x] #39277
  • [ ] #39278
• [ ] #39275
• [ ] Instrument the web application.
  • [x] #40467
  • [x] #40468
• [ ] Implement client OpenTelemetry instrumentations
  • [ ] #39280
  • [ ] #39279
  • [x] #39281
  • [x] #39282
  • [x] #40466
  • [ ] #40592
  • [x] #43847
  • [x] #44008
• [ ] Implement integration tests for client OpenTelemetry instrumentation
  • [ ] #43844
  • [ ] #43845
  • [ ] #43846
• [ ] Improve client OpenTelemetry events by adding valuable information
  • [x] #40562
  • [ ] #40559
• [ ] Make targeted performance improvements to core workflow based on OpenTelementy metrics.
• [ ] Document configuration
  • [ ] #45165
• [ ] Configure OpenTelemetry backends
  • [x] #45166
  • [ ] #45168
• [ ] Document usage
  • [ ] Recommended tags and context for traces
  • [ ] Best practices for instrumenting features
  • [ ] Docs on inspecting and interpreting results in Honeycomb
• [ ] Configure event sampling
• [ ] Configure event batching to limit API calls

Artifacts:

• RFC 722: client performance observability
• Client observability state

What specific customers are we iterating on the problem and solution with?

Internal Sourcegraph developers

Delivery plan

Tracked issues

@valerybugakov

• [ ] https://github.com/sourcegraph/sourcegraph/issues/40592
• [ ] https://github.com/sourcegraph/sourcegraph/issues/39275
• [ ] https://github.com/sourcegraph/sourcegraph/issues/39276
• [ ] https://github.com/sourcegraph/sourcegraph/issues/39738
• [ ] https://github.com/sourcegraph/sourcegraph/issues/40651
• [ ] https://github.com/sourcegraph/sourcegraph/issues/43844 (PRs: ~#43843~)
• [ ] https://github.com/sourcegraph/sourcegraph/issues/43845
• [ ] https://github.com/sourcegraph/sourcegraph/issues/43846
• [ ] https://github.com/sourcegraph/sourcegraph/issues/39278
• [ ] https://github.com/sourcegraph/sourcegraph/issues/39279
• [ ] https://github.com/sourcegraph/sourcegraph/issues/39280
• [ ] https://github.com/sourcegraph/sourcegraph/issues/40559
• [ ] https://github.com/sourcegraph/sourcegraph/issues/45165
• [ ] https://github.com/sourcegraph/sourcegraph/issues/45168

Completed

• [x] (🏁 905 days ago) https://github.com/sourcegraph/sourcegraph/issues/19555
• [x] (🏁 690 days ago) https://github.com/sourcegraph/sourcegraph/issues/24869
• [x] (🏁 587 days ago) https://github.com/sourcegraph/sourcegraph/issues/27714
• [x] (🏁 587 days ago) https://github.com/sourcegraph/sourcegraph/issues/27702
• [x] (🏁 587 days ago) https://github.com/sourcegraph/sourcegraph/issues/27682
• [x] (🏁 561 days ago) https://github.com/sourcegraph/sourcegraph/issues/27354

Legend

• 👩 Customer issue
• 🐛 Bug
• 🧶 Technical debt
• 🎩 Quality of life
• 🛠️ Roadmap
• 🕵️ Spike
• 🔒 Security issue
• 🙆 Stretch goal

[sourcegraph-bot-2]

Heads up @taylorsperry @jasongornall - the "team/frontend-platform" label was applied to this issue.