Move PrometheusServerProvider and PrometheusExporterPortProvider to oss (#2461)

Author: ShaunakDas88

src/main/java/com/datastax/fallout/components/metrics/ExistingPromPushProvisioner.java

@@ -33,19 +33,19 @@ public class ExistingPromPushProvisioner extends NoRemoteAccessProvisioner
 {
     private static final String PREFIX = "fallout.configuration.management.existing_prompush.";
     private static final String NAME = "existing_prompush";
-    private static final String DESCRIPTION = "For exporting metrics to an existing Prometheus PushGateway";
+    private static final String DESCRIPTION = "For exporting metrics to an existing Prometheus server";
 
     static final PropertySpec<String> hostUriSpec = PropertySpecBuilder
         .createStr(PREFIX)
         .name("host")
-        .description("Host URI for the existing Prometheus PushGateway API")
+        .description("Host URI for the existing Prometheus server")
         .required()
         .build();
 
     static final PropertySpec<Integer> portSpec = PropertySpecBuilder
         .createInt(PREFIX)
         .name("port")
-        .description("The port for the existing Prometheus PushGateway API")
+        .description("The port for the existing Prometheus server")
         .required()
         .build();
 
@@ -104,17 +104,17 @@ public void validateProperties(PropertyGroup properties) throws PropertySpec.Val
     @Override
     public void doSummarizeInfo(InfoConsumer infoConsumer)
     {
-        getNodeGroup().findFirstProvider(PromPushProvider.class)
+        getNodeGroup().findFirstProvider(PrometheusServerPushProvider.class)
             .ifPresent(p -> {
-                infoConsumer.accept("host_uri", p.getHostUri());
-                infoConsumer.accept("prompush_port", p.getPort());
+                infoConsumer.accept("host", p.getHost());
+                infoConsumer.accept("port", p.getPort());
             });
     }
 
     @Override
     public Set<Class<? extends Provider>> getAvailableProviders(PropertyGroup properties)
     {
-        return Set.of(PromPushProvider.class);
+        return Set.of(PrometheusServerPushProvider.class);
     }
 
     @Override
@@ -140,21 +140,18 @@ protected NodeGroup.State checkStateImpl(NodeGroup nodeGroup)
     {
         if (!createProviders(nodeGroup))
             return NodeGroup.State.FAILED;
-        PromPushProvider provider = nodeGroup.findFirstRequiredProvider(PromPushProvider.class);
+        PrometheusServerPushProvider provider = nodeGroup.findFirstRequiredProvider(PrometheusServerPushProvider.class);
         // fail fast if issues connecting to prom pushgateway
-        String uri = String.format("%s:%d/metrics", provider.getHostUri(), provider.getPort());
+        String uri = provider.getMetricsEndpoint();
         try
         {
-            HttpUtils.httpGetString(
-                uri,
-                Optional.ofNullable(provider.getApiKey())
-            );
-            nodeGroup.logger().info("Successfully verified existing Prometheus PushGateway API");
+            HttpUtils.httpGetString(uri, provider.getApiKey());
+            nodeGroup.logger().info("Successfully verified existing Prometheus server");
             return NodeGroup.State.STARTED_SERVICES_CONFIGURED;
         }
         catch (IOException e)
         {
-            nodeGroup.logger().error("Failed to connect to existing Prometheus PushGateway API");
+            nodeGroup.logger().error("Failed to connect to existing Prometheus server");
             return NodeGroup.State.FAILED;
         }
     }
@@ -163,8 +160,8 @@ private boolean createProviders(NodeGroup nodeGroup)
     {
         String hostUri = hostUriSpec.value(nodeGroup.getProperties());
         Integer promPushPort = portSpec.value(nodeGroup.getProperties());
-        String apiKey = apiKeySpec.value(nodeGroup.getProperties());
-        new PromPushProvider(
+        Optional<String> apiKey = apiKeySpec.optionalValue(nodeGroup.getProperties());
+        new PrometheusServerPushProvider(
             getNodeGroup().getNodes().get(0),
             hostUri,
             promPushPort,
@@ -188,7 +185,7 @@ protected boolean stopImpl(NodeGroup nodeGroup)
     @Override
     protected boolean destroyImpl(NodeGroup nodeGroup)
     {
-        nodeGroup.getNodes().get(0).maybeUnregister(PromPushProvider.class);
+        nodeGroup.getNodes().get(0).maybeUnregister(PrometheusServerPushProvider.class);
         return true;
     }
 

…components/metrics/PromPushProvider.java …rics/PrometheusExporterPortProvider.javasrc/main/java/com/datastax/fallout/components/metrics/PromPushProvider.java renamed to src/main/java/com/datastax/fallout/components/metrics/PrometheusExporterPortProvider.java src/main/java/com/datastax/fallout/components/metrics/PromPushProvider.java renamed to src/main/java/com/datastax/fallout/components/metrics/PrometheusExporterPortProvider.java

@@ -20,54 +20,30 @@
 import com.datastax.fallout.ops.Node;
 import com.datastax.fallout.ops.Provider;
 
-public class PromPushProvider extends Provider
+public class PrometheusExporterPortProvider extends Provider
 {
-    public static final String prompushKeySubdir = "prompush";
-    private final String hostUri;
-    private final Integer promPushPort;
-    private final String apiKey;
+    final int port;
 
-    public PromPushProvider(Node node, String hostUri, Integer promPushPort, String apiKey)
+    public PrometheusExporterPortProvider(Node node, int port)
     {
         super(node);
-        this.hostUri = hostUri;
-        this.promPushPort = promPushPort;
-        this.apiKey = apiKey;
+        this.port = port;
     }
 
     @Override
     public String name()
     {
-        return "prompush";
+        return "PrometheusExporterPortProvider";
     }
 
-    public String getHostUri()
+    public int getPort()
     {
-        return hostUri;
-    }
-
-    public Integer getPort()
-    {
-        return promPushPort;
-    }
-
-    public String getApiKey()
-    {
-        return apiKey;
+        return port;
     }
 
     @Override
     public Map<String, String> toInfoMap()
     {
-        return Map.of(
-            "host_uri", hostUri,
-            "prompush_port", String.valueOf(promPushPort)
-        );
-    }
-
-    @Override
-    public boolean isNodeGroupProvider()
-    {
-        return true;
+        return Map.of("port", "" + port);
     }
 }

src/main/java/com/datastax/fallout/components/metrics/PrometheusServerProvider.java

@@ -0,0 +1,89 @@
+/*
+ * Copyright 2025 DataStax, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.datastax.fallout.components.metrics;
+
+import java.util.Map;
+import java.util.Optional;
+
+import com.datastax.fallout.ops.Node;
+import com.datastax.fallout.ops.Provider;
+
+// Represents a Prometheus server that scrapes metrics from source(s)
+public class PrometheusServerProvider extends Provider
+{
+    protected final String host;
+    protected final Integer port;
+    protected final Optional<String> apiKey;
+
+    public PrometheusServerProvider(Node node, String host, Integer port)
+    {
+        this(node, host, port, Optional.empty());
+    }
+
+    public PrometheusServerProvider(Node node, String host, Integer port, Optional<String> apiKey)
+    {
+        super(node);
+        this.host = host;
+        this.port = port;
+        this.apiKey = apiKey;
+    }
+
+    @Override
+    public String name()
+    {
+        return "PrometheusServerProvider";
+    }
+
+    @Override
+    public Map<String, String> toInfoMap()
+    {
+        return Map.of(
+            "host", host,
+            "port", String.valueOf(port)
+        );
+    }
+
+    public String getHost()
+    {
+        return host;
+    }
+
+    public Integer getPort()
+    {
+        return port;
+    }
+
+    public Optional<String> getApiKey()
+    {
+        return apiKey;
+    }
+
+    public String getMetricsEndpoint()
+    {
+        return String.format("%s:%d/metrics", host, port);
+    }
+
+    public String getQueryEndpoint()
+    {
+        return String.format("%s:%d/api/v1/query", host, port);
+    }
+
+    public String getQueryRangeEndpoint()
+    {
+        return String.format("%s:%d/api/v1/query_range", host, port);
+    }
+
+}

src/main/java/com/datastax/fallout/components/metrics/PrometheusServerPushProvider.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2025 DataStax, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.datastax.fallout.components.metrics;
+
+import java.util.Optional;
+
+import com.datastax.fallout.ops.Node;
+
+// Represents a Prometheus server that can scrape as well as have metrics pushed to it
+public class PrometheusServerPushProvider extends PrometheusServerProvider
+{
+    public static final String promPushKeySubdir = "prompush";
+
+    public PrometheusServerPushProvider(Node node, String host, Integer port, Optional<String> apiKey)
+    {
+        super(node, host, port, apiKey);
+    }
+
+    @Override
+    public String name()
+    {
+        return "PrometheusServerPush";
+    }
+
+    public String getImportEndpoint()
+    {
+        return String.format("%s:%d/api/v1/import", host, port);
+    }
+}