Skip to content

Commit

Permalink
Polish
Browse files Browse the repository at this point in the history
  • Loading branch information
ttddyy committed May 24, 2024
1 parent a8eceb4 commit 770a56a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
[![CI](https://github.com/jdbc-observations/datasource-micrometer/actions/workflows/ci.yml/badge.svg)](https://github.com/jdbc-observations/datasource-micrometer/actions/workflows/ci.yml?event=push&branch=main)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/net.ttddyy.observation/datasource-micrometer/badge.svg)](https://search.maven.org/search?q=net.ttddyy.observation)

The Datasource Micrometer provides a [Micrometer Tracing][micrometer-tracing] instrumentation for JDBC operations.
The Datasource Micrometer provides [Micrometer Observation API][micrometer-observation] instrumentation for JDBC operations.

[micrometer-tracing]: https://micrometer.io/docs/tracing
[micrometer-observation]: https://docs.micrometer.io/micrometer/reference/observation.html

## Modules

Expand Down Expand Up @@ -106,11 +106,11 @@ The produced jars support following JDK versions at runtime:

## Dependent Library Versions

| DataSource Micrometer | Spring Boot | Micrometer Tracing BOM | Micrometer BOM |
|:---------------------:|:-----------:|:----------------------:|:--------------:|
| `1.0.0` | 3.0.0 | 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 |
| 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

Expand Down
6 changes: 3 additions & 3 deletions docs/src/main/asciidoc/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ It includes an introduction to {project-full-name}, along with installation inst
[[getting-started-introducing-datasource-micrometer]]
== Introducing Datasource Micrometer

The Datasource Micrometer provides a {micrometer-observation}[Micrometer Observation API] instrumentation for JDBC operations.
The Datasource Micrometer provides {micrometer-observation}[Micrometer Observation API] instrumentation for JDBC operations.

Currently, this project provides two modules - core instrumentation and its Spring Boot Auto Configuration.

If you are a {micrometer}[Micrometer] user but not using Spring Boot, you can directly use the `datasource-micrometer` module, which doesn't have a dependency on Spring Framework. +
If you are a {micrometer}[Micrometer] user but not using Spring Boot, you can directly use the `datasource-micrometer` module, which doesn't have a dependency on the Spring Framework. +
If you are a Spring Boot 3 user, then you can add the `datasource-micrometer-spring-boot` module to the classpath.
Then, it automatically instruments the `DataSource` and provides a tracing capability on the JDBC operations.
This will automatically instruments the `DataSource` and provide tracing capabilities for JDBC operations.

The instrumentation implementation uses https://github.com/ttddyy/datasource-proxy[datasource-proxy] to provide a proxy for JDBC operations.

Expand Down

0 comments on commit 770a56a

Please sign in to comment.