Tungsten

v0.1.0

Tungsten v0.1.0 Tungsten.CDP.Tracing View Source

Tracing

This domain has no documentation

Link to this section Summary

Types

cdp_memory_dump_config_type()

Tracing.MemoryDumpConfig

cdp_stream_compression_type()

Tracing.StreamCompression

cdp_stream_format_type()

Tracing.StreamFormat

cdp_trace_config_type()

Tracing.TraceConfig

Functions

get_categories(session, parameters \\ %{}, options \\ [])

Tracing.getCategories

record_clock_sync_marker(session, parameters, options \\ [])

Tracing.recordClockSyncMarker

request_memory_dump(session, parameters \\ %{}, options \\ [])

Tracing.requestMemoryDump

start(session, parameters \\ %{}, options \\ [])

Tracing.start

stop(session, parameters \\ %{}, options \\ [])

Tracing.end

Link to this section Types

Link to this type

cdp_memory_dump_config_type() View Source 
cdp_memory_dump_config_type() :: map()

Tracing.MemoryDumpConfig

Configuration for memory dump. Used only when "memory-infra" category is enabled.

Link to this type

cdp_stream_compression_type() View Source 
cdp_stream_compression_type() :: :gzip | :none

Tracing.StreamCompression

Compression type to use for traces returned via streams.

Link to this type

cdp_stream_format_type() View Source 
cdp_stream_format_type() :: :proto | :json

Tracing.StreamFormat

Data format of a trace. Can be either the legacy JSON format or the protocol buffer format. Note that the JSON format will be deprecated soon.

Link to this type

cdp_trace_config_type() View Source 
cdp_trace_config_type() :: %{
  optional(:record_mode) =>
    :echo_to_console
    | :record_as_much_as_possible
    | :record_continuously
    | :record_until_full,
  optional(:enable_sampling) => boolean(),
  optional(:enable_systrace) => boolean(),
  optional(:enable_argument_filter) => boolean(),
  optional(:included_categories) => [String.t()],
  optional(:excluded_categories) => [String.t()],
  optional(:synthetic_delays) => [String.t()],
  optional(:memory_dump_config) => cdp_memory_dump_config_type()
}

Tracing.TraceConfig

This type has no documentation

Link to this section Functions

Link to this function

get_categories(session, parameters \\ %{}, options \\ []) View Source 
get_categories(GenServer.server(), map(), Tungsten.Connection.exec_options()) ::
  {:ok, %{categories: [String.t()]}} | {:error, term()}

Tracing.getCategories

Gets supported tracing categories.

Link to this function

record_clock_sync_marker(session, parameters, options \\ []) View Source 
record_clock_sync_marker(
  GenServer.server(),
  %{sync_id: String.t()},
  Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}

Tracing.recordClockSyncMarker

Record a clock sync marker in the trace.

Link to this function

request_memory_dump(session, parameters \\ %{}, options \\ []) View Source 
request_memory_dump(
  GenServer.server(),
  map(),
  Tungsten.Connection.exec_options()
) :: {:ok, %{dump_guid: String.t(), success: boolean()}} | {:error, term()}

Tracing.requestMemoryDump

Request a global memory dump.

Link to this function

start(session, parameters \\ %{}, options \\ []) View Source 
start(
  GenServer.server(),
  %{
    optional(:categories) => String.t(),
    optional(:options) => String.t(),
    optional(:buffer_usage_reporting_interval) => integer() | float(),
    optional(:transfer_mode) => :return_as_stream | :report_events,
    optional(:stream_format) => cdp_stream_format_type(),
    optional(:stream_compression) => cdp_stream_compression_type(),
    optional(:trace_config) => cdp_trace_config_type()
  },
  Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}

Tracing.start

Start trace events collection.

Link to this function

stop(session, parameters \\ %{}, options \\ []) View Source 
stop(GenServer.server(), map(), Tungsten.Connection.exec_options()) ::
  {:ok, map()} | {:error, term()}

Tracing.end

Stop trace events collection.