Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation #330

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve documentation #330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,15 @@
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
# Quarkus Logging Json
Quarkus logging extension outputting the logging in json.
# Quarkus Logging JSON
Quarkus logging extension outputting the log messages in JSON.
It supports the following formats: default, [Elastic Common Schema (ECS)](https://www.elastic.co/guide/en/ecs-logging/overview/current/intro.html).

## Version to use
| Quarkus Version | Use version |
|-------|-------|
| 3.x.x | 3.x.x |
| 2.x.x | 1.x.x, 2.x.x |
| Quarkus Version | Use version |
|-----------------|--------------|
| 3.x.x | 3.x.x |
| 2.x.x | 1.x.x, 2.x.x |

# Configuration
The extension is enabled by default for console, when added to the project.
Expand Down
3 changes: 2 additions & 1 deletion docs/modules/ROOT/pages/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@

include::./includes/attributes.adoc[]

Quarkus logging extension outputting the logging in JSON.
Quarkus logging extension outputting the log messages in JSON.
It supports the following formats: default, https://www.elastic.co/guide/en/ecs-logging/overview/current/intro.html[Elastic Common Schema (ECS)].

== Installation

Expand Down
2 changes: 1 addition & 1 deletion runtime/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

<artifactId>quarkus-logging-json</artifactId>
<name>Quarkus Logging JSON - Runtime</name>
<description>Logging in JSON with support for custom fields</description>
<description>Logging in JSON with support for custom fields and Elastic Common Schema (ECS)</description>
<dependencies>
<dependency>
<groupId>io.quarkus</groupId>
Expand Down