This is an automated email from the ASF dual-hosted git repository.
rzo1 pushed a commit to branch experimental/prometheus_cluster_details_wip
in repository https://gitbox.apache.org/repos/asf/storm.git
The following commit(s) were added to
refs/heads/experimental/prometheus_cluster_details_wip by this push:
new bf59e13b3 WIP
bf59e13b3 is described below
commit bf59e13b36a71ac3e1bb530281c037e25e7d3cfd
Author: Richard Zowalla <[email protected]>
AuthorDate: Fri Jun 7 21:09:10 2024 +0200
WIP
---
external/storm-metrics-prometheus/README.md | 28 +++++++---------------------
external/storm-metrics-prometheus/pom.xml | 24 +++---------------------
2 files changed, 10 insertions(+), 42 deletions(-)
diff --git a/external/storm-metrics-prometheus/README.md
b/external/storm-metrics-prometheus/README.md
index df071a052..b67f2fb16 100644
--- a/external/storm-metrics-prometheus/README.md
+++ b/external/storm-metrics-prometheus/README.md
@@ -1,16 +1,18 @@
# Storm Metrics Prometheus
-This module provides [Cluster
Metrics](https://storm.apache.org/releases/current/metrics_v2.html) via
-a [Prometheus Pushgateway](https://github.com/prometheus/pushgateway).
+This module contains a reporter to push [Cluster
Metrics](https://storm.apache.org/releases/current/metrics_v2.html) to
+a [Prometheus Pushgateway](https://github.com/prometheus/pushgateway), where
it can be scraped by a Prometheus instance.
## Usage
-To use, edit the storm.yaml config file:
+To use, edit your `storm.yaml` config file:
+
```yaml
storm.daemon.metrics.reporter.plugins:
- "org.apache.storm.metrics.prometheus.PrometheusPreparableReporter"
storm.daemon.metrics.reporter.interval.secs: 10
+# Configuration for the Prometheus Pushgateway
storm.daemon.metrics.reporter.plugin.prometheus.job: "job_name"
storm.daemon.metrics.reporter.plugin.prometheus.endpoint: "localhost:9091"
storm.daemon.metrics.reporter.plugin.prometheus.scheme: "http"
@@ -19,21 +21,5 @@
storm.daemon.metrics.reporter.plugin.prometheus.basic_auth_password: ""
storm.daemon.metrics.reporter.plugin.prometheus.skip_tls_validation: false
```
-## License
-
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you 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.
+In addition, ensure to put this jar as well as the required transient
+dependencies for prometheus into `/lib` of your Storm installation.
diff --git a/external/storm-metrics-prometheus/pom.xml
b/external/storm-metrics-prometheus/pom.xml
index 7db062c21..55d1096bb 100644
--- a/external/storm-metrics-prometheus/pom.xml
+++ b/external/storm-metrics-prometheus/pom.xml
@@ -39,8 +39,7 @@
<groupId>org.apache.storm</groupId>
<artifactId>storm-server</artifactId>
<version>${project.version}</version>
- <!-- keep storm out of the jar-with-dependencies -->
- <scope>${provided.scope}</scope>
+ <scope>provided</scope>
</dependency>
<dependency>
<groupId>io.prometheus</groupId>
@@ -52,18 +51,6 @@
<artifactId>prometheus-metrics-exporter-pushgateway</artifactId>
<version>${prometheus.client.version}</version>
</dependency>
-
- <!-- test dependencies -->
- <dependency>
- <groupId>org.mockito</groupId>
- <artifactId>mockito-core</artifactId>
- <scope>test</scope>
- </dependency>
- <dependency>
- <groupId>org.hamcrest</groupId>
- <artifactId>hamcrest</artifactId>
- <scope>test</scope>
- </dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
@@ -82,18 +69,13 @@
<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>testcontainers</artifactId>
- <version>1.19.8</version>
- <scope>test</scope>
- </dependency>
- <dependency>
- <groupId>org.awaitility</groupId>
- <artifactId>awaitility</artifactId>
+ <version>${testcontainers.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>junit-jupiter</artifactId>
- <version>1.19.6</version>
+ <version>${testcontainers.version}</version>
<scope>test</scope>
</dependency>
</dependencies>
