Merge #4275

4275: Deprecate `service-telemetry` r=Dexterp37 a=Dexterp37

This adds a deprecation annotation to `Telemetry` and `TelemetryHolder` in addition to the README and changelog entries.



Co-authored-by: Alessio Placitelli <alessio.placitelli@gmail.com>

components/service/telemetry/README.md

@@ -2,6 +2,12 @@
 
 A generic library for sending telemetry pings from Android applications to Mozilla's telemetry service.
 
+## Deprecated
+This component is now deprecated: only maintenance fixes will be provided and no new feature development will happen.
+Use [the Glean SDK](../glean) instead.
+This library will not be removed until all projects using it start using the Glean SDK.
+Please do reach out to the Glean team (Mozilla Slack in *#glean* or *glean-team@mozilla.com*) for support transitioning to the new SDK.
+
 ## Motivation
 
 The goal of this library is to provide a generic set of components to support a variety of telemetry use cases. It tries to not be opinionated about dependency injection frameworks or http clients. The only dependency is ``support-annotations`` to ensure code quality.

components/service/telemetry/src/main/java/org/mozilla/telemetry/Telemetry.java

@@ -35,6 +35,11 @@
 import kotlin.Unit;
 import kotlin.jvm.functions.Function0;
 
+/**
+ * @deprecated The whole service-telemetry library is deprecated. Please use the
+ *              <a href="https://mozilla.github.io/glean/book/index.html">Glean SDK</a> instead.
+ */
+@Deprecated
 public class Telemetry {
     private final TelemetryConfiguration configuration;
     private final TelemetryStorage storage;

components/service/telemetry/src/main/java/org/mozilla/telemetry/TelemetryHolder.java

@@ -8,7 +8,11 @@
  * Holder of a static reference to the Telemetry instance. This is required for background services
  * that somehow need to get access to the configuration and storage. This is not particular nice.
  * Hopefully we can replace this with something better.
+ *
+ * @deprecated The whole service-telemetry library is deprecated. Please use the
+ *              <a href="https://mozilla.github.io/glean/book/index.html">Glean SDK</a> instead.
  */
+@Deprecated
 public class TelemetryHolder {
     private static Telemetry telemetry;
 

docs/changelog.md

@@ -35,6 +35,9 @@ permalink: /changelog/
   * Added `CustomTabState.trustedOrigins` extension method to turn the verification state of a custom tab into a list of origins.
   * Added `WebAppHideToolbarFeature.onTrustedScopesChange` to change the trusted scopes after the feature is created.
 
+* **service-telemetry**
+  * This component is now deprecated. Please use the [Glean SDK](https://mozilla.github.io/glean/book/index.html) instead. This library will not be removed until all projects using it start using the Glean SDK.
+
 # 10.0.1
 
 * [Commits](https://github.com/mozilla-mobile/android-components/compare/v10.0.0...v10.0.1)