ark::perf::TracerCollectorStage

Defined in header “ark/perf/stages/tracer_collector_stage.hh”.


This stage will initialize the global profiler, and then periodically collect and emit statistics, suitable for display in the GUI (or logging).

Methods

  • TracerCollectorStage(std::string name)
    Constructor.

  • ~TracerCollectorStage()
    Destructor, implemented in source due to forward declares.

  • void add_arguments(core::ArgumentParser & parser)
    Called before initialization, allows a stage to add custom command line options to the CLI. The resulting parsed arguments are made available to the stage through the StageInterface during initizilation.

  • void initialize(pipeline::StageInterface & interface)
    Called from the executor when we are initialized.

  • void shutdown()
    Do one last collection of scopes.

  • void finalize()
    Called on shutdown, when the pipeline is finishing execution. Based on configuration, this could emit a final summary report.

  • const TracerReport & report()
    Returns the active tracer report; this is here for testing.