io.camunda.zeebe.qa.util.actuator.PartitionsActuator Maven / Gradle / Ivy

Go to download
/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH under
 * one or more contributor license agreements. See the NOTICE file distributed
 * with this work for additional information regarding copyright ownership.
 * Licensed under the Zeebe Community License 1.1. You may not use this file
 * except in compliance with the Zeebe Community License 1.1.
 */
package io.camunda.zeebe.qa.util.actuator;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import feign.Feign;
import feign.Headers;
import feign.RequestLine;
import feign.Retryer;
import feign.Target.HardCodedTarget;
import feign.jackson.JacksonDecoder;
import feign.jackson.JacksonEncoder;
import io.camunda.zeebe.qa.util.cluster.TestStandaloneBroker;
import io.zeebe.containers.ZeebeBrokerNode;
import java.util.Map;

/**
 * Java interface for the broker's partitions actuator (roughly mapping to the broker admin
 * service). To instantiate this interface, you can use {@link Feign}; see {@link #of(String)} as an
 * example.
 *
 * You can use one of {@link #of(String)} or {@link #of(ZeebeBrokerNode)} 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). See {@link LoggersActuator} for a more complete
 * example.
 */
@SuppressWarnings({"unused", "UnusedReturnValue"})
public interface PartitionsActuator {

  /**
   * Returns a {@link PartitionsActuator} instance using the given node as upstream. This only
   * accepts {@link ZeebeBrokerNode} at the moment, as only the broker has this actuator. It can be
   * changed if we move these to the gateway.
   *
   * @param node the node to connect to
   * @return a new instance of {@link PartitionsActuator}
   */
  static PartitionsActuator of(final ZeebeBrokerNode node) {
    final var endpoint =
        String.format("http://%s/actuator/partitions", node.getExternalMonitoringAddress());
    return of(endpoint);
  }

  /**
   * Returns a {@link PartitionsActuator} instance using the given node as upstream. This only
   * accepts {@link TestStandaloneBroker} at the moment, as only the broker has this actuator. It
   * can be changed if we move these to the gateway.
   *
   * @param node the node to connect to
   * @return a new instance of {@link PartitionsActuator}
   */
  static PartitionsActuator of(final TestStandaloneBroker node) {
    return of(node.actuatorUri("partitions").toString());
  }

  /**
   * Returns a {@link PartitionsActuator} instance using the given endpoint as upstream. The
   * endpoint is expected to be a complete absolute URL, e.g.
   * "http://localhost:9600/actuator/partitions".
   *
   * @param endpoint the actuator URL to connect to
   * @return a new instance of {@link PartitionsActuator}
   */
  @SuppressWarnings("JavadocLinkAsPlainText")
  static PartitionsActuator of(final String endpoint) {
    final var target = new HardCodedTarget<>(PartitionsActuator.class, endpoint);
    return Feign.builder()
        .encoder(new JacksonEncoder())
        .decoder(new JacksonDecoder())
        .retryer(Retryer.NEVER_RETRY)
        .target(target);
  }

  @RequestLine("GET")
  @Headers("Accept: application/json")
  Map query();

  @RequestLine("POST /pauseExporting")
  @Headers({"Content-Type: application/json", "Accept: application/json"})
  Map pauseExporting();

  @RequestLine("POST /softPauseExporting")
  @Headers({"Content-Type: application/json", "Accept: application/json"})
  Map softPauseExporting();

  @RequestLine("POST /resumeExporting")
  @Headers({"Content-Type: application/json", "Accept: application/json"})
  Map resumeExporting();

  @RequestLine("POST /pauseProcessing")
  @Headers({"Content-Type: application/json", "Accept: application/json"})
  Map pauseProcessing();

  @RequestLine("POST /resumeProcessing")
  @Headers({"Content-Type: application/json", "Accept: application/json"})
  Map resumeProcessing();

  @RequestLine("POST /takeSnapshot")
  @Headers({"Content-Type: application/json", "Accept: application/json"})
  Map takeSnapshot();

  @RequestLine("POST /prepareUpgrade")
  @Headers({"Content-Type: application/json", "Accept: application/json"})
  Map prepareUpgrade();

  @JsonIgnoreProperties(ignoreUnknown = true)
  record PartitionStatus(
      String role,
      String snapshotId,
      Long processedPosition,
      Long processedPositionInSnapshot,
      String streamProcessorPhase,
      Long exportedPosition,
      String exporterPhase) {}
}