Package io.opentelemetry.api.trace

Enum Span.Kind

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Span.Kind>
    Enclosing interface:
    Span
    public static enum Span.Kind
extends java.lang.Enum<Span.Kind>
    Type of span. Can be used to specify additional relationships between spans in addition to a parent/child relationship.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CLIENT
      Indicates that the span covers the client-side wrapper around an RPC or other remote request.
      CONSUMER
      Indicates that the span describes consumer receiving a message from a broker.
      INTERNAL
      Default value.
      PRODUCER
      Indicates that the span describes producer sending a message to a broker.
      SERVER
      Indicates that the span covers server-side handling of an RPC or other remote request.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Span.Kind valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Span.Kind[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • INTERNAL

        public static final Span.Kind INTERNAL
        Default value. Indicates that the span is used internally.

      • SERVER

        public static final Span.Kind SERVER
        Indicates that the span covers server-side handling of an RPC or other remote request.

      • CLIENT

        public static final Span.Kind CLIENT
        Indicates that the span covers the client-side wrapper around an RPC or other remote request.

      • PRODUCER

        public static final Span.Kind PRODUCER
        Indicates that the span describes producer sending a message to a broker. Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans.

      • CONSUMER

        public static final Span.Kind CONSUMER
        Indicates that the span describes consumer receiving a message from a broker. Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans.

    • Method Detail

      • values

        public static Span.Kind[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Span.Kind c : Span.Kind.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Span.Kind valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null