Skip to content

Commit 4cacd89

Browse files
Simran-BSimran-B
authored
DOC-745 | Fix API call recording OpenAPI description and release notes (#737)
* Fix API call recording OpenAPI description and release notes * Apply to 3.13 * Upper-case requestType in responses
1 parent cd7b519 commit 4cacd89

File tree

4 files changed

+160
-28
lines changed

4 files changed

+160
-28
lines changed

‎site/content/3.12/develop/http-api/monitoring/logs.md

Lines changed: 72 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -848,14 +848,17 @@ paths:
848848
operationId: getRecentApiCalls
849849
description: |
850850
Get a list of the most recent requests with a timestamp and the endpoint.
851-
This feature is for debugging purposes.
851+
This feature is for debugging purposes.
852852
853853
You can control how much memory is used to record API calls with the
854-
`--server.memory-per-api-call-list` and `--server.number-of-api-call-lists`
855-
startup options.
854+
`--server.api-recording-memory-limit` startup option.
856855
857-
You can disable API call recording via the `--server.api-call-recording`
858-
startup option. The endpoint returns an empty list of calls in this case.
856+
You can disable this endpoint
857+
with the `--log.recording-api-enabled` startup option.
858+
859+
Whether API calls are recorded is independently controlled by the
860+
`--server.api-call-recording` startup option.
861+
The endpoint returns an empty list of calls if turned off.
859862
parameters:
860863
- name: database-name
861864
in: path
@@ -870,7 +873,7 @@ paths:
870873
responses:
871874
'200':
872875
description: |
873-
The
876+
Returns the recorded API calls.
874877
content:
875878
application/json:
876879
schema:
@@ -913,7 +916,7 @@ paths:
913916
description: |
914917
The HTTP request method.
915918
type: string
916-
enum: [get, patch, put, delete, head]
919+
enum: [GET, PATCH, PUT, DELETE, HEAD]
917920
path:
918921
description: |
919922
The HTTP request path excluding the database prefix (`/_db/<database-name>`).
@@ -953,6 +956,68 @@ paths:
953956
description: |
954957
A descriptive error message.
955958
type: string
959+
'403':
960+
description: |
961+
The recording API has been disabled.
962+
content:
963+
application/json:
964+
schema:
965+
type: object
966+
required:
967+
- error
968+
- code
969+
- errorNum
970+
- errorMessage
971+
properties:
972+
error:
973+
description: |
974+
A flag indicating that an error occurred.
975+
type: boolean
976+
example: true
977+
code:
978+
description: |
979+
The HTTP response status code.
980+
type: integer
981+
example: 403
982+
errorNum:
983+
description: |
984+
ArangoDB error number for the error that occurred.
985+
type: integer
986+
errorMessage:
987+
description: |
988+
A descriptive error message.
989+
type: string
990+
'501':
991+
description: |
992+
The method has not been called on a Coordinator or single server.
993+
content:
994+
application/json:
995+
schema:
996+
type: object
997+
required:
998+
- error
999+
- code
1000+
- errorNum
1001+
- errorMessage
1002+
properties:
1003+
error:
1004+
description: |
1005+
A flag indicating that an error occurred.
1006+
type: boolean
1007+
example: true
1008+
code:
1009+
description: |
1010+
The HTTP response status code.
1011+
type: integer
1012+
example: 501
1013+
errorNum:
1014+
description: |
1015+
ArangoDB error number for the error that occurred.
1016+
type: integer
1017+
errorMessage:
1018+
description: |
1019+
A descriptive error message.
1020+
type: string
9561021
tags:
9571022
- Monitoring
9581023
```

‎site/content/3.12/release-notes/version-3.12/whats-new-in-3-12.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2167,19 +2167,20 @@ A new `/_admin/server/api-calls` endpoint has been added to let you retrieve a
21672167
list of the most recent requests with a timestamp and the endpoint. This feature
21682168
is for debugging purposes.
21692169

2170-
You can configure the memory limit for this feature with the following startup options:
2170+
You can configure the memory limit for this feature with the following startup option:
21712171

2172-
- `--server.number-of-api-call-lists`:
2173-
The size of the ring buffer for API call record lists (default: `256`).
2174-
- `--server.memory-per-api-call-list`:
2175-
The amount of memory used for a single API call record list (default: `100000` bytes)
2176-
2177-
This means that approximately 25 MB of memory are reserved by default.
2172+
- `--server.api-recording-memory-limit`:
2173+
Size limit for the list of API call records (default: `25600000`).
21782174

2175+
This means that 25 MB of memory is reserved by default.
21792176

21802177
API call recording is enabled by default but you can disable it via the new
21812178
`--server.api-call-recording` startup option.
21822179

2180+
The `/_admin/server/api-calls` endpoint exposes the recorded API calls.
2181+
It is enabled by default. You can disable it altogether by setting the new
2182+
`--log.recording-api-enabled` startup option to `false`.
2183+
21832184
A metric has been added for the time spent on API call recording to track the
21842185
impact of this feature:
21852186

‎site/content/3.13/develop/http-api/monitoring/logs.md

Lines changed: 72 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -848,14 +848,17 @@ paths:
848848
operationId: getRecentApiCalls
849849
description: |
850850
Get a list of the most recent requests with a timestamp and the endpoint.
851-
This feature is for debugging purposes.
851+
This feature is for debugging purposes.
852852
853853
You can control how much memory is used to record API calls with the
854-
`--server.memory-per-api-call-list` and `--server.number-of-api-call-lists`
855-
startup options.
854+
`--server.api-recording-memory-limit` startup option.
856855
857-
You can disable API call recording via the `--server.api-call-recording`
858-
startup option. The endpoint returns an empty list of calls in this case.
856+
You can disable this endpoint
857+
with the `--log.recording-api-enabled` startup option.
858+
859+
Whether API calls are recorded is independently controlled by the
860+
`--server.api-call-recording` startup option.
861+
The endpoint returns an empty list of calls if turned off.
859862
parameters:
860863
- name: database-name
861864
in: path
@@ -870,7 +873,7 @@ paths:
870873
responses:
871874
'200':
872875
description: |
873-
The
876+
Returns the recorded API calls.
874877
content:
875878
application/json:
876879
schema:
@@ -913,7 +916,7 @@ paths:
913916
description: |
914917
The HTTP request method.
915918
type: string
916-
enum: [get, patch, put, delete, head]
919+
enum: [GET, PATCH, PUT, DELETE, HEAD]
917920
path:
918921
description: |
919922
The HTTP request path excluding the database prefix (`/_db/<database-name>`).
@@ -953,6 +956,68 @@ paths:
953956
description: |
954957
A descriptive error message.
955958
type: string
959+
'403':
960+
description: |
961+
The recording API has been disabled.
962+
content:
963+
application/json:
964+
schema:
965+
type: object
966+
required:
967+
- error
968+
- code
969+
- errorNum
970+
- errorMessage
971+
properties:
972+
error:
973+
description: |
974+
A flag indicating that an error occurred.
975+
type: boolean
976+
example: true
977+
code:
978+
description: |
979+
The HTTP response status code.
980+
type: integer
981+
example: 403
982+
errorNum:
983+
description: |
984+
ArangoDB error number for the error that occurred.
985+
type: integer
986+
errorMessage:
987+
description: |
988+
A descriptive error message.
989+
type: string
990+
'501':
991+
description: |
992+
The method has not been called on a Coordinator or single server.
993+
content:
994+
application/json:
995+
schema:
996+
type: object
997+
required:
998+
- error
999+
- code
1000+
- errorNum
1001+
- errorMessage
1002+
properties:
1003+
error:
1004+
description: |
1005+
A flag indicating that an error occurred.
1006+
type: boolean
1007+
example: true
1008+
code:
1009+
description: |
1010+
The HTTP response status code.
1011+
type: integer
1012+
example: 501
1013+
errorNum:
1014+
description: |
1015+
ArangoDB error number for the error that occurred.
1016+
type: integer
1017+
errorMessage:
1018+
description: |
1019+
A descriptive error message.
1020+
type: string
9561021
tags:
9571022
- Monitoring
9581023
```

‎site/content/3.13/release-notes/version-3.12/whats-new-in-3-12.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2167,19 +2167,20 @@ A new `/_admin/server/api-calls` endpoint has been added to let you retrieve a
21672167
list of the most recent requests with a timestamp and the endpoint. This feature
21682168
is for debugging purposes.
21692169

2170-
You can configure the memory limit for this feature with the following startup options:
2170+
You can configure the memory limit for this feature with the following startup option:
21712171

2172-
- `--server.number-of-api-call-lists`:
2173-
The size of the ring buffer for API call record lists (default: `256`).
2174-
- `--server.memory-per-api-call-list`:
2175-
The amount of memory used for a single API call record list (default: `100000` bytes)
2176-
2177-
This means that approximately 25 MB of memory are reserved by default.
2172+
- `--server.api-recording-memory-limit`:
2173+
Size limit for the list of API call records (default: `25600000`).
21782174

2175+
This means that 25 MB of memory is reserved by default.
21792176

21802177
API call recording is enabled by default but you can disable it via the new
21812178
`--server.api-call-recording` startup option.
21822179

2180+
The `/_admin/server/api-calls` endpoint exposes the recorded API calls.
2181+
It is enabled by default. You can disable it altogether by setting the new
2182+
`--log.recording-api-enabled` startup option to `false`.
2183+
21832184
A metric has been added for the time spent on API call recording to track the
21842185
impact of this feature:
21852186

0 commit comments

Comments
 (0)