fix: Use structlog as the logging package, since simple_logger is not agent friendly (#1176)

* fix: updates to fix merge conflicts

Signed-off-by: Debarati Basu-Nag <dbasunag@redhat.com>

* fix: make all logs json formatted

Signed-off-by: Debarati Basu-Nag <dbasunag@redhat.com>

* fix: addressed comment from coderabbit and simplied the code a bit

Signed-off-by: Debarati Basu-Nag <dbasunag@redhat.com>

* fix: address review comments

Signed-off-by: Debarati Basu-Nag <dbasunag@redhat.com>

---------

Signed-off-by: Debarati Basu-Nag <dbasunag@redhat.com>
Co-authored-by: Jorge <jgarciao@users.noreply.github.com>

Author: dbasunag

.github/workflows/scripts/pr_workflow.py

@@ -1,3 +1,4 @@
+import logging
 import os
 import re
 import sys
@@ -23,9 +24,8 @@
 from github.PullRequest import PullRequest
 from github.Repository import Repository
 from github.Team import Team
-from simple_logger.logger import get_logger
 
-LOGGER = get_logger(name="pr_labeler")
+LOGGER = logging.getLogger("pr_labeler")
 
 
 class PrBaseClass:

pyproject.toml

@@ -50,7 +50,7 @@ dependencies = [
     "openshift-python-utilities>=5.0.71",
     "pytest-dependency>=0.6.0",
     "pytest-progress",
-    "python-simple-logger",
+    "structlog>=24.1.0",
     "pyyaml",
     "tenacity",
     "types-requests>=2.32.0.20241016",

tests/cluster_health/test_cluster_health.py

@@ -1,7 +1,8 @@
 import pytest
 from ocp_resources.node import Node
 from ocp_utilities.infra import assert_nodes_in_healthy_condition, assert_nodes_schedulable
-from simple_logger.logger import get_logger
+
+from utilities.opendatahub_logger import get_logger
 
 LOGGER = get_logger(name=__name__)
 

tests/cluster_health/test_operator_health.py

@@ -3,10 +3,10 @@
 from ocp_resources.data_science_cluster import DataScienceCluster
 from ocp_resources.dsc_initialization import DSCInitialization
 from pytest_testconfig import config as py_config
-from simple_logger.logger import get_logger
 
 from utilities.general import wait_for_pods_running
 from utilities.infra import wait_for_dsc_status_ready, wait_for_dsci_status_ready
+from utilities.opendatahub_logger import get_logger
 
 LOGGER = get_logger(name=__name__)
 

tests/conftest.py

@@ -37,7 +37,6 @@
 from pytest import Config, FixtureRequest
 from pytest_testconfig import config as py_config
 from semver import Version
-from simple_logger.logger import get_logger
 
 from utilities.certificates_utils import create_ca_bundle_file
 from utilities.constants import (
@@ -65,6 +64,7 @@
 from utilities.logger import RedactedString
 from utilities.mariadb_utils import wait_for_mariadb_operator_deployments
 from utilities.minio import create_minio_data_connection_secret
+from utilities.opendatahub_logger import get_logger
 from utilities.operator_utils import get_cluster_service_version, get_csv_related_images
 from utilities.serving_runtime import get_runtime_image_from_template
 from utilities.user_utils import get_byoidc_issuer_url, get_oidc_tokens

tests/fixtures/inference.py

@@ -13,7 +13,6 @@
 from ocp_resources.service import Service
 from ocp_resources.serving_runtime import ServingRuntime
 from pytest_testconfig import py_config
-from simple_logger.logger import get_logger
 from timeout_sampler import retry
 
 from utilities.constants import (
@@ -24,6 +23,7 @@
 )
 from utilities.inference_utils import create_isvc
 from utilities.infra import get_data_science_cluster, wait_for_dsc_status_ready
+from utilities.opendatahub_logger import get_logger
 from utilities.serving_runtime import ServingRuntimeFromTemplate
 
 LOGGER = get_logger(name=__name__)

tests/llama_stack/conftest.py

@@ -16,7 +16,6 @@
 from ocp_resources.secret import Secret
 from ocp_resources.service import Service
 from semver import Version
-from simple_logger.logger import get_logger
 
 from tests.llama_stack.constants import (
     LLAMA_STACK_DISTRIBUTION_SECRET_DATA,
@@ -43,6 +42,7 @@
 from utilities.constants import Annotations, DscComponents
 from utilities.data_science_cluster_utils import update_components_in_dsc
 from utilities.general import generate_random_name
+from utilities.opendatahub_logger import get_logger
 from utilities.resources.llama_stack_distribution import LlamaStackDistribution
 
 LOGGER = get_logger(name=__name__)

tests/llama_stack/inference/test_completions.py

@@ -1,8 +1,8 @@
 import pytest
 from llama_stack_client import LlamaStackClient
-from simple_logger.logger import get_logger
 
 from tests.llama_stack.constants import ModelInfo
+from utilities.opendatahub_logger import get_logger
 
 LOGGER = get_logger(name=__name__)
 

tests/llama_stack/safety/test_trustyai_fms_provider.py

@@ -1,9 +1,9 @@
 import pytest
 import yaml
-from simple_logger.logger import get_logger
 
 from tests.llama_stack.constants import LlamaStackProviders
 from utilities.constants import BUILTIN_DETECTOR_CONFIG, CHAT_GENERATION_CONFIG, QWEN_MODEL_NAME, MinIo
+from utilities.opendatahub_logger import get_logger
 
 LOGGER = get_logger(name=__name__)
 SECURE_SHIELD_ID: str = "secure_shield"

tests/llama_stack/utils.py

@@ -13,13 +13,13 @@
 from llama_stack_client.types.file import File
 from llama_stack_client.types.vector_stores.vector_store_file import VectorStoreFile
 from ocp_resources.pod import Pod
-from simple_logger.logger import get_logger
 from timeout_sampler import retry
 
 from tests.llama_stack.constants import (
     LLS_CORE_POD_FILTER,
 )
 from utilities.exceptions import UnexpectedResourceCountError
+from utilities.opendatahub_logger import get_logger
 from utilities.path_utils import resolve_repo_path
 from utilities.resources.llama_stack_distribution import LlamaStackDistribution