File: README

package info (click to toggle)
check-pgbackrest 1.9-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 716 kB
  • sloc: sh: 1,238; perl: 868; makefile: 41; sql: 25
file content (145 lines) | stat: -rw-r--r-- 4,821 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
NAME
    check_pgbackrest - pgBackRest backup check plugin for Nagios

SYNOPSIS
      check_pgbackrest [-s|--service SERVICE] [-S|--stanza NAME]
      check_pgbackrest [-l|--list]
      check_pgbackrest [--help]

DESCRIPTION
    check_pgbackrest is designed to monitor pgBackRest backups from Nagios.

    -s, --service SERVICE
        The Nagios service to run. See section SERVICES for a description of
        available services or use "--list" for a short service and
        description list.

    -S, --stanza NAME
        Name of the stanza to check.

    -O, --output OUTPUT_FORMAT
        The output format. Supported outputs are: "human", "json" and
        "nagios" (default).

    -C, --command FILE
        pgBackRest executable file (default: "pgbackrest").

    -c, --config CONFIGURATION_FILE
        pgBackRest configuration file.

    -P, --prefix COMMAND
        Some prefix command to execute the pgBackRest info command (eg:
        "sudo -iu postgres").

    -l, --list
        List available services.

    --debug
        Print some debug messages.

    -V, --version
        Print version and exit.

    -?, --help
        Show this help page.

  SERVICES
    Descriptions and parameters of available services.

    retention
        Fail when the number of full backups is less than the
        "--retention-full" argument.

        Fail when the newest backup is older than the "--retention-age"
        argument.

        Fail when the newest full backup is older than the
        "--retention-age-to-full" argument.

        The following units are accepted (not case sensitive): s (second), m
        (minute), h (hour), d (day). You can use more than one unit per
        given value.

        Arguments are not mandatory to only show some information.

    archives
        Check if all archived WALs exist between the oldest and the latest
        WAL needed for the recovery.

        This service requires the "--repo-path" argument to specify where
        the archived WALs are stored.

        The "--repo-host" and "--repo-host-user" arguments allow to list
        remote archived WALs using SFTP.

        The "--repo-s3" enables remote archived WALs stored in Amazon S3.

        The "--repo-s3-over-http" switch to HTTP connection instead of
        HTTPS.

        Archives must be compressed (.gz). If needed, use "compress-level=0"
        instead of "compress=n".

        Use the "--wal-segsize" argument to set the WAL segment size.

        The following units are accepted (not case sensitive): b (Byte), k
        (KB), m (MB), g (GB), t (TB), p (PB), e (EB) or Z (ZB). Only
        integers are accepted. Eg. "1.5MB" will be refused, use "1500kB".

        The factor between units is 1024 bytes. Eg. "1g = 1G =
        1024*1024*1024."

        Use the "--ignore-archived-before" argument to ignore the archived
        WALs generated before the provided interval. Used to only check the
        latest archives.

        Use the "--ignore-archived-after" argument to ignore the archived
        WALs generated after the provided interval.

        The "--latest-archive-age-alert" argument defines the max age of the
        latest archived WAL as an interval before raising a critical alert.

        The following units are accepted as interval (not case sensitive): s
        (second), m (minute), h (hour), d (day). You can use more than one
        unit per given value. If not set, the last unit is in seconds. Eg.
        "1h 55m 6" = "1h55m6s".

        All the missing archives are only shown in the "--debug" mode.

        Use "--list-archives" in addition with "--debug" to print the list
        of all the archived WAL segments.

        By default, all the archives older than the oldest backup start
        archive or newer than the max_wal returned by the pgBackRest info
        command are ignored.

        Use the "--extended-check" argument to force a full check of the
        found archives and raise warnings in case of inconsistencies.

        After pgBackRest 2.28, it is possible to use the "repo-ls" and
        "repo-get" internal commands with the "--enable-internal-pgbr-cmds"
        argument to list and get the content of files in the repository.

    check_pgb_version
        Check if this script is running a given version.

        You must provide the expected version using "--target-version".

CONTRIBUTING
    check_pgbackrest is an open project. Any contribution to improve it is
    welcome.

VERSION
    check_pgbackrest version 1.9, released on Tue Jul 28 2020.

LICENSING
    This program is open source, licensed under the PostgreSQL license. For
    license terms, see the LICENSE file.

AUTHORS
    Author: Stefan Fercot.

    Logo: Damien Cazeils (www.damiencazeils.com).

    Copyright: (c) 2018-2020, Dalibo.