Email job status option

[tim-shortons]

If possible, an option to send an email upon completion with the job status.

I am handling this in a rather inelegant way in crontab for the time being
/root/scripts/plex_backup/linux_plex_backup.sh; newest=$(ls -Art /share/plex_backup/*.log | tail -n 1); mutt -s "Plex Backup Complete" notreal@fake.com < "$newest"

Initially I had a simple mutt output in crontab
/root/scripts/plex_backup/linux_plex_backup.sh | mutt -s "Plex Backup Complete" notreal@fake.com

Unfortunately, cron will try and output the entire job even if you have logAll=no and the output is too large to email, in my case 90MB. Thus I had to retrieve the contents of the actual log file instead or relying on the job output. Then I ran into the issue of retrieving the correct log file contents, hence the newest logic.

I am going to take a stab at adding an email option to the script, but I am no scripter/programmer.

[007revad]

@tim-shortons

Give me a week and I'll add support for emailing the log file. I'd use msmtp as most Linux distros include msmtp and I'm already familiar with using it in bash scripts to send emails.

[007revad]

@tim-shortons

Do you want to try this version https://github.com/007revad/Linux_Plex_Backup/releases/tag/v1.2.7-RC

The readme for v1.2.7-RC is here https://github.com/007revad/Linux_Plex_Backup/tree/develop

[tim-shortons]

My last modification. Modified to switch email on logAll = yes to logAll = no, this allows for the condensed log which is small enough to email. Perhaps other's won't run into email size restriction depending on your plex instance, but my full log was hitting 100MB with over 750,000 lines. I like the idea of having a full log, but didn't feel like messing with grep and sed to cut the output down to a size that could be emailed or writing a second output. Maybe I'll mess with it later, as it stands the small log will suffice.

https://gist.github.com/tim-shortons/51aab74d0a51f9cbcd9c96bcee47e261

[007revad]

I'll add a Client setting in backup_linux_plex.conf that can be set to mutt or msmtp

My Synology and Asustor versions of this script have a LogAll setting that if set to "no" the script skips logging every file so the log is only 1KB:

ASUSTOR AS5304T ADM 4.1.0.RLQ1
Hostname: NIMBUSTOR
Plex version: 1.29.2.6364
Stopping Plex...
Plex Media Server has stopped.
Checking status of Plex processes...
All Plex processes have stopped.
=======================================
Backing up Plex Media Server data files:
=======================================
Starting Plex...

Backup Started:  Sun Dec  4 21:08:28 EST 2022
Backup Finished: Sun Dec  4 21:08:39 EST 2022
Backup Duration: 0d:00h:00m:11s

Currently if there were any errors the email says to see the error log:

ASUSTOR AS5304T ADM 4.1.0.RLQ1
Hostname: NIMBUSTOR
Plex version: 1.29.2.6364
Stopping Plex...
Plex Media Server has stopped.
Checking status of Plex processes...
All Plex processes have stopped.
=======================================
Backing up Plex Media Server data files:
=======================================
Starting Plex...

Backup Started:  Sun Dec  4 21:08:28 EST 2022
Backup Finished: Sun Dec  4 21:08:39 EST 2022
Backup Duration: 0d:00h:00m:11s

Plex backup completed successfully

WARNING Plex backup had errors! See error log:
ASUSTOR_20221204-2108_Plex_1.29.2.6364_Backup_Preferences_ERROR.log

I'll change this to include the error log in the email.

I might change the script to either:

• Use LogAll=no when emailing the log is enabled.
• Write a 2nd log that skips logging every file.

[007revad]

I just realised this script does have the LogAll setting.

[007revad]

PS my full logs are 120 to 160MB

[tim-shortons]

I just realised this script does have the LogAll setting.

Yeah it was already in your the script config.

# Log all files backed up.
# Set LogAll= to yes or no. Blank is the same as no.
LogAll=

# Email log. Requires LogAll=yes
# Uses msmtp to send the email.
to_email_address=
from_email_address=

My modification is to perform a check on that value and if no send the email.

        if [[ -d "${3}" ]]; then  # Make sure directory exists
            if [[ -w "${3}" ]]; then  # Make sure directory is writable 
                if [[ -r "${3}" ]]; then  # Make sure directory is readable 
                    if [[ ${LogAll,,} == "no" ]]; then

Thanks for confirming the full log size, seems my 100MB log is not unexpected.