Interface Tracing

All Known Implementing Classes:
TracingImpl

public interface Tracing
  • Method Details

    • end

      void end()
      Stop trace events collection.
    • getCategories

      java.util.List<java.lang.String> getCategories()
      Gets supported tracing categories.
      Returns:
      A list of supported tracing categories.
    • recordClockSyncMarker

      void recordClockSyncMarker​(java.lang.String syncId)
      Record a clock sync marker in the trace.
      Parameters:
      syncId - The ID of this clock sync marker
    • requestMemoryDump

      RequestMemoryDumpResult requestMemoryDump​(java.lang.Boolean deterministic)
      Request a global memory dump.
      Parameters:
      deterministic - Enables more deterministic results by forcing garbage collection
      Returns:
      RequestMemoryDumpResult
    • start

      void start​(java.lang.String categories, java.lang.String options, java.lang.Double bufferUsageReportingInterval, TransferMode transferMode, StreamFormat streamFormat, StreamCompression streamCompression, TraceConfig traceConfig)
      Start trace events collection.
      Parameters:
      categories - Category/tag filter
      options - Tracing options
      bufferUsageReportingInterval - If set, the agent will issue bufferUsage events at this interval, specified in milliseconds
      transferMode - Whether to report trace events as series of dataCollected events or to save trace to a stream (defaults to `ReportEvents`).
      streamFormat - Trace data format to use. This only applies when using `ReturnAsStream` transfer mode (defaults to `json`).
      streamCompression - Compression format to use. This only applies when using `ReturnAsStream` transfer mode (defaults to `none`)
    • requestMemoryDump

      RequestMemoryDumpResult requestMemoryDump()
      Request a global memory dump.
      Returns:
      RequestMemoryDumpResult
    • start

      void start()
      Start trace events collection.