@@ 1,16 1,16 @@
# borgbase-exporter
borgbase-exporter is a [Prometheus] exporter that exposes information about
-[borgbase] repositories.
+[BorgBase] repositories.
[Prometheus]: https://prometheus.io/
-[borgbase]: https://www.borgbase.com/
+[BorgBase]: https://www.borgbase.com/
-It polls [borgbase's GraphQL API] at a specified interval (default: 2 minutes).
+It polls [BorgBase's GraphQL API] at a specified interval (default: 2 minutes).
-[borgbase's GraphQL API]: https://api.borgbase.com/graphql
+[BorgBase's GraphQL API]: https://api.borgbase.com/graphql
-This app uses [gqlclient] to generate GraphQL code for borgbase's API.
+This app uses [gqlclient] to generate GraphQL code for BorgBase's API.
[gqlclient]: https://git.sr.ht/~emersion/gqlclient
@@ 48,17 48,17 @@ Timestamp of the last seen event keyed by (repo id, ip, slug, ssh key name)
# Usage
-You must configure the borgbase API token with the environment variable
+You must configure the BorgBase API token with the environment variable
`BORGBASE_API_TOKEN`.
```
Usage of ./borgbase-exporter:
-endpoint string
- The borgbase API address (default "https://api.borgbase.com/graphql")
+ The BorgBase API address (default "https://api.borgbase.com/graphql")
-listen-address string
The address to bind to (default ":9908")
-polling-interval int
- Interval in seconds before fetching data again from borgbase's API (default 120)
+ Interval in seconds before fetching data again from BorgBase's API (default 120)
```
# License
@@ 25,9 25,9 @@ var (
)
func init() {
- flag.IntVar(&pollingInterval, "polling-interval", defaultPollingInterval, "Interval in seconds before fetching data again from borgbase's API")
+ flag.IntVar(&pollingInterval, "polling-interval", defaultPollingInterval, "Interval in seconds before fetching data again from BorgBase's API")
flag.StringVar(&listenAddress, "listen-address", ":9908", "The address to bind to")
- flag.StringVar(&endpoint, "endpoint", borgbase.DefaultEndpoint, "The borgbase API address")
+ flag.StringVar(&endpoint, "endpoint", borgbase.DefaultEndpoint, "The BorgBase API address")
}
func main() {
@@ 55,7 55,7 @@ func main() {
http.Handle("/metrics", promhttp.Handler())
- logger.Info().Str("listen-address", listenAddress).Msg("Borgbase exporter listening")
+ logger.Info().Str("listen-address", listenAddress).Msg("BorgBase exporter listening")
if err := http.ListenAndServe(listenAddress, nil); err != nil {
logger.Fatal().Err(err).Msg("")
}