Skip to content

Commit

Permalink
[receiver/mongodbatlas] Document access log requirements (open-teleme…
Browse files Browse the repository at this point in the history
…try#23363)

Access Logs required permissions for monitoring were
not documented in the receiver README.

Should have been documented for
open-telemetry#21182
  • Loading branch information
Sam DeHaan authored and fchikwekwe committed Jun 23, 2023
1 parent 792e18a commit bef28ba
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions receiver/mongodbatlasreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ In order to collect project events, the requesting API key needs the appropriate

In order to collect organization events, the requesting API key needs the appropriate permission which at minimum is the `Organization Member` role. Organization events are collected across all the projects hosted on Atlas within the organization. These events are not associated with a project.

In order to collect access logs, the requesting API key needs the appropriate permission which requires either the `Project Owner` or `Organization Owner` role. Access logs are specific to each cluster.

MongoDB Atlas [Documentation](https://www.mongodb.com/docs/atlas/reference/api/logs/#logs) recommends a polling interval of 5 minutes.

- `public_key` (required for metrics, logs, or alerts in `poll` mode)
Expand Down

0 comments on commit bef28ba

Please sign in to comment.