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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
package main
import (
"os"
"os/signal"
"path/filepath"
"strings"
"syscall"
"time"
"github.com/go-kit/log"
"github.com/go-kit/log/level"
"github.com/prometheus/common/promlog"
"github.com/prometheus/common/promlog/flag"
"github.com/prometheus/exporter-toolkit/web/kingpinflag"
"github.com/woblerr/pgbackrest_exporter/backrest"
kingpin "gopkg.in/alecthomas/kingpin.v2"
)
var version = "unknown"
func main() {
var (
webPath = kingpin.Flag(
"web.endpoint",
"Endpoint used for metrics.",
).Default("/metrics").String()
webAdditionalToolkitFlags = kingpinflag.AddFlags(kingpin.CommandLine, ":9854")
collectionInterval = kingpin.Flag(
"collect.interval",
"Collecting metrics interval in seconds.",
).Default("600").Int()
backrestCustomConfig = kingpin.Flag(
"backrest.config",
"Full path to pgBackRest configuration file.",
).Default("").String()
backrestCustomConfigIncludePath = kingpin.Flag(
"backrest.config-include-path",
"Full path to additional pgBackRest configuration files.",
).Default("").String()
backrestIncludeStanza = kingpin.Flag(
"backrest.stanza-include",
"Specific stanza for collecting metrics. Can be specified several times.",
).Default("").PlaceHolder("\"\"").Strings()
backrestExcludeStanza = kingpin.Flag(
"backrest.stanza-exclude",
"Specific stanza to exclude from collecting metrics. Can be specified several times.",
).Default("").PlaceHolder("\"\"").Strings()
backrestBackupType = kingpin.Flag(
"backrest.backup-type",
"Specific backup type for collecting metrics. One of: [full, incr, diff].",
).Default("").String()
backrestBackupDBCount = kingpin.Flag(
"backrest.database-count",
"Exposing the number of databases in backups.",
).Default("false").Bool()
backrestBackupDBCountParallelProcesses = kingpin.Flag(
"backrest.database-parallel-processes",
"Number of parallel processes for collecting information about databases.",
).Default("1").Int()
backrestBackupDBCountLatest = kingpin.Flag(
"backrest.database-count-latest",
"Exposing the number of databases in the latest backups.",
).Default("false").Bool()
backrestBackupReferenceCount = kingpin.Flag(
"backrest.reference-count",
"Exposing the number of references to another backups (backup reference list).",
).Default("false").Bool()
backrestVerboseWAL = kingpin.Flag(
"backrest.verbose-wal",
"Exposing additional labels for WAL metrics.",
).Default("false").Bool()
)
// Set logger config.
promlogConfig := &promlog.Config{}
// Add flags log.level and log.format from promlog package.
flag.AddFlags(kingpin.CommandLine, promlogConfig)
// Add short help flag.
kingpin.HelpFlag.Short('h')
// Load command line arguments.
kingpin.Parse()
// Setup signal catching.
sigs := make(chan os.Signal, 1)
// Catch listed signals.
signal.Notify(sigs, syscall.SIGINT, syscall.SIGTERM)
// Set logger.
logger := promlog.New(promlogConfig)
// Method invoked upon seeing signal.
go func(logger log.Logger) {
s := <-sigs
level.Warn(logger).Log(
"msg", "Stopping exporter",
"name", filepath.Base(os.Args[0]),
"signal", s)
os.Exit(1)
}(logger)
level.Info(logger).Log(
"msg", "Starting exporter",
"name", filepath.Base(os.Args[0]),
"version", version)
if *backrestCustomConfig != "" {
level.Info(logger).Log(
"mgs", "Custom pgBackRest configuration file",
"file", *backrestCustomConfig)
}
if *backrestCustomConfigIncludePath != "" {
level.Info(logger).Log(
"mgs", "Custom path to additional pgBackRest configuration files",
"path", *backrestCustomConfigIncludePath)
}
if strings.Join(*backrestIncludeStanza, "") != "" {
backrest.MetricResetFlag = false
for _, stanza := range *backrestIncludeStanza {
level.Info(logger).Log(
"mgs", "Collecting metrics for specific stanza",
"stanza", stanza)
}
}
if strings.Join(*backrestExcludeStanza, "") != "" {
for _, stanza := range *backrestExcludeStanza {
level.Info(logger).Log(
"mgs", "Exclude collecting metrics for specific stanza",
"stanza", stanza)
}
}
if *backrestBackupType != "" {
level.Info(logger).Log(
"mgs", "Collecting metrics for specific backup type",
"type", *backrestBackupType)
}
if *backrestBackupReferenceCount {
level.Info(logger).Log(
"msg", "Exposing the number of references to another backups (backup reference list).",
"reference-count", *backrestBackupReferenceCount)
}
if *backrestBackupDBCount {
level.Info(logger).Log(
"msg", "Exposing the number of databases in backups",
"database-count", *backrestBackupDBCount,
"database-parallel-processes", *backrestBackupDBCountParallelProcesses)
}
if *backrestBackupDBCountLatest {
level.Info(logger).Log(
"msg", "Exposing the number of databases in the latest backups",
"database-count-latest", *backrestBackupDBCountLatest)
}
if *backrestVerboseWAL {
level.Info(logger).Log(
"mgs", "Enabling additional labels for WAL metrics",
"verbose-wal", *backrestVerboseWAL)
}
// Setup parameters for exporter.
backrest.SetPromPortAndPath(*webAdditionalToolkitFlags, *webPath)
level.Info(logger).Log(
"mgs", "Use exporter parameters",
"endpoint", *webPath,
"config.file", *webAdditionalToolkitFlags.WebConfigFile,
)
// Start exporter.
backrest.StartPromEndpoint(logger)
// Set up exporter info metric.
// There is no need to reset metric every time,
// it is set up once at startup.
backrest.GetExporterInfo(version, logger)
for {
// Get information form pgBackRest and set metrics.
backrest.GetPgBackRestInfo(
*backrestCustomConfig,
*backrestCustomConfigIncludePath,
*backrestBackupType,
*backrestIncludeStanza,
*backrestExcludeStanza,
*backrestBackupReferenceCount,
*backrestBackupDBCount,
*backrestBackupDBCountLatest,
*backrestVerboseWAL,
*backrestBackupDBCountParallelProcesses,
logger,
)
// Sleep for 'collection.interval' seconds.
time.Sleep(time.Duration(*collectionInterval) * time.Second)
}
}
|
