Skip to content

Commit

Permalink
Adjust readme
Browse files Browse the repository at this point in the history
  • Loading branch information
skjolber committed Jan 20, 2025
1 parent 81e9f5e commit a12f4bd
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 15 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,18 @@ This library is mostly based on
* SLF4J 2
* Logback + Logback logstash
* GRPC
* Lognet (deprecated)
* Ecosystem
* Logbook
* [Ecosystem](https://github.com/grpc-ecosystem/grpc-spring)
* [Lognet](https://github.com/LogNet/grpc-spring-boot-starter) (deprecated due to lack of maintenance)
* [Logbook](https://github.com/zalando/logbook)

Supported web technologies are:

* Spring web
* Spring + gRPC via Lognet
* Micrometer
* Spring + gRPC

Supported clouds:

* GCP (stackdriver)
* GCP (Stackdriver)
* Azure

# License
Expand All @@ -66,7 +65,7 @@ Each Spring Boot starter has a corresponding Spring Boot test starter. The Sprin
The above starters are implemented in two flavours:

* Servlet-based web
* Lognet gRPC
* Netty-based gRPC

## Getting started
See [Getting started with gRPC](guides/gRPC.md) or [Getting started with servlet-based web](guides/web.md). Alternatively, go directly to the [examples](examples).
Expand All @@ -77,7 +76,9 @@ See [Getting started with gRPC](guides/gRPC.md) or [Getting started with servlet
* Better define and tune request-response logging JSON format
* Add support for other text formats


# See also

* [logback-logstash-syntax-highlighting-decorators](https://github.com/entur/logback-logstash-syntax-highlighting-decorators)



9 changes: 5 additions & 4 deletions azure/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ For

```groovy
ext {
cloudLoggingVersion = '2.0.x'
cloudLoggingVersion = '4.0.x'
}
```

Expand Down Expand Up @@ -185,7 +185,8 @@ gRPC request-response-logging for local development, for additional coloring and
## on-demand-spring-boot-starter-azure-grpc
Selective (on-demand) logging for logging only interesting requests.

Try the [configuration](on-demand-spring-boot-starter-azure-grpc/src/main/java/no/entur/logging/cloud/azure/spring/grpc/lognet/properties/OndemandProperties.java)
See the [configuration properties](../on-demand/on-demand-spring-boot-starter-gcp-grpc/src/main/java/no/entur/logging/cloud/spring/ondemand/grpc/properties/OndemandProperties.java)

```
entur.logging.grpc.ondemand.enabled=true
```
Expand All @@ -199,7 +200,7 @@ Import the below artifacts:
Add

```xml
<cloud-logging.version>2.0.x</cloud-logging>
<cloud-logging.version>4.0.x</cloud-logging>
```

and
Expand Down Expand Up @@ -277,7 +278,7 @@ For

```groovy
ext {
cloudLoggingVersion = '2.0.x'
cloudLoggingVersion = '4.0.x'
}
```

Expand Down
2 changes: 1 addition & 1 deletion examples/gcp-web-example/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# gcp-web-example
Simple REST service example with a few unit tests.
Simple Spring REST service example with a few unit tests.
5 changes: 3 additions & 2 deletions gcp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,8 @@ gRPC request-response-logging for local development, for additional coloring and
## on-demand-spring-boot-starter-gcp-grpc
Selective (on-demand) logging for logging only interesting requests.

Try the [configuration](on-demand-spring-boot-starter-gcp-grpc/src/main/java/no/entur/logging/cloud/gcp/spring/grpc/lognet/properties/OndemandProperties.java)
See the [configuration properties](../on-demand/on-demand-spring-boot-starter-gcp-grpc/src/main/java/no/entur/logging/cloud/spring/ondemand/grpc/properties/OndemandProperties.java)

```
entur.logging.grpc.ondemand.enabled=true
```
Expand All @@ -199,7 +200,7 @@ Import the below artifacts:
Add

```xml
<cloud-logging.version>2.0.x</cloud-logging>
<cloud-logging.version>4.0.x</cloud-logging>
```

and
Expand Down

0 comments on commit a12f4bd

Please sign in to comment.