borgbackup / borgbackup/borg

fetch metadata state of a borg repo (formats: text,json,...)

Open
#2,934 4 comments 1 reaction 0 assignees View on GitHub
monitoring
Dominant language
Python
Stars
13.7k
Forks
875
Avg merge
12h 37m
Merged PRs (30d)
199

Description

For monitoring purposes it would be nice to fetch the (full) ~~state~~ metadata state of a borg repo non-blocking, even if it is blocked. It could open the folder read only fetches all infos of the archives/blobs/... and drops the data structure as json

```bash
user@host:~$ borg state --full --json foorepo
{
...
}
user@host:~$ borg state --current-archive --json foorepo
{
...
}
```

Of this is achievable with overlayfs and list as well, but monitoring support of borg is very limited, so that it is quite hard to write general rules for systems like collectd, nagios, zabbix ...

Contributor guide

Open the contributing guide

Research direction

Start by reviewing Borg's existing command-line and JSON-output behavior, then clarify the requested metadata scope and the meaning of non-blocking access when a repository is locked. Done should include an agreed command interface, supported output formats, and monitoring data for the requested repository states.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.