Skip to content

Commit

Permalink
Document that remote user logging attribute requires Quarkus Security
Browse files Browse the repository at this point in the history
  • Loading branch information
@michalvavrik
michalvavrik committed Nov 28, 2023
1 parent 7d4f0c6 commit 2beb27e
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/src/main/asciidoc/http-reference.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,13 @@ include::{generated-dir}/config/quarkus-vertx-http-config-group-access-log-confi
Set `quarkus.http.record-request-start-time=true` to enable recording request start times when using any of the attributes related to logging request processing times.

Check warning on line 431 in docs/src/main/asciidoc/http-reference.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using 'by using' or 'that uses' rather than 'using'.

Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'by using' or 'that uses' rather than 'using'.", "location": {"path": "docs/src/main/asciidoc/http-reference.adoc", "range": {"start": {"line": 431, "column": 95}}}, "severity": "INFO"}
====

[NOTE]
====
Assuming security has been set up for the application (see our xref:security-overview.adoc[guide] for more details),
logging attribute `Remote user that was authenticated` is set to the value of the `io.quarkus.security.identity.SecurityIdentity` principal.
Please refer to the xref:logging.adoc[Logging guide] for options how to add contextual log information yourself.
====

[TIP]
====
Use `quarkus.http.access-log.exclude-pattern=/some/path/.*` to exclude all entries concerning the path `/some/path/...` (_including subsequent paths_) from the log.
Expand Down

0 comments on commit 2beb27e

Please sign in to comment.