Skip to content

Add info about the server-logs.xml file (#2125) #2128

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

Merged
merged 1 commit into from
Feb 18, 2025
Merged

Add info about the server-logs.xml file (#2125) #2128

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
4 changes: 4 additions & 0 deletions modules/ROOT/pages/authentication-authorization/sso-integration.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,11 @@ server.jvm.additional=-Djavax.net.ssl.trustStorePassword=mypasword

While setting up an OIDC integration, it is sometimes necessary to perform troubleshooting.
In these cases, it can be useful to view the claims contained in the JWT supplied by the identity provider.

To enable the logging of these claims at `DEBUG` level in the security log, set xref:configuration/configuration-settings.adoc#config_dbms.security.logs.oidc.jwt_claims_at_debug_level_enabled[dbms.security.logs.oidc.jwt_claims_at_debug_level_enabled] to be `true` and the security log level to `DEBUG`.
You can do this in _<NEO4J_HOME>/conf/server-logs.xml_.

If you need more information on how to set up and manage the security log, see xref:monitoring/logging.adoc#security-events-logging[Configure the security log].

[WARNING]
====
Expand Down
3 changes: 2 additions & 1 deletion modules/ROOT/pages/monitoring/logging.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ and xref:configuration/configuration-settings.adoc#config_db.logs.query.threshol
| `VERBOSE`

| _security.log_
| Logs information about security events.
| label:Enterprise[] Logs information about security events.
| xref:configuration/configuration-settings.adoc#config_dbms.security.auth_enabled[`dbms.security.auth_enabled`]
| `true`

Expand Down Expand Up @@ -662,6 +662,7 @@ For more details on loggers, see the https://logging.apache.org/log4j/2.x/manual

[[garbage-collection-log-file-configuration]]
== Configure the garbage collection log

The garbage collection log, or GC log for short, is special and cannot be configured with Log4j 2.
The GC log is handled by the Java Virtual Machine(JVM) and must be passed directly to the command line.
To simplify this process, Neo4j exposes the following settings in _neo4j.conf_:
Expand Down
5 changes: 5 additions & 0 deletions modules/ROOT/pages/tutorial/tutorial-sso-configuration.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,7 +514,11 @@ Neo4j Browser will try to reconnect and reflect the changed permissions faster t

While setting up an OIDC integration, it is sometimes necessary to perform troubleshooting.
In these cases, it can be useful to view the claims contained in the JWT supplied by the identity provider.

To enable the logging of these claims at `DEBUG` level in the security log, set xref:configuration/configuration-settings.adoc#config_dbms.security.logs.oidc.jwt_claims_at_debug_level_enabled[dbms.security.logs.oidc.jwt_claims_at_debug_level_enabled] to `true` and the security log level to `DEBUG`.
You can do this in _<NEO4J_HOME>/conf/server-logs.xml_.

If you need more information on how to set up and manage the security log, see xref:monitoring/logging.adoc#security-events-logging[Configure the security log].

[WARNING]
====
Expand All @@ -523,6 +527,7 @@ Also, bear in mind that the set of claims provided by an identity provider in th
====

=== How to debug further problems with the configuration

Apart from the logs available in _logs/debug.log_ and _logs/security.log_ in the Neo4j path, you can also use the web-development console in your web browser when doing the SSO authentication flow with Bloom or Neo4j Browser.
This could reveal potential problems, such as the one presented below with an example identity provider and the Cross-Origin Request policy:

Expand Down