Skip to content

Commit 9268f5e

Browse files
Add info about the server-logs.xml file (#2125) (#2128)
1 parent 07adc98 commit 9268f5e

File tree

3 files changed

+11
-1
lines changed

3 files changed

+11
-1
lines changed

modules/ROOT/pages/authentication-authorization/sso-integration.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,11 @@ server.jvm.additional=-Djavax.net.ssl.trustStorePassword=mypasword
402402

403403
While setting up an OIDC integration, it is sometimes necessary to perform troubleshooting.
404404
In these cases, it can be useful to view the claims contained in the JWT supplied by the identity provider.
405+
405406
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`.
407+
You can do this in _<NEO4J_HOME>/conf/server-logs.xml_.
408+
409+
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].
406410

407411
[WARNING]
408412
====

modules/ROOT/pages/monitoring/logging.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ and xref:configuration/configuration-settings.adoc#config_db.logs.query.threshol
6060
| `VERBOSE`
6161

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

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

663663
[[garbage-collection-log-file-configuration]]
664664
== Configure the garbage collection log
665+
665666
The garbage collection log, or GC log for short, is special and cannot be configured with Log4j 2.
666667
The GC log is handled by the Java Virtual Machine(JVM) and must be passed directly to the command line.
667668
To simplify this process, Neo4j exposes the following settings in _neo4j.conf_:

modules/ROOT/pages/tutorial/tutorial-sso-configuration.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -514,7 +514,11 @@ Neo4j Browser will try to reconnect and reflect the changed permissions faster t
514514

515515
While setting up an OIDC integration, it is sometimes necessary to perform troubleshooting.
516516
In these cases, it can be useful to view the claims contained in the JWT supplied by the identity provider.
517+
517518
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`.
519+
You can do this in _<NEO4J_HOME>/conf/server-logs.xml_.
520+
521+
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].
518522

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

525529
=== How to debug further problems with the configuration
530+
526531
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.
527532
This could reveal potential problems, such as the one presented below with an example identity provider and the Cross-Origin Request policy:
528533

0 commit comments

Comments
 (0)