Details
-
Improvement
-
Resolution: Fixed
-
Major - P3
-
None
-
None
-
None
Description
----------------------------
Original Description
Our docs about log download via API endpoint present mongod.gz as an option for the LOG-NAME parameter. However when using such name the returned document is empty. Using mongodb.gz does effectively return the node's mongod logs.
Also, the example presented seem to suggest the use of curly brackets in the -u section of the endpoint
curl -X GET -u "{username:apiKey}" --digest -o mongod-audit-log.gz \
|
"https://cloud.mongodb.com/api/atlas/v1.0/groups/99999962187d9d67ca76b85f8/clusters/mycluster-shard-00-00.mongodb.net/logs/mongodb-audit-log.gz?startDate=1500249600&endDate=1500422400"
|
When using such syntax there is no error retrieved, however the returned document is also empty.
- Please change the text in the description of the LOG-NAME parameter from mongod.gz to mongodb.gz
- Please remove the curly brackets in the example to avoid confusion.
Link to docs page here
----------------------------
Description
https://docs.atlas.mongodb.com/reference/api/logs/
- The LOG-NAME parameter seems to incorrectly list mongod.gz as an option. It should list mongodb.gz instead.
- The username argument (-u) in the curl example is confusing. Including the curly braces does not error but returns an empty document.
curl -X GET -u "{username:apiKey}" --digest -o mongod-audit-log.gz \
|
"https://cloud.mongodb.com/api/atlas/v1.0/groups/99999962187d9d67ca76b85f8/clusters/mycluster-shard-00-00.mongodb.net/logs/mongodb-audit-log.gz?startDate=1500249600&endDate=1500422400"
|