ephraimbuddy commented on a change in pull request #9604: URL: https://github.com/apache/airflow/pull/9604#discussion_r449929959
########## File path: airflow/providers/google/cloud/log/stackdriver_task_handler.py ########## @@ -0,0 +1,295 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +""" +Handler that integrates with Stackdriver +""" +import logging +from typing import Collection, Dict, List, Optional, Tuple, Type + +from cached_property import cached_property +from google.api_core.gapic_v1.client_info import ClientInfo +from google.cloud import logging as gcp_logging +from google.cloud.logging.handlers.transports import BackgroundThreadTransport, Transport +from google.cloud.logging.resource import Resource + +from airflow import version +from airflow.models import TaskInstance +from airflow.providers.google.cloud.utils.credentials_provider import get_credentials_and_project_id + +DEFAULT_LOGGER_NAME = "airflow" +_GLOBAL_RESOURCE = Resource(type="global", labels={}) + +_DEFAULT_SCOPESS = frozenset([ + "https://www.googleapis.com/auth/logging.read";, + "https://www.googleapis.com/auth/logging.write"; +]) + + +class StackdriverTaskHandler(logging.Handler): + """Handler that directly makes Stackdriver logging API calls. + + This is a Python standard ``logging`` handler using that can be used to + route Python standard logging messages directly to the Stackdriver + Logging API. + + It can also be used to save logs for executing tasks. To do this, you should set as a handler with + the name "tasks". In this case, it will also be used to read the log for display in Web UI. + + This handler supports both an asynchronous and synchronous transport. + + + :param gcp_key_path: Path to GCP Credential JSON file. + If ommited, authorization based on `the Application Default Credentials + <https://cloud.google.com/docs/authentication/production#finding_credentials_automatically>`__ will + be used. + :type gcp_key_path: str + :param scopes: OAuth scopes for the credentials, + :type scopes: Sequence[str] + :param name: the name of the custom log in Stackdriver Logging. Defaults + to 'airflow'. The name of the Python logger will be represented + in the ``python_logger`` field. + :type name: str + :param transport: Class for creating new transport objects. It should + extend from the base :class:`google.cloud.logging.handlers.Transport` type and + implement :meth`google.cloud.logging.handlers.Transport.send`. Defaults to + :class:`google.cloud.logging.handlers.BackgroundThreadTransport`. The other + option is :class:`google.cloud.logging.handlers.SyncTransport`. + :type transport: :class:`type` + :param resource: (Optional) Monitored resource of the entry, defaults + to the global resource type. + :type resource: :class:`~google.cloud.logging.resource.Resource` + :param labels: (Optional) Mapping of labels for the entry. + :type labels: dict + """ + + LABEL_TASK_ID = "task_id" + LABEL_DAG_ID = "dag_id" + LABEL_EXECUTION_DATE = "execution_date" + LABEL_TRY_NUMBER = "try_number" + + def __init__( + self, + gcp_key_path: Optional[str] = None, + # See: https://github.com/PyCQA/pylint/issues/2377 + scopes: Optional[Collection[str]] = _DEFAULT_SCOPESS, # pylint: disable=unsubscriptable-object + name: str = DEFAULT_LOGGER_NAME, + transport: Type[Transport] = BackgroundThreadTransport, + resource: Resource = _GLOBAL_RESOURCE, + labels: Optional[Dict[str, str]] = None, + ): + super().__init__() + self.gcp_key_path: Optional[str] = gcp_key_path + # See: https://github.com/PyCQA/pylint/issues/2377 + self.scopes: Optional[Collection[str]] = scopes # pylint: disable=unsubscriptable-object + self.name: str = name + self.transport_type: Type[Transport] = transport + self.resource: Resource = resource + self.labels: Optional[Dict[str, str]] = labels + self.task_instance_labels: Optional[Dict[str, str]] = {} + + @cached_property + def _client(self) -> gcp_logging.Client: + """Google Cloud Library API client""" + credentials, _ = get_credentials_and_project_id( + key_path=self.gcp_key_path, + scopes=self.scopes, + ) + client = gcp_logging.Client( + credentials=credentials, + client_info=ClientInfo(client_library_version='airflow_v' + version.version) + ) + return client + + @cached_property + def _transport(self) -> Transport: + """Object responsible for sending data to Stackdriver""" + return self.transport_type(self._client, self.name) + + def emit(self, record: logging.LogRecord) -> None: + """Actually log the specified logging record. + + :param record: The record to be logged. + :type record: logging.LogRecord + """ + message = self.format(record) + labels: Optional[Dict[str, str]] + if self.labels and self.task_instance_labels: + labels = {} + labels.update(self.labels) + labels.update(self.task_instance_labels) + elif self.labels: + labels = self.labels + elif self.task_instance_labels: + labels = self.task_instance_labels + else: + labels = None + self._transport.send(record, message, resource=self.resource, labels=labels) + + def set_context(self, task_instance: TaskInstance) -> None: + """ + Configures the logger to add information with information about the current task + + :param task_instance: Currently executed task + :type task_instance: :class: airflow.models.TaskInstance + """ + self.task_instance_labels = self._task_instance_to_labels(task_instance) + + def read( + self, task_instance: TaskInstance, try_number: Optional[int] = None, metadata: Optional[Dict] = None + ) -> Tuple[List[str], List[Dict]]: + """ + Read logs of given task instance from Stackdriver logging. + + :param task_instance: task instance object + :type: task_instance: :class: airflow.models.TaskInstance Review comment: ```suggestion :type task_instance: :class: airflow.models.TaskInstance ``` ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
