search

lf-lang / reactor-c

A reactor runtime written in C
Other
11 stars 24 forks source link

Trace deadline violations #457

Closed petervdonovan closed 3 months ago

petervdonovan commented 3 months ago

This allows deadline violations to be traced using a format that is similar to regular reaction executions. I am not sure if we want to mainline it, but we could do so backwards-compatibly.

This branch is based on initialize-master-thread-id-windows, which would need to be merged first.

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The changes add tracing points in various files to enhance monitoring of reactions within the system. Specifically, tracepoint_reaction_starts and tracepoint_reaction_ends are inserted before and after critical operations to log the starts and ends of reactions, incorporating the reaction's deadline for improved logging precision.

Changes

File Change Summary
core/reactor.c Added tracing points before and after invoking the deadline violation handler for reactions.
core/reactor_common.c Added tracing points before and after a code block within schedule_output_reactions function.
core/threaded/reactor_threaded.c Added tracing points before and after handling deadline violations in _lf_worker_handle_deadline_violation_for_reaction.
include/core/tracepoint.h Updated tracepoint_reaction_starts and tracepoint_reaction_ends macros to include reaction->deadline parameter.

Sequence Diagram(s)

sequenceDiagram
    participant Environment
    participant Reaction
    participant Monitor

    Environment->>+Reaction: Invoke deadline violation handler
    Reaction->>+Monitor: tracepoint_reaction_starts(reaction, deadline)
    Reaction-->>-Monitor: tracepoint_reaction_ends(reaction, deadline)
    Reaction-->>-Environment: Return from handler
sequenceDiagram
    participant ScheduleFunc as schedule_output_reactions
    participant Monitor

    ScheduleFunc->>+Monitor: tracepoint_reaction_starts(downstream_to_execute_now, deadline)
    ScheduleFunc-->>-Monitor: tracepoint_reaction_ends(downstream_to_execute_now, deadline)

[!TIP]

Early access features: enabled We are currently testing the following features in early access: - **OpenAI `gpt-4o` model for code reviews and chat**: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues. - OSS projects are currently opted into early access features by default.

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
petervdonovan commented 3 months ago

Changes look good, but why does this remove the lf_check_deadline API function? This doesn't seem backwards compatible, or is it?

Ah, I forgot that this was a user-facing API and mistook it for dead code. I'll fix that.

petervdonovan commented 3 months ago

Looks good! Should we get this merged?

OK. I don't think it strictly needs to be merged, but I think that merging it probably will not break things for anyone (unless they are depending on very specific properties of the tracing output) and will make observability a little simpler to maintain. Let's merge this if we can easily do so.

If/when we merge this, I would recommend doing a squash to keep the version history clean. This branch was a little messy.