chore: logdoc #158
chore: logdoc #158
Conversation
docs/log-output-guide.md
Outdated
|
|
||
| ## Troubleshooting | ||
|
|
||
| If we are loging a specific intergration or service provider. It is nessary to ensure the SPID is correct in the keycloak deployment. (Check <realm of interest>/Identity Providers/<idp of interest>/Service Provider Entity ID). |
There was a problem hiding this comment.
SPID is only applicable for SAML IDP type.
There was a problem hiding this comment.
good catch, modified this
| </subsystem> | ||
| ``` | ||
|
|
||
| This configuration will output the requests and responses in the format: |
There was a problem hiding this comment.
does this log stored in the log files created in /var/log/eap?
There was a problem hiding this comment.
Hmm, not sure I was reading them directly from the raw output of the pod logs. If it's in the raw ouput wouldn't that mean it was stored with the others? (I can check by rsh into the pod and pulling those files down locally)
There was a problem hiding this comment.
I looked at the saved logs, the output doesn't seem to be saved to the
/var/log/eap folder
docs/log-output-guide.md
Outdated
|
|
||
| The keycloak configuration can be located in the [configuration folder](../docker/keycloak/configuration). Presently it is part of the image we deploy, meaning the image needs to be rebuilt before the logging change can take effect. For testing purposes, there is a keycloak deployment that allows users to edit the config in openshift and preview the effect by restarting the keycloak pod. Without the need to rebuild the image. | ||
|
|
||
| The test instance config is `sso-keycloak-4-sso-config` found in the `b861c7-test` namespace and is the associated with the `sso-keycloak-4` deployment. Making changes to the config will only be reflected in the `sso-keycloak-4` app after restarting the `sso-keyclaok-4` pod. |
There was a problem hiding this comment.
hm.. since the configuration changes can be also applied for other instances, wonder if this is too specific info for this testing.
There was a problem hiding this comment.
Do we need to rebuild those images before we can do that? It might be worth making an ops/dev ticket to convert the rest of the keycloak images, just so we have a consistent pattern.
Modified the troubleshooting tip
This documents how to turn the relevant logging a request dumping on.