Add grafana module (#8851)

Add Grafana Otel LGTM container implementation.

Expose ports for Grafana (3000), OTLP GRPC (4317), OTLP HTTP (4318)
and Prometheus (9090). Also, utility methods to get URLs.

Co-authored-by: Kevin Wittek <[email protected]>

Author: eddumelendez

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -27,6 +27,7 @@ body:
         - Dynalite
         - Elasticsearch
         - GCloud
+        - Grafana
         - HiveMQ
         - InfluxDB
         - K3S

.github/ISSUE_TEMPLATE/enhancement.yaml

@@ -27,6 +27,7 @@ body:
         - Dynalite
         - Elasticsearch
         - GCloud
+        - Grafana
         - HiveMQ
         - InfluxDB
         - K3S

.github/ISSUE_TEMPLATE/feature.yaml

@@ -27,6 +27,7 @@ body:
         - Dynalite
         - Elasticsearch
         - GCloud
+        - Grafana
         - HiveMQ
         - InfluxDB
         - K3S

.github/dependabot.yml

@@ -106,6 +106,11 @@ updates:
     schedule:
       interval: "weekly"
     open-pull-requests-limit: 10
+  - package-ecosystem: "gradle"
+    directory: "/modules/grafana"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10
   - package-ecosystem: "gradle"
     directory: "/modules/hivemq"
     schedule:

.github/labeler.yml

@@ -67,6 +67,10 @@
   - changed-files:
     - any-glob-to-any-file:
       - modules/gcloud/**/*
+"modules/grafana":
+  - changed-files:
+    - any-glob-to-any-file:
+      - modules/grafana/**/*
 "modules/hivemq":
   - changed-files:
     - any-glob-to-any-file:

.github/settings.yml

@@ -145,6 +145,9 @@ labels:
   - name: modules/gcloud
     color: '#006b75'
 
+  - name: modules/grafana
+    color: '#006b75'
+
   - name: modules/hivemq
     color: '#006b75'
 

docs/modules/grafana.md

@@ -0,0 +1,28 @@
+# Grafana
+
+Testcontainers module for [Grafana OTel LGTM](https://hub.docker.com/r/grafana/otel-lgtm).
+
+## LGTM's usage examples
+
+You can start a Grafana OTel LGTM container instance from any Java application by using:
+
+<!--codeinclude-->
+[Grafana Otel LGTM container](../../modules/grafana/src/test/java/org/testcontainers/grafana/LgtmStackContainerTest.java) inside_block:container
+<!--/codeinclude-->
+
+Add the following dependency to your `pom.xml`/`build.gradle` file:
+
+=== "Gradle"
+    ```groovy
+    testImplementation "org.testcontainers:grafana:{{latest_version}}"
+    ```
+
+=== "Maven"
+    ```xml
+    <dependency>
+        <groupId>org.testcontainers</groupId>
+        <artifactId>grafana</artifactId>
+        <version>{{latest_version}}</version>
+        <scope>test</scope>
+    </dependency>
+    ```

mkdocs.yml

@@ -81,6 +81,7 @@ nav:
           - modules/docker_compose.md
           - modules/elasticsearch.md
           - modules/gcloud.md
+          - modules/grafana.md
           - modules/hivemq.md
           - modules/k3s.md
           - modules/k6.md

modules/grafana/build.gradle

@@ -0,0 +1,23 @@
+description = "Testcontainers :: Grafana"
+
+dependencies {
+    api project(':testcontainers')
+
+    testImplementation 'org.assertj:assertj-core:3.25.3'
+    testImplementation 'io.rest-assured:rest-assured:5.4.0'
+    testImplementation 'io.micrometer:micrometer-registry-otlp:1.13.1'
+    testImplementation 'uk.org.webcompere:system-stubs-junit4:2.1.6'
+}
+
+test {
+    javaLauncher = javaToolchains.launcherFor {
+        languageVersion = JavaLanguageVersion.of(11)
+    }
+}
+
+compileTestJava {
+    javaCompiler = javaToolchains.compilerFor {
+        languageVersion = JavaLanguageVersion.of(11)
+    }
+    options.release.set(11)
+}

modules/grafana/src/main/java/org/testcontainers/grafana/LgtmStackContainer.java

@@ -0,0 +1,64 @@
+package org.testcontainers.grafana;
+
+import com.github.dockerjava.api.command.InspectContainerResponse;
+import lombok.extern.slf4j.Slf4j;
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.containers.wait.strategy.Wait;
+import org.testcontainers.utility.DockerImageName;
+
+/**
+ * Testcontainers implementation for Grafana OTel LGTM.
+ * <p>
+ * Supported image: {@code grafana/otel-lgtm}
+ * <p>
+ * Exposed ports:
+ * <ul>
+ *     <li>Grafana: 3000</li>
+ *     <li>OTel Http: 4317</li>
+ *     <li>OTel Grpc: 4318</li>
+ *     <li>Prometheus: 9090</li>
+ * </ul>
+ */
+@Slf4j
+public class LgtmStackContainer extends GenericContainer<LgtmStackContainer> {
+
+    private static final DockerImageName DEFAULT_IMAGE_NAME = DockerImageName.parse("grafana/otel-lgtm");
+
+    private static final int GRAFANA_PORT = 3000;
+
+    private static final int OTLP_GRPC_PORT = 4317;
+
+    private static final int OTLP_HTTP_PORT = 4318;
+
+    private static final int PROMETHEUS_PORT = 9090;
+
+    public LgtmStackContainer(String image) {
+        this(DockerImageName.parse(image));
+    }
+
+    public LgtmStackContainer(DockerImageName image) {
+        super(image);
+        image.assertCompatibleWith(DEFAULT_IMAGE_NAME);
+        withExposedPorts(GRAFANA_PORT, OTLP_GRPC_PORT, OTLP_HTTP_PORT, PROMETHEUS_PORT);
+        waitingFor(
+            Wait.forLogMessage(".*The OpenTelemetry collector and the Grafana LGTM stack are up and running.*\\s", 1)
+        );
+    }
+
+    @Override
+    protected void containerIsStarted(InspectContainerResponse containerInfo) {
+        log.info("Access to the Grafana dashboard: {}", getOtlpHttpUrl());
+    }
+
+    public String getOtlpGrpcUrl() {
+        return "http://" + getHost() + ":" + getMappedPort(OTLP_GRPC_PORT);
+    }
+
+    public String getOtlpHttpUrl() {
+        return "http://" + getHost() + ":" + getMappedPort(OTLP_HTTP_PORT);
+    }
+
+    public String getPromehteusHttpUrl() {
+        return "http://" + getHost() + ":" + getMappedPort(PROMETHEUS_PORT);
+    }
+}