Merge branch 'v2_update_2_'

Author: daniel-sanche

google/cloud/logging/handlers/__init__.py

@@ -16,12 +16,16 @@
 
 from google.cloud.logging_v2.handlers.app_engine import AppEngineHandler
 from google.cloud.logging_v2.handlers.container_engine import ContainerEngineHandler
+from google.cloud.logging_v2.handlers.structured_log import StructuredLogHandler
+from google.cloud.logging_v2.handlers.handlers import CloudLoggingFilter
 from google.cloud.logging_v2.handlers.handlers import CloudLoggingHandler
 from google.cloud.logging_v2.handlers.handlers import setup_logging
 
 __all__ = [
     "AppEngineHandler",
+    "CloudLoggingFilter",
     "CloudLoggingHandler",
     "ContainerEngineHandler",
+    "StructuredLogHandler",
     "setup_logging",
 ]

google/cloud/logging_v2/client.py

@@ -16,6 +16,7 @@
 
 import logging
 import os
+import sys
 
 try:
     from google.cloud.logging_v2 import _gapic
@@ -36,6 +37,7 @@
 from google.cloud.logging_v2.handlers import CloudLoggingHandler
 from google.cloud.logging_v2.handlers import AppEngineHandler
 from google.cloud.logging_v2.handlers import ContainerEngineHandler
+from google.cloud.logging_v2.handlers import StructuredLogHandler
 from google.cloud.logging_v2.handlers import setup_logging
 from google.cloud.logging_v2.handlers.handlers import EXCLUDED_LOGGER_DEFAULTS
 from google.cloud.logging_v2.resource import Resource
@@ -53,6 +55,7 @@
 _GAE_RESOURCE_TYPE = "gae_app"
 _GKE_RESOURCE_TYPE = "k8s_container"
 _GCF_RESOURCE_TYPE = "cloud_function"
+_RUN_RESOURCE_TYPE = "cloud_run_revision"
 
 
 class Client(ClientWithProject):
@@ -347,18 +350,22 @@ def get_default_handler(self, **kw):
         """
         monitored_resource = kw.pop("resource", detect_resource(self.project))
 
-        if (
-            isinstance(monitored_resource, Resource)
-            and monitored_resource.type == _GAE_RESOURCE_TYPE
-        ):
-            return AppEngineHandler(self, **kw)
-        elif (
-            isinstance(monitored_resource, Resource)
-            and monitored_resource.type == _GKE_RESOURCE_TYPE
-        ):
-            return ContainerEngineHandler(**kw)
-        else:
-            return CloudLoggingHandler(self, resource=monitored_resource, **kw)
+        if isinstance(monitored_resource, Resource):
+            if monitored_resource.type == _GAE_RESOURCE_TYPE:
+                return AppEngineHandler(self, **kw)
+            elif monitored_resource.type == _GKE_RESOURCE_TYPE:
+                return ContainerEngineHandler(**kw)
+            elif (
+                monitored_resource.type == _GCF_RESOURCE_TYPE
+                and sys.version_info[0] == 3
+                and sys.version_info[1] >= 8
+            ):
+                # Cloud Functions with runtimes > 3.8 supports structured logs on standard out
+                # 3.7 should use the standard CloudLoggingHandler, which sends logs over the network.
+                return StructuredLogHandler(**kw, project_id=self.project)
+            elif monitored_resource.type == _RUN_RESOURCE_TYPE:
+                return StructuredLogHandler(**kw, project_id=self.project)
+        return CloudLoggingHandler(self, resource=monitored_resource, **kw)
 
     def setup_logging(
         self, *, log_level=logging.INFO, excluded_loggers=EXCLUDED_LOGGER_DEFAULTS, **kw

google/cloud/logging_v2/handlers/__init__.py

@@ -16,12 +16,16 @@
 
 from google.cloud.logging_v2.handlers.app_engine import AppEngineHandler
 from google.cloud.logging_v2.handlers.container_engine import ContainerEngineHandler
+from google.cloud.logging_v2.handlers.structured_log import StructuredLogHandler
 from google.cloud.logging_v2.handlers.handlers import CloudLoggingHandler
+from google.cloud.logging_v2.handlers.handlers import CloudLoggingFilter
 from google.cloud.logging_v2.handlers.handlers import setup_logging
 
 __all__ = [
     "AppEngineHandler",
+    "CloudLoggingFilter",
     "CloudLoggingHandler",
     "ContainerEngineHandler",
+    "StructuredLogHandler",
     "setup_logging",
 ]

google/cloud/logging_v2/handlers/_helpers.py

@@ -16,6 +16,7 @@
 
 import math
 import json
+import re
 
 try:
     import flask
@@ -55,12 +56,13 @@ def get_request_data_from_flask():
     """Get http_request and trace data from flask request headers.
 
     Returns:
