From f732007b376fff9b8797617644dd85182d8cb330 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 31 Jan 2025 00:08:22 +0900 Subject: [PATCH] Update files for matrix-registration-bot: add the common section for "Troubleshooting" See: https://github.com/moan0s/matrix-registration-bot/blob/main/README.md Signed-off-by: Suguru Hirahara --- ...figuring-playbook-bot-matrix-registration-bot.md | 13 +++++++++++++ .../defaults/main.yml | 3 ++- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/configuring-playbook-bot-matrix-registration-bot.md b/docs/configuring-playbook-bot-matrix-registration-bot.md index a425b5969..fffd239f2 100644 --- a/docs/configuring-playbook-bot-matrix-registration-bot.md +++ b/docs/configuring-playbook-bot-matrix-registration-bot.md @@ -72,3 +72,16 @@ To clean the cache (session & encryption data) after you changed the bot's usern ```sh just run-tags bot-matrix-registration-bot-clean-cache ``` + +## Troubleshooting + +As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-registration-bot`. + +### Increase logging verbosity + +The default logging level for this component is `INFO`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook: + +```yaml +# Valid values: ERROR, INFO, DEBUG +matrix_bot_matrix_registration_bot_logging_level: DEBUG +``` diff --git a/roles/custom/matrix-bot-matrix-registration-bot/defaults/main.yml b/roles/custom/matrix-bot-matrix-registration-bot/defaults/main.yml index ba1fc7273..9423e8fad 100644 --- a/roles/custom/matrix-bot-matrix-registration-bot/defaults/main.yml +++ b/roles/custom/matrix-bot-matrix-registration-bot/defaults/main.yml @@ -39,7 +39,8 @@ matrix_bot_matrix_registration_bot_api_token: '' matrix_bot_matrix_registration_bot_device_id: "matrix-docker-ansible-deploy" -matrix_bot_matrix_registration_bot_logging_level: info +# Valid values: ERROR, INFO, DEBUG +matrix_bot_matrix_registration_bot_logging_level: INFO matrix_bot_matrix_registration_bot_container_network: ""