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

[patrickelectric]

Summary by Sourcery

Enhancements:

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

[sourcery-ai]

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}