crash_reporter_breadcrumb_observer.h 3.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. // Copyright 2019 The Chromium Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style license that can be
  3. // found in the LICENSE file.
  4. #ifndef COMPONENTS_BREADCRUMBS_CORE_CRASH_REPORTER_BREADCRUMB_OBSERVER_H_
  5. #define COMPONENTS_BREADCRUMBS_CORE_CRASH_REPORTER_BREADCRUMB_OBSERVER_H_
  6. #include <string>
  7. #include <vector>
  8. #include "base/containers/circular_deque.h"
  9. #include "base/no_destructor.h"
  10. #include "base/scoped_multi_source_observation.h"
  11. #include "components/breadcrumbs/core/breadcrumb_manager.h"
  12. #include "components/breadcrumbs/core/breadcrumb_manager_keyed_service.h"
  13. #include "components/breadcrumbs/core/breadcrumb_manager_observer.h"
  14. class CrashReporterBreadcrumbObserverTest;
  15. namespace breadcrumbs {
  16. // Key for breadcrumbs attached to crash reports.
  17. extern const char kBreadcrumbsProductDataKey[];
  18. // Combines breadcrumbs from multiple BreadcrumbManagers and sends the merged
  19. // breadcrumb events to the embedder's crash reporter (e.g., crashpad, breakpad)
  20. // for attachment to crash reports.
  21. class CrashReporterBreadcrumbObserver : public BreadcrumbManagerObserver {
  22. public:
  23. // Creates a singleton instance.
  24. static CrashReporterBreadcrumbObserver& GetInstance();
  25. // Starts collecting breadcrumb events logged to |breadcrumb_manager|.
  26. void ObserveBreadcrumbManager(BreadcrumbManager* breadcrumb_manager);
  27. // Stops collecting breadcrumb events logged to |breadcrumb_manager|.
  28. void StopObservingBreadcrumbManager(BreadcrumbManager* breadcrumb_manager);
  29. // Starts collecting breadcrumb events logged to |breadcrumb_manager_service|.
  30. void ObserveBreadcrumbManagerService(
  31. BreadcrumbManagerKeyedService* breadcrumb_manager_service);
  32. // Stops collecting breadcrumb events logged to |breadcrumb_manager_service|.
  33. void StopObservingBreadcrumbManagerService(
  34. BreadcrumbManagerKeyedService* breadcrumb_manager_service);
  35. // Sets breadcrumb events associated with the previous application session.
  36. // Note: this behaves the same as EventAdded(), but takes multiple events and
  37. // adds them to the start of the breadcrumbs log.
  38. void SetPreviousSessionEvents(const std::vector<std::string>& events);
  39. private:
  40. friend base::NoDestructor<CrashReporterBreadcrumbObserver>;
  41. friend class ::CrashReporterBreadcrumbObserverTest;
  42. CrashReporterBreadcrumbObserver();
  43. ~CrashReporterBreadcrumbObserver() override;
  44. // BreadcrumbObserver:
  45. void EventAdded(BreadcrumbManager* manager,
  46. const std::string& event) override;
  47. // Updates the breadcrumbs stored in the crash log.
  48. void UpdateBreadcrumbEventsCrashKey();
  49. // The full list of received breadcrumbs that will be sent to the crash
  50. // report. Older events are at the front. A maximum size is enforced for
  51. // privacy purposes, so old events may be removed when new events are added.
  52. base::circular_deque<std::string> breadcrumbs_;
  53. // Tracks observed BreadcrumbManagers and stops observing them on destruction.
  54. base::ScopedMultiSourceObservation<BreadcrumbManager,
  55. BreadcrumbManagerObserver>
  56. breadcrumb_manager_observations_{this};
  57. // Tracks observed BreadcrumbManagerKeyedServices and stops observing them on
  58. // destruction.
  59. base::ScopedMultiSourceObservation<BreadcrumbManagerKeyedService,
  60. BreadcrumbManagerObserver>
  61. breadcrumb_manager_service_observations_{this};
  62. };
  63. } // namespace breadcrumbs
  64. #endif // COMPONENTS_BREADCRUMBS_CORE_CRASH_REPORTER_BREADCRUMB_OBSERVER_H_