Rename Handler and release 1.0.0 (#19)

* rename handler to OtelScoutHandler

* delete otelLoggingManager class module

* bump version to 1.0.0

* remote deprecated otel logger tests

* use x-scout-key as header

Author: quinnmil

README.md

@@ -22,12 +22,12 @@ pip install scout-apm-python-logging
 
 ### Using dictConfig
 
-We recommend setting up the `OtelScoutHandler` using Python's [`dictConfig`](https://docs.python.org/3/library/logging.config.html#logging.config.dictConfig). Here's an example configuration:
+We recommend setting up the `ScoutOtelHandler` using Python's [`dictConfig`](https://docs.python.org/3/library/logging.config.html#logging.config.dictConfig). Here's an example configuration:
 
 ```python
 import logging
 from logging.config import dictConfig
-from scout_apm_python_logging import OtelScoutHandler
+from scout_apm_python_logging import ScoutOtelHandler
 
 LOGGING_CONFIG = {
     "version": 1,
@@ -40,7 +40,7 @@ LOGGING_CONFIG = {
     "handlers": {
         "otel": {
             "level": "DEBUG",
-            "class": "scout_apm_python_logging.OtelScoutHandler",
+            "class": "scout_apm_python_logging.ScoutOtelHandler",
             "service_name": "your-service-name",
         },
         "console": {
@@ -63,33 +63,35 @@ dictConfig(LOGGING_CONFIG)
 
 ### Adding to an Existing Logger
 
-You can also add the `OtelScoutHandler` to an existing logger:
+You can also add the `ScoutOtelHandler` to an existing logger:
 
 ```python
 import logging
-from scout_apm_python_logging import OtelScoutHandler
+from scout_apm_python_logging import ScoutOtelHandler
 
 # Get your logger
 logger = logging.getLogger(__name__)
 
-# Create and add the OtelScoutHandler
-handler = OtelScoutHandler(service_name="your-service-name")
+# Create and add the ScoutOtelHandler
+handler = ScoutOtelHandler(service_name="your-service-name")
 logger.addHandler(handler)
 ```
 
+> Alternative logging configurations are covered in our [documentation](/https://scoutapm.com/docs/features/log-management#common-configurations-python)
+
 ## Configuration
 
-The `OtelScoutHandler` only requires `service_name` to be supplied to the handler as an argument:
+The `ScoutOtelHandler` only requires `service_name` to be supplied to the handler as an argument:
 
 If the `scout-apm` is [configured](https://scoutapm.com/docs/python#some-configuration-required) (You've set your `SCOUT_KEY`, etc), you'll only need add your `SCOUT_LOGS_INGEST_KEY` to whichever configuration you are already using. This can also be set as an environment variable.
 
-Make sure to set the `SCOUT_LOGS_INGEST_KEY` variable before running your application.
+Make sure to set the `SCOUT_LOGS_INGEST_KEY` variable in the above configuration before running your application.
 
 ## OpenTelemetry
 
 The Scout APM Python Logging Agent leverages [OpenTelemetry Python](https://github.com/open-telemetry/opentelemetry-python) to provide powerful and standardized logging capabilities. OpenTelemetry is an observability framework for cloud-native software, offering a collection of tools, APIs, and SDKs for generating, collecting, and exporting telemetry data (metrics, logs, and traces).
 
-Our `OtelScoutHandler` utilizes the OpenTelemetry Python SDK to:
+Our `ScoutOtelHandler` utilizes the OpenTelemetry Python SDK to:
 
 1. Create a `LoggerProvider` with a custom resource that includes your service name and instance ID.
 2. Set up an OTLP (OpenTelemetry Protocol) exporter configured to send logs to Scout's ingestion endpoint.

examples/dictConfig.py

@@ -17,7 +17,7 @@
     "handlers": {
         "otel": {
             "level": "DEBUG",
-            "class": "scout_apm_logging.OtelScoutHandler",
+            "class": "scout_apm_logging.ScoutOtelHandler",
             "service_name": "example-python-app",
         },
         "console": {

examples/flask_app.py

@@ -17,7 +17,7 @@
     "handlers": {
         "otel": {
             "level": "DEBUG",
-            "class": "scout_apm_logging.OtelScoutHandler",
+            "class": "scout_apm_logging.ScoutOtelHandler",
             "service_name": "example-python-app",
         },
         "console": {

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "scout-apm-logging"
-version = "0.1.2"
+version = "1.0.0"
 description = "Scout APM Python Logging Agent"
 authors = ["Quinn Milionis <[email protected]>"]
 readme = "README.md"

scout_apm_logging/__init__.py

@@ -1 +1 @@
-from scout_apm_logging.handler import OtelScoutHandler
+from scout_apm_logging.handler import ScoutOtelHandler

scout_apm_logging/handler.py

@@ -11,7 +11,7 @@
 from scout_apm_logging.utils.operation_utils import get_operation_detail
 
 
-class OtelScoutHandler(logging.Handler):
+class ScoutOtelHandler(logging.Handler):
     def __init__(self, service_name):
         super().__init__()
         self.logger_provider = None
@@ -33,7 +33,7 @@ def setup_logging(self):
         _logs.set_logger_provider(self.logger_provider)
 
         otlp_exporter = OTLPLogExporter(
-            headers={"x-telemetryhub-key": self.ingest_key},
+            headers={"x-scout-key": self.ingest_key},
             endpoint=self.endpoint,
         )
         self.logger_provider.add_log_record_processor(
@@ -87,7 +87,7 @@ def emit(self, record):
 
             self.otel_handler.emit(record)
         except Exception as e:
-            print(f"Error in OtelScoutHandler.emit: {e}")
+            print(f"Error in ScoutOtelHandler.emit: {e}")
         finally:
             self._handling_log.value = False
 

scout_apm_logging/otel_logger.py

@@ -2,7 +2,7 @@
 import logging
 import io
 from unittest.mock import patch, MagicMock
-from scout_apm_logging.handler import OtelScoutHandler
+from scout_apm_logging.handler import ScoutOtelHandler
 from scout_apm.core.tracked_request import Span
 
 
@@ -13,7 +13,7 @@ def otel_scout_handler():
     ), patch("scout_apm_logging.handler.BatchLogRecordProcessor"), patch(
         "scout_apm_logging.handler.Resource"
     ):
-        handler = OtelScoutHandler(service_name="test-service")
+        handler = ScoutOtelHandler(service_name="test-service")
         yield handler
 
 
@@ -155,7 +155,7 @@ def test_emit_exception_handling(otel_scout_handler):
 
         # Check that the exception was caught and the error message was printed
         assert (
-            "Error in OtelScoutHandler.emit: Test exception" in mock_stdout.getvalue()
+            "Error in ScoutOtelHandler.emit: Test exception" in mock_stdout.getvalue()
         )
 
     otel_scout_handler._handling_log.value = False