Package 

Interface OpenTelemetryRum

  • 
public interface OpenTelemetryRum

    Entrypoint for the OpenTelemetry Real User Monitoring library for Android.

    This class is internal and is hence not for public use. Its APIs are unstable and can change at any time.

    • Method Detail

      • builder

         static OpenTelemetryRumBuilder builder(Application application)

        Returns a new OpenTelemetryRumBuilder for OpenTelemetryRum with a defaultconfiguration. Use this version if you would like to configure individual aspects of theOpenTelemetry SDK but would still prefer to allow OpenTelemetry RUM to create the SDK foryou. For additional configuration, call the two-argument version of build and pass it your OtelRumConfig instance. If you would like to "bring your own" SDK, call thetwo-argument version that takes the SDK as a parameter.

        Parameters:
        application - The Application that is being instrumented.

      • builder

         static SdkPreconfiguredRumBuilder builder(Application application, OpenTelemetrySdk openTelemetrySdk)

        Returns a new SdkPreconfiguredRumBuilder for OpenTelemetryRum. This versionrequires the user to preconfigure and create their own OpenTelemetrySdk instance. If youprefer to use the builder to configure individual aspects of the OpenTelemetry SDK and tocreate and manage it for you, call the one-argument version.

        Specific consideration should be given to the creation of your provided SDK to ensure thatthe SdkTracerProvider, SdkMeterProvider, and SdkLoggerProvider areconfigured correctly for your target RUM provider.

        Parameters:
        application - The Application that is being instrumented.
        openTelemetrySdk - The OpenTelemetrySdk that the user has already created.

      • getOpenTelemetry

         abstract OpenTelemetry getOpenTelemetry()

        Get a handle to the instance of the OpenTelemetry API that thisinstance is using for instrumentation.

      • getRumSessionId

         abstract String getRumSessionId()

        Get the client session ID associated with this instance of the RUM instrumentation library.Note: this value will change throughout the lifetime of an application instance, so it isrecommended that you do not cache this value, but always retrieve it from here when needed.