Skip to content

Commit

Permalink
Update SyntheticRun doc
Browse files Browse the repository at this point in the history
  • Loading branch information
maxep committed Aug 20, 2024
1 parent 6dbeeb3 commit e83f998
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion BenchmarkTests/Runner/Scenarios/SyntheticScenario.swift
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,16 @@ internal struct SyntheticScenario: Scenario {
}
}

/// The Synthetics benchmark run value.
/// The Synthetics benchmark run.
///
/// The run specifies the execution context of a benchmark scenrio.
/// Each execution will collect different type of benchmarking data:
/// - The `baseline` run collects various metrics during the scenario execution **without**
/// the Datadog SDK being initialised.
/// - The `instrumented` run collects the same metrics as `baseline` but **with** the
/// Datadog SDK initialised. Comparing the `baseline` and `instrumented` runs will provide
/// the overhead of the SDK for each metric.
/// - The `profiling` run will only collect traces of the SDK internal processes.
internal enum SyntheticRun: String {
case baseline
case instrumented
Expand Down

0 comments on commit e83f998

Please sign in to comment.