Fix next Pylint, add logger_name comments to logging samples (Azure#39345)

Author: lzchen

sdk/monitor/azure-monitor-opentelemetry-exporter/azure/monitor/opentelemetry/exporter/export/_base.py

@@ -308,7 +308,7 @@ def _transmit(self, envelopes: List[TelemetryItem]) -> ExportResult:
                     _update_requests_map(_REQ_EXCEPTION_NAME[1], value=exc_type)
                 result = ExportResult.FAILED_RETRYABLE
             except Exception as ex:
-                logger.error("Envelopes could not be exported and are not retryable: %s.", ex)
+                logger.exception("Envelopes could not be exported and are not retryable: %s.")
                 if self._should_collect_stats():
                     _update_requests_map(_REQ_EXCEPTION_NAME[1], value=ex.__class__.__name__)
                 result = ExportResult.FAILED_NOT_RETRYABLE

sdk/monitor/azure-monitor-opentelemetry/README.md

@@ -61,7 +61,7 @@ You can use `configure_azure_monitor` to set up instrumentation for your app to
 |-------------------|----------------------------------------------------|----------------------|
 | `connection_string` | The [connection string][connection_string_doc] for your Application Insights resource. The connection string will be automatically populated from the `APPLICATIONINSIGHTS_CONNECTION_STRING` environment variable if not explicitly passed in. | `APPLICATIONINSIGHTS_CONNECTION_STRING` |
 | `enable_live_metrics` | Enable [live metrics][application_insights_live_metrics] feature. Defaults to `False`. | `N/A` |
-| `logger_name` | The name of the [Python logger][python_logger] under which telemetry is collected. | `N/A` |
+| `logger_name` | The name of the [Python logger][python_logger] under which telemetry is collected. Setting this value is imperative so logs created from the SDK itself are not tracked. | `N/A` |
 | `instrumentation_options` | A nested dictionary that determines which instrumentations to enable or disable. Instrumentations are referred to by their [Library Names](#officially-supported-instrumentations). For example, `{"azure_sdk": {"enabled": False}, "flask": {"enabled": False}, "django": {"enabled": True}}` will disable Azure Core Tracing and the Flask instrumentation but leave Django and the other default instrumentations enabled. The `OTEL_PYTHON_DISABLED_INSTRUMENTATIONS` environment variable explained below can also be used to disable instrumentations. | `N/A` |
 | `resource` | Specifies the OpenTelemetry [Resource][ot_spec_resource] associated with your application. Passed in [Resource Attributes][ot_spec_resource_attributes] take priority over default attributes and those from [Resource Detectors][ot_python_resource_detectors]. | [OTEL_SERVICE_NAME][ot_spec_service_name], [OTEL_RESOURCE_ATTRIBUTES][ot_spec_resource_attributes], [OTEL_EXPERIMENTAL_RESOURCE_DETECTORS][ot_python_resource_detectors] |
 | `span_processors` | A list of [span processors][ot_span_processor] that will perform processing on each of your spans before they are exported. Useful for filtering/modifying telemetry. | `N/A` |

sdk/monitor/azure-monitor-opentelemetry/azure/monitor/opentelemetry/_autoinstrumentation/configurator.py

@@ -61,7 +61,7 @@ def _configure(self, **kwargs):
                 "Azure Monitor Configurator configured successfully.", _ATTACH_SUCCESS_CONFIGURATOR
             )
         except Exception as e:
-            AzureDiagnosticLogging.error(
+            AzureDiagnosticLogging.error(  # pylint: disable=C
                 "Azure Monitor Configurator failed during configuration: %s" % str(e),
                 _ATTACH_FAILURE_CONFIGURATOR,
             )

sdk/monitor/azure-monitor-opentelemetry/azure/monitor/opentelemetry/_autoinstrumentation/distro.py

@@ -49,7 +49,7 @@ def _configure(self, **kwargs) -> None:
             )
         except Exception as e:
             AzureStatusLogger.log_status(False, reason=str(e))
-            AzureDiagnosticLogging.error(
+            AzureDiagnosticLogging.error(  # pylint: disable=C
                 "Azure Monitor OpenTelemetry Distro failed during configuration: %s" % str(e),
                 _ATTACH_FAILURE_DISTRO,
             )

sdk/monitor/azure-monitor-opentelemetry/azure/monitor/opentelemetry/_utils/__init__.py

@@ -39,7 +39,7 @@ def _get_customer_ikey_from_env_var():
         try:
             _CUSTOMER_IKEY_ENV_VAR = ConnectionStringParser().instrumentation_key
         except ValueError as e:
-            logger.error("Failed to parse Instrumentation Key: %s", e)
+            logger.error("Failed to parse Instrumentation Key: %s", e)  # pylint: disable=C
     return _CUSTOMER_IKEY_ENV_VAR
 
 

sdk/monitor/azure-monitor-opentelemetry/azure/monitor/opentelemetry/_utils/configurations.py

@@ -119,7 +119,7 @@ def _default_sampling_ratio(configurations):
         try:
             default = float(environ[SAMPLING_RATIO_ENV_VAR])
         except ValueError as e:
-            _logger.error(
+            _logger.error(  # pylint: disable=C
                 _INVALID_FLOAT_MESSAGE,
                 SAMPLING_RATIO_ENV_VAR,
                 default,

sdk/monitor/azure-monitor-opentelemetry/samples/logging/basic.py

@@ -10,10 +10,11 @@
 
 configure_azure_monitor(
     # Set logger_name to the name of the logger you want to capture logging telemetry with
+    # This is imperative so you do not collect logging telemetry from the SDK itself.
     logger_name="my_application_logger",
 )
 
-# Logging calls with this logger will be tracked
+# Logging telemetry will be collected from logging calls made with this logger and all of it's children loggers.
 logger = getLogger("my_application_logger")
 logger.setLevel(INFO)
 

sdk/monitor/azure-monitor-opentelemetry/samples/logging/correlated_logs.py

@@ -9,7 +9,9 @@
 from azure.monitor.opentelemetry import configure_azure_monitor
 from opentelemetry import trace
 
-configure_azure_monitor()
+configure_azure_monitor(
+    logger_name=__name__,
+)
 
 logger = getLogger(__name__)
 tracer = trace.get_tracer(__name__)

sdk/monitor/azure-monitor-opentelemetry/samples/logging/custom_properties.py

@@ -8,7 +8,9 @@
 
 from azure.monitor.opentelemetry import configure_azure_monitor
 
-configure_azure_monitor()
+configure_azure_monitor(
+    logger_name=__name__,
+)
 
 logger = getLogger(__name__)
 logger.setLevel(DEBUG)

sdk/monitor/azure-monitor-opentelemetry/samples/logging/exception_logs.py

@@ -8,7 +8,9 @@
 
 from azure.monitor.opentelemetry import configure_azure_monitor
 
-configure_azure_monitor()
+configure_azure_monitor(
+    logger_name=__name__,
+)
 
 logger = getLogger(__name__)