Skip to content

Feature/add bucket usage total metric #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
schakko merged 7 commits into from
Mar 22, 2025
Merged

Feature/add bucket usage total metric #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7d58c3a
feat: added/updated metrics
thomashoell Mar 13, 2025
5d972b0
feat: updated configuration section to reflect changes to the config …
thomashoell Mar 13, 2025
808d2ea
feat: updated configuration section to reflect changes to the definit…
thomashoell Mar 13, 2025
6cedc5b
refactor: renamed metric in accordance to prometheus naming conventions
thomashoell Mar 14, 2025
c92ca25
metrics were renamed
thomashoell Mar 17, 2025
1b7b25c
docs: fixed typos, metrics and added Makefile
schakko Mar 22, 2025
e10ffc8
fix: metrics naming updated
schakko Mar 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file modified .gitignore
100644 → 100755
View file
Open in desktop
Empty file.
2 changes: 2 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
run:
npm start
2 changes: 1 addition & 1 deletion docs/10-deployment/20-helm-chart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ We provide a [Helm chart for backmon](https://github.com/dreitier/helm-charts/).
You can either use that repository and install the helm chart with

```bash
$ git clone https://github.com/dreitier/helm-charts/`
$ git clone https://github.com/dreitier/helm-charts/
$ cd helm-charts/charts/backmon
$ helm install backmon
```
Expand Down
61 changes: 32 additions & 29 deletions docs/20-reference/10-backmon-configuration/01-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,10 @@ environments:
- "/regular_ex.*ssions_are_supported/"
all_others: exclude
env_2:
access_key_id: my_access_key_id
secret_access_key: my_secret_access_key
auto_discover_disks: true
s3:
access_key_id: my_access_key_id
secret_access_key: my_secret_access_key
auto_discover_disks: true
disks:
include:
- my-bucket-1
Expand All @@ -70,31 +71,33 @@ environments:

## Available configuration keys

| Key | Default | Required | Description |
|------------------------------------------|-------------------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `port` | `80` (*int*) | No | Default HTTP port to listen for requests. TLS is not supported at the moment. Consider using a proxy if you need encryption. |
| `update_interval` | `1h` (*duration*) | No | Checks each disk in that duration interval. [time.ParseDuration format](https://pkg.go.dev/time#example-ParseDuration) must be used. |
| `log_level` | `<empty>` (*one of `debug`, `info`*) | No | Used log level; will be overwritten if `--debug` is used. |
| `downloads.enabled` | `false` | No | If `true`, the latest artifact of a monitored backup disk can be downloaded. This is disabled by default for security reasons ([#1](https://github.com/dreitier/backmon/issues/1)). |
| `http.basic_auth.username` | `<empty>` (*string*) | No | Username for HTTP Basic Authentication. If this is set, `http.basic_auth.password` must be also set. |
| `http.basic_auth.password` | `<empty>` (*string*) | No | Password for HTTP Basic Authentication. If this is set, `http.basic_auth.username` must be also set. |
| `http.tls.certificate` | `<empty>` (*string*) | No | Path to certificate file. If this is set, `http.tls.key` must be also set. |
| `http.tls.key` | `<empty>` (*string*) | No | Path to private key file. If this is set, `http.tls.certificate` must be also set. |
| `http.tls.strict` | `false` (*bool*) | No | If set to true, a preferred TLS default configuration is used. |
| `environments` | `<empty>` (*list of environment*) | No | Each `environment` to check. |
| `environments[]` | `<empty>` (*string*) | __Yes__ | Name of environment. |
| `environments[$env].definitions` | `backup_definitions.yaml` (*string*) | No | YAML file containing the backup definitions. |
| `environments[$env].path` | `<empty>` (*string*) | No | Local path to check for. If you use the `path` parameter, other parameters specific for S3 are ignored. |
| `environments[$env].region` | `eu-central-1` (*string*) | No | AWS region |
| `environments[$env].force_path_style` | `false` (*bool*) | No | Use path-style for that S3 bucket. This is deprecated by AWS S3 and should be probably `false`. |
| `environments[$env].access_key_id` | `<empty>` (*string*) | __Yes__ | AWS Access Key |
| `environments[$env].secret_access_key` | `<empty>` (*string*) | __Yes__ | AWS Secret Access Key |
| `environments[$env].endpoint` | `<empty>` (*string*) | No | Custom AWS S3 endpoint. This must be used for Minio buckets or if you are using a local S3 instance. |
| `environments[$env].token` | `<empty>` (*string*) | No | AWS STS session token. You can leave that empty. |
| `environments[$env].auto_discover_disks` | `true` (*bool*) | No | Automatically iterate over each S3 bucket. |
| `environments[$env].disks.include` | `<empty>` (*list of strings*) | No | Only include the disks with the given name; case-sensitive; regular expressions are supported. |
| `environments[$env].disks.exclude` | `<empty>` (*list of strings*) | No | Only include the disks with the given name; case-sensitive; regular expressions are supported. |
| `environments[$env].disks.all_others` | `include` (*one of `include`, `exclude`*) | No | Behaviour for disks which are not explicitly included or excluded. |
| Key | Default | Required | Description |
|---------------------------------------------|-------------------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `port` | `80` (*int*) | No | Default HTTP port to listen for requests. TLS is not supported at the moment. Consider using a proxy if you need encryption. |
| `update_interval` | `1h` (*duration*) | No | Checks each disk in that duration interval. [time.ParseDuration format](https://pkg.go.dev/time#example-ParseDuration) must be used. |
| `log_level` | `<empty>` (*one of `debug`, `info`*) | No | Used log level; will be overwritten if `--debug` is used. |
| `downloads.enabled` | `false` | No | If `true`, the latest artifact of a monitored backup disk can be downloaded. This is disabled by default for security reasons ([#1](https://github.com/dreitier/backmon/issues/1)). |
| `http.basic_auth.username` | `<empty>` (*string*) | No | Username for HTTP Basic Authentication. If this is set, `http.basic_auth.password` must be also set. |
| `http.basic_auth.password` | `<empty>` (*string*) | No | Password for HTTP Basic Authentication. If this is set, `http.basic_auth.username` must be also set. |
| `http.tls.certificate` | `<empty>` (*string*) | No | Path to certificate file. If this is set, `http.tls.key` must be also set. |
| `http.tls.key` | `<empty>` (*string*) | No | Path to private key file. If this is set, `http.tls.certificate` must be also set. |
| `http.tls.strict` | `false` (*bool*) | No | If set to true, a preferred TLS default configuration is used. |
| `environments` | `<empty>` (*list of environment*) | No | Each `environment` to check. |
| `environments[]` | `<empty>` (*string*) | __Yes__ | Name of environment. |
| `environments[$env].definitions` | `backup_definitions.yaml` (*string*) | No | YAML file containing the backup definitions. |
| `environments[$env].path` | `<empty>` (*string*) | No | Local path to check for. If you use the `path` parameter, other parameters specific for S3 are ignored. |
| `environments[$env].s3.region` | `eu-central-1` (*string*) | No | AWS region |
| `environments[$env].s3.access_key_id` | `<empty>` (*string*) | __Yes__ | AWS Access Key |
| `environments[$env].s3.secret_access_key` | `<empty>` (*string*) | __Yes__ | AWS Secret Access Key |
| `environments[$env].s3.endpoint` | `<empty>` (*string*) | No | Custom AWS S3 endpoint. This must be used for Minio buckets or if you are using a local S3 instance. |
| `environments[$env].s3.force_path_style` | `false` (*bool*) | No | Use path-style for that S3 bucket. This is deprecated by AWS S3 and should be probably `false`. |
| `environments[$env].s3.insecure` | `false` (*bool*) | No | Whether to use HTTP or HTTPS to access the S3 endpoint. This is intended primarily for accessing a local S3 endpoint like MinIO. |
| `environments[$env].s3.tls_skip_verify` | `false` (*bool*) | No | Whether to verify the X.509 certificated presented by the S3 endpoint. This is intended primarily for accessing a local S3 endpoint which uses a self signed certificate |
| `environments[$env].s3.token` | `<empty>` (*string*) | No | AWS STS session token. You can leave that empty. |
| `environments[$env].s3.auto_discover_disks` | `true` (*bool*) | No | Automatically iterate over each S3 bucket. |
| `environments[$env].disks.include` | `<empty>` (*list of strings*) | No | Only include the disks with the given name; case-sensitive; regular expressions are supported. |
| `environments[$env].disks.exclude` | `<empty>` (*list of strings*) | No | Only include the disks with the given name; case-sensitive; regular expressions are supported. |
| `environments[$env].disks.all_others` | `include` (*one of `include`, `exclude`*) | No | Behaviour for disks which are not explicitly included or excluded. |

## `disks`

Expand All @@ -121,6 +124,6 @@ disks:
```

:::info
If you have set `environments[$env].auto_discover_disks` to `false`, only the `disks.include` configuration parameter
If you have set `environments[$env].s3.auto_discover_disks` to `false`, only the `disks.include` configuration parameter
makes any sense.
:::
4 changes: 3 additions & 1 deletion docs/20-reference/10-backmon-configuration/10-storage/20-aws-s3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ environments:
secret_access_key: my_secret_access_key
```

For a full list of configuration option for the S3 provider see [`the corresponding section`](../01-overview.md#available-configuration-keys)

Your AWS account contains the following S3 buckets:

- `bucket-1`
Expand Down Expand Up @@ -158,4 +160,4 @@ backmon:
- key: BACKMON_AWS_SECRET_ACCESS_KEY
# replace ${SECRET_ACCESS_KEY} with the secret access key you noted down previously
value: ${SECRET_ACCESS_KEY}
```
```
Loading