Class Tracing

  • public class Tracing
extends java.lang.Object
    Class created by Automatic Code-Generator.
    This class was built using the Chrome Remote Dev-Tools A.P.I., which is specified by two JSON-RPC Files. These files were obtained from the Chrome Dev Tools Protocol Git Hub Page, which has a "Tip of Tree" (the latest) API-Specification Page Here: JSON-RPC Protocol Specification.

    JSON-Viewable Google-API:
    These files may be viewed here: browser_protocol.json and js_protocol.json.
    These files were converted into this Java-Browser (CDT) Library; they are a Java-Alternative to the Node.js implementation.

    HTML-Viewable API:
    In addition to this Class-Library, these files were also converted to a simple HTML Page, which may be browsed here: Browser API Web-Page

    Node.js RDP-API Implementation:
    You may read about the Node.js Chrome Remote Interface on the Node.js Package Manager Web-Site: NPM
    [No Description Provided by Google]

    This class is intended to be used with a Headless Browser

    These methods have been tested, to some degree, using Google Chrome. In order to use this class you must start a web-browser instance and make a connection to the browser using a Remote Debugging Port. The initializations may be accomplished using class BRDPC (Browser Remote Debug Protocol Connection).

    Google-Chrome was used during the development process of the classes in this particular package. Note that, lately, it has been asserted Microsoft has switched to using the Chrome-Engine for its Microsoft Edge Browser Internal Code-Base. Therefore, there may limited support / functionality when running the methods in this class with Microsoft-Edge. There is the possibility these will work with Opera & Safari.

    Check whether the your Web-Browser will allow itself to be driven by the Web-Socket RDP-Port 9223.

    Foreign Function API:
    Every one of the methods that reside in this class are designed to do nothing more than:

    1. Accept Parameters from the User, and "Marshall Them" into a Valid JSON-Request
    2. Transmit the Marshalled Request-JSON to a Headless Web-Browser over a Web-Socket RDP Connection
    3. Receive BOTH that Method's Results AND any Browser Event-Firings from the Web-Socket
    4. Parse JSON Method-Results and Browser-Event Firings, and Subsequently Convert them to Standard Java-Types
    5. Report these Method-Results and Browser-Events to the User via an User-Registered Event-Listener or a Promise Object


    Java-HTML Difference:
    Unlike the bulk of the Java HTML JAR Library, there is very little native Java-Code, and very little testing that may be done on any of the classes & methods in this package. The code inside these classes does nothing more than marshall-and-unmarshall Java-Types into Json-Requests (and vice-versa). The Java-Script & Browser modules inside of a Google-Chrome instance are, theoretically, handling these requests, and returning their results (or events) over the Web-Socket Connection.

    It has been asserted (by Google Chrome Developers) that some of these methods are only "partially working" or "experimental".



    Stateless Class:
    This class neither contains any program-state, nor can it be instantiated. The @StaticFunctional Annotation may also be called 'The Spaghetti Report'. Static-Functional classes are, essentially, C-Styled Files, without any constructors or non-static member fields. It is a concept very similar to the Java-Bean's @Stateless Annotation.

    • 1 Constructor(s), 1 declared private, zero-argument constructor
    • 5 Method(s), 5 declared static
    • 9 Field(s), 9 declared static, 8 declared final
    • Fields excused from final modifier (with explanation):
      Field 'counter' is not final. Reason: CONFIGURATION


    • Nested Class Summary

       
      Type Classes: Tracing Domain Types
      Modifier and Type Inner-Class
      static class  Tracing.TraceConfig
      [No Description Provided by Google]
       
      Event Classes: Tracing Domain Events
      Modifier and Type Inner-Class
      static class  Tracing.bufferUsage
      [No Description Provided by Google]
      static class  Tracing.dataCollected
      Contains an bucket of collected trace events.
      static class  Tracing.tracingComplete
      Signals that tracing is stopped and there is no trace buffers pending flush, all data were delivered via dataCollected events.

    • Field Summary

       
      Tracing Domain Enumerated String Types
      Modifier and Type Field
      static String[] MemoryDumpLevelOfDetail
      Details exposed when memory request explicitly declared.
      static String[] StreamCompression
      Compression type to use for traces returned via streams.
      static String[] StreamFormat
      Data format of a trace.
      static String[] TracingBackend
      Backend type to use for tracing.

    • Method Summary

       
      Tracing Domain Commands
      Script Returns Modifier and Type Method
      NONE (void) static Script<> end()
      Stop trace events collection.
      String[] static Script<> getCategories()
      Gets supported tracing categories.
      NONE (void) static Script<> recordClockSyncMarker​(String syncId)
      Record a clock sync marker in the trace.
      Ret2<String,
           ​Boolean>      		 static Script<> requestMemoryDump​(Boolean deterministic, String levelOfDetail)
      Request a global memory dump.
      NONE (void) static Script<> start​(String categories, String options, Number bufferUsageReportingInterval, String transferMode, String streamFormat, String streamCompression, Tracing.TraceConfig traceConfig, String perfettoConfig, String tracingBackend)
      Start trace events collection.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • StreamFormat

        🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static final java.lang.String[] 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.

      • MemoryDumpLevelOfDetail

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static final java.lang.String[] MemoryDumpLevelOfDetail
        Details exposed when memory request explicitly declared. Keep consistent with memory_dump_request_args.h and memory_instrumentation.mojom

      • TracingBackend

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static final java.lang.String[] TracingBackend
        Backend type to use for tracing. chrome uses the Chrome-integrated tracing service and is supported on all platforms. system is only supported on Chrome OS and uses the Perfetto system tracing service. auto chooses system when the perfettoConfig provided to Tracing.start specifies at least one non-Chrome data source; otherwise uses chrome.

    • Method Detail

      • end

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> end()
        Stop trace events collection.
        Returns:
        An instance of Script<String, JsonObject, Ret0>

        This Script instance must be executed before the browser receives the invocation-request.

        This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.

      • getCategories

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​java.lang.String[]> getCategories
            ()
        Gets supported tracing categories.
        Returns:
        An instance of Script<String, JsonObject, String[]>

        This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, String[]> will be returned.

        Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may may be retrieved.

        This Browser Function returns

        • String[] (categories)
          A list of supported tracing categories.

      • recordClockSyncMarker

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> recordClockSyncMarker​
            (java.lang.String syncId)
        Record a clock sync marker in the trace.
        Parameters:
        syncId - The ID of this clock sync marker
        Returns:
        An instance of Script<String, JsonObject, Ret0>

        This Script instance must be executed before the browser receives the invocation-request.

        This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.

      • requestMemoryDump

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret2<java.lang.String,​java.lang.Boolean>> requestMemoryDump​
            (java.lang.Boolean deterministic,
             java.lang.String levelOfDetail)
        Request a global memory dump.
        Parameters:
        deterministic - Enables more deterministic results by forcing garbage collection
        OPTIONAL
        levelOfDetail - Specifies level of details in memory dump. Defaults to "detailed".
        OPTIONAL
        Returns:
        An instance of Script<String, JsonObject, Ret2>

        This Script may be executed (using Script.exec()), and a Promise returned.

        When the Promise is awaited (using Promise.await()), the Ret2 will subsequently be returned from that call.

        The returned values are encapsulated in an instance of Ret2

        • Ret2.a: String (dumpGuid)
          GUID of the resulting global memory dump.

        • Ret2.b: Boolean (success)
          True iff the global memory dump succeeded.

      • start

        🡅  ⇈  ⮫ 🗕  🗗  🗖 
        public static Script<java.lang.String,​JsonObject,​Ret0> start​
            (java.lang.String categories,
             java.lang.String options,
             java.lang.Number bufferUsageReportingInterval,
             java.lang.String transferMode,
             java.lang.String streamFormat,
             java.lang.String streamCompression,
             Tracing.TraceConfig traceConfig,
             java.lang.String perfettoConfig,
             java.lang.String tracingBackend)
        Start trace events collection.
        Parameters:
        categories - Category/tag filter
        OPTIONAL
        DEPRECATED
        options - Tracing options
        OPTIONAL
        DEPRECATED
        bufferUsageReportingInterval - If set, the agent will issue bufferUsage events at this interval, specified in milliseconds
        OPTIONAL
        transferMode - Whether to report trace events as series of dataCollected events or to save trace to a stream (defaults to ReportEvents).
        Acceptable Values: ["ReportEvents", "ReturnAsStream"]
        OPTIONAL
        streamFormat - Trace data format to use. This only applies when using ReturnAsStream transfer mode (defaults to json).
        OPTIONAL
        streamCompression - Compression format to use. This only applies when using ReturnAsStream transfer mode (defaults to none)
        OPTIONAL
        traceConfig - -
        OPTIONAL
        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)
        OPTIONAL
        tracingBackend - Backend type (defaults to auto)
        OPTIONAL
        Returns:
        An instance of Script<String, JsonObject, Ret0>

        This Script instance must be executed before the browser receives the invocation-request.

        This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.