Migrate from Lwt_log to Logs #256
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
This was referenced Apr 8, 2025
vouillon
reviewed
Apr 23, 2025
src/files/ocsigenserver.conf/gen.ml
Outdated
| ; "ocsigenserver" ] | ||
| in | ||
| let packages = | ||
| "lwt_ssl,bytes,lwt.unix,logs,logs-syslog,syslog-message,ipaddr,findlib,cryptokit,re,str,xml-light,dynlink,cohttp-lwt-unix,hmap" |
There was a problem hiding this comment.
This needs to be updated as follows:
Suggested change
| "lwt_ssl,bytes,lwt.unix,logs,logs-syslog,syslog-message,ipaddr,findlib,cryptokit,re,str,xml-light,dynlink,cohttp-lwt-unix,hmap" | |
| "lwt_ssl,bytes,lwt.unix,logs,logs-syslog.unix,syslog-message,ipaddr,findlib,cryptokit,re,str,xml-light,dynlink,cohttp-lwt-unix" |
I suspect the computation of the dependencies fail silently when hmap is not installed. This is why ocsigenserver tries (unsuccessfully) to load unix.cma. One should check the return value of Unix.close_process_in inp below.
There was a problem hiding this comment.
I added a failure case when this happens so it should now be noticed. Thanks for the debugging !
This replaces all uses of the Lwt_log library by Logs. Lwt_log is deprecated and its README suggest to use Logs instead so it seems like a good choice. The bulk of the change was done with the lwt-log-to-logs tool. This is almost a 1 to 1 translation as the two libraries are very similar but there are some differences: - The "Fatal" log level doesn't exist in Logs. "Error" is used instead. - Log messages are formatted with Format. - Logs has no equivalent of "broadcast" and "dispatch" available out of the box. These operations are easily supported by generating more code. - There is no equivalent for Lwt_log.add_rule in Logs. Luckily it can be avoided in this project. This might cause more work in Ocsigen applications that use their own log sections. - Syslog support is done by the "logs-syslog" library. - There is no equivalent for Lwt_log.close. Ocsigen_messages is still able to close its reporters, except for the syslog reporter, which doesn't support this operation.
This restores Ocsigen's message format, including the date and section name. This adds the log level to the message, which was missing before.
Co-authored-by: Jérôme Vouillon <[email protected]>
This caused the config to be generated with the wrong dependency list, which caused errors while loading server plugins at runtime.
|
I think we can merge both if you fix the build and resolve the conflict of ocsigen/eliom#822. |
balat
approved these changes
May 2, 2025
The comments are not replaced as any generic comment would be less useful than the signature itself.
|
Thanks for reviewing :) I think it's all fixed now. |
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.
Based on top of these other PRs,
The Eliom side work is,
This replaces all uses of the Lwt_log library by Logs. Lwt_log is
deprecated and its README suggest to use Logs instead so it seems like a
good choice.
The bulk of the change was done with the lwt-log-to-logs tool: Julow/lwt-to-direct-style#5
This is almost a 1 to 1 translation as the two libraries are very
similar but there are some differences:
The "Fatal" log level doesn't exist in Logs. "Error" is used instead.
Log messages are formatted with Format.
Logs has no equivalent of "broadcast" and "dispatch" available out of
the box. These operations are easily supported by generating more
code.
There is no equivalent for Lwt_log.add_rule in Logs. Luckily it can be
avoided in this project. This might cause more work in Ocsigen
applications that use their own log sections.
Syslog support is done by the "logs-syslog" library.
There is no equivalent for Lwt_log.close. Ocsigen_messages is still
able to close its reporters, except for the syslog reporter, which
doesn't support this operation.