Error logging improvement. #114
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
route443
force-pushed
the
dev/error-logs
branch
from
10fa2c8 to
9413deb
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR implements unified error handling for the OpenID Connect module with improved logging capabilities and debugging support. The changes introduce error reference IDs, JSON log formatting, and optional stack trace output.
Key changes:
- Added unified
oidcError()function for consistent error handling with reference IDs - Converted error handling from simple logging to structured error throwing with try-catch blocks
- Added configurable JSON log format and debug mode with stack traces
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| openid_connect.server_conf | Added commented debug configuration variable |
| openid_connect.js | Complete error handling refactor with new unified error function and structured exception handling |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
roman-f5
reviewed
Aug 20, 2025
route443
force-pushed
the
dev/error-logs
branch
from
9413deb to
fd22fa9
Compare
roman-f5
reviewed
Aug 21, 2025
roman-f5
reviewed
Aug 21, 2025
roman-f5
reviewed
Aug 21, 2025
- Implemented unified function for error handling. - Each error is assigned its own identifier, generated by using the first 8 chars of the $request_id variable. - Added support for JSON log output. This is controlled by the $oidc_log_format variable, which must be set to 'json'. - Added support for stack trace output. This is enabled by the $oidc_debug variable, which must have any non-empty value. If this variable is defined, the $internal_error_message variable is overwritten with the text of the last error and returned to the User Agent - so use this only for debugging!
route443
force-pushed
the
dev/error-logs
branch
from
fd22fa9 to
db3282f
Compare
roman-f5
approved these changes
Aug 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
$oidc_log_formatvariable, which must be set to 'json'.$oidc_debug variable, which must have any non-empty value. If this variable is defined, the $internal_error_message variable is overwritten with the text of the last error and returned to the User Agent - so use this only for debugging!Fixes issue #113
Example:
{"refId":"276072cf:codeExchange.validate","message":"OIDC ID Token validation error: nonce from token (0000) does not match client (1111)","clientIp":"127.0.0.1","host":"localhost:8080","method":"GET","uri":"/_codexch","httpVersion":"1.0","stack":"Error: OIDC ID Token validation error: nonce from token (0000) does not match client ()\n at validateIdTokenClaims (/tmp/nginx-test-z0FP7gJiCP/openid_connect.js:168)\n at validateIdToken (/tmp/nginx-test-z0FP7gJiCP/openid_connect.js:127)\n at native (native)\n"}