chore: Add X-Goog-Api-Client metric header to requests (#826)

Author: jonathanedey

Diff for: firebase_admin/_http_client.py

@@ -21,6 +21,7 @@
 import requests
 from requests.packages.urllib3.util import retry # pylint: disable=import-error
 
+from firebase_admin import _utils
 
 if hasattr(retry.Retry.DEFAULT, 'allowed_methods'):
     _ANY_METHOD = {'allowed_methods': None}
@@ -36,6 +37,9 @@
 
 DEFAULT_TIMEOUT_SECONDS = 120
 
+METRICS_HEADERS = {
+    'X-GOOG-API-CLIENT': _utils.get_metrics_header(),
+}
 
 class HttpClient:
     """Base HTTP client used to make HTTP calls.
@@ -72,6 +76,7 @@ def __init__(
 
         if headers:
             self._session.headers.update(headers)
+        self._session.headers.update(METRICS_HEADERS)
         if retries:
             self._session.mount('http://', requests.adapters.HTTPAdapter(max_retries=retries))
             self._session.mount('https://', requests.adapters.HTTPAdapter(max_retries=retries))

Diff for: firebase_admin/_utils.py

@@ -15,6 +15,7 @@
 """Internal utilities common to all modules."""
 
 import json
+from platform import python_version
 
 import google.auth
 import requests
@@ -75,6 +76,8 @@
     16: exceptions.UNAUTHENTICATED,
 }
 
+def get_metrics_header():
+    return f'gl-python/{python_version()} fire-admin/{firebase_admin.__version__}'
 
 def _get_initialized_app(app):
     """Returns a reference to an initialized App instance."""

Diff for: firebase_admin/app_check.py

@@ -51,6 +51,10 @@ class _AppCheckService:
     _scoped_project_id = None
     _jwks_client = None
 
+    _APP_CHECK_HEADERS = {
+        'X-GOOG-API-CLIENT': _utils.get_metrics_header(),
+    }
+
     def __init__(self, app):
         # Validate and store the project_id to validate the JWT claims
         self._project_id = app.project_id
@@ -62,7 +66,8 @@ def __init__(self, app):
                 'GOOGLE_CLOUD_PROJECT environment variable.')
         self._scoped_project_id = 'projects/' + app.project_id
         # Default lifespan is 300 seconds (5 minutes) so we change it to 21600 seconds (6 hours).
-        self._jwks_client = PyJWKClient(self._JWKS_URL, lifespan=21600)
+        self._jwks_client = PyJWKClient(
+            self._JWKS_URL, lifespan=21600, headers=self._APP_CHECK_HEADERS)
 
 
     def verify_token(self, token: str) -> Dict[str, Any]:

Diff for: firebase_admin/storage.py

@@ -55,8 +55,13 @@ def bucket(name=None, app=None) -> storage.Bucket:
 class _StorageClient:
     """Holds a Google Cloud Storage client instance."""
 
+    STORAGE_HEADERS = {
+        'X-GOOG-API-CLIENT': _utils.get_metrics_header(),
+    }
+
     def __init__(self, credentials, project, default_bucket):
-        self._client = storage.Client(credentials=credentials, project=project)
+        self._client = storage.Client(
+            credentials=credentials, project=project, extra_headers=self.STORAGE_HEADERS)
         self._default_bucket = default_bucket
 
     @classmethod