README.md

Datasource Micrometer

The Datasource Micrometer provides Micrometer Observation API instrumentation for JDBC operations.

Modules

datasource-micrometer
Micrometer observability instrumentation for JDBC DataSource.

datasource-micrometer-spring-boot
Spring Boot 3.x AutoConfiguration for micrometer observability.

Dependency Settings

datasource-micrometer

<!-- Maven -->
<dependency>
    <groupId>net.ttddyy.observation</groupId>
    <artifactId>datasource-micrometer</artifactId>
    <version>...</version>
</dependency>

// Gradle
dependencies {
    implementation "net.ttddyy.observation:datasource-micrometer:..."
}

datasource-micrometer-spring-boot

<!-- Maven -->
<dependency>
    <groupId>net.ttddyy.observation</groupId>
    <artifactId>datasource-micrometer-spring-boot</artifactId>
    <version>...</version>
</dependency>

// Gradle
dependencies {
    implementation "net.ttddyy.observation:datasource-micrometer-spring-boot:..."
}

Using Snapshot

You need add Sonatype Snapshot repositories.

<!-- Maven -->
<repositories>
    <repository>
        <id>sonatype-snapshots</id>
        <name>Sonatype Snapshots</name>
        <url>https://oss.sonatype.org/content/repositories/snapshots</url>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

// Gradle
repositories {
    maven {
        url "https://oss.sonatype.org/content/repositories/snapshots"
    }
}

Java versions

The produced jars support following JDK versions at runtime:

• datasource-micrometer: Java 8+ to match with micrometer 1.x java baseline.
• datasource-micrometer-spring-boot: Java 17+ to match with Spring Boot 3.x java baseline.

Documentation

• Current release
  • Reference Doc.
  • API Doc.
  • Changelog
• Snapshot
  • Reference Doc.
  • API Doc.
  • Changelog
• Other versions (TBD)

Dependent Library Versions

DataSource Micrometer	Spring Boot	Micrometer Tracing BOM	Micrometer BOM
1.0.0	3.0.0 and up	1.0.0	1.10.2
1.0.0-RC1	3.0.0-RC1	1.0.0-RC1	1.10.0-RC1
1.0.0-M1	3.0.0-M6	1.0.0-M8	1.10.0-M5

Development

To build the entire project, JDK-17 is required.

./mvnw install

Building document

./mvnw install -Pdocs -pl docs

Building javadoc

./mvnw javadoc:aggregate

Apply Source Code Format

./mvnw spring-javaformat:apply