com.github.testsmith.cdt.protocol.commands.Tracing Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdt-java-client Show documentation
Chrome DevTools java client
The newest version!
package com.github.testsmith.cdt.protocol.commands;

/*-
 * #%L
 * cdt-java-client
 * %%
 * Copyright (C) 2018 - 2024 Kenan Klisura
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import com.github.testsmith.cdt.protocol.events.tracing.BufferUsage;
import com.github.testsmith.cdt.protocol.events.tracing.DataCollected;
import com.github.testsmith.cdt.protocol.events.tracing.TracingComplete;
import com.github.testsmith.cdt.protocol.support.annotations.EventName;
import com.github.testsmith.cdt.protocol.support.annotations.Experimental;
import com.github.testsmith.cdt.protocol.support.annotations.Optional;
import com.github.testsmith.cdt.protocol.support.annotations.ParamName;
import com.github.testsmith.cdt.protocol.support.annotations.ReturnTypeParameter;
import com.github.testsmith.cdt.protocol.support.annotations.Returns;
import com.github.testsmith.cdt.protocol.support.types.EventHandler;
import com.github.testsmith.cdt.protocol.support.types.EventListener;
import com.github.testsmith.cdt.protocol.types.tracing.MemoryDumpLevelOfDetail;
import com.github.testsmith.cdt.protocol.types.tracing.RequestMemoryDump;
import com.github.testsmith.cdt.protocol.types.tracing.StartTransferMode;
import com.github.testsmith.cdt.protocol.types.tracing.StreamCompression;
import com.github.testsmith.cdt.protocol.types.tracing.StreamFormat;
import com.github.testsmith.cdt.protocol.types.tracing.TraceConfig;
import com.github.testsmith.cdt.protocol.types.tracing.TracingBackend;
import java.util.List;

/**
 * Tracing interface.
 *
 * @author roy
 * @version $Id: $Id
 */
@Experimental
public interface Tracing {

  /** Stop trace events collection. */
  void end();

  /**
   * Gets supported tracing categories.
   *
   * @return a {@link java.util.List} object
   */
  @Returns("categories")
  @ReturnTypeParameter(String.class)
  List getCategories();

  /**
   * Record a clock sync marker in the trace.
   *
   * @param syncId The ID of this clock sync marker
   */
  void recordClockSyncMarker(@ParamName("syncId") String syncId);

  /**
   * Request a global memory dump.
   *
   * @return a {@link com.github.testsmith.cdt.protocol.types.tracing.RequestMemoryDump} object
   */
  RequestMemoryDump requestMemoryDump();

  /**
   * Request a global memory dump.
   *
   * @param deterministic Enables more deterministic results by forcing garbage collection
   * @param levelOfDetail Specifies level of details in memory dump. Defaults to "detailed".
   * @return a {@link com.github.testsmith.cdt.protocol.types.tracing.RequestMemoryDump} object
   */
  RequestMemoryDump requestMemoryDump(
      @Optional @ParamName("deterministic") Boolean deterministic,
      @Optional @ParamName("levelOfDetail") MemoryDumpLevelOfDetail levelOfDetail);

  /** Start trace events collection. */
  void start();

  /**
   * Start trace events collection.
   *
   * @param categories Category/tag filter
   * @param options Tracing options
   * @param bufferUsageReportingInterval If set, the agent will issue bufferUsage events at this
   *     interval, specified in milliseconds
   * @param transferMode Whether to report trace events as series of dataCollected events or to save
   *     trace to a stream (defaults to `ReportEvents`).
   * @param streamFormat Trace data format to use. This only applies when using `ReturnAsStream`
   *     transfer mode (defaults to `json`).
   * @param streamCompression Compression format to use. This only applies when using
   *     `ReturnAsStream` transfer mode (defaults to `none`)
   * @param traceConfig a {@link com.github.testsmith.cdt.protocol.types.tracing.TraceConfig} object
   * @param perfettoConfig Base64-encoded serialized perfetto.protos.TraceConfig protobuf message
   *     When specified, the parameters `categories`, `options`, `traceConfig` are ignored. (Encoded
   *     as a base64 string when passed over JSON)
   * @param tracingBackend Backend type (defaults to `auto`)
   */
  void start(
      @Deprecated @Optional @ParamName("categories") String categories,
      @Deprecated @Optional @ParamName("options") String options,
      @Optional @ParamName("bufferUsageReportingInterval") Double bufferUsageReportingInterval,
      @Optional @ParamName("transferMode") StartTransferMode transferMode,
      @Optional @ParamName("streamFormat") StreamFormat streamFormat,
      @Optional @ParamName("streamCompression") StreamCompression streamCompression,
      @Optional @ParamName("traceConfig") TraceConfig traceConfig,
      @Optional @ParamName("perfettoConfig") String perfettoConfig,
      @Optional @ParamName("tracingBackend") TracingBackend tracingBackend);

  /**
   * onBufferUsage.
   *
   * @param eventListener a {@link com.github.testsmith.cdt.protocol.support.types.EventHandler}
   *     object
   * @return a {@link com.github.testsmith.cdt.protocol.support.types.EventListener} object
   */
  @EventName("bufferUsage")
  EventListener onBufferUsage(EventHandler eventListener);

  /**
   * Contains an bucket of collected trace events. When tracing is stopped collected events will be
   * send as a sequence of dataCollected events followed by tracingComplete event.
   *
   * @param eventListener a {@link com.github.testsmith.cdt.protocol.support.types.EventHandler}
   *     object
   * @return a {@link com.github.testsmith.cdt.protocol.support.types.EventListener} object
   */
  @EventName("dataCollected")
  EventListener onDataCollected(EventHandler eventListener);

  /**
   * Signals that tracing is stopped and there is no trace buffers pending flush, all data were
   * delivered via dataCollected events.
   *
   * @param eventListener a {@link com.github.testsmith.cdt.protocol.support.types.EventHandler}
   *     object
   * @return a {@link com.github.testsmith.cdt.protocol.support.types.EventListener} object
   */
  @EventName("tracingComplete")
  EventListener onTracingComplete(EventHandler eventListener);
}