Skip to content

Commit c6b017e

Browse files
committed
Add licensing section to README.md
- add default licensing section - add minimum Java version info (Java 8) - fix typos
1 parent f33b90b commit c6b017e

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
# Java Logging Support for Cloud Foundry
22

3-
[![Build Status](https://travis-ci.org/SAP/cf-java-logging-support.svg?branch=master)](https://travis-ci.org/SAP/cf-java-logging-support)[![REUSE status](https://api.reuse.software/badge/github.com/SAP/cf-java-logging-support)](https://api.reuse.software/info/github.com/SAP/cf-java-logging-support)
3+
[![Build Status](https://travis-ci.org/SAP/cf-java-logging-support.svg?branch=master)](https://travis-ci.org/SAP/cf-java-logging-support)
4+
[![REUSE status](https://api.reuse.software/badge/github.com/SAP/cf-java-logging-support)](https://api.reuse.software/info/github.com/SAP/cf-java-logging-support)
45

56
## Summary
67

7-
This is a collection of support libraries for Java applications running on Cloud Foundry that serves three main purposes: It provides (a) means to emit *structured application log messages*, (b) instrument parts of your application stack to *collect request metrics* and (c) java clients for producing *custom metrics*.
8+
This is a collection of support libraries for Java applications (Java 8 and above) running on Cloud Foundry that serves three main purposes: It provides (a) means to emit *structured application log messages*, (b) instrument parts of your application stack to *collect request metrics* and (c) java clients for producing *custom metrics*.
89

910
When we say structured, we actually mean in JSON format. In that sense, it shares ideas with [logstash-logback-encoder](https://github.com/logstash/logstash-logback-encoder) (and a first internal version was actually based on it), but takes a simpler approach as we want to ensure that these structured messages adhere to standardized formats. With such standardized formats in place, it becomes much easier to ingest, process and search such messages in log analysis stacks such as [ELK](https://www.elastic.co/webinars/introduction-elk-stack).
1011

1112
If you're interested in the specifications of these standardized formats, you may want to have a closer look at the `fields.yml` files in the [beats folder](./cf-java-logging-support-core/beats).
1213

13-
While [logstash-logback-encoder](https://github.com/logstash/logstash-logback-encoder) is tied to [logback](http://logback.qos.ch/), we've tried to keep implementation neutral and have implemented the core functionality on top of [slf4j](http://www.slf4j.org/), but provided implementations for both [logback](http://logback.qos.ch/) and [log4j2](http://logging.apache.org/log4j/2.x/) (and we're open to contributions that would support other implementations).
14+
While [logstash-logback-encoder](https://github.com/logstash/logstash-logback-encoder) is tied to [logback](http://logback.qos.ch/), we've tried to keep implementation neutral and have implemented the core functionality on top of [slf4j](http://www.slf4j.org/), but provided implementations for both [logback](http://logback.qos.ch/) and [log4j2](http://logging.apache.org/log4j/2.x/) (and we're open to contributions that would support other implementations).
1415

1516
The instrumentation part is currently focusing on providing [request filters for Java Servlets](http://www.oracle.com/technetwork/java/filters-137243.html) and [client and server filters for Jersey](https://jersey.java.net/documentation/latest/filters-and-interceptors.html), but again, we're open to contributions for other APIs and frameworks.
1617

@@ -73,7 +74,6 @@ If you want to use the `custom metrics`, just define the following dependency:
7374
</dependency>
7475
```
7576

76-
7777
## Implementation variants and logging configurations
7878

7979
The *core* feature (on which all other features rely) is just using the `org.slf4j` API, but to actually get logs written, you need to pick an implementation feature. As stated above, we have two implementations:
@@ -209,7 +209,7 @@ public class DemoController {
209209
private LongTaskTimer longTimer;
210210

211211
DemoController() {
212-
this.counter = Metrics.counter("demo.contoller.number.of.requests", "unit", "requests");
212+
this.counter = Metrics.counter("demo.controller.number.of.requests", "unit", "requests");
213213
List<Tag> tags = new ArrayList<Tag>(Arrays.asList(new Tag[] { Tag.of("parallel", "clients") }));
214214
this.concurrentHttpRequests = Metrics.gauge("demo.controller.number.of.clients.being.served", tags,
215215
new AtomicInteger(0));
@@ -311,8 +311,12 @@ Stacktraces can be logged within one log message. Further details can be found
311311

312312
In order to illustrate how the different features are used, this repository includes two sample applications:
313313
* a Jersey implementation in the [./sample folder](./sample)
314-
* a Spring Boot implementaiton in the [./sample-spring-boot folder](./sample-spring-boot)
314+
* a Spring Boot implementation in the [./sample-spring-boot folder](./sample-spring-boot)
315315

316316
## Documentation
317317

318318
More info on the actual implementation can be found in the [Wiki](https://github.com/SAP/cf-java-logging-support/wiki).
319+
320+
## Licensing
321+
322+
Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the [REUSE](https://api.reuse.software/info/github.com/SAP/cf-java-logging-support) tool.

0 commit comments

Comments
 (0)