Properly document new log capability for databases (#18293)

* Properly document new log capability for databases * Fix documentation
DataDog · Aug 9, 2024 · 87f372d · 87f372d
1 parent 2b20305
commit 87f372d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/datadog_checks_base/datadog_checks/base/utils/db/transform.py b/datadog_checks_base/datadog_checks/base/utils/db/transform.py
@@ -492,7 +492,7 @@ def get_log(transformers, name, **modifiers):
     """
     Send a log.
 
-    The required modifiers are `attributes` and `cursor`.
+    The only required modifier is `attributes`.
 
     For example, if you have this configuration:
 

diff --git a/docs/developer/base/databases.md b/docs/developer/base/databases.md
@@ -123,3 +123,10 @@ the metric `foo.current` will be sent as a gauge with the value of `foo.bar`.
     options:
       show_root_heading: false
       show_root_toc_entry: false
+
+#### log
+
+::: datadog_checks.base.utils.db.transform.get_log
+    options:
+      show_root_heading: false
+      show_root_toc_entry: false