chore: update docs, bump maven version

Author: eledhwen

README.md

@@ -13,9 +13,9 @@ A typical `data-pipeline` use-case can be:
 * a system performing iterative analysis on an input: the `data-pipeline` data model retains intermediate results from all steps, and each result is tagged with lineage metadata
 
 On top of its core feature-set, complying to the `data-pipeline` model comes with rather nice benefits:
-* out-of-the-box support for [micrometer](https://micrometer.io) based metrics (success/failure rates, error tracking, etc.)
+* out-of-the-box support for [micrometer](https://micrometer.io) based [metrics](doc/integrations.md#metrics) (success/failure rates, error tracking, etc.) and [tracing](doc/integrations.md#tracing)
 * out-of-the-box support for [slf4j](https://www.slf4j.org) log markers (pipeline id, component id, etc.)
-* easily pluggable [resilience4j](https://resilience4j.readme.io) based resilience features (retries, time-limiter, etc.)
+* easily pluggable [resilience4j](https://resilience4j.readme.io) based [resilience features](doc/integrations.md#resilience4j) (retries, time-limiter, etc.)
 
 ## I. Installation
 
@@ -25,7 +25,7 @@ The library requires Java 17+, in order to use it, add the following in your `po
 <dependency>
     <groupId>tech.illuin</groupId>
     <artifactId>data-pipeline</artifactId>
-    <version>0.23.4</version>
+    <version>0.24</version>
 </dependency>
 ```
 

core/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <groupId>tech.illuin</groupId>
         <artifactId>data-pipeline-parent</artifactId>
-        <version>0.23.4</version>
+        <version>0.24</version>
     </parent>
 
     <artifactId>data-pipeline</artifactId>

core/src/main/java/tech/illuin/pipeline/builder/PayloadPipelineBuilder.java

@@ -356,12 +356,18 @@ public PayloadPipelineBuilder<I> setDefaultSinkErrorHandler(SinkErrorHandler def
         return this;
     }
 
+    /**
+     * @deprecated Use {@link #observabilityManager()} instead
+     */
     @Deprecated
     public MeterRegistry meterRegistry()
     {
         return this.observabilityManagerBuilder.meterRegistry();
     }
 
+    /**
+     * @deprecated Use {@link #addObservabilityComponent(MeterRegistry)} instead
+     */
     @Deprecated
     public PayloadPipelineBuilder<I> setMeterRegistry(MeterRegistry meterRegistry)
     {

core/src/main/java/tech/illuin/pipeline/builder/SimplePipelineBuilder.java

@@ -344,12 +344,18 @@ public SimplePipelineBuilder<I> setDefaultSinkErrorHandler(SinkErrorHandler defa
         return this;
     }
 
+    /**
+     * @deprecated Use {@link #observabilityManager()} instead
+     */
     @Deprecated
     public MeterRegistry meterRegistry()
     {
         return this.observabilityManagerBuilder.meterRegistry();
     }
 
+    /**
+     * @deprecated Use {@link #addObservabilityComponent(MeterRegistry)} instead
+     */
     @Deprecated
     public SimplePipelineBuilder<I> setMeterRegistry(MeterRegistry meterRegistry)
     {

doc/integrations.md

@@ -2,14 +2,16 @@
 
 ## Micrometer
 
+### Metrics
+
 `data-pipeline` automatically manages a number of micrometer meters in order to give insights into the performance and reliability of a pipeline and its components.
 
 In order to enable activity tracking through micrometer, pass a `io.micrometer.core.instrument.MeterRegistry` to the pipeline builder:
 
 ```java
 var pipeline = Pipeline.of("my-pipeline")
     // register steps, sinks, etc.
-    .setMeterRegistry(meterRegistry)
+    .addObservabilityComponent(meterRegistry)
     //.build()
 ;
 ```
@@ -51,9 +53,25 @@ Each of these have a number of predefined tags like the `pipeline` name, or a `r
 | sink           | `pipeline.sink.run.failure`               | `counter` | `pipeline` `sink`                | Total count of failed sink runs            |
 | sink           | `pipeline.sink.run.error.total`           | `counter` | `pipeline` `sink` `error`        | Total count of sink exceptions             |
 
+### Tracing
+
+`data-pipeline` also manages tracing spans via `micrometer-tracing` on core components:
+* pipeline execution
+* pipeline phases: initialization, steps and sinks
+
+In order to enable tracing through micrometer, pass a `io.micrometer.tracing.Tracer` to the pipeline builder:
+
+```java
+var pipeline = Pipeline.of("my-pipeline")
+    // register steps, sinks, etc.
+    .addObservabilityComponent(tracer)
+    //.build()
+;
+```
+
 ## Prometheus
 
-Given the micrometer integration above, existing meters are trivially converted to prometheus metrics:
+Given the micrometer integration [above](#metrics), existing meters are trivially converted to prometheus metrics:
 * through `micrometer-registry-prometheus`: [Prometheus integration](https://micrometer.io/docs/registry/prometheus) ; note that there are many alternatives such as [OTLP, Influx, Graphite or Datadog](https://micrometer.io/docs)
 * or in a spring-boot application for instance: [Production-ready Features - Prometheus](https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html#actuator.metrics.export.prometheus)
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>tech.illuin</groupId>
     <artifactId>data-pipeline-parent</artifactId>
-    <version>0.23.4</version>
+    <version>0.24</version>
     <packaging>pom</packaging>
 
     <modules>

resilience4j/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <groupId>tech.illuin</groupId>
         <artifactId>data-pipeline-parent</artifactId>
-        <version>0.23.4</version>
+        <version>0.24</version>
     </parent>
 
     <artifactId>data-pipeline-resilience4j</artifactId>