Package 

Interface SignalConfiguration


  • 
    public interface SignalConfiguration
    
                        

    Provides an OpenTelemetry objects which handle the APM backend connectivity for all signals.

    • Method Summary

      Modifier and Type Method Description
      static DefaultSignalConfiguration create() This function provides a convenient way of creating a common SignalConfiguration object thatrequires and endpoint URL, and optionally a server secret token for Bearer authentication purposes.
      static SignalConfiguration custom(SpanExporter spanExporter, LogRecordExporter logExporter, MetricExporter metricExporter) This function provides a convenient way to create a SignalConfiguration with a custom OpenTelemetry's SpanExporter, LogRecordExporter and MetricExporter which processors will be BatchSpanProcessor, BatchLogRecordProcessor and PeriodicMetricReader respectively.
      static SignalConfiguration custom(SpanProcessor spanProcessor, LogRecordProcessor logProcessor, MetricReader metricReader) This function provides a convenient way of creating a fully customized SignalConfiguration object by providinga SpanProcessor, LogRecordProcessor and a MetricReader directly.
      static SignalConfiguration getDefault() This function provides a SignalConfiguration instance that uses the server parameters defined at compile time.
      abstract SpanProcessor getSpanProcessor()
      abstract LogRecordProcessor getLogProcessor()
      abstract MetricReader getMetricReader()
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • create

         static DefaultSignalConfiguration create()

        This function provides a convenient way of creating a common SignalConfiguration object thatrequires and endpoint URL, and optionally a server secret token for Bearer authentication purposes.

        An example of using this function to create a configuration with a secret token:

         {@code SignalConfiguration myConfiguration = SignalConfiguration.create("https://my.server.url").withSecretToken("my_bearer_token");}
         
      • custom

         static SignalConfiguration custom(SpanExporter spanExporter, LogRecordExporter logExporter, MetricExporter metricExporter)

        This function provides a convenient way to create a SignalConfiguration with a custom OpenTelemetry's SpanExporter, LogRecordExporter and MetricExporter which processors will be BatchSpanProcessor, BatchLogRecordProcessor and PeriodicMetricReader respectively.

      • custom

         static SignalConfiguration custom(SpanProcessor spanProcessor, LogRecordProcessor logProcessor, MetricReader metricReader)

        This function provides a convenient way of creating a fully customized SignalConfiguration object by providinga SpanProcessor, LogRecordProcessor and a MetricReader directly. This option might come in handy to avoid having to create a custom SignalConfiguration implementation.