NetworkTraceLoggingPolicy Class

The logging policy in the pipeline is used to output HTTP network trace to the configured logger.

This accepts both global configuration, and per-request level with "enable_http_logger"

Inheritance

azure.core.pipeline.policies._base.SansIOHTTPPolicy

NetworkTraceLoggingPolicy

Constructor

NetworkTraceLoggingPolicy(logging_enable=False, **kwargs)

Parameters

logging_enable

bool

default value: False

Use to enable per operation. Defaults to False.

Examples

Configuring a network trace logging policy.

   from azure.core.pipeline.policies import NetworkTraceLoggingPolicy
   import sys
   import logging

   # Create a logger for the 'azure' SDK
   logger = logging.getLogger("azure")
   logger.setLevel(logging.DEBUG)

   # Configure a console output
   handler = logging.StreamHandler(stream=sys.stdout)
   logger.addHandler(handler)

   # Configure a file output
   file_handler = logging.FileHandler(filename)
   logger.addHandler(file_handler)

   # Enable network trace logging. This will be logged at DEBUG level.
   # By default, logging is disabled.
   logging_policy = NetworkTraceLoggingPolicy()
   logging_policy.enable_http_logger = True

   # The logger can also be enabled per operation.
   policies.append(logging_policy)
   client = PipelineClient(base_url=url, policies=policies)
   request = client.get(url)
   pipeline_response = client._pipeline.run(request, logging_enable=True)

Methods

on_request	Logs HTTP request to the DEBUG logger.
on_response	Logs HTTP response to the DEBUG logger.

on_request

Logs HTTP request to the DEBUG logger.

on_request(request: azure.core.pipeline.PipelineRequest) -> None

Parameters

request

PipelineRequest

Required

The PipelineRequest object.

on_response

Logs HTTP response to the DEBUG logger.

on_response(request: azure.core.pipeline.PipelineRequest, response: azure.core.pipeline.PipelineResponse) -> None

Parameters

request

PipelineRequest

Required

The PipelineRequest object.

response

PipelineResponse

Required

The PipelineResponse object.