Fix Spring Boot OpenTelemetry example (#50)

Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>

Author: jeremyprime

README.md

@@ -11,7 +11,7 @@ This project provides both the [core Spring Data Valkey library](spring-data-val
 * Connection package as low-level abstraction across multiple drivers ([Valkey GLIDE](https://github.com/valkey-io/valkey-glide), [Lettuce](https://github.com/lettuce-io/lettuce-core), and [Jedis](https://github.com/redis/jedis)).
 * Exception translation to Spring's portable Data Access exception hierarchy for driver exceptions.
 * `ValkeyTemplate` that provides a high level abstraction for performing various Valkey operations, exception translation and serialization support.
-* Pubsub support (such as a MessageListenerContainer for message-driven POJOs). Available with Jedis and Lettuce, with Valkey GLIDE support WIP for version 1.0.0.
+* Pubsub support (such as a MessageListenerContainer for message-driven POJOs).
 * OpenTelemetry instrumentation support when using the Valkey GLIDE client for emitting traces and metrics for Valkey operations.
 * Valkey Sentinel support is currently available in Jedis and Lettuce, while support in Valkey GLIDE is planned for a future release.
 * Reactive API using Lettuce.
@@ -30,10 +30,10 @@ This project provides both the [core Spring Data Valkey library](spring-data-val
 * Support for multiple Valkey drivers ([Valkey GLIDE](https://github.com/valkey-io/valkey-glide), [Lettuce](https://github.com/lettuce-io/lettuce-core), and [Jedis](https://github.com/redis/jedis)).
 * Connection pooling configuration for all supported clients.
 * Valkey Cluster auto-configuration and support.
-* Property-based OpenTelemetry configuration for Valkey GLIDE, enabling automatic trace and metric export without application code changes.
 * Valkey Sentinel configuration support (Lettuce and Jedis only).
 * SSL/TLS connection support with Spring Boot SSL bundles.
 * Spring Boot Actuator health indicators and metrics for Valkey connections.
+* Property-based OpenTelemetry configuration for Valkey GLIDE, enabling automatic trace and metric export without application code changes.
 * `@DataValkeyTest` slice test annotation for focused Valkey testing.
 * Testcontainers integration with `@ServiceConnection` annotation.
 * Docker Compose support for automatic service detection and startup.

examples/README.md

@@ -39,6 +39,8 @@ Replace `quickstart` with any example name below. To run from project root, use
 | **streams** | Valkey Streams for event sourcing and message queues (XADD, XREAD, consumer groups) |
 | **collections** | Valkey-backed Java collections (ValkeyList, ValkeySet, ValkeyMap) and atomic counters |
 | **scripting** | Lua script execution (EVAL, EVALSHA) for atomic operations |
+| **telemetry** | OpenTelemetry instrumentation with manual SDK setup for tracing and metrics |
+| **boot-telemetry** | Spring Boot with OpenTelemetry enabled via configuration properties and Docker Compose |
 
 ## Notes
 

examples/boot-telemetry/README.md

@@ -4,8 +4,6 @@ This example demonstrates using **Spring Boot** with **Spring Data Valkey**, bac
 
 On startup, the application executes a small number of Valkey `SET` / `GET` commands using `StringValkeyTemplate`. Each command is automatically instrumented by GLIDE and exported via OpenTelemetry.
 
----
-
 ## How it works
 
 - Spring Boot auto-configures all Valkey beans
@@ -16,17 +14,28 @@ On startup, the application executes a small number of Valkey `SET` / `GET` comm
 
 No explicit OpenTelemetry SDK or client setup code is required.
 
----
-
 ## Running the example
 
+From the project root:
+
 ```bash
-../../mvnw clean compile exec:java
-````
+$ ./mvnw -q compile exec:java -pl examples/boot-telemetry
+```
+
+Or from this boot-telemetry folder:
+
+```bash
+$ ../../mvnw -q compile exec:java -Dspring.docker.compose.file=compose.yaml
+```
 
 Docker Compose is started automatically and kept running after the application exits.
 
----
+When finished, stop and remove the container:
+
+```bash
+$ docker stop boot-telemetry-otel-collector-1 && docker rm boot-telemetry-otel-collector-1
+```
+
 
 ## Key configuration properties
 
@@ -40,16 +49,14 @@ spring.data.valkey.valkey-glide.open-telemetry.metrics-endpoint=http://localhost
 spring.docker.compose.lifecycle-management=start-only
 ```
 
----
-
 ## Inspecting OpenTelemetry
 
 ```bash
-docker logs -f spring-boot-opentelemetry-otel-collector-1
+$ docker logs -f boot-telemetry-otel-collector-1
 ```
 
-If yoy change the configuration of the docker shutdown the existing containers first and then run the example again:
+If you change the configuration of the docker shutdown the existing containers first and then run the example again:
 
 ```bash
-docker compose down --remove-orphans
+$ docker compose down --remove-orphans
 ```

…ringboot/SpringBootTelemetryExample.java …elemetry/SpringBootTelemetryExample.javaexamples/boot-telemetry/src/main/java/example/springboot/SpringBootTelemetryExample.java renamed to examples/boot-telemetry/src/main/java/example/boottelemetry/SpringBootTelemetryExample.java examples/boot-telemetry/src/main/java/example/springboot/SpringBootTelemetryExample.java renamed to examples/boot-telemetry/src/main/java/example/boottelemetry/SpringBootTelemetryExample.java

@@ -19,7 +19,7 @@
  * for example by viewing the collector logs:</p>
  *
  * <pre>
- * docker logs -f spring-boot-opentelemetry-otel-collector-1
+ * docker logs -f boot-telemetry-otel-collector-1
  * </pre>
  */
 @SpringBootApplication
@@ -43,10 +43,14 @@ public void run(String... args) {
 
             valkeyTemplate.opsForValue().set(key, value);
             String readBack = valkeyTemplate.opsForValue().get(key);
-
-            // System.out.println("Iteration " + i + ": " + key + "=" + readBack);
+            System.out.println("Iteration " + i + ": " + key + "=" + readBack);
         }
 
         System.out.println("Completed " + iterations + " iterations of Valkey commands.");
+
+        // Cleanup
+        for (int i = 0; i < iterations; i++) {
+            valkeyTemplate.delete("key" + i);
+        }
     }
 }

examples/boot-telemetry/src/main/resources/application.properties

@@ -2,6 +2,8 @@ spring.data.valkey.host=localhost
 spring.data.valkey.port=6379
 spring.data.valkey.client-type=valkeyglide
 
+# Docker Compose configuration
+spring.docker.compose.file=examples/boot-telemetry/compose.yaml
 # Keep the Docker Compose services running after the example stops
 # Provide the option to inspect the services if needed
 # Run `docker logs -f spring-boot-opentelemetry-otel-collector-1` to see the OpenTelemetry Collector logs
@@ -13,4 +15,4 @@ spring.data.valkey.valkey-glide.open-telemetry.enabled=true
 spring.data.valkey.valkey-glide.open-telemetry.traces-endpoint=http://localhost:4318/v1/traces
 spring.data.valkey.valkey-glide.open-telemetry.metrics-endpoint=http://localhost:4318/v1/metrics
 spring.data.valkey.valkey-glide.open-telemetry.sample-percentage=10
-spring.data.valkey.valkey-glide.open-telemetry.flush-interval-ms=1000
+spring.data.valkey.valkey-glide.open-telemetry.flush-interval-ms=50

examples/pom.xml

@@ -18,10 +18,10 @@
 	<description>Example projects demonstrating Spring Data Valkey features</description>
 
 	<modules>
+		<module>boot-telemetry</module>
 		<module>cache</module>
 		<module>cluster</module>
 		<module>collections</module>
-		<module>telemetry</module>
 		<module>operations</module>
 		<module>pipeline</module>
 		<module>quickstart</module>
@@ -30,6 +30,7 @@
 		<module>serialization</module>
 		<module>spring-boot</module>
 		<module>streams</module>
+		<module>telemetry</module>
 		<module>transactions</module>
 	</modules>
 

examples/telemetry/src/main/java/example/telemetry/OpenTelemetryExample.java

@@ -34,7 +34,7 @@
  * for example by viewing the collector logs:</p>
  *
  * <pre>
- * docker logs -f spring-boot-opentelemetry-otel-collector-1
+ * docker logs -f boot-telemetry-otel-collector-1
  * </pre>
  */
 public class OpenTelemetryExample {
@@ -70,12 +70,15 @@ public static void main(String[] args) {
 
                 template.opsForValue().set(key, value);
                 String readBack = template.opsForValue().get(key);
-
-                // System.out.println("Iteration " + i + ": " + key + "=" + readBack);
+                System.out.println("Iteration " + i + ": " + key + "=" + readBack);
             }
 
             System.out.println("Completed " + iterations + " iterations of Valkey commands.");
 
+            // Cleanup
+            for (int i = 0; i < iterations; i++) {
+                template.delete("key" + i);
+            }
         } finally {
             connectionFactory.destroy();
         }

spring-boot-starter-data-valkey/README.md

@@ -15,6 +15,7 @@ The project is a fork of Spring Boot Starter Data Redis 3.5.1 (part of the [Spri
 * Valkey Sentinel configuration support (Lettuce and Jedis only).
 * SSL/TLS connection support with Spring Boot SSL bundles.
 * Spring Boot Actuator health indicators and metrics for Valkey connections.
+* Property-based OpenTelemetry configuration for Valkey GLIDE, enabling automatic trace and metric export without application code changes.
 * `@DataValkeyTest` slice test annotation for focused Valkey testing.
 * Testcontainers integration with `@ServiceConnection` annotation.
 * Docker Compose support for automatic service detection and startup.

spring-data-valkey/README.md

@@ -7,7 +7,7 @@ Spring Data Valkey provides Spring Data integration for [Valkey](https://valkey.
 * Connection package as low-level abstraction across multiple drivers ([Valkey GLIDE](https://github.com/valkey-io/valkey-glide), [Lettuce](https://github.com/lettuce-io/lettuce-core), and [Jedis](https://github.com/redis/jedis))
 * Exception translation to Spring's portable Data Access exception hierarchy
 * `ValkeyTemplate` for high-level abstraction with serialization support
-* Pubsub support with MessageListenerContainer (Jedis and Lettuce, GLIDE support planned)
+* Pubsub support with MessageListenerContainer
 * Valkey Sentinel support (Jedis and Lettuce, GLIDE support planned)
 * Reactive API using Lettuce
 * JDK, String, JSON and Spring Object/XML mapping serializers