Skip to content

Commit

Permalink
[Turbopack] add tracing to task execution (vercel#74770)
Browse files Browse the repository at this point in the history
add tracing to task_execution_completed

add tracing for strongly consistent read

improve aggregation update tracing

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the PR.
- Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to understand the PR)
- When linking to a Slack thread, you might want to share details of the conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->
  • Loading branch information
sokra authored Jan 14, 2025
1 parent 92e3200 commit fe7c60b
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 11 deletions.
24 changes: 16 additions & 8 deletions turbopack/crates/turbo-tasks-backend/src/backend/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -420,14 +420,21 @@ impl<B: BackingStorage> TurboTasksBackendInner<B> {
break;
}
drop(task);
AggregationUpdateQueue::run(
AggregationUpdateJob::UpdateAggregationNumber {
task_id,
base_aggregation_number: u32::MAX,
distance: None,
},
&mut ctx,
);
{
let _span = tracing::trace_span!(
"make root node for strongly consistent read",
%task_id
)
.entered();
AggregationUpdateQueue::run(
AggregationUpdateJob::UpdateAggregationNumber {
task_id,
base_aggregation_number: u32::MAX,
distance: None,
},
&mut ctx,
);
}
task = ctx.task(task_id, TaskDataCategory::All);
}

Expand Down Expand Up @@ -1173,6 +1180,7 @@ impl<B: BackingStorage> TurboTasksBackendInner<B> {
operation::UpdateOutputOperation::run(task_id, result, self.execute_context(turbo_tasks));
}

#[tracing::instrument(level = "trace", skip_all)]
fn task_execution_completed(
&self,
task_id: TaskId,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1568,7 +1568,7 @@ impl AggregationUpdateQueue {
) {
#[cfg(feature = "trace_aggregation_update")]
let _span =
trace_span!("process update aggregation numger", base_aggregation_number).entered();
trace_span!("check update aggregation number", base_aggregation_number).entered();

let mut task = ctx.task(task_id, TaskDataCategory::Meta);
let current = get!(task, AggregationNumber).copied().unwrap_or_default();
Expand Down Expand Up @@ -1601,7 +1601,13 @@ impl AggregationUpdateQueue {
}
} else {
#[cfg(feature = "trace_aggregation_update")]
let _span = trace_span!("update aggregation numger", aggregation_number).entered();
let _span = trace_span!(
"update aggregation number",
task = ctx.get_task_description(task_id),
old,
aggregation_number
)
.entered();
task.insert(CachedDataItem::AggregationNumber {
value: AggregationNumber {
base: base_aggregation_number,
Expand Down Expand Up @@ -1655,7 +1661,7 @@ impl AggregationUpdateQueue {
/// upper edges as this amplifies the updates needed when changes to that task occur.
fn optimize_task(&mut self, ctx: &mut impl ExecuteContext<'_>, task_id: TaskId) {
#[cfg(feature = "trace_aggregation_update")]
let _span = trace_span!("optimize").entered();
let _span = trace_span!("check optimize").entered();

let task = ctx.task(task_id, TaskDataCategory::Meta);
let aggregation_number = get!(task, AggregationNumber).copied().unwrap_or_default();
Expand Down Expand Up @@ -1750,6 +1756,14 @@ impl AggregationUpdateQueue {
}

if aggregation_number.effective != new_aggregation_number {
#[cfg(feature = "trace_aggregation_update")]
let _span = trace_span!(
"optimize",
upper_count,
old_aggregation_number = aggregation_number.effective,
new_aggregation_number,
)
.entered();
self.push(AggregationUpdateJob::UpdateAggregationNumber {
task_id,
base_aggregation_number: new_aggregation_number
Expand Down

0 comments on commit fe7c60b

Please sign in to comment.