Skip to content

Commit 11a536f

Browse files
jvincent-mongodbjvincent-mongodb
authored
DOCSP-37771 -- Add new log rotation API endpoints (#156)
Add new log rotation API endpoints. - [JIRA](https://jira.mongodb.org/browse/DOCSP-37771) - STAGING - https://preview-mongodbjvincentmongodb.gatsbyjs.io/ops-manager/DOCSP-37771/reference/api/automation-config/get-system-log-rotate-config/ - https://preview-mongodbjvincentmongodb.gatsbyjs.io/ops-manager/DOCSP-37771/reference/api/automation-config/update-system-log-rotate-config/ - https://preview-mongodbjvincentmongodb.gatsbyjs.io/ops-manager/DOCSP-37771/reference/api/automation-config/get-audit-log-rotate-config/ - https://preview-mongodbjvincentmongodb.gatsbyjs.io/ops-manager/DOCSP-37771/reference/api/automation-config/update-audit-log-rotate-config/ - [LATEST BUILD LOG](https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=6601e8f66fc5f04850d7ea8a) ### Self-Review Checklist - [ ] [Define](https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions) taxonomy [values](https://wiki.corp.mongodb.com/display/DE/Docs+Taxonomy) at top of page. - [ ] Add genre facets (tutorial or reference), as in this [example PR](10gen/cloud-docs#5042). - [ ] Add programmingLanguage (if necessary). - [ ] Add meta keywords (if necessary). - [ ] Resolve any new warnings or errors in the build. - [ ] Proofread for spelling and grammatical errors. - [ ] Check staging for rendering issues. - [ ] Confirm links are working.
1 parent a5ab26e commit 11a536f

File tree

5 files changed

+585
-0
lines changed

5 files changed

+585
-0
lines changed

‎source/reference/api/automation-config.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,3 +108,7 @@ configuration resource.
108108
/reference/api/automation-config/update-backup-log-attributes
109109
/reference/api/automation-config/get-monitoring-log-attributes
110110
/reference/api/automation-config/update-monitoring-log-attributes
111+
/reference/api/automation-config/get-audit-log-rotate-config
112+
/reference/api/automation-config/update-audit-log-rotate-config
113+
/reference/api/automation-config/get-system-log-rotate-config
114+
/reference/api/automation-config/update-system-log-rotate-config

‎source/reference/api/automation-config/get-audit-log-rotate-config.txt

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
.. _get-audit-log-rotate-config:
2+
3+
======================================
4+
Get the Audit Log Rotate Configuration
5+
======================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 2
13+
:class: singlecol
14+
15+
This endpoint returns the current audit log rotation configuration.
16+
17+
Required Roles
18+
--------------
19+
20+
This resource requires the :authrole:`Project Automation Admin` role.
21+
22+
Resource
23+
--------
24+
25+
.. include:: /includes/api/base-api-uri.rst
26+
27+
.. code-block:: http
28+
29+
GET /groups/{PROJECT-ID}/automationConfig/auditLogRotateConfig
30+
31+
Request
32+
-------
33+
34+
Path Parameters
35+
~~~~~~~~~~~~~~~
36+
37+
.. list-table::
38+
:widths: 20 14 11 55
39+
:header-rows: 1
40+
:stub-columns: 1
41+
42+
* - Name
43+
- Type
44+
- Necessity
45+
- Description
46+
47+
* - PROJECT-ID
48+
- string
49+
- Required
50+
- Unique identifier of the :opsmgr:`project </reference/glossary/#std-term-project>`
51+
that owns the automation configuration.
52+
53+
Query Parameters
54+
~~~~~~~~~~~~~~~~
55+
56+
.. include:: /includes/api/no-query-single-parameters.rst
57+
58+
Body Parameters
59+
~~~~~~~~~~~~~~~
60+
61+
.. include:: /includes/api/no-body-parameters.rst
62+
63+
Response
64+
--------
65+
66+
.. list-table::
67+
:widths: 25 25 50
68+
:header-rows: 1
69+
:stub-columns: 1
70+
71+
* - Name
72+
- Type
73+
- Description
74+
75+
* - sizeThresholdMB
76+
- float
77+
- Maximum size in MB for an individual log file before rotation.
78+
79+
* - timeThresholdHrs
80+
- int
81+
- Maximum time in hours for an individual log file before rotation.
82+
83+
* - numUncompressed
84+
- int
85+
- Maximum number of total log files to leave uncompressed,
86+
including the current log file. The default is ``5``. If number of log
87+
files is more than max uncompressed, sort by date, and then keep
88+
compressing the oldest file until the restraint is met.
89+
90+
* - percentOfDiskspace
91+
- float
92+
- Maximum percentage of total disk space all log files
93+
should take up before deletion. The default is ``.02``. If log files
94+
size is taking up more than max percent of total disk space, sort by
95+
date, and then keep deleting the oldest file until the restraint is met.
96+
97+
* - numTotal
98+
- int
99+
- Total number of log files. If the number of log files on disk is
100+
greater than this number, the oldest files will be deleted.
101+
If a number is not specified, defaults to 0 and is determined
102+
by other settings.
103+
104+
Example Request
105+
---------------
106+
107+
.. code-block:: sh
108+
109+
curl --user "{publicApiKey}:{privateApiKey}" --digest \
110+
--header "Accept: application/json" \
111+
--include \
112+
--request GET "https://{+opsmgr-url+}/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/auditLogRotateConfig?pretty=true" \
113+
--output auditLogRotateConfig.json
114+
115+
Example Response
116+
----------------
117+
118+
Response Header
119+
~~~~~~~~~~~~~~~
120+
121+
.. include:: /includes/api/api-headers/401.rst
122+
123+
.. include:: /includes/api/api-headers/200.rst
124+
125+
Response Body
126+
~~~~~~~~~~~~~
127+
128+
The response body only includes fields that are configured in |mms|.
129+
130+
.. code-block:: json
131+
132+
{
133+
"sizeThresholdMB": 5005.5,
134+
"timeThresholdHrs": 13,
135+
"numUncompressed": 10,
136+
"percentOfDiskspace": 0.1,
137+
"numTotal": 15
138+
}

‎source/reference/api/automation-config/get-system-log-rotate-config.txt

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
.. _get-system-log-rotate-config:
2+
3+
=======================================
4+
Get the System Log Rotate Configuration
5+
=======================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 2
13+
:class: singlecol
14+
15+
This endpoint returns the current system log rotation configuration.
16+
17+
Required Roles
18+
--------------
19+
20+
This resource requires the :authrole:`Project Automation Admin` role.
21+
22+
Resource
23+
--------
24+
25+
.. include:: /includes/api/base-api-uri.rst
26+
27+
.. code-block:: http
28+
29+
GET /groups/{PROJECT-ID}/automationConfig/systemLogRotateConfig
30+
31+
Request
32+
-------
33+
34+
Path Parameters
35+
~~~~~~~~~~~~~~~
36+
37+
.. list-table::
38+
:widths: 20 14 11 55
39+
:header-rows: 1
40+
:stub-columns: 1
41+
42+
* - Name
43+
- Type
44+
- Necessity
45+
- Description
46+
47+
* - PROJECT-ID
48+
- string
49+
- Required
50+
- Unique identifier of the :opsmgr:`project </reference/glossary/#std-term-project>`
51+
that owns the automation configuration.
52+
53+
Query Parameters
54+
~~~~~~~~~~~~~~~~
55+
56+
.. include:: /includes/api/no-query-single-parameters.rst
57+
58+
Body Parameters
59+
~~~~~~~~~~~~~~~
60+
61+
.. include:: /includes/api/no-body-parameters.rst
62+
63+
Response
64+
--------
65+
66+
.. list-table::
67+
:widths: 25 25 50
68+
:header-rows: 1
69+
:stub-columns: 1
70+
71+
* - Name
72+
- Type
73+
- Description
74+
75+
* - sizeThresholdMB
76+
- float
77+
- Maximum size in MB for an individual log file before rotation.
78+
79+
* - timeThresholdHrs
80+
- int
81+
- Maximum time in hours for an individual log file before rotation.
82+
83+
* - numUncompressed
84+
- int
85+
- Maximum number of total log files to leave uncompressed,
86+
including the current log file. The default is ``5``. If number of log
87+
files is more than max uncompressed, sort by date, and then keep
88+
compressing the oldest file until the restraint is met.
89+
90+
* - percentOfDiskspace
91+
- float
92+
- Maximum percentage of total disk space all log files
93+
should take up before deletion. The default is ``.02``. If log files
94+
size is taking up more than max percent of total disk space, sort by
95+
date, and then keep deleting the oldest file until the restraint is met.
96+
97+
* - numTotal
98+
- int
99+
- Total number of log files. If the number of log files on disk is
100+
greater than this number, the oldest files will be deleted.
101+
If a number is not specified, defaults to 0 and is determined
102+
by other settings.
103+
104+
Example Request
105+
---------------
106+
107+
.. code-block:: sh
108+
109+
curl --user "{publicApiKey}:{privateApiKey}" --digest \
110+
--header "Accept: application/json" \
111+
--include \
112+
--request GET "https://{+opsmgr-url+}/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/systemLogRotateConfig?pretty=true" \
113+
--output systemLogRotateConfig.json
114+
115+
Example Response
116+
----------------
117+
118+
Response Header
119+
~~~~~~~~~~~~~~~
120+
121+
.. include:: /includes/api/api-headers/401.rst
122+
123+
.. include:: /includes/api/api-headers/200.rst
124+
125+
Response Body
126+
~~~~~~~~~~~~~
127+
128+
The response body only includes fields that are configured in |mms|.
129+
130+
.. code-block:: json
131+
132+
{
133+
"sizeThresholdMB": 5005.5,
134+
"timeThresholdHrs": 13,
135+
"numUncompressed": 10,
136+
"percentOfDiskspace": 0.1,
137+
"numTotal": 15
138+
}
139+

0 commit comments

Comments
 (0)