-        Tuple[Optional[dict], Optional[str]]:
-            Data related to the current http request and the trace_id for the
-            request. Both fields will be None if a flask request isn't found.
+        Tuple[Optional[dict], Optional[str], Optional[str]]:
+            Data related to the current http request, trace_id, and span_id for
+            the request. All fields will be None if a django request isn't
+            found.
     """
     if flask is None or not flask.request:
-        return None, None
+        return None, None, None
 
     # build http_request
     http_request = {
@@ -73,34 +75,34 @@ def get_request_data_from_flask():
         "protocol": flask.request.environ.get(_PROTOCOL_HEADER),
     }
 
-    # find trace id
-    trace_id = None
+    # find trace id and span id
     header = flask.request.headers.get(_FLASK_TRACE_HEADER)
-    if header:
-        trace_id = header.split("/", 1)[0]
+    trace_id, span_id = _parse_trace_span(header)
 
-    return http_request, trace_id
+    return http_request, trace_id, span_id
 
 
 def get_request_data_from_django():
     """Get http_request and trace data from django request headers.
 
     Returns:
-        Tuple[Optional[dict], Optional[str]]:
-            Data related to the current http request and the trace_id for the
-            request. Both fields will be None if a django request isn't found.
+        Tuple[Optional[dict], Optional[str], Optional[str]]:
+            Data related to the current http request, trace_id, and span_id for
+            the request. All fields will be None if a django request isn't
+            found.
     """
     request = _get_django_request()
 
     if request is None:
-        return None, None
+        return None, None, None
 
     # convert content_length to int if it exists
     content_length = None
     try:
         content_length = int(request.META.get(_DJANGO_CONTENT_LENGTH))
     except (ValueError, TypeError):
         content_length = None
+
     # build http_request
     http_request = {
         "requestMethod": request.method,
@@ -112,32 +114,55 @@ def get_request_data_from_django():
         "protocol": request.META.get(_PROTOCOL_HEADER),
     }
 
-    # find trace id
-    trace_id = None
+    # find trace id and span id
     header = request.META.get(_DJANGO_TRACE_HEADER)
-    if header:
-        trace_id = header.split("/", 1)[0]
+    trace_id, span_id = _parse_trace_span(header)
+
+    return http_request, trace_id, span_id
 
-    return http_request, trace_id
+
+def _parse_trace_span(header):
+    """Given an X_CLOUD_TRACE header, extract the trace and span ids.
+
+    Args:
+        header (str): the string extracted from the X_CLOUD_TRACE header
+    Returns:
+        Tuple[Optional[dict], Optional[str]]:
+            The trace_id and span_id extracted from the header
+            Each field will be None if not found.
+    """
+    trace_id = None
+    span_id = None
+    if header:
+        try:
+            split_header = header.split("/", 1)
+            trace_id = split_header[0]
+            header_suffix = split_header[1]
+            # the span is the set of alphanumeric characters after the /
+            span_id = re.findall(r"^\w+", header_suffix)[0]
+        except IndexError:
+            pass
+    return trace_id, span_id
 
 
 def get_request_data():
     """Helper to get http_request and trace data from supported web
     frameworks (currently supported: Flask and Django).
 
     Returns:
-        Tuple[Optional[dict], Optional[str]]:
-            Data related to the current http request and the trace_id for the
-            request. Both fields will be None if a supported web request isn't found.
+        Tuple[Optional[dict], Optional[str], Optional[str]]:
+            Data related to the current http request, trace_id, and span_id for
+            the request. All fields will be None if a django request isn't
+            found.
     """
     checkers = (
         get_request_data_from_django,
         get_request_data_from_flask,
     )
 
     for checker in checkers:
-        http_request, trace_id = checker()
+        http_request, trace_id, span_id = checker()
         if http_request is not None:
-            return http_request, trace_id
+            return http_request, trace_id, span_id
 
-    return None, None
+    return None, None, None

google/cloud/logging_v2/handlers/app_engine.py

@@ -90,7 +90,7 @@ def get_gae_labels(self):
         """
         gae_labels = {}
 
-        _, trace_id = get_request_data()
+        _, trace_id, _ = get_request_data()
         if trace_id is not None:
             gae_labels[_TRACE_ID_LABEL] = trace_id
 
@@ -107,7 +107,7 @@ def emit(self, record):
             record (logging.LogRecord): The record to be logged.
         """
         message = super(AppEngineHandler, self).format(record)
-        inferred_http, inferred_trace = get_request_data()
+        inferred_http, inferred_trace, _ = get_request_data()
         if inferred_trace is not None:
             inferred_trace = f"projects/{self.project_id}/traces/{inferred_trace}"
         # allow user overrides