Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Regenerate README
  • Loading branch information
jsoriano committed Jul 3, 2023
commit 970e166e5c6c01c1c50545ae6b13f98daf1f844b
74 changes: 0 additions & 74 deletions test/packages/parallel/mongodb/_dev/build/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,82 +37,8 @@ Mongo shell).
db.grantRolesToUser("user", ["clusterMonitor"])
```

## Logs

### log

The `log` dataset collects the MongoDB logs.

{{event "log"}}

The fields reported are:

{{fields "log"}}

## Metrics

### collstats

The `collstats` dataset uses the top administrative command to return usage
statistics for each collection. It provides the amount of time, in microseconds,
used and a count of operations for the following types: total, readLock, writeLock,
queries, getmore, insert, update, remove, and commands.

It requires the following privileges, which is covered by the [clusterMonitor](https://docs.mongodb.com/manual/reference/built-in-roles/#clusterMonitor) role:

* [top action](https://docs.mongodb.com/manual/reference/privilege-actions/#top) on [cluster resource](https://docs.mongodb.com/manual/reference/resource-document/#cluster-resource)

{{event "collstats"}}

The fields reported are:

{{fields "collstats"}}

### dbstats

The `dbstats` dataset collects storage statistics for a given database.

It requires the following privileges, which is covered by the [clusterMonitor](https://docs.mongodb.com/manual/reference/built-in-roles/#clusterMonitor) role:

* [listDatabases](https://docs.mongodb.com/manual/reference/privilege-actions/#listDatabases)
action on [cluster resource](https://docs.mongodb.com/manual/reference/resource-document/#cluster-resource)

* for each of the databases, also need [dbStats](https://docs.mongodb.com/manual/reference/privilege-actions/#dbStats)
action on the [database resource](https://docs.mongodb.com/manual/reference/resource-document/#database-and-or-collection-resource)

{{event "dbstats"}}

The fields reported are:

{{fields "dbstats"}}

### metrics

It requires the following privileges, which is covered by the clusterMonitor role:

* [serverStatus](https://docs.mongodb.com/manual/reference/privilege-actions/#serverStatus)
action on [cluster resource](https://docs.mongodb.com/manual/reference/resource-document/#cluster-resource)

{{event "metrics"}}

The fields reported are:

{{fields "metrics"}}

### replstatus
The `replstatus` dataset collects status of the replica set.
It requires the following privileges, which is covered by the [clusterMonitor](https://docs.mongodb.com/manual/reference/built-in-roles/#clusterMonitor) role:

* [find/listCollections](https://docs.mongodb.com/manual/reference/privilege-actions/#find) action on the [local database](https://docs.mongodb.com/manual/reference/local-database/) resource
* [collStats](https://docs.mongodb.com/manual/reference/privilege-actions/#collStats) action on the [local.oplog.rs](https://docs.mongodb.com/manual/reference/local-database/#local.oplog.rs) collection resource
* [replSetGetStatus](https://docs.mongodb.com/manual/reference/privilege-actions/#replSetGetStatus) action on [cluster resource](https://docs.mongodb.com/manual/reference/resource-document/#cluster-resource)

{{event "replstatus"}}

The fields reported are:

{{fields "replstatus"}}

### status

The `status` returns a document that provides an overview of the database's state.
Expand Down
Loading