Package io.camunda.zeebe.qa.util.actuator

Interface LoggersActuator

public interface LoggersActuator
Java interface for any node's loggers actuator. To instantiate this interface, you can use Feign; see of(String) as an example.

You can use one of of(String) or of(ZeebeNode) to create a new client to use for yourself.

Adding a new method is simple: simply define the input/output here as you normally would, and make sure to add the correct JSON encoding headers (`Accept` for the response type, `Content-Type` if there's a body to send).

  • Method Details

    • of

      static LoggersActuator of(io.zeebe.containers.ZeebeNode<?> node)
      Returns a LoggersActuator instance using the given node as upstream.
      Parameters:
      node - the node to connect to
      Returns:
      a new instance of LoggersActuator

    • of

      static LoggersActuator of(TestApplication<?> node)
      Returns a LoggersActuator instance using the given node as upstream.
      Parameters:
      node - the node to connect to
      Returns:
      a new instance of LoggersActuator

    • of

      static LoggersActuator of(String endpoint)
      Returns a LoggersActuator instance using the given endpoint as upstream. The endpoint is expected to be a complete absolute URL, e.g. "http://localhost:9600/actuator/loggers".
      Parameters:
      endpoint - the actuator URL to connect to
      Returns:
      a new instance of LoggersActuator

    • set

      default void set(String id, org.slf4j.event.Level level)
      A convenience method to set the level of a logger remotely via the Spring Boot actuator, using SLF4J levels as input to avoid any errors (e.g. typos).
      Parameters:
      id - the logger ID, e.g. io.camunda.zeebe.gateway
      level - the level you wish to set

    • set

      void set(String id, LoggersActuator.LoggerInfo level)

    • get

      LoggersActuator.LoggerInfo get(String id)