Skip to content

core: libs: commonwealth: utils: logs: Set encoding for logs #3414

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 4, 2025

Conversation

patrickelectric
Copy link
Member

@patrickelectric patrickelectric commented Jul 4, 2025

Summary by Sourcery

Enhancements:

  • Add encoding argument to zenoh session.put calls to enforce APPLICATION_JSON with foxglove.Log schema for log messages

Copy link

sourcery-ai bot commented Jul 4, 2025

Reviewer's Guide

Introduces an explicit encoding parameter to the zenoh session.put call for foxglove logs, ensuring messages use the APPLICATION_JSON format with the foxglove.Log schema.

Sequence diagram for log message publishing with explicit encoding

sequenceDiagram
    participant sink
    participant session
    participant zenoh.Encoding
    participant foxglove_log
    sink->foxglove_log: Create log message dict
    sink->zenoh.Encoding: Get APPLICATION_JSON encoding
    zenoh.Encoding->zenoh.Encoding: with_schema("foxglove.Log")
    sink->session: put(topic, json.dumps(foxglove_log), encoding)
Loading

Class diagram for updated log message publishing in logs.py

classDiagram
    class session {
        +put(topic, message, encoding=None)
    }
    class zenoh.Encoding {
        +APPLICATION_JSON
        +with_schema(schema_name)
    }
    class foxglove_log {
        +level
        +message
        +timestamp
        +file
        +line
    }
    session <.. zenoh.Encoding : uses
    session <.. foxglove_log : uses
Loading

File-Level Changes

Change Details Files
Added encoding argument to session.put for structured logging
  • Refactored session.put call to pass encoding
  • Used zenoh.Encoding.APPLICATION_JSON.with_schema("foxglove.Log")
  • Adjusted formatting around session.put invocation
core/libs/commonwealth/src/commonwealth/utils/logs.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @patrickelectric - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@joaoantoniocardoso joaoantoniocardoso merged commit b652295 into bluerobotics:master Jul 4, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants