wip

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Author: csviri

docs/content/en/docs/migration/v5-3-migration.md

@@ -4,7 +4,7 @@ description: Migrating from v5.2 to v5.3
 ---
 
 
-## Renamed JUnit Module
+## Rename of JUnit module
 
 If you use JUnit extension in your test just rename it from:
 
@@ -44,7 +44,7 @@ The following table shows the relevant method renames:
 | `finishedReconciliation`           | `reconciliationFinished`     |
 | `cleanupDoneFor`                   | `cleanupDone`                |
 | `receivedEvent`                    | `eventReceived`              |
-| `timeControllerExecution`          | `timedControllerExecution`   |
+
 
 Other changes:
 - `reconciliationFinished(..)` method is extended with `RetryInfo`

micrometer-support/src/main/java/io/javaoperatorsdk/operator/monitoring/micrometer/MicrometerMetrics.java

@@ -146,7 +146,7 @@ public void controllerRegistered(Controller<? extends HasMetadata> controller) {
   }
 
   @Override
-  public <T> T timedControllerExecution(ControllerExecution<T> execution) {
+  public <T> T timeControllerExecution(ControllerExecution<T> execution) {
     final var name = execution.controllerName();
     final var execName = PREFIX + CONTROLLERS_EXECUTION + execution.name();
     final var resourceID = execution.resourceID();

micrometer-support/src/main/java/io/javaoperatorsdk/operator/monitoring/micrometer/MicrometerMetricsV2.java

@@ -156,7 +156,7 @@ private String numberOfResourcesRefName(String name) {
   }
 
   @Override
-  public <T> T timedControllerExecution(ControllerExecution<T> execution) {
+  public <T> T timeControllerExecution(ControllerExecution<T> execution) {
     final var name = execution.controllerName();
     final var timer = executionTimers.get(name);
     return timer.record(

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/monitoring/AggregatedMetrics.java

@@ -34,7 +34,7 @@
  * All method calls are delegated to each metrics instance in the list in the order they were
  * provided to the constructor.
  *
- * <p><strong>Important:</strong> The {@link #timedControllerExecution(ControllerExecution)} method
+ * <p><strong>Important:</strong> The {@link #timeControllerExecution(ControllerExecution)} method
  * is handled specially - it is only invoked on the first metrics instance in the list, since it's
  * not an idempotent operation and can only be executed once. The controller execution cannot be
  * repeated multiple times as it would produce side effects and potentially inconsistent results.
@@ -110,7 +110,7 @@ public void reconciliationSucceeded(HasMetadata resource, Map<String, Object> me
   }
 
   @Override
-  public <T> T timedControllerExecution(ControllerExecution<T> execution) throws Exception {
-    return metricsList.get(0).timedControllerExecution(execution);
+  public <T> T timeControllerExecution(ControllerExecution<T> execution) throws Exception {
+    return metricsList.get(0).timeControllerExecution(execution);
   }
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/monitoring/Metrics.java

@@ -115,7 +115,7 @@ default void cleanupDone(ResourceID resourceID, Map<String, Object> metadata) {}
    * {@link io.javaoperatorsdk.operator.api.reconciler.Cleaner#cleanup(HasMetadata, Context)}. Note
    * that instances are automatically created for you by the SDK and passed to your Metrics
    * implementation at the appropriate time to the {@link
-   * #timedControllerExecution(ControllerExecution)} method.
+   * #timeControllerExecution(ControllerExecution)} method.
    *
    * @param <T> the outcome type associated with the controller execution. Currently, one of {@link
    *     io.javaoperatorsdk.operator.api.reconciler.UpdateControl} or {@link
@@ -184,7 +184,7 @@ interface ControllerExecution<T> {
    * @throws Exception if an error occurred during the controller's execution, usually this should
    *     just be a pass-through of whatever the controller returned
    */
-  default <T> T timedControllerExecution(ControllerExecution<T> execution) throws Exception {
+  default <T> T timeControllerExecution(ControllerExecution<T> execution) throws Exception {
     return execution.execute();
   }
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/Controller.java

@@ -143,7 +143,7 @@ public Controller(
 
   @Override
   public UpdateControl<P> reconcile(P resource, Context<P> context) throws Exception {
-    return metrics.timedControllerExecution(
+    return metrics.timeControllerExecution(
         new ControllerExecution<>() {
           @Override
           public String name() {
@@ -196,7 +196,7 @@ public UpdateControl<P> execute() throws Exception {
   @Override
   public DeleteControl cleanup(P resource, Context<P> context) {
     try {
-      return metrics.timedControllerExecution(
+      return metrics.timeControllerExecution(
           new ControllerExecution<>() {
             @Override
             public String name() {

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/api/monitoring/AggregatedMetricsTest.java

@@ -150,30 +150,30 @@ void reconciliationSucceeded_shouldDelegateToAllMetricsInOrder() {
   }
 
   @Test
-  void timedControllerExecution_shouldOnlyDelegateToFirstMetrics() throws Exception {
+  void timeControllerExecution_shouldOnlyDelegateToFirstMetrics() throws Exception {
     final var expectedResult = "execution result";
-    when(metrics1.timedControllerExecution(controllerExecution)).thenReturn(expectedResult);
+    when(metrics1.timeControllerExecution(controllerExecution)).thenReturn(expectedResult);
 
-    final var result = aggregatedMetrics.timedControllerExecution(controllerExecution);
+    final var result = aggregatedMetrics.timeControllerExecution(controllerExecution);
 
     assertThat(result).isEqualTo(expectedResult);
-    verify(metrics1).timedControllerExecution(controllerExecution);
-    verify(metrics2, never()).timedControllerExecution(any());
-    verify(metrics3, never()).timedControllerExecution(any());
+    verify(metrics1).timeControllerExecution(controllerExecution);
+    verify(metrics2, never()).timeControllerExecution(any());
+    verify(metrics3, never()).timeControllerExecution(any());
     verifyNoMoreInteractions(metrics1, metrics2, metrics3);
   }
 
   @Test
-  void timedControllerExecution_shouldPropagateException() throws Exception {
+  void timeControllerExecution_shouldPropagateException() throws Exception {
     final var expectedException = new RuntimeException("Controller execution failed");
-    when(metrics1.timedControllerExecution(controllerExecution)).thenThrow(expectedException);
+    when(metrics1.timeControllerExecution(controllerExecution)).thenThrow(expectedException);
 
-    assertThatThrownBy(() -> aggregatedMetrics.timedControllerExecution(controllerExecution))
+    assertThatThrownBy(() -> aggregatedMetrics.timeControllerExecution(controllerExecution))
         .isSameAs(expectedException);
 
-    verify(metrics1).timedControllerExecution(controllerExecution);
-    verify(metrics2, never()).timedControllerExecution(any());
-    verify(metrics3, never()).timedControllerExecution(any());
+    verify(metrics1).timeControllerExecution(controllerExecution);
+    verify(metrics2, never()).timeControllerExecution(any());
+    verify(metrics3, never()).timeControllerExecution(any());
     verifyNoMoreInteractions(metrics1, metrics2, metrics3);
   }
 }

sample-operators/metrics-processing/src/test/java/io/javaoperatorsdk/operator/sample/metrics/MetricsHandlingE2E.java

@@ -52,14 +52,12 @@ class MetricsHandlingE2E {
   static final Logger log = LoggerFactory.getLogger(MetricsHandlingE2E.class);
   static final String OBSERVABILITY_NAMESPACE = "observability";
   static final int PROMETHEUS_PORT = 9090;
-  static final int GRAFANA_PORT = 3000;
   static final int OTEL_COLLECTOR_PORT = 4318;
   public static final Duration TEST_DURATION = Duration.ofSeconds(60);
   public static final String NAME_LABEL_KEY = "app.kubernetes.io/name";
 
   private LocalPortForward prometheusPortForward;
   private LocalPortForward otelCollectorPortForward;
-  private LocalPortForward grafanaPortForward;
 
   static final KubernetesClient client = new KubernetesClientBuilder().build();
 
@@ -90,7 +88,6 @@ void setupObservability() throws InterruptedException {
     if (isLocal()) {
       otelCollectorPortForward =
           portForward(NAME_LABEL_KEY, "otel-collector-collector", OTEL_COLLECTOR_PORT);
-      grafanaPortForward = portForward(NAME_LABEL_KEY, "grafana", GRAFANA_PORT);
     }
     Thread.sleep(2000);
   }
@@ -99,7 +96,6 @@ void setupObservability() throws InterruptedException {
   void cleanup() throws IOException {
     closePortForward(prometheusPortForward);
     closePortForward(otelCollectorPortForward);
-    closePortForward(grafanaPortForward);
   }
 
   private LocalPortForward portForward(String labelKey, String labelValue, int port) {