Package com.google.api.gax.tracing

Class SpanName

java.lang.Object
com.google.api.gax.tracing.SpanName
@BetaApi("Surface for tracing is not yet stable") @InternalApi("For google-cloud-java client use only") public abstract class SpanName extends Object
A value class to represent the name of the operation in an ApiTracer.

  • Constructor Details

    • SpanName

      public SpanName()

  • Method Details

    • of

      public static SpanName of(String clientName, String methodName)
      Creates a new instance of the name.
      Parameters:
      clientName - The name of the client. In general this will be GAPIC generated client name. However, in some cases, when the GAPIC generated client is wrapped, this will be overridden to specify the manually written wrapper's name.
      methodName - The name of the logical operation being traced.

    • of

      public static SpanName of(ApiTracerContext apiTracerContext)
      Returns a new SpanName parsed from the given ApiTracerContext

      This is extracted from ApiTracerContext.fullMethodName() using the FULL_METHOD_NAME_REGEX

      • If fullMethodName() is "google.pubsub.v1.Publisher/Publish", the client name is "Publisher".
      • If fullMethodName() is "google.pubsub.v1.Publisher/Publish", the base method name is "Publish".
      Returns:
      a new SpanName with the parsed client name and method name

    • getClientName

      public abstract String getClientName()
      The name of the client. ie BigtableData

    • getMethodName

      public abstract String getMethodName()
      The name of the logical operation being traced. ie. ReadRows.

    • toString

      public String toString()
      Overrides:
      toString in class Object