[IMP] sentry: adds an option to use sentry's structured log feature

Author: MaX-Lo

sentry/hooks.py

@@ -128,6 +128,9 @@ def initialize_sentry(config):
     # Remove logging_level, since in sentry_sdk is include in 'integrations'
     del options["logging_level"]
 
+    if config.get("sentry_enable_logs", False):
+        options["enable_logs"] = True
+
     client = sentry_sdk.init(**options)
 
     sentry_sdk.set_tag("include_context", config.get("sentry_include_context", True))

sentry/readme/CONFIGURE.md

@@ -19,6 +19,7 @@ options:
     sentry_enabled = true
     sentry_logging_level = warn
     sentry_exclude_loggers = werkzeug
+    sentry_enable_logs = true
     sentry_ignore_exceptions = odoo.exceptions.AccessDenied,
         odoo.exceptions.AccessError,odoo.exceptions.MissingError,
         odoo.exceptions.RedirectWarning,odoo.exceptions.UserError,

sentry/static/description/index.html

@@ -432,6 +432,7 @@ <h3><a class="toc-backref" href="#toc-entry-3">Example Odoo configuration</a></h
 sentry_enabled = true
 sentry_logging_level = warn
 sentry_exclude_loggers = werkzeug
+sentry_enable_logs = true
 sentry_ignore_exceptions = odoo.exceptions.AccessDenied,
     odoo.exceptions.AccessError,odoo.exceptions.MissingError,
     odoo.exceptions.RedirectWarning,odoo.exceptions.UserError,

sentry/tests/test_client.py

@@ -53,6 +53,19 @@ def has_event(self, event_level, event_msg):
                 return event
         return False
 
+    def has_log_item(self, log_level: str, log_msg: str) -> bool:
+        for envelope in self.envelopes:
+            log_items = filter(lambda envelope_item: envelope_item.data_category == "log_item", envelope.items)
+            payload_items = []
+            for item in log_items:
+                payload_items.extend(item.payload.json["items"])
+            if any(
+                    (item["level"] == log_level and item["body"] == log_msg) for item in payload_items
+            ):
+                return True
+
+        return False
+
     def flush(self, *args, **kwargs):
         pass
 
@@ -123,6 +136,13 @@ def assertEventNotCaptured(self, client, event_level, event_msg):
             msg=f"Event: {event_msg} was captured",
         )
 
+    def assertLogCaptured(self, client, log_level: str, log_msg: str):
+        client.flush()
+        self.assertTrue(
+            client.transport.has_log_item(log_level, log_msg),
+            msg=f"Log item: {log_msg} was not captured",
+        )
+
     def test_initialize_raven_sets_dsn(self):
         self.assertEqual(self.client.dsn, self.dsn)
 
@@ -224,6 +244,19 @@ def test_exclude_logger(self):
         remove_handler_ignore(self.logger.name)
         self.assertEventNotCaptured(client, level, msg)
 
+    def test_enable_logs(self):
+        self.patch_config(
+            {
+                "sentry_enable_logs": True,
+            }
+        )
+        client = initialize_sentry(config)._client
+        client.transport = InMemoryTransport({"dsn": self.dsn})
+        level, msg = logging.WARNING, "Test log sending is enabled"
+        self.log(level, msg)
+        level = "warn"
+        self.assertLogCaptured(client, level, msg)
+
     def test_invalid_logging_level(self):
         self.patch_config(
             {