code review feedback

Author: anshbansal

metadata-ingestion/src/datahub/ingestion/api/source.py

@@ -81,22 +81,24 @@ class StructuredLogLevel(Enum):
     ERROR = logging.ERROR
 
 
-class StructuredLogType(Enum):
+class StructuredLogCategory(Enum):
     """
     This is used to categorise the errors mainly based on the biggest impact area
     This is to be used to help in self-serve understand the impact of any log entry
     More enums to be added as logs are updated to be self-serve
     """
 
     LINEAGE = "LINEAGE"
+    USAGE = "USAGE"
+    PROFILING = "PROFILING"
 
 
 @dataclass
 class StructuredLogEntry(Report):
     title: Optional[str]
     message: str
     context: LossyList[str]
-    log_type: Optional[StructuredLogType] = None
+    log_category: Optional[StructuredLogCategory] = None
 
 
 @dataclass
@@ -119,7 +121,7 @@ def report_log(
         exc: Optional[BaseException] = None,
         log: bool = False,
         stacklevel: int = 1,
-        log_type: Optional[StructuredLogType] = None,
+        log_category: Optional[StructuredLogCategory] = None,
     ) -> None:
         """
         Report a user-facing log for the ingestion run.
@@ -130,7 +132,7 @@ def report_log(
             title: The category / heading to present on for this message in the UI.
             context: Additional context (e.g. where, how) for the log entry.
             exc: The exception associated with the event. We'll show the stack trace when in debug mode.
-            log_type: The type of the log entry. This is used to categorise the log entry.
+            log_category: The type of the log entry. This is used to categorise the log entry.
             log: Whether to log the entry to the console.
             stacklevel: The stack level to use for the log entry.
         """
@@ -175,7 +177,7 @@ def report_log(
                 title=title,
                 message=message,
                 context=context_list,
-                log_type=log_type,
+                log_category=log_category,
             )
         else:
             if context is not None:
@@ -235,7 +237,7 @@ def report_warning(
         context: Optional[str] = None,
         title: Optional[LiteralString] = None,
         exc: Optional[BaseException] = None,
-        log_type: Optional[StructuredLogType] = None,
+        log_category: Optional[StructuredLogCategory] = None,
     ) -> None:
         """
         See docs of StructuredLogs.report_log for details of args
@@ -247,7 +249,7 @@ def report_warning(
             context,
             exc,
             log=False,
-            log_type=log_type,
+            log_category=log_category,
         )
 
     def warning(
@@ -257,7 +259,7 @@ def warning(
         title: Optional[LiteralString] = None,
         exc: Optional[BaseException] = None,
         log: bool = True,
-        log_type: Optional[StructuredLogType] = None,
+        log_category: Optional[StructuredLogCategory] = None,
     ) -> None:
         """
         See docs of StructuredLogs.report_log for details of args
@@ -269,7 +271,7 @@ def warning(
             context,
             exc,
             log=log,
-            log_type=log_type,
+            log_category=log_category,
         )
 
     def report_failure(
@@ -279,7 +281,7 @@ def report_failure(
         title: Optional[LiteralString] = None,
         exc: Optional[BaseException] = None,
         log: bool = True,
-        log_type: Optional[StructuredLogType] = None,
+        log_category: Optional[StructuredLogCategory] = None,
     ) -> None:
         """
         See docs of StructuredLogs.report_log for details of args
@@ -291,7 +293,7 @@ def report_failure(
             context,
             exc,
             log=log,
-            log_type=log_type,
+            log_category=log_category,
         )
 
     def failure(
@@ -301,7 +303,7 @@ def failure(
         title: Optional[LiteralString] = None,
         exc: Optional[BaseException] = None,
         log: bool = True,
-        log_type: Optional[StructuredLogType] = None,
+        log_category: Optional[StructuredLogCategory] = None,
     ) -> None:
         """
         See docs of StructuredLogs.report_log for details of args
@@ -313,7 +315,7 @@ def failure(
             context,
             exc,
             log=log,
-            log_type=log_type,
+            log_category=log_category,
         )
 
     def info(
@@ -323,7 +325,7 @@ def info(
         title: Optional[LiteralString] = None,
         exc: Optional[BaseException] = None,
         log: bool = True,
-        log_type: Optional[StructuredLogType] = None,
+        log_category: Optional[StructuredLogCategory] = None,
     ) -> None:
         """
         See docs of StructuredLogs.report_log for details of args
@@ -335,7 +337,7 @@ def info(
             context,
             exc,
             log=log,
-            log_type=log_type,
+            log_category=log_category,
         )
 
     @contextlib.contextmanager
@@ -345,7 +347,7 @@ def report_exc(
         title: Optional[LiteralString] = None,
         context: Optional[str] = None,
         level: StructuredLogLevel = StructuredLogLevel.ERROR,
-        log_type: Optional[StructuredLogType] = None,
+        log_category: Optional[StructuredLogCategory] = None,
     ) -> Iterator[None]:
         # Convenience method that helps avoid boilerplate try/except blocks.
         # TODO: I'm not super happy with the naming here - it's not obvious that this
@@ -359,7 +361,7 @@ def report_exc(
                 title=title,
                 context=context,
                 exc=exc,
-                log_type=log_type,
+                log_category=log_category,
             )
 
     def __post_init__(self) -> None:

metadata-ingestion/src/datahub/ingestion/source/mock_data/datahub_mock_data.py

@@ -13,7 +13,7 @@
     platform_name,
     support_status,
 )
-from datahub.ingestion.api.source import Source, SourceReport, StructuredLogType
+from datahub.ingestion.api.source import Source, SourceReport, StructuredLogCategory
 from datahub.ingestion.api.workunit import MetadataWorkUnit
 from datahub.ingestion.source.common.subtypes import DatasetSubTypes
 from datahub.ingestion.source.mock_data.datahub_mock_data_report import (
@@ -178,7 +178,7 @@ def get_workunits(self) -> Iterable[MetadataWorkUnit]:
                     message="This is test warning",
                     title="Test Warning",
                     context=f"This is test warning {i}",
-                    log_type=StructuredLogType.LINEAGE,
+                    log_category=StructuredLogCategory.LINEAGE,
                 )
 
         # We don't want any implicit aspects to be produced