Class ZipkinOptionsConfigParser

    INTERNAL API. Retrieves the default HOCON Phobos.Tracing.Zipkin.Config for the Zipkin Phobos.Tracing plugin and parses it into a IntermediateZipkinOptions object.

    Inheritance
    System.Object
    ZipkinOptionsConfigParser
    Namespace:Phobos.Tracing.Zipkin.Config
    Assembly:Phobos.Tracing.Zipkin.dll
    Syntax
    public static class ZipkinOptionsConfigParser

    Properties

    DefaultZipkinConfig

    The default HOCON configuration for this module.

    Declaration
    public static Config DefaultZipkinConfig { get; }
    Property Value
    Type Description
    Akka.Configuration.Config

    Methods

    AddressToEndpoint(Address)

    Converts an Akka.NET Akka.Actor.Address into a Zipkin Petabridge.Tracing.Zipkin.Endpoint.

    Declaration
    public static Endpoint AddressToEndpoint(this Address addr)
    Parameters
    Type Name Description
    Akka.Actor.Address addr

    The address of the local Akka.Actor.ActorSystem.
    Returns
    Type Description
    Petabridge.Tracing.Zipkin.Endpoint

    An Petabridge.Tracing.Zipkin.Endpoint instance.

    FromConfig(ActorSystem)

    Used to extract all of the relevant data needed to bootstrap Zipkin from the Akka.Actor.ActorSystem itself.

    Declaration
    public static IntermediateZipkinOptions FromConfig(ActorSystem system)
    Parameters
    Type Name Description
    Akka.Actor.ActorSystem system

    The Akka.Actor.ActorSystem to which this Zipkin tracer will be paired.
    Returns
    Type Description
    IntermediateZipkinOptions

    A parsed IntermediateZipkinOptions

    FromConfig(Address, Config)

    Should only pass the phobos.tracing HOCON section into this method.

    Declaration
    public static IntermediateZipkinOptions FromConfig(Address uri, Config hocon)
    Parameters
    Type Name Description
    Akka.Actor.Address uri

    The bound address of the current Akka.Actor.ActorSystem
    Akka.Configuration.Config hocon

    The phobos.tracing HOCON section.
    Returns
    Type Description
    IntermediateZipkinOptions

    A parsed IntermediateZipkinOptions

    ParseSpanKind(String)

    Parses a string into an optional Petabridge.Tracing.Zipkin.SpanKind.

    Declaration
    public static SpanKind? ParseSpanKind(string spanKind)
    Parameters
    Type Name Description
    System.String spanKind

    The kind of span we'll be logging by default.
    Returns
    Type Description
    System.Nullable<Petabridge.Tracing.Zipkin.SpanKind>

    A Petabridge.Tracing.Zipkin.SpanKind or null.