diff --git a/docs/source/how_to/logging.md b/docs/source/how_to/logging.md index 7ae3b18..d88882d 100644 --- a/docs/source/how_to/logging.md +++ b/docs/source/how_to/logging.md @@ -1,4 +1,4 @@ -# Logging +# Keeping Logs Auto Archiver's logs can be helpful for debugging problematic archiving processes. This guide shows you how to use the logs to @@ -6,6 +6,22 @@ Auto Archiver's logs can be helpful for debugging problematic archiving processe Logging settings can be set on the command line or using the orchestration config file ([learn more](../installation/configuration)). A special `logging` section defines the logging options. +#### Enabling or Disabling Logging + +Logging to the console is enabled by default. If you want to globally disable Auto Archiver's logging, then you can set `enabled: false` in your `logging` config: + +```{code} yaml + +... +logging: + enabled: false +... +``` + +```{note} +This will disable all logs from Auto Archiver, but it does not disable logs for other tools that the Auto Archiver uses (for example: yt-dlp, firefox or ffmpeg). These logs will still appear in your console. +``` + #### Logging Level There are 7 logging levels in total, with 4 commonly used levels. They are: `DEBUG`, `INFO`, `WARNING` and `ERROR`. diff --git a/docs/source/how_to/new_config_format.md b/docs/source/how_to/new_config_format.md index 54ddb8c..6c12276 100644 --- a/docs/source/how_to/new_config_format.md +++ b/docs/source/how_to/new_config_format.md @@ -42,10 +42,11 @@ The feeder and formatter settings have been changed from a single string to a li - `steps.formatter (string)` → `steps.formatters (list)` Example: -```{yaml} + +```{code} yaml + steps: feeder: cli_feeder - - telegram_archiver ... formatter: html_formatter @@ -54,8 +55,8 @@ steps: feeders: - cli_feeder ... - formatters: - - html_formatter + formatters: + - html_formatter ``` ```{note} Auto Archiver still only supports one feeder and formatter, but from v0.13 onwards they must be added to the configuration file as a list. @@ -63,7 +64,7 @@ steps: #### b) Extractor (formerly Archiver) Steps Settings -With v0.13 of Auto Archiver, the `archivers` have been renamed to `extractors` to reflect the work they actually do - extract information from a URL. Change the configuration by renaming: +With v0.13 of Auto Archiver, `archivers` have been renamed to `extractors` to better reflect what they actually do - extract information from a URL. Change the configuration by renaming: - `steps.archivers` → `steps.extractors` @@ -74,10 +75,10 @@ The names of the actual modules have also changed, so for any extractor modules - `wayback_archiver_enricher` → `wayback_extractor_enricher` - `vk_archiver` → `vk_extractor` -Additionally, the `youtube_archiver` has been renamed to `generic_extractor` and should be considere the default/fallback extractor. Read more about the [generic extractor](../modules/autogen/extractor/generic_extractor.md). +Additionally, the `youtube_archiver` has been renamed to `generic_extractor` as it is considered the default/fallback extractor. Read more about the [generic extractor](../modules/autogen/extractor/generic_extractor.md). Example: -```{yaml} +```{code} yaml steps: ... archivers: @@ -115,10 +116,10 @@ Then, you can generate a `simple` or `full` config using: >>> # generate a simple config >>> auto-archiver >>> # config will be written to orchestration.yaml ->>> +>>> >>> # generate a full config >>> auto-archiver --mode=full ->>> +>>> ``` After this, copy over any settings from your old config to the new config.