From ca26bb7aa9915eb345e63fd644b08baa5311cdd9 Mon Sep 17 00:00:00 2001 From: Gustavo Martin Morcuende Date: Tue, 31 Jan 2017 23:58:54 +0100 Subject: [PATCH] Update README --- SpringJava/Kafka/SpringCloudStream/README | 33 +++++++++++++++++++------------ 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/SpringJava/Kafka/SpringCloudStream/README b/SpringJava/Kafka/SpringCloudStream/README index 81733af..3ef55d2 100644 --- a/SpringJava/Kafka/SpringCloudStream/README +++ b/SpringJava/Kafka/SpringCloudStream/README @@ -1,37 +1,43 @@ -1. It does not work on gradle. Going back to the old and good maven configuration. +### 1. This project does not work on gradle 3.1 but it does on maven :) + Gradle is a pain in ass when working with hierarchical projects. -2. Documentation: http://docs.spring.io/spring-cloud-stream/docs/current/reference/html/ - https://github.com/mbogoevici/spring-cloud-stream +### 2. You can find documentation: + [http://docs.spring.io/spring-cloud-stream/docs/current/reference/html/](http://docs.spring.io/spring-cloud-stream/docs/current/reference/html/) + [https://github.com/mbogoevici/spring-cloud-stream](https://github.com/mbogoevici/spring-cloud-stream) -3. Examples: https://github.com/spring-cloud/spring-cloud-stream-samples +### 3. Examples: + [https://github.com/spring-cloud/spring-cloud-stream-samples](https://github.com/spring-cloud/spring-cloud-stream-samples) -4. Issues while debugging. +### 4. Issues while debugging. -Debugging from Eclipse/IntelliJ does not work because it needs to search for resources in /BOOT-INF/lib and /BOOT-INF/classes directories. +* Debugging from Eclipse/IntelliJ does not work because it needs to search for resources in `/BOOT-INF/lib` and `/BOOT-INF/classes` directories. By default Eclipse/IntelliJ do not know anything about those folders :( -spring-boot-maven-plugin creates META-INF/MANIFEST.MF in target/my.jar file whith this value: -Main-Class: org.springframework.boot.loader.JarLauncher +* `spring-boot-maven-plugin` creates `META-INF/MANIFEST.MF` in `target/some-project.jar` file whith this value: + `Main-Class: org.springframework.boot.loader.JarLauncher` -JarLauncher contains: https://github.com/spring-projects/spring-boot/blob/master/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/JarLauncher.java +* `JarLauncher` used when running from console with `java -jar` contains: [JarLauncher.java](https://github.com/spring-projects/spring-boot/blob/master/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/JarLauncher.java) +```java static final String BOOT_INF_CLASSES = "BOOT-INF/classes/"; static final String BOOT_INF_LIB = "BOOT-INF/lib/"; +``` -The best you can do for debugging spring boot applications is running from console in this way: -java -jar -Djaxp.debug=1 -Xdebug -Xrunjdwp:transport=dt_socket,address=8000,server=y,suspend=n target/spring-cloud-stream-kafka-consumer-example-1.0-SNAPSHOT.jar +* The best you can do for debugging spring boot applications is running from console in this way: +`java -jar -Djaxp.debug=1 -Xdebug -Xrunjdwp:transport=dt_socket,address=8000,server=y,suspend=n target/spring-stream-kafka-consumer-1.0-SNAPSHOT.jar` And then you must use the remote debugging option from Eclipse/IntelliJ -5. Consumer with health indicator: - http://docs.spring.io/spring-cloud-stream/docs/current/reference/html/_health_indicator.html +### 5. Consumer with health indicator: + See: [http://docs.spring.io/spring-cloud-stream/docs/current/reference/html/_health_indicator.html](http://docs.spring.io/spring-cloud-stream/docs/current/reference/html/_health_indicator.html) You can retrieve information from this URL (do not forget you must comment out the web-environment property in application.yml of spring-stream-kafka-consumer): GET http://localhost:8080/health + ```javascript { "status": "UP", "diskSpace": { @@ -50,3 +56,4 @@ And then you must use the remote debugging option from Eclipse/IntelliJ } } } + ``` -- 2.1.4