Package org.acemq.amqp.actuator

Class ActuatorOptions

java.lang.Object
org.acemq.amqp.actuator.ActuatorOptions
public final class ActuatorOptions extends Object
How an AceMqActuator is exposed.

Every default is the one the Go and .NET libraries use, so an operator moving between services in different languages meets the same port and the same three paths. 


 AceMqActuator actuator = AceMqActuator.start(ActuatorOptions.builder()
         .connection(mq)
         .application("orders", "1.4.2")
         .build());

  • Field Details

    • DEFAULT_METRICS_PATH

      public static final String DEFAULT_METRICS_PATH
      Prometheus text format.
      See Also:

    • DEFAULT_HEALTH_PATH

      public static final String DEFAULT_HEALTH_PATH
      Connection health, as JSON.
      See Also:

    • DEFAULT_INFO_PATH

      public static final String DEFAULT_INFO_PATH
      Library version, application version and transport capabilities, as JSON.
      See Also:

    • DEFAULT_PORT

      public static final int DEFAULT_PORT
      The OpenTelemetry convention for a Prometheus endpoint, and what Go and .NET use.
      See Also:

  • Method Details

    • builder

      public static ActuatorOptions.Builder builder()
      Returns:
      a builder holding the defaults

    • connection

      public @Nullable AceMq connection()
      Returns:
      the connection health and info report on, absent when none was supplied

    • bindAddress

      public String bindAddress()
      Returns:
      the interface to listen on

    • port

      public int port()
      Returns:
      the port to listen on, or 0 to take whatever the operating system gives

    • metricsPath

      public String metricsPath()
      Returns:
      the path serving the Prometheus text format

    • healthPath

      public String healthPath()
      Returns:
      the path serving the health report

    • infoPath

      public String infoPath()
      Returns:
      the path serving library and transport information

    • applicationName

      public @Nullable String applicationName()
      Returns:
      what the application calls itself, for /acemq-info

    • applicationVersion

      public @Nullable String applicationVersion()
      Returns:
      the application's own version, for /acemq-info

    • registry

      public @Nullable io.micrometer.prometheusmetrics.PrometheusMeterRegistry registry()
      Returns:
      the registry to scrape, or absent to have the actuator create one

    • attachToGlobalRegistry

      public boolean attachToGlobalRegistry()
      Returns:
      whether a registry the actuator created is added to Micrometer's global one