package core_profiler

  1. Overview
  2. Docs
Profiling library

Install

Dune Dependency

Authors

Maintainers

Sources

core_profiler-v0.14.0.tar.gz
sha256=df3c0775a78177c37a340e384e6d1297f40aeaf66e167da008bcd8361d0ab8f7
md5=db303227e57c8eae72a6cdcf4997e1fd

doc/core_profiler/Core_profiler/index.html

Module Core_profilerSource

Sourcemodule Check_environment : sig ... end
Sourcemodule Common : sig ... end
Sourcemodule Fstats : sig ... end
Sourcemodule Header_protocol : sig ... end

This file is automatically generated by a target in the build system. Do not modify it by hand.

Sourcemodule Offline : sig ... end

Running a program with offline metrics collection causes it to write out a data file on exit. This data file is typically called profiler.dat. The collected metrics can then be analyzed using profiler-tool.exe.

Sourcemodule Online : sig ... end

Use this module for online tracking of perf metrics. When using this module, the metrics are written out to stdout every second. There is no mertric file generated for offline analysis. The rate at which metrics are dumped to stdout is controlled by the environment variable CORE_PROFILER=PRINT_INTERVAL=N where N is the integer number of seconds to wait between outputs.

Sourcemodule Probe_id : sig ... end

Timer, Probe, Groups and Group points are all assigned globally unique Id.ts.

Sourcemodule Probe_type : sig ... end
Sourcemodule Profiler_epoch : sig ... end

Time_ns and Time represents time since 1970 (the unix epoch). When writing out perf mertics, we don't have enough bits to express nanos since the unix epch. Instead we record an arbitrary point of time as the Profiler_epoch.t. Times can be stored with respect to this epoch.

Sourcemodule Protocol : sig ... end
Sourcemodule Std_offline : sig ... end

Open this Std for offline use of probes.

Sourcemodule Std_online : sig ... end

Open this Std for online use.

OCaml

Innovation. Community. Security.