feat: allow logging to stdout, stderr #217
Merged
Conversation
This file contains 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
HeikoSchlittermann
force-pushed
the
feat-log-to-stdout
branch
from
7c28c83
to
9345bc1
Compare
|
What is the use case for logging to stderr? For stdout a pretty common name would be "-", that is |
|
I currently do not have a use case for logging to STDERR. I suggested it for both (stderr, stdout) just for completeness. Logging to STDOUT though I have a use case for: I'd like to have Systemd capture all the output. Depending on the invocation, I'm fine with |
MichaelEischer
requested changes
Apr 22, 2023
There was a problem hiding this comment.
I'm fine with
--log -too. But IMHO--log stdoutis more self-explanatory.
Both variants are special cases that can be pretty surprising. Although using - to mean stdout/stdin is quite common for unix commands. Thus, we should stick to that convention. Please change the PR to use --log - to log to stdout and remove the stderr variant.
The --log option accepts "-" as filename. This prevents rest-server from opening the log file, it simply writes to the STDOUT stream provided by the caller. **BREAKING** in case use really used "-" to specify a file named "-" you'll need to update your rest-server invocation to use "./-".
HeikoSchlittermann
force-pushed
the
feat-log-to-stdout
branch
from
9345bc1
to
9f074d8
Compare
MichaelEischer
approved these changes
Apr 30, 2023
4 tasks
netbsd-srcmastr
pushed a commit
to NetBSD/pkgsrc
that referenced
this pull request
Oct 19, 2023
Fix PKGNAME while here. Changelog for rest-server 0.12.1 (2023-07-09) ============================================ The following sections list the changes in rest-server 0.12.1 relevant to users. The changes are ordered by importance. Summary ------- * Fix #230: Fix erroneous warnings about unsupported fsync * Fix #238: API: Return empty array when listing empty folders * Enh #217: Log to stdout using the `--log -` option Details ------- * Bugfix #230: Fix erroneous warnings about unsupported fsync Due to a regression in rest-server 0.12.0, it continuously printed `WARNING: fsync is not supported by the data storage. This can lead to data loss, if the system crashes or the storage is unexpectedly disconnected.` for systems that support fsync. We have fixed the warning. restic/rest-server#230 restic/rest-server#231 * Bugfix #238: API: Return empty array when listing empty folders Rest-server returned `null` when listing an empty folder. This has been changed to returning an empty array in accordance with the REST protocol specification. This change has no impact on restic users. restic/rest-server#238 restic/rest-server#239 * Enhancement #217: Log to stdout using the `--log -` option Logging to stdout was possible using `--log /dev/stdout`. However, when the rest server is run as a different user, for example, using `sudo -u restic rest-server [...] --log /dev/stdout` This did not work due to permission issues. For logging to stdout, the `--log` option now supports the special filename `-` which also works in these cases. restic/rest-server#217
netbsd-srcmastr
pushed a commit
to NetBSD/pkgsrc
that referenced
this pull request
Aug 6, 2024
Changelog for rest-server 0.13.0 (2024-07-26) ============================================ The following sections list the changes in rest-server 0.13.0 relevant to users. The changes are ordered by importance. Summary ------- * Chg #267: Update dependencies and require Go 1.18 or newer * Chg #273: Shut down cleanly on TERM and INT signals * Enh #271: Print listening address after start-up * Enh #272: Support listening on a unix socket Details ------- * Change #267: Update dependencies and require Go 1.18 or newer Most dependencies have been updated. Since some libraries require newer language features, support for Go 1.17 has been dropped, which means that rest-server now requires at least Go 1.18 to build. restic/rest-server#267 * Change #273: Shut down cleanly on TERM and INT signals Rest-server now listens for TERM and INT signals and cleanly closes down the http.Server and listener when receiving either of them. This is particularly useful when listening on a unix socket, as the server will now remove the socket file when it shuts down. restic/rest-server#273 * Enhancement #271: Print listening address after start-up When started with `--listen :0`, rest-server would print `start server on :0` The message now also includes the actual address listened on, for example `start server on 0.0.0.0:37333`. This is useful when starting a server with an auto-allocated free port number (port 0). restic/rest-server#271 * Enhancement #272: Support listening on a unix socket It is now possible to make rest-server listen on a unix socket by prefixing the socket filename with `unix:` and passing it to the `--listen` option, for example `--listen unix:/tmp/foo`. This is useful in combination with remote port forwarding to enable a remote server to backup locally, e.g.: ``` rest-server --listen unix:/tmp/foo & ssh -R /tmp/foo:/tmp/foo user@host restic -r rest:http+unix:///tmp/foo:/repo backup ``` restic/rest-server#272 Changelog for rest-server 0.12.1 (2023-07-09) ============================================ The following sections list the changes in rest-server 0.12.1 relevant to users. The changes are ordered by importance. Summary ------- * Fix #230: Fix erroneous warnings about unsupported fsync * Fix #238: API: Return empty array when listing empty folders * Enh #217: Log to stdout using the `--log -` option Details ------- * Bugfix #230: Fix erroneous warnings about unsupported fsync Due to a regression in rest-server 0.12.0, it continuously printed `WARNING: fsync is not supported by the data storage. This can lead to data loss, if the system crashes or the storage is unexpectedly disconnected.` for systems that support fsync. We have fixed the warning. restic/rest-server#230 restic/rest-server#231 * Bugfix #238: API: Return empty array when listing empty folders Rest-server returned `null` when listing an empty folder. This has been changed to returning an empty array in accordance with the REST protocol specification. This change has no impact on restic users. restic/rest-server#238 restic/rest-server#239 * Enhancement #217: Log to stdout using the `--log -` option Logging to stdout was possible using `--log /dev/stdout`. However, when the rest server is run as a different user, for example, using `sudo -u restic rest-server [...] --log /dev/stdout` This did not work due to permission issues. For logging to stdout, the `--log` option now supports the special filename `-` which also works in these cases. restic/rest-server#217
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.
What is the purpose of this change? What does it change?
The --log option accepts "stdout", "stderr" as filenames. This prevents rest-server from opening these files, it simply writes the logs to the STDOUT or STDERR stream provided by the caller.
BREAKING in case the user really used "stdout", "stderr" to specify file names, you'll need to update your rest-server invocation to use "./stdout", "./stderr".
Was the change discussed in an issue or in the forum before?
No.
Checklist
Not in the manual, but in the options help
changelog/unreleased/that describes the changes for our users (template here)gofmton the code in all commits