diff --git a/README.adoc b/README.adoc index b5cd823ef..e6021ce0f 100644 --- a/README.adoc +++ b/README.adoc @@ -12,6 +12,18 @@ image::https://badges.gitter.im/spring-cloud/spring-cloud-sleuth.svg[Gitter,link == Spring Cloud Sleuth +=== !!!! IMPORTANT !!!! + +Spring Cloud Sleuth's last minor version is 3.1. You can check the https://github.com/spring-cloud/spring-cloud-sleuth/tree/3.1.x[3.1.x] branch for the latest commits. + +WARNING: Spring Cloud Sleuth will not work with Spring Boot 3.x onward. The last major version of Spring Boot that Sleuth will support is 2.x. + +The core of this project got moved to https://micrometer.io/docs/tracing[Micrometer Tracing] project and the instrumentations will be moved to https://micrometer.io/[Micrometer] and all respective projects (no longer all instrumentations will be done in a single repository. + +You can check the https://github.com/micrometer-metrics/tracing/wiki/Spring-Cloud-Sleuth-3.1-Migration-Guide[Micrometer Tracing migration guide] to learn how to migrate from Spring Cloud Sleuth to Micrometer Tracing. + +=== Introduction + Spring Cloud Sleuth provides Spring Boot auto-configuration for distributed tracing. Sleuth configures everything you need to get started. diff --git a/docs/src/main/asciidoc/README.adoc b/docs/src/main/asciidoc/README.adoc index 445ce5c52..06b7d198a 100644 --- a/docs/src/main/asciidoc/README.adoc +++ b/docs/src/main/asciidoc/README.adoc @@ -5,6 +5,18 @@ image::https://badges.gitter.im/spring-cloud/spring-cloud-sleuth.svg[Gitter,link == Spring Cloud Sleuth +=== !!!! IMPORTANT !!!! + +Spring Cloud Sleuth's last minor version is 3.1. You can check the https://github.com/spring-cloud/spring-cloud-sleuth/tree/3.1.x[3.1.x] branch for the latest commits. + +WARNING: Spring Cloud Sleuth will not work with Spring Boot 3.x onward. The last major version of Spring Boot that Sleuth will support is 2.x. + +The core of this project got moved to https://micrometer.io/docs/tracing[Micrometer Tracing] project and the instrumentations will be moved to https://micrometer.io/[Micrometer] and all respective projects (no longer all instrumentations will be done in a single repository. + +You can check the https://github.com/micrometer-metrics/tracing/wiki/Spring-Cloud-Sleuth-3.1-Migration-Guide[Micrometer Tracing migration guide] to learn how to migrate from Spring Cloud Sleuth to Micrometer Tracing. + +=== Introduction + Spring Cloud Sleuth provides Spring Boot auto-configuration for distributed tracing. Sleuth configures everything you need to get started. diff --git a/docs/src/main/asciidoc/spring-cloud-sleuth.adoc b/docs/src/main/asciidoc/spring-cloud-sleuth.adoc index 92ac1694f..fb092b6a6 100644 --- a/docs/src/main/asciidoc/spring-cloud-sleuth.adoc +++ b/docs/src/main/asciidoc/spring-cloud-sleuth.adoc @@ -2,6 +2,16 @@ = Spring Cloud Sleuth Reference Documentation Adrian Cole, Spencer Gibb, Marcin Grzejszczak, Dave Syer, Jay Bryant +== !!!! IMPORTANT !!!! + +Spring Cloud Sleuth's last minor version is 3.1. You can check the https://github.com/spring-cloud/spring-cloud-sleuth/tree/3.1.x[3.1.x] branch for the latest commits. + +WARNING: Spring Cloud Sleuth will not work with Spring Boot 3.x onward. The last major version of Spring Boot that Sleuth will support is 2.x. + +The core of this project got moved to https://micrometer.io/docs/tracing[Micrometer Tracing] project and the instrumentations will be moved to https://micrometer.io/[Micrometer] and all respective projects (no longer all instrumentations will be done in a single repository. + +You can check the https://github.com/micrometer-metrics/tracing/wiki/Spring-Cloud-Sleuth-3.1-Migration-Guide[Micrometer Tracing migration guide] to learn how to migrate from Spring Cloud Sleuth to Micrometer Tracing. + :docinfo: shared include::_attributes.adoc[] diff --git a/docs/src/main/asciidoc/spring-cloud-sleuth.htmlsingleadoc b/docs/src/main/asciidoc/spring-cloud-sleuth.htmlsingleadoc index 741b91da1..3b2c55cfc 100644 --- a/docs/src/main/asciidoc/spring-cloud-sleuth.htmlsingleadoc +++ b/docs/src/main/asciidoc/spring-cloud-sleuth.htmlsingleadoc @@ -2,6 +2,16 @@ = Spring Cloud Sleuth Reference Documentation Adrian Cole, Spencer Gibb, Marcin Grzejszczak, Dave Syer, Jay Bryant +== !!!! IMPORTANT !!!! + +Spring Cloud Sleuth's last minor version is 3.1. You can check the https://github.com/spring-cloud/spring-cloud-sleuth/tree/3.1.x[3.1.x] branch for the latest commits. + +WARNING: Spring Cloud Sleuth will not work with Spring Boot 3.x onward. The last major version of Spring Boot that Sleuth will support is 2.x. + +The core of this project got moved to https://micrometer.io/docs/tracing[Micrometer Tracing] project and the instrumentations will be moved to https://micrometer.io/[Micrometer] and all respective projects (no longer all instrumentations will be done in a single repository. + +You can check the https://github.com/micrometer-metrics/tracing/wiki/Spring-Cloud-Sleuth-3.1-Migration-Guide[Micrometer Tracing migration guide] to learn how to migrate from Spring Cloud Sleuth to Micrometer Tracing. + :docinfo: shared include::_attributes.adoc[] @@ -11,4 +21,4 @@ include::using.adoc[leveloffset=+1] include::project-features.adoc[leveloffset=+1] include::howto.adoc[leveloffset=+1] include::integrations.adoc[leveloffset=+1] -include::appendix.adoc[leveloffset=+1] \ No newline at end of file +include::appendix.adoc[leveloffset=+1] diff --git a/docs/src/main/asciidoc/spring-cloud-sleuth.pdfadoc b/docs/src/main/asciidoc/spring-cloud-sleuth.pdfadoc index e1edcb891..438230e66 100644 --- a/docs/src/main/asciidoc/spring-cloud-sleuth.pdfadoc +++ b/docs/src/main/asciidoc/spring-cloud-sleuth.pdfadoc @@ -2,6 +2,16 @@ = Spring Cloud Sleuth Reference Documentation Adrian Cole, Spencer Gibb, Marcin Grzejszczak, Dave Syer, Jay Bryant +== !!!! IMPORTANT !!!! + +Spring Cloud Sleuth's last minor version is 3.1. You can check the https://github.com/spring-cloud/spring-cloud-sleuth/tree/3.1.x[3.1.x] branch for the latest commits. + +WARNING: Spring Cloud Sleuth will not work with Spring Boot 3.x onward. The last major version of Spring Boot that Sleuth will support is 2.x. + +The core of this project got moved to https://micrometer.io/docs/tracing[Micrometer Tracing] project and the instrumentations will be moved to https://micrometer.io/[Micrometer] and all respective projects (no longer all instrumentations will be done in a single repository. + +You can check the https://github.com/micrometer-metrics/tracing/wiki/Spring-Cloud-Sleuth-3.1-Migration-Guide[Micrometer Tracing migration guide] to learn how to migrate from Spring Cloud Sleuth to Micrometer Tracing. + include::_attributes.adoc[] include::legal.adoc[leveloffset=+1]