kopia-mon

KO | EN

gitlite — search

#javascript #react #llm #machine-learning #deep-learning #nodejs #macos #java #awesome #cli #kubernetes #vue #security #mcp

(★ 53)

Status monitoring and reporting for kopia backup

파일 탐색기

최종 버전 다운로드 (.zip)

- launch.json
- settings.json
- backup-errors.png
- backup-success.png
- no-backup.png
- report.template
- snapshot.template
- __init__.py
- content_verify_output.txt
- snapshot_verify_output_no_errors.txt
- snapshot_verify_output_with_errors.txt
- test_kopiaapi.py
.gitignore
emailutil.py
environment-dev.yml
environment.yml
kopia-mon.py
kopiaapi.py
LICENSE.md
README.md
repoinfo.py
requirements.txt
status.py

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# kopia-mon
kopia-mon is a off-line monitoring and alerting tool for Kopia backup. It is designed to run on a schedule, review all the backup tasks that completed since its previous run, and send an email report with any detected errors.

<u>**Main features:**</u>
* Email based reporting and alerting for kopia backup
* Perform periodic snapshot verification with file download
* Always send the report or only when errors occur
* Alert on snapshot or snapshot verification errors
* Alert on snapshot inactivity/ missed backups
* Optionally do a basic verification that there were actually changes that required backup when detecting inactivity
* Optionally set a different email header when errors are detected
* Handles multiple repositories in a single email
* Support for SMTP servers that require authentication like gmail

⭐ If you are using this tool then please star the repo so I have an idea how many people are using it.

## Example reports:
A daily report with no errors:
![Example success report](https://raw.githubusercontent.com/ekutner/kopia-mon/master/images/backup-success.png)

A daily report with an error in one of the snapshots:
![Example error report](https://raw.githubusercontent.com/ekutner/kopia-mon/master/images/backup-errors.png)

A daily report when no snapshot has been taken for too long:
![Example error report](https://raw.githubusercontent.com/ekutner/kopia-mon/master/images/no-backup.png)

**NOTE:** The program has only been tested with gmail, both for sending and receiving the emails. Other SMTP providers that use TLS should work but there are no guarantees. Likewise, if the recipient is not on gmail, the email formatting may not work correctly and the email may look messed up.

# Setup
The kopia command line must be in the environment path when kopia-mon is started.

## Install and configure Python
### Using pip
Python with minimum version 3.11 is required. It is recommended to use a virtual environment, if you know how to use it and how to get the scheduler to run the script from the correct environment.

Installing dependencies: 
```
pip install -r requirements.txt
```

### Using Anaconda
Create a new environment for kopia-mon:
```
conda env create -f environment.yml
```
Activate the environment before using the script:
```
conda activate kopia-mon
```

## Create and configure a Gmail account
Since the config file holds a cleartext (=unencrypted) password it is **highly** recommended that you create a dedicated gmail account just for sending emails from kopia-mon. Once you create the account had over to the "Manage Account" panel and select the "Security" tab. Find the "Signing in to Google" section on that page and select "App passwords". Create a new app password and, copy it, and paste in appropriate place in the config file.

## Scheduling
The program doesn't manage scheduling. You should use your OS scheduling service (cron, Windows Task Scheduler, etc.) to run it periodically. Kopia's "After Snapshot" action should also work but it hasn't been tested and unless it's very important to be notified immediately about errors I wouldn't recommend it.

## Snapshot verification
Basic snapshot verification is done by the Kopia UI, however it stops short of downloading blobs from the storage to verify there are no corruptions there. Therefor, it is highly recommended to run periodic snapshot verification with file download, which is what kopia-mon can now do.  
See further information in [this discussion](https://kopia.discourse.group/t/does-kopiaui-not-verify-snapshots/3778/14) and in the [kopia documentation](https://kopia.io/docs/advanced/consistency/).

<BR>

# Configuration
## Command line
```python kopia-mon.py```

**Optional arguments:**  
**`-c <CONFIG_FILE>`** - Path to config file. Default: "config.yaml"  
**`--no-send-email`** - Write the report to stdout instead of sending it by email  
**`--set-exit-code`** -  Set the exit code to 0 if no report was generated, 2 if a report was generated and 6 if an error report was generated. An exit code of 1 would indicate a python error, as usual.

## Config file
kopia-mon requires a YAML configuration file with the following structure:

**email:**  
&nbsp;&nbsp; **from:** (required) - Email address of sender  
&nbsp;&nbsp; **to:** (required) - A single email address or array of email addresses to send the report to>  
&nbsp;&nbsp; **_subject:_** (optional) - The subject of the email when there are **_no errors_**  
&nbsp;&nbsp; **_subject-error:_** (optional) - The subject of the email when there **_are errors_**  
&nbsp;&nbsp; **server:**  
&nbsp;&nbsp;&nbsp;&nbsp; **address:** (required) - The address of the SMTP server to use for sending the emails  
&nbsp;&nbsp;&nbsp;&nbsp; **port:** (required) - The port of the SMTP server  
&nbsp;&nbsp;&nbsp;&nbsp; **transport:** (optional) - The transport encryption to use. Either SSL (the default) or TLS  
&nbsp;&nbsp;&nbsp;&nbsp; **user:** (required) - The username to authenticate to the SMTP server with  
&nbsp;&nbsp;&nbsp;&nbsp; **password:** (required) - The password to authenticate with  
**repositories:**  
&nbsp;&nbsp; \- **config-file:** (required) - The kopia config file for the repository  
&nbsp;&nbsp;&nbsp;&nbsp; **inactivity_days:** (required) - minimum days of inactivity before reporting an error  
&nbsp;&nbsp;&nbsp;&nbsp; **validate_inactivity:** (required) - Boolean value indicating if kopia-mon should try to verify if there were any actual file changes, that were expected to be backup up but didn't, before reporting an inactivity error. This check ignores ignored files so a change in an ignored file will still trigger the alert  
&nbsp;&nbsp;&nbsp;&nbsp; **errors_only:** (required) - Boolean value indicating if kopia-mon should only send an email when errors are detected or every time it runs  
&nbsp;&nbsp;&nbsp;&nbsp; **snapshot_verify:** (optional) - If not specified than snapshot verification will not be performed   
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; **interval_days:** (required) - The interval in days to run snapshot verify  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; **percent:** 1 (required) - The percent of files to download during verification

Example:
```
email:
  from: me@myself.com
  to: me@myself.com
  subject: Kopia Backup Report
  subject-error: Kopia Backup Report - HAS ERRORS
  server:
    address: smtp.gmail.com
    port: 465
    user: me@gmail.com
    password: my_app_password
repositories:
  - config-file: documents.config
    inactivity_days: 2
    validate_inactivity: false
    errors_only: true
  - config-file: media.config
    inactivity_days: 5
    validate_inactivity: true
    errors_only: true
    snapshot_verify:
        interval_days: 1
        percent: 1
```

kopia-mon

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

kopia-mon

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README