Skip to content
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

feat: Structured logging #3948

Closed

Conversation

benjaminhuth
Copy link
Member

@benjaminhuth benjaminhuth commented Dec 4, 2024

This is a WIP / discussion PR to make structured logging happen

Basic idea:

  • Abstract interface for structured logger in Core
    • implements concret payloads, for now Eigen types and std::span<double>
  • Plugins / clients can implement this interface
    • provide implementation in json plugin
  • Put structured log into verbose stream of default log
    • ideally, preserve for matrices as readable as it is today

Adds new macro:

ACTS_STRUCTURED(key, value);

Example output from GainMatrixUpdater:

{
    "key": "Calibrated measurement",
    "level": "STRUCTURED",
    "tag": "KalmanFitterActor",
    "type": "vector",
    "val": [
      -2.510865401566629,
      -28.269642010055627,
      207.08573197488712
    ]
  },
  {
    "key": "Calibrated measurement covariance",
    "level": "STRUCTURED",
    "tag": "KalmanFitterActor",
    "type": "matrix",
    "val": [
      [      
        0.000225,
        0.0,   
        0.0    
      ],     
      [      
        0.0,   
        0.000225,
        0.0    
      ],     
      [      
        0.0,   
        0.0,   
        625.0  
      ]      
    ]
  },

TODO:

  • Attach structured logger to Acts::Logger, no global state
  • Add timestamp to structured log
  • Check how to nicely format matrices in automatic VERBOSE messages from ACTS_STRUCTURED

--- END COMMIT MESSAGE ---

@paulgessinger @andiwand

@benjaminhuth benjaminhuth added the 🚧 WIP Work-in-progress label Dec 4, 2024
Copy link

coderabbitai bot commented Dec 4, 2024

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@github-actions github-actions bot added Component - Core Affects the Core module Component - Examples Affects the Examples module Component - Plugins Affects one or more Plugins Track Fitting labels Dec 4, 2024
@github-actions github-actions bot added this to the next milestone Dec 4, 2024
@benjaminhuth
Copy link
Member Author

Close because of #3955

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Core Affects the Core module Component - Examples Affects the Examples module Component - Plugins Affects one or more Plugins 🚧 WIP Work-in-progress Track Fitting
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant