Skip to content

document required permissions for PBM collector #1054

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
idoqo merged 4 commits into from
Mar 25, 2025
Merged

document required permissions for PBM collector #1054

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fb861e4
document required permissions for PBM collector
idoqo Mar 17, 2025
723ed47
fix typo
idoqo Mar 18, 2025
a8f3d96
change grammar
idoqo Mar 23, 2025
fd8ce15
Merge branch 'main' into document-pbm-permissions
idoqo Mar 25, 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
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ podman run -d -p 9216:9216 percona/mongodb_exporter:0.40 --mongodb.uri=mongodb:/
docker run -d -p 9216:9216 percona/mongodb_exporter:0.40 --mongodb.uri=mongodb://127.0.0.1:17001
```

#### Permissions
### Permissions
Connecting user should have sufficient rights to query needed stats:

```
Expand All @@ -74,6 +74,24 @@ Connecting user should have sufficient rights to query needed stats:
"db":"local"
}
```
When using the PBM collector to get metrics from Percona Backup for MongoDB, the user should also have enough permissions
to query the PBM internal collectors (in the `admin` database). One option is to grant `find` privileges on the `admin` collection:
```
privileges: [
{ resource: { db: "admin", collection: "" }, actions: [ "find" ] },
],
```

Alternatively, you can grant the `find` privilege for each PBM internal collection (see: https://docs.percona.com/percona-backup-mongodb/details/control-collections.html):
```
privileges: [
{ resource: { db: "admin", collection: "pbmBackups" }, actions: [ "find" ] },
{ resource: { db: "admin", collection: "pbmAgents" }, actions: [ "find" ] },
{ resource: { db: "admin", collection: "pbmConfig" }, actions: [ "find" ] },
...
],
```
However, this is not recommended as the list of internal collections may change in future releases.

More info about roles in MongoDB [documentation](https://docs.mongodb.com/manual/reference/built-in-roles/#mongodb-authrole-clusterMonitor).

Expand Down
Loading