Skip to content

Commit

Permalink
fix documentation after review
Browse files Browse the repository at this point in the history
  • Loading branch information
troosan committed Sep 25, 2024
1 parent e47cc90 commit 25f82d3
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ public final class LogConfig {
/**
* Socket handlers.
* <p>
* The named socket handlers configured here can be linked on one or more categories.
* The named socket handlers configured here can be linked to one or more categories.
*/
@ConfigItem(name = "handler.socket")
@ConfigDocSection
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public class SocketConfig {
Optional<String> filter;

/**
* Syslog async logging config
* Socket async logging config
*/
AsyncConfig async;
}
8 changes: 4 additions & 4 deletions docs/src/main/asciidoc/centralized-log-management.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -240,10 +240,10 @@ Launch your application, you should see your logs arriving inside the Elastic St
[[logstash_ecs]]
== GELF alternative: Send logs to Logstash in the ECS (Elastic Common Schema) format

You can also send your logs to Logstash using a tcp input, using the https://www.elastic.co/guide/en/ecs-logging/overview/current/intro.html[ECS] format.
To achieve this we'll use the `quarkus-logging-json` extention to format the logs in json format and the socket handler to send them to Logstash.
You can also send your logs to Logstash using a TCP input in the https://www.elastic.co/guide/en/ecs-logging/overview/current/intro.html[ECS] format.
To achieve this we will use the `quarkus-logging-json` extension to format the logs in JSON format and the socket handler to send them to Logstash.

For this you can use the same docker compose yml file as above but with a different Logstash pipeline configuration.
For this you can use the same `docker-compose.yml` file as above but with a different Logstash pipeline configuration.

Check warning on line 246 in docs/src/main/asciidoc/centralized-log-management.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'. Raw Output: {"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.", "location": {"path": "docs/src/main/asciidoc/centralized-log-management.adoc", "range": {"start": {"line": 246, "column": 36}}}, "severity": "INFO"}

[source]
----
Expand Down Expand Up @@ -271,7 +271,7 @@ output {
}
----

Then configure your application to log in json format instead of GELF
Then configure your application to log in JSON format instead of GELF
----
<dependency>
<groupId>io.quarkus</groupId>
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/logging.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -512,7 +512,7 @@ For details about its configuration, see the xref:#quarkus-core_section_quarkus-

This handler will send the logs to a socket.
It is disabled by default, so you must first enable it.
When enabled, it sends all log events to a socket, for instance to a logstash server.
When enabled, it sends all log events to a socket, for instance to a Logstash server.

This will typically be used in conjunction with the `quarkus-logging-json` extension so send logs in ECS format to an Elasticsearch instance.
An example configuration can be found in the xref:centralized-log-management.adoc[Centralized log management] guide.
Expand Down

0 comments on commit 25f82d3

Please sign in to comment.