diff --git a/README.md b/README.md index b09b86ff..ec93bec5 100644 --- a/README.md +++ b/README.md @@ -65,12 +65,12 @@ All in all, you should do the following: 4. Adjust your logging configuration accordingly. Let's say you want to make use of the *servlet filter* feature, then you need to add the following dependency to your -POM with property `cf-logging-version` referring to the latest nexus version (currently `4.3.0`): +POM with a property `cf-java-logging-support.version`, referring to the latest released version (currently `4.3.0`): ```xml - 4.3.0 + 4.3.0 ``` @@ -78,7 +78,7 @@ POM with property `cf-logging-version` referring to the latest nexus version (cu com.sap.hcp.cf.logging cf-java-logging-support-servlet - ${cf-logging-version} + ${cf-java-logging-support.version} ``` @@ -86,6 +86,27 @@ This feature only depends on the servlet API which you have included in your POM about the *servlet filter* feature (like e.g. how to adjust the web.xml) in the [Wiki](https://github.com/SAP/cf-java-logging-support/wiki/Instrumenting-Servlets). +### Bill of Materials (BOM) + +If you want to use multiple features, you may want to consider using the provided BOM (Bill of Materials) to avoid +version conflicts. You can find the BOM in the `cf-java-logging-support-bom` module. To use it, add the following to your POM: + +``` xml + + + + com.sap.hcp.cf.logging + cf-java-logging-support-bom + ${cf-java-logging-support.version} + pom + import + + + +``` + +You can control the version of all features by just changing the property `cf-java-logging-support.version` in your POM and omitting any version in your `cf-java-logging-support` dependencies. Please note that our BOM manages solely the versions of the `cf-java-logging-support` features, but not the versions of the logging implementation backends or other used libraries (e.g. logback or log4j2). + ## Implementation variants and logging configurations The *core* feature (on which all other features rely) is just using the `org.slf4j` API, but to actually get logs @@ -103,7 +124,7 @@ corresponding dependencies in your POM file: com.sap.hcp.cf.logging cf-java-logging-support-logback - ${cf-logging-version} + ${cf-java-logging-support.version} @@ -119,7 +140,7 @@ corresponding dependencies in your POM file: com.sap.hcp.cf.logging cf-java-logging-support-log4j2 - ${cf-logging-version} + ${cf-java-logging-support.version} org.apache.logging.log4j diff --git a/cf-java-logging-support-bom/pom.xml b/cf-java-logging-support-bom/pom.xml new file mode 100644 index 00000000..385fe001 --- /dev/null +++ b/cf-java-logging-support-bom/pom.xml @@ -0,0 +1,47 @@ + + 4.0.0 + + cf-java-logging-support-bom + pom + Bill of Materials for cf-java-logging-support dependencies + cf-java-logging-support-bom + + + com.sap.hcp.cf.logging + cf-java-logging-support-parent + 4.3.0 + ../pom.xml + + + + + + com.sap.hcp.cf.logging + cf-java-logging-support-core + ${project.version} + + + com.sap.hcp.cf.logging + cf-java-logging-support-logback + ${project.version} + + + com.sap.hcp.cf.logging + cf-java-logging-support-log4j2 + ${project.version} + + + com.sap.hcp.cf.logging + cf-java-logging-support-servlet + ${project.version} + + + com.sap.hcp.cf.logging + cf-java-logging-support-servlet-dynlog-jwt + ${project.version} + + + + + diff --git a/pom.xml b/pom.xml index f959c252..e72fb6ad 100644 --- a/pom.xml +++ b/pom.xml @@ -99,6 +99,7 @@ + cf-java-logging-support-bom cf-java-logging-support-core cf-java-logging-support-logback cf-java-logging-support-log4j2