Source code for google.cloud.logging.handlers.transports.base

# Copyright 2016 Google LLC
#
# Licensed 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.

"""Module containing base class for logging transport."""


[docs]class Transport(object): """Base class for Google Cloud Logging handler transports. Subclasses of :class:`Transport` must have constructors that accept a client and name object, and must override :meth:`send`. """
[docs] def send( self, record, message, resource=None, labels=None, trace=None, span_id=None ): """Transport send to be implemented by subclasses. :type record: :class:`logging.LogRecord` :param record: Python log record that the handler was called with. :type message: str :param message: The message from the ``LogRecord`` after being formatted by the associated log formatters. :type resource: :class:`~google.cloud.logging.resource.Resource` :param resource: (Optional) Monitored resource of the entry. :type labels: dict :param labels: (Optional) Mapping of labels for the entry. """ raise NotImplementedError
[docs] def flush(self): """Submit any pending log records. For blocking/sync transports, this is a no-op. """