feat(ingest): various logging improvements

[hsheth2]

Follow up on #8015

Checklist

• The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
• Links to related issues (if applicable)
• Tests for the changes have been added/updated (if applicable)
• Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
• For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Summary by CodeRabbit

• New Features

  • Enhanced error logging to include workunit_id for better traceability.
  • Improved telemetry logging with more detailed function call information.

• Bug Fixes

  • Implemented safe initialization for the properties dictionary in telemetry tracking.

• Chores

  • Introduced a maximum length for log entries to maintain clarity and prevent excessive length.

[coderabbitai]

Walkthrough

Recent changes enhance the logging and telemetry functionality within the metadata ingestion system. Key improvements include capturing additional context in logging messages, establishing a maximum length for log entries, and refining the handling of event properties. These updates aim to improve traceability, maintain clarity in log outputs, and ensure safer access patterns, ultimately boosting the robustness of the system's monitoring and debugging capabilities.

Changes

Files	Change Summary
src/datahub/ingestion/sink/datahub_rest.py	Modified _write_done_callback to log workunit_id from record_envelope.metadata, enhancing error traceability.
src/datahub/telemetry/telemetry.py	Updated logging messages for consistency; enhanced ping method to log function call details and ensure safe initialization of properties.
src/datahub/utilities/logging_manager.py	Introduced constant IN_MEMORY_LOG_BUFFER_MAX_LINE_LENGTH set to 2000 characters; modified write method to truncate long log lines.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Telemetry
    participant LoggingManager
    participant DataHubRest

    User->>Telemetry: Initiate tracking
    Telemetry->>LoggingManager: Log init tracking
    Telemetry->>Telemetry: Send ping event
    Telemetry->>LoggingManager: Log ping event details
    LoggingManager-->>Telemetry: Confirm logging
    Telemetry-->>User: Acknowledge tracking event

Loading

Poem

🐇 In the logs where bunnies hop,
New details bloom, no need to stop!
With max lengths set, our messages clear,
Debugging's a breeze, let out a cheer!
So here's to changes, bright and spry,
In the world of code, we leap and fly! 🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2

Outside diff range, codebase verification and nitpick comments (1)

metadata-ingestion/src/datahub/utilities/logging_manager.py (1)

164-166: Truncation Logic Issue in write Method

The current truncation logic in the write method does not account for the length of the truncation indicator "[truncated]". This could result in a line that exceeds the intended maximum length. Consider adjusting the truncation logic to ensure the total length, including "[truncated]", does not exceed IN_MEMORY_LOG_BUFFER_MAX_LINE_LENGTH.

• File: metadata-ingestion/src/datahub/utilities/logging_manager.py
• Lines: 164-166

Analysis chain

Ensure line truncation logic is robust.

The truncation logic in the write method is correctly implemented. However, ensure that the truncation indicator "[truncated]" does not itself cause the line to exceed the maximum length.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the truncation logic in the `write` method is robust.

# Test: Check that the truncated line does not exceed the maximum length.
ast-grep --lang python --pattern $'class _LogBuffer {
  $$$
  def write(self, line: str) -> None:
    if len(line) > $_:
      line = line[:$_] + "[truncated]"
    $$$
  $$$
}'

Length of output: 740

---

Script:

#!/bin/bash
# Description: Verify that the truncation logic in the `write` method is robust.

# Test: Check that the truncated line does not exceed the maximum length.
ast-grep --lang python --pattern $'class _LogBuffer:
  def write(self, line: str) -> None:
    if len(line) > $_:
      line = line[:$_] + "[truncated]"
    $$$'

Length of output: 162

---

Script:

#!/bin/bash
# Description: Search for the `write` method in the codebase to verify the truncation logic.

# Use ripgrep to find the `write` method and its implementation.
rg 'def write' -A 5 --glob '*.py'

Length of output: 10097

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 840b150 and 03fbdfe.

Files selected for processing (3)

• metadata-ingestion/src/datahub/ingestion/sink/datahub_rest.py (1 hunks)
• metadata-ingestion/src/datahub/telemetry/telemetry.py (2 hunks)
• metadata-ingestion/src/datahub/utilities/logging_manager.py (2 hunks)

Additional comments not posted (3)

metadata-ingestion/src/datahub/telemetry/telemetry.py (3)

286-286: Ensure consistent log message casing.

The log message in init_tracking has been updated for consistent casing. Ensure all log messages across the module follow this convention for consistency.

---

313-314: Initialize properties with a default value.

The initialization of properties with a default empty dictionary is a good practice to avoid NoneType errors. Ensure this pattern is consistently applied across similar methods.

---

317-323: Enhance log message clarity in ping method.

The additional logging for "function-call" events provides more context. Ensure that similar enhancements are applied to other event types if applicable.

[coderabbitai]

Define IN_MEMORY_LOG_BUFFER_MAX_LINE_LENGTH as a configurable parameter.

Consider making IN_MEMORY_LOG_BUFFER_MAX_LINE_LENGTH configurable through an environment variable or configuration file to allow flexibility in adjusting the log line length limit without modifying the code.

IN_MEMORY_LOG_BUFFER_MAX_LINE_LENGTH = int(os.getenv("LOG_BUFFER_MAX_LINE_LENGTH", 2000))

[coderabbitai]

Ensure metadata key existence before accessing.

The code assumes the existence of the workunit_id key in record_envelope.metadata. Consider using get to safely access the key and handle cases where it might not exist.

workunit_id = record_envelope.metadata.get("workunit_id")
if workunit_id:
    e.info["workunit_id"] = workunit_id

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)

metadata-ingestion/src/datahub/utilities/logging_manager.py (1)

164-165: Truncate long log lines to maintain clarity.

The write method now truncates log lines that exceed the defined maximum length, appending "[truncated]" to indicate this. Ensure that this behavior is documented for users.

+        # Truncate lines that exceed the maximum length.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 840b150 and 03fbdfe.

Files selected for processing (3)

• metadata-ingestion/src/datahub/ingestion/sink/datahub_rest.py (1 hunks)
• metadata-ingestion/src/datahub/telemetry/telemetry.py (2 hunks)
• metadata-ingestion/src/datahub/utilities/logging_manager.py (2 hunks)

Additional comments not posted (5)

metadata-ingestion/src/datahub/utilities/logging_manager.py (1)

38-38: Define a constant for maximum log line length.

The addition of IN_MEMORY_LOG_BUFFER_MAX_LINE_LENGTH helps control log size, preventing excessively long entries.

metadata-ingestion/src/datahub/ingestion/sink/datahub_rest.py (1)

205-206: Enhance error logging with workunit_id.

Including workunit_id in the error information provides additional context, improving traceability and debugging.

metadata-ingestion/src/datahub/telemetry/telemetry.py (3)

286-286: Use consistent logging style.

The change to lowercase "telemetry" in the debug log statement aligns with a consistent logging style.

---

313-314: Ensure safe access to properties.

Initializing properties to an empty dictionary if not provided ensures safer access patterns and prevents potential errors.

---

317-323: Log detailed telemetry events for function-call.

The enhanced logging for function-call events provides specific details about the function and its status, improving traceability.

[asikowitz]

ayy python 3.8