Package com.oracle.bmc.apmtraces.model

Class Trace.Builder

  • Enclosing class:
    Trace
    public static class Trace.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • key

        public Trace.Builder key​(String key)
        Unique identifier (traceId) for the trace that represents the span set.

        Note that this field is defined as traceKey in the API and it maps to the traceId in the trace data in Application Performance Monitoring.

        Parameters:
        key - the value to set
        Returns:
        this builder

      • rootSpanOperationName

        public Trace.Builder rootSpanOperationName​(String rootSpanOperationName)
        Root span name associated with the trace.

        This is the flow start operation name. Null is displayed if the root span is not yet completed.

        Parameters:
        rootSpanOperationName - the value to set
        Returns:
        this builder

      • timeEarliestSpanStarted

        public Trace.Builder timeEarliestSpanStarted​(Date timeEarliestSpanStarted)
        Start time of the earliest span in the span collection.
        Parameters:
        timeEarliestSpanStarted - the value to set
        Returns:
        this builder

      • timeLatestSpanEnded

        public Trace.Builder timeLatestSpanEnded​(Date timeLatestSpanEnded)
        End time of the span that most recently ended in the span collection.
        Parameters:
        timeLatestSpanEnded - the value to set
        Returns:
        this builder

      • spanCount

        public Trace.Builder spanCount​(Integer spanCount)
        The number of spans that have been processed by the system for the trace.

        Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.

        Parameters:
        spanCount - the value to set
        Returns:
        this builder

      • errorSpanCount

        public Trace.Builder errorSpanCount​(Integer errorSpanCount)
        The number of spans with errors that have been processed by the system for the trace.

        Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.

        Parameters:
        errorSpanCount - the value to set
        Returns:
        this builder

      • rootSpanServiceName

        public Trace.Builder rootSpanServiceName​(String rootSpanServiceName)
        Service associated with the trace.
        Parameters:
        rootSpanServiceName - the value to set
        Returns:
        this builder

      • timeRootSpanStarted

        public Trace.Builder timeRootSpanStarted​(Date timeRootSpanStarted)
        Start time of the root span for the span collection.
        Parameters:
        timeRootSpanStarted - the value to set
        Returns:
        this builder

      • timeRootSpanEnded

        public Trace.Builder timeRootSpanEnded​(Date timeRootSpanEnded)
        End time of the root span for the span collection.
        Parameters:
        timeRootSpanEnded - the value to set
        Returns:
        this builder

      • rootSpanDurationInMs

        public Trace.Builder rootSpanDurationInMs​(Integer rootSpanDurationInMs)
        Time taken for the root span operation to complete in milliseconds.
        Parameters:
        rootSpanDurationInMs - the value to set
        Returns:
        this builder

      • traceDurationInMs

        public Trace.Builder traceDurationInMs​(Integer traceDurationInMs)
        Time between the start of the earliest span and the end of the most recent span in milliseconds.
        Parameters:
        traceDurationInMs - the value to set
        Returns:
        this builder

      • isFault

        public Trace.Builder isFault​(Boolean isFault)
        Boolean flag that indicates whether the trace has an error.
        Parameters:
        isFault - the value to set
        Returns:
        this builder

      • traceStatus

        public Trace.Builder traceStatus​(String traceStatus)
        The status of the trace.

        The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.

        Parameters:
        traceStatus - the value to set
        Returns:
        this builder

      • traceErrorType

        public Trace.Builder traceErrorType​(String traceErrorType)
        Error type of the trace.
        Parameters:
        traceErrorType - the value to set
        Returns:
        this builder

      • traceErrorCode

        public Trace.Builder traceErrorCode​(String traceErrorCode)
        Error code of the trace.
        Parameters:
        traceErrorCode - the value to set
        Returns:
        this builder

      • serviceSummaries

        public Trace.Builder serviceSummaries​(List<TraceServiceSummary> serviceSummaries)
        A summary of the spans by service.
        Parameters:
        serviceSummaries - the value to set
        Returns:
        this builder

      • sourceName

        public Trace.Builder sourceName​(Trace.SourceName sourceName)
        Source of trace (traces, syn_traces).
        Parameters:
        sourceName - the value to set
        Returns:
        this builder

      • spans

        public Trace.Builder spans​(List<Span> spans)
        An array of spans in the trace.
        Parameters:
        spans - the value to set
        Returns:
        this builder

      • build

        public Trace build()