chore!: deprecate AppEngineHandler and ContainerEngineHandler

docs/handlers-structured-log.rst

@@ -0,0 +1,6 @@
+Structured Log Handler
+====================================
+
+.. automodule:: google.cloud.logging_v2.handlers.structured_log
+  :members:
+  :show-inheritance:

docs/usage.rst

@@ -327,19 +327,14 @@ logging handler can use different transports. The default is
 fluentd logging handlers
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-Besides :class:`~google.cloud.logging.handlers.handlers.CloudLoggingHandler`,
-which writes directly to the API, two other handlers are provided.
-:class:`~google.cloud.logging.handlers.app_engine.AppEngineHandler`, which is
-recommended when running on the Google App Engine Flexible vanilla runtimes
-(i.e. your app.yaml contains ``runtime: python``), and
-:class:`~google.cloud.logging.handlers.container_engine.ContainerEngineHandler`
-, which is recommended when running on `Google Kubernetes Engine`_ with the
-Cloud Logging plugin enabled.
+Two handler classes are provided: :class:`~google.cloud.logging.handlers.handlers.CloudLoggingHandler`,
+which writes directly to the API, and :class:`~google.cloud.logging.handlers.structured_log.StructuredLogHandler`,
+which writes logs as structured JSON to standard output (to be later parsed by the environment).
 
 :meth:`~google.cloud.logging.client.Client.get_default_handler` and
 :meth:`~google.cloud.logging.client.Client.setup_logging` will attempt to use
-the environment to automatically detect whether the code is running in
-these platforms and use the appropriate handler.
+the environment to automatically detect where the code is running and use the
+appropriate handler.
 
 In both cases, the fluentd agent is configured to automatically parse log files
 in an expected format and forward them to Cloud Logging. The handlers

docs/v2.rst

@@ -12,8 +12,7 @@ v2
    sink
    stdlib-usage
    handlers
-   handlers-app-engine
-   handlers-container-engine
+   handlers-structured-log
    transports-sync
    transports-thread
    transports-base

google/cloud/logging/handlers/__init__.py

@@ -14,18 +14,14 @@
 
 """Python :mod:`logging` handlers for Google Cloud Logging."""
 
-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

@@ -35,8 +35,6 @@
 from google.cloud.logging_v2._http import _MetricsAPI as JSONMetricsAPI
 from google.cloud.logging_v2._http import _SinksAPI as JSONSinksAPI
 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
@@ -352,9 +350,9 @@ def get_default_handler(self, **kw):
 
         if isinstance(monitored_resource, Resource):
             if monitored_resource.type == _GAE_RESOURCE_TYPE:
-                return AppEngineHandler(self, **kw)
+                CloudLoggingHandler(self, resource=monitored_resource, **kw)
             elif monitored_resource.type == _GKE_RESOURCE_TYPE:
-                return ContainerEngineHandler(**kw)
+                return StructuredLogHandler(**kw, project_id=self.project)
             elif (
                 monitored_resource.type == _GCF_RESOURCE_TYPE
                 and sys.version_info[0] == 3

google/cloud/logging_v2/handlers/__init__.py

@@ -14,18 +14,14 @@
 
 """Python :mod:`logging` handlers for Google Cloud Logging."""
 
-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

@@ -14,8 +14,6 @@
 
 """Helper functions for logging handlers."""
 
-import math
-import json
 import re
 
 try:
@@ -34,24 +32,6 @@
 _PROTOCOL_HEADER = "SERVER_PROTOCOL"
 
 
-def format_stackdriver_json(record, message):
-    """Helper to format a LogRecord in in Stackdriver fluentd format.
-
-    Returns:
-        str: JSON str to be written to the log file.
-    """
-    subsecond, second = math.modf(record.created)
-
-    payload = {
-        "message": message,
-        "timestamp": {"seconds": int(second), "nanos": int(subsecond * 1e9)},
-        "thread": record.thread,
-        "severity": record.levelname,
-    }
-
-    return json.dumps(payload, ensure_ascii=False)
-
-
 def get_request_data_from_flask():
     """Get http_request and trace data from flask request headers.
 
@@ -68,10 +48,7 @@ def get_request_data_from_flask():
     http_request = {
         "requestMethod": flask.request.method,
         "requestUrl": flask.request.url,
-        "requestSize": flask.request.content_length,
         "userAgent": flask.request.user_agent.string,
-        "remoteIp": flask.request.remote_addr,
-        "referer": flask.request.referrer,
         "protocol": flask.request.environ.get(_PROTOCOL_HEADER),
     }
 
@@ -96,21 +73,11 @@ def get_request_data_from_django():
     if request is 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,
         "requestUrl": request.build_absolute_uri(),
-        "requestSize": content_length,
         "userAgent": request.META.get(_DJANGO_USERAGENT_HEADER),
-        "remoteIp": request.META.get(_DJANGO_REMOTE_ADDR_HEADER),
-        "referer": request.META.get(_DJANGO_REFERER_HEADER),
         "protocol": request.META.get(_PROTOCOL_HEADER),
     }