trace.py

# Copyright 2017, OpenCensus Authors
#
# 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.

import logging

from opencensus.log import decorate_log_record_factory
from opencensus.trace import integrations


def trace_integration(tracer=None):
    """Customize LogRecord with opencensus trace data.
    https://docs.python.org/3/howto/logging-cookbook.html#customizing-logrecord

    LogRecordFactory created after the integration will produce `LogRecord`s
    with extra traceId, spanId, and traceSampled attributes from the opencensus
    context.
    """
    logging.setLogRecordFactory(
        decorate_log_record_factory(logging.getLogRecordFactory()),
    )
    # pylint: disable=protected-access
    integrations.add_integration(integrations._Integrations.LOGGING)