Skip to content

jdbc-observations/datasource-micrometer

Repository files navigation

Datasource Micrometer

CI Maven Central

Datasource Micrometer adds Micrometer Observation API instrumentation for JDBC operations.


Modules

Module Purpose
datasource-micrometer Micrometer observability instrumentation for JDBC DataSource.
datasource-micrometer-opentelemetry OpenTelemetry semantic conventions support.
datasource-micrometer-spring-boot Spring Boot auto-configuration and related support.
datasource-micrometer-bom Bill of Materials (BOM) for aligned versions of all modules.

Documentation

Channel Reference API Changelog
Current release HTML Javadoc CHANGELOG
Snapshot HTML Javadoc CHANGELOG

Other versions: TBD.


Dependencies

Replace ... with the version from Maven Central.

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-opentelemetry

Maven

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

Gradle

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

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:..."
}

datasource-micrometer-bom

Import the BOM to align transitive versions (optional but recommended when you use multiple artifacts).

Maven

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>net.ttddyy.observation</groupId>
      <artifactId>datasource-micrometer-bom</artifactId>
      <version>...</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

Gradle

dependencies {
  implementation platform("net.ttddyy.observation:datasource-micrometer-bom:...")
}

Snapshot releases

Add the Maven Central Portal Snapshots repository, then use a snapshot version as usual.

Maven

<repositories>
    <repository>
        <name>Central Portal Snapshots</name>
        <id>central-portal-snapshots</id>
        <url>https://central.sonatype.com/repository/maven-snapshots/</url>
        <releases>
            <enabled>false</enabled>
        </releases>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

Gradle

repositories {
    maven {
        name = 'Central Portal Snapshots'
        url = 'https://central.sonatype.com/repository/maven-snapshots/'

        // Only resolve datasource-micrometer artifacts from this repo
        content {
            includeModule("net.ttddyy.observation", "<datasource-micrometer artifacts>")
        }
    }
    mavenCentral()
}

Full setup details: Consuming snapshot releases (Sonatype).


Java versions

Runtime JDK requirements by artifact:

Artifact JDK
datasource-micrometer 8+ (aligned with Micrometer 1.x)
datasource-micrometer-spring-boot 17+ (aligned with Spring Boot 3.x)

Compatible versions

Spring Boot (summary)

Datasource Micrometer Spring Boot
2.x 4.x
1.x 3.x

Spring Boot, Micrometer BOM, and Micrometer Tracing BOM

Datasource Micrometer Spring Boot Micrometer Tracing BOM Micrometer BOM
2.x 4.x 1.6.x 1.16.x
2.0.0-RC1 4.0.0-[M3,R1,R2] 1.6.0-[M3,R1] 1.16.0-[M3,R1]
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

JDK 17 is required to build the project.

Task Command
Full build ./mvnw install
Documentation site ./mvnw install -Pdocs -pl docs
Aggregated Javadoc ./mvnw javadoc:aggregate
Apply source formatting ./mvnw spring-javaformat:apply

About

Micrometer Observation API instrumentation and Spring Boot 3 Auto-Configuration for JDBC APIs

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages