[Dataflow] Extractor instrumentation is here! #2204
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull request overview
This PR introduces instrumentation capabilities for the dataflow extractor, allowing users to monitor and analyze how often each dataflow processor is called during analysis. The primary use case is enabling a heatmap display in the REPL that shows processor call frequencies.
Key changes:
- Adds a new configuration option
repl.dfProcessorHeatto enable dataflow processor instrumentation in the REPL - Introduces a flexible instrumentation hook
solver.instrument.dataflowExtractorsthat allows custom modification of dataflow processors - Enhances the config query output to show only updated configuration keys when changes are made
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| src/dataflow/instrument/instrument-dataflow-count.ts | New instrumentation function that wraps dataflow processors to count invocations per RType |
| src/dataflow/extractor.ts | Integrates the instrumentation hook into the dataflow graph production pipeline; adds optional chaining to control flow graph access |
| src/config.ts | Adds new configuration options for REPL processor heatmap and solver instrumentation hooks |
| src/cli/repl/core.ts | Implements heatmap display logic in REPL, setting up instrumentation when dfProcessorHeat is enabled |
| src/queries/catalog/config-query/config-query-format.ts | Enhances config query output to show only modified keys when updating configuration; adds helper functions for key collection and value retrieval |
| src/documentation/wiki-query.ts | Updates documentation to mention the new dfProcessorHeat configuration option |
| src/documentation/wiki-interface.ts | Adds instrument section to the example configuration structure in documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
EagleoutIce
deleted the
2155-provide-a-way-to-instrument-all-df-handlers
branch
Member
Author
|
This pull request is included in v2.8.4 (see Release v2.8.4 (Extractor Instrumentation, Bugfixes, and Support for more Versions)). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.