Introduce ENABLE_JSON_LOGGING
#216
Open
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
This change adds the `ENABLE_JSON_LOGGING` option to export restic metadata in JSON format. The goal is to improve accessibility by allowing users to utilize tools like `jq` to process the metadata. This enables users to create external scripts for extracting metadata and sending notifications using `run_commands`. update doc and include notify script as sample to send backup metadata via apprise Export `LOG_FILE` and create docker-compose for contributing - export `LOG_FILE` so it will be available for subprocess executed via `run_commands` - Add docker-compose.contribute.yml facilitate contributing process - make `notify` executable and copy it to /usr/local/bin - notify: update content to only include summary and errors for now. jq was complaining on payload too large when using verbose mode. - update doc
|
Hi @jeankhawand please any idea why it is still not deployed ? |
|
@djmaze that's will also make it easy to restore snapshots in the futur |
djmaze
requested changes
Jan 13, 2025
| @@ -99,7 +99,10 @@ _Note: `BACKUP_CRON`, `PRUNE_CRON` and `CHECK_CRON` are mutually exclusive._ | |||
| - `TZ` - Optional. Set your timezone for the correct cron execution time. | |||
| - `SKIP_INIT` - Skip initialization of the restic repository, even if it can not be accessed. | |||
| - `SKIP_INIT_CHECK`- Do not fail, if initialization of the restic repository fails for whatever reason. | |||
|
|
|||
| - `ENABLE_JSON_LOGGING` = Converts Restic's standard output to JSON format. This allows users to leverage tools like `jq` to extract specific fields from the metadata. Additionally, it supports calling external scripts for further processing, such as [executing commands after a backup](#execute-commands-after-backup). For example: | |||
There was a problem hiding this comment.
I guess this should also document that the LOG_FILE env variable is set for the commands to be used.
| @@ -0,0 +1,72 @@ | |||
| version: "3.3" | |||
There was a problem hiding this comment.
Not sure why you added this file and what the name is exactly about? IMO we can just remove this.
| @@ -0,0 +1,83 @@ | |||
| #!/bin/bash | |||
There was a problem hiding this comment.
This functionality should also be tested. I will add a test.
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.
This change adds the
ENABLE_JSON_LOGGINGoption to export restic metadata in JSON format. The goal is to improve accessibility by allowing users to utilize tools likejqto process the metadata. This enables users to create external scripts for extracting metadata and sending notifications usingrun_commands.update doc and include notify script as sample to send backup metadata via apprise
Export
LOG_FILEand create docker-compose for contributingLOG_FILEso it will be available for subprocess executed viarun_commandsnotifyexecutable and copy it to /usr/local/bin