Skip to content

Commit 0639a20

Browse files
committed
update readme.md
1 parent 10246a2 commit 0639a20

File tree

2 files changed

+55
-10
lines changed

2 files changed

+55
-10
lines changed

logging-spring-commons/pom.xml

+37-1
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,45 @@
99
<version>2.0.3</version>
1010
</parent>
1111

12-
<groupId>pl.piomin</groupId>
1312
<artifactId>logging-spring-commons</artifactId>
1413

14+
<name>logging-spring-commons</name>
15+
<description>Library for HTTP logging with Spring Boot</description>
16+
<url>https://github.com/piomin/spring-boot-logging</url>
17+
18+
<developers>
19+
<developer>
20+
<name>Piotr Mińkowski</name>
21+
<email>[email protected]</email>
22+
<url>https://github.com/piomin</url>
23+
</developer>
24+
</developers>
25+
26+
<licenses>
27+
<license>
28+
<name>MIT License</name>
29+
<url>http://www.opensource.org/licenses/mit-license.php</url>
30+
<distribution>repo</distribution>
31+
</license>
32+
</licenses>
33+
34+
<scm>
35+
<connection>scm:git:git://github.com/piomin/spring-boot-logging.git</connection>
36+
<developerConnection>scm:git:[email protected]:piomin/spring-boot-logging.git</developerConnection>
37+
<url>https://github.com/piomin/spring-boot-logging</url>
38+
</scm>
39+
40+
<distributionManagement>
41+
<snapshotRepository>
42+
<id>ossrh</id>
43+
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
44+
</snapshotRepository>
45+
<repository>
46+
<id>ossrh</id>
47+
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
48+
</repository>
49+
</distributionManagement>
50+
1551
<dependencies>
1652
<dependency>
1753
<groupId>org.springframework</groupId>

readme.md

+18-9
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,22 @@ In short, let’s begin from a brief review of main features provided by logstas
2727
4. It is auto-configurable Spring Boot library – you don’t have to do anything more than including it as a dependency to your application to make it work
2828

2929
## Getting started
30-
The current version of library is `2.0.1`.\
31-
For logging with Spring WebMvc:
30+
The current version of library is `2.0.3`.\
31+
For logging with Spring WebMvc and Logstash:
3232
```
3333
<dependency>
3434
<groupId>com.github.piomin</groupId>
3535
<artifactId>logstash-logging-spring-boot-starter</artifactId>
36-
<version>2.0.1</version>
36+
<version>2.0.3</version>
37+
</dependency>
38+
```
39+
40+
For logging with Spring WebMvc and Loki:
41+
```
42+
<dependency>
43+
<groupId>com.github.piomin</groupId>
44+
<artifactId>loki-logging-spring-boot-starter</artifactId>
45+
<version>2.0.3</version>
3746
</dependency>
3847
```
3948

@@ -42,22 +51,22 @@ For logging with Spring WebFlux:
4251
<dependency>
4352
<groupId>com.github.piomin</groupId>
4453
<artifactId>reactive-logstash-logging-spring-boot-starter</artifactId>
45-
<version>2.0.1</version>
54+
<version>2.0.3</version>
4655
</dependency>
4756
```
4857

49-
By default, the library is enabled, but tries to locate Logback configuration inside your application to settings for Logstash appender. If such appender won’t be found, the library uses Spring Boot default logging configuration, which does not include Logstash appender. To force it use auto-configured appender definition inside library we have to set property logging.logstash.enabled to `true`.
58+
By default, the library is enabled, but tries to locate Logback configuration inside your application to settings for Logstash appender. If such appender won’t be found, the library uses Spring Boot default logging configuration, which does not include Logstash appender. To force it use auto-configured appender definition inside library we have to set property `logging.logstash.enabled` to `true`.
5059
```
5160
logging.logstash:
5261
enabled: true
53-
url: 192.168.99.100:5000
62+
url: loki.example.com:5000
5463
```
5564

5665
## Manual add jar to pom.xml
5766

58-
Add `reactive-logstash-logging-spring-boot-starter-2.0.1.pom` to `${basedir}/dependencies`
67+
Add `reactive-logstash-logging-spring-boot-starter-2.0.3.pom` to `${basedir}/dependencies`
5968

60-
Add `pom.xml` to `${basedir}/dependencies` and rename to `reactive-logstash-logging-spring-boot-starter-1.4.0.RELEASE.pom`
69+
Add `pom.xml` to `${basedir}/dependencies` and rename to `reactive-logstash-logging-spring-boot-starter-2.0.3.pom`
6170

6271
Add this script to `pom.xml` in plugins section.
6372

@@ -69,7 +78,7 @@ Add this script to `pom.xml` in plugins section.
6978
<configuration>
7079
<groupId>com.github.piomin</groupId>
7180
<artifactId>reactive-logstash-logging-spring-boot-starter</artifactId>
72-
<version>2.0.1</version>
81+
<version>2.0.3</version>
7382
<packaging>jar</packaging>
7483
<file>${basedir}/dependencies/reactive-logstash-logging-spring-boot-starter-1.3.1.RELEASE.jar</file>
7584
<generatePom>false</generatePom>

0 commit comments

Comments
 (0)