vdk-logging-format: Deprecate plugin (#2888)

This PR deprecates the vdk-logging-format plugin in favour of vdk-structlog. --------- Signed-off-by: Gabriel Georgiev <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
vmware · Nov 13, 2023 · cdf3a14 · cdf3a14
1 parent 8cfad1b
commit cdf3a14
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/projects/vdk-plugins/vdk-logging-format/README.md b/projects/vdk-plugins/vdk-logging-format/README.md
@@ -1,3 +1,5 @@
+# This plugin has been deprecated; please use vdk-structlog instead.
+
 This plugins allows for the configuration of the format of VDK logs.
 
 # TEXT

diff --git a/projects/vdk-plugins/vdk-logging-format/src/vdk/plugin/logging_format/logging_format.py b/projects/vdk-plugins/vdk-logging-format/src/vdk/plugin/logging_format/logging_format.py
@@ -78,6 +78,17 @@ def vdk_configure(config_builder: ConfigurationBuilder):
 
 @hookimpl(tryfirst=True)
 def vdk_start(plugin_registry: IPluginRegistry, command_line_args: List):
+    log = logging.getLogger(__name__)
+    log.warning(
+        "-------------------------------------------------------------------------"
+    )
+    log.warning(
+        "Vdk-logging-format has been deprecated; please use vdk-structlog instead."
+    )
+    log.warning(
+        "-------------------------------------------------------------------------"
+    )
+
     logging_format = os.getenv("VDK_LOGGING_FORMAT")
     if (
         logging_format == "JSON"