Skip to content

Commit baf1263

Browse files
git-thuerk-donegit-thuerk-done
authored
updating error codes (#33666)
1 parent f096982 commit baf1263

File tree

10 files changed

+397
-191
lines changed

10 files changed

+397
-191
lines changed

‎config/_default/menus/main.en.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7598,6 +7598,11 @@ menu:
75987598
url: synthetics/api_tests/grpc_tests
75997599
parent: api_tests
76007600
weight: 108
7601+
- name: Error codes
7602+
identifier: synthetics_api_tests_errors
7603+
url: synthetics/api_tests/errors
7604+
parent: api_tests
7605+
weight: 109
76017606
- name: Multistep API Testing
76027607
url: synthetics/multistep
76037608
parent: synthetics

‎content/en/synthetics/api_tests/dns_tests.md‎

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -114,22 +114,7 @@ To display your list of variables, type `{{` in your desired field.
114114

115115
A test is considered `FAILED` if it does not satisfy one or more assertions or if the request prematurely failed. In some cases, the test can fail without testing the assertions against the endpoint.
116116

117-
These reasons include the following:
118-
119-
`CONNRESET`
120-
: The connection was abruptly closed by the remote server. Possible causes include the web server encountering an error or crashing while responding, or loss of connectivity of the web server.
121-
122-
`DNS`
123-
: DNS entry not found for the test URL. Possible causes include misconfigured test URL or the wrong configuration of your DNS entries.
124-
125-
`INVALID_REQUEST`
126-
: The configuration of the test is invalid (for example, a typo in the URL).
127-
128-
`TIMEOUT`
129-
: The request couldn't be completed in a reasonable time. Two types of `TIMEOUT` can happen:
130-
- `TIMEOUT: The request couldn't be completed in a reasonable time.` indicates that the request duration hit the test defined timeout (default is set to 60s).
131-
For each request only the completed stages for the request are displayed in the network waterfall. For example, in the case of `Total response time` only being displayed, the timeout occurred during the DNS resolution.
132-
- `TIMEOUT: Overall test execution couldn't be completed in a reasonable time.` indicates that the test duration (request + assertions) hits the maximum duration (60.5s).
117+
For a complete list of DNS error codes, see [API Testing Errors][12].
133118

134119
## Permissions
135120

@@ -156,3 +141,4 @@ If you are using the [custom role feature][11], add your user to any custom role
156141
[9]: /synthetics/settings/#global-variables
157142
[10]: /account_management/rbac/
158143
[11]: /account_management/rbac#custom-roles
144+
[12]: /synthetics/api_tests/errors/

‎content/en/synthetics/api_tests/errors.md‎

Lines changed: 372 additions & 32 deletions
Large diffs are not rendered by default.

‎content/en/synthetics/api_tests/grpc_tests.md‎

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -181,34 +181,13 @@ To display your list of variables, type `{{` in your desired field.
181181

182182
A test is considered `FAILED` if it does not satisfy one or more assertions or if the request prematurely failed. In some cases, the test can fail without testing the assertions against the endpoint.
183183

184-
These reasons include the following:
185-
186-
`gRPC specific errors`
187-
: gRPC has a list of specific status codes that can be found in the [official gRPC documentation][10].
188-
189-
`CONNRESET`
190-
: The connection was abruptly closed by the remote server. Possible causes include the web server encountering an error or crashing while responding, or losing connectivity to the web server.
191-
192-
`DNS`
193-
: DNS entry not found for the test URL. Possible causes include a misconfigured test URL or the wrong configuration of your DNS entries.
194-
195-
`INVALID_REQUEST`
196-
: The configuration of the test is invalid (for example, a typo in the URL).
197-
198-
`SSL`
199-
: The SSL connection couldn't be performed. [See the dedicated error page for more information][11].
200-
201-
`TIMEOUT`
202-
: The request couldn't be completed in a reasonable time. Two types of `TIMEOUT` can happen:
203-
- `TIMEOUT: The request couldn't be completed in a reasonable time.` indicates that the request duration hit the test defined timeout (default is set to 60 seconds).
204-
For each request, only the completed stages for the request are displayed in the network waterfall. For example, in the case of `Total response time` only being displayed, the timeout occurred during the DNS resolution.
205-
- `TIMEOUT: Overall test execution couldn't be completed in a reasonable time.` indicates that the test duration (request and assertions) hits the maximum duration of 60.5 seconds.
184+
For a complete list of gRPC error codes, see [API Testing Errors][10].
206185

207186
## Permissions
208187

209-
By default, only users with the [Datadog Admin and Datadog Standard roles][12] can create, edit, and delete Synthetic gRPC tests. To get create, edit, and delete access to Synthetic gRPC tests, upgrade your user to one of those two [default roles][12].
188+
By default, only users with the [Datadog Admin and Datadog Standard roles][11] can create, edit, and delete Synthetic gRPC tests. To get create, edit, and delete access to Synthetic gRPC tests, upgrade your user to one of those two [default roles][11].
210189

211-
If you are using the [custom role feature][13], add your user to any custom role that includes `synthetics_read` and `synthetics_write` permissions.
190+
If you are using the [custom role feature][12], add your user to any custom role that includes `synthetics_read` and `synthetics_write` permissions.
212191

213192
### Restrict access
214193

@@ -228,7 +207,6 @@ If you are using the [custom role feature][13], add your user to any custom role
228207
[7]: /monitors/notify/?tab=is_recoveryis_alert_recovery#conditional-variables
229208
[8]: /synthetics/guide/synthetic-test-monitors
230209
[9]: /synthetics/settings/#global-variables
231-
[10]: https://grpc.github.io/grpc/core/md_doc_statuscodes.html
232-
[11]: /synthetics/api_tests/errors/#ssl-errors
233-
[12]: /account_management/rbac/
234-
[13]: /account_management/rbac#custom-roles
210+
[10]: /synthetics/api_tests/errors/#grpc-errors
211+
[11]: /account_management/rbac/
212+
[12]: /account_management/rbac#custom-roles

‎content/en/synthetics/api_tests/http_tests.md‎

Lines changed: 2 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -211,40 +211,7 @@ To display your list of variables, type `{{` in your desired field:
211211
212212
A test is considered `FAILED` if it does not satisfy one or more assertions or if the request prematurely failed. In some cases, the test can fail without testing the assertions against the endpoint.
213213
214-
The most common errors include the following:
215-
216-
`AUTHENTICATION_ERROR`
217-
: Synthetic Monitoring automatically disables test retries when authentication failures occur. This safety measure remains in effect until you update the test with valid credentials. This prevents unnecessary test executions that would generate false alerts and increase billable usage.
218-
219-
`CONNREFUSED`
220-
: No connection could be made because the target machine actively refused it.
221-
222-
`CONNRESET`
223-
: The connection was abruptly closed by the remote server. Possible causes include the web server encountering an error or crashing while responding, or loss of connectivity of the web server.
224-
225-
`DNS`
226-
: DNS entry not found for the test URL. Possible causes include misconfigured test URL or the wrong configuration of your DNS entries.
227-
228-
`Error performing HTTP/2 request`
229-
: The request could not be performed. See the dedicated [error][16] page for more information.
230-
231-
`INVALID_REQUEST`
232-
: The configuration of the test is invalid (for example, a typo in the URL).
233-
234-
`SSL`
235-
: The SSL connection couldn't be performed. [See the dedicated error page for more information][12].
236-
237-
`TIMEOUT`
238-
: The request couldn't be completed in a reasonable time. Two types of `TIMEOUT` can happen:
239-
- `TIMEOUT: The request couldn't be completed in a reasonable time.` indicates that the request duration hit the test defined timeout (default is set to 60s).
240-
For each request only the completed stages for the request are displayed in the network waterfall. For example, in the case of `Total response time` only being displayed, the timeout occurred during the DNS resolution.
241-
- `TIMEOUT: Overall test execution couldn't be completed in a reasonable time.` indicates that the test duration (request + assertions) hits the maximum duration (60.5s).
242-
243-
`MALFORMED_RESPONSE`
244-
: The remote server responded with a payload that does not comply with HTTP specifications. This error can happen when remote servers differ in their HTTP support. To prevent issues, run tests with a consistent HTTP version: either HTTP/2 (if available) or HTTP/1.1.
245-
246-
`INCORRECT_ASSERTION`
247-
: The expected value of the assertion does not match the actual value. For example, when asserting on an HTTP response status code, if you expect `200` but the response returns `400`, the INCORRECT_ASSERTION error is thrown.
214+
For a complete list of HTTP and SSL error codes, see [API Testing Errors][12].
248215
249216
## Permissions
250217
@@ -271,7 +238,7 @@ If you are using the [custom role feature][14], add your user to any custom role
271238
[9]: /monitors/notify/?tab=is_recoveryis_alert_recovery#conditional-variables
272239
[10]: /synthetics/guide/synthetic-test-monitors
273240
[11]: /synthetics/settings/#global-variables
274-
[12]: /synthetics/api_tests/errors/#ssl-errors
241+
[12]: /synthetics/api_tests/errors/
275242
[13]: /account_management/rbac/
276243
[14]: /account_management/rbac#custom-roles
277244
[15]: /account_management/rbac/#create-a-custom-role

‎content/en/synthetics/api_tests/icmp_tests.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,7 @@ To display your list of variables, type `{{` in your desired field.
108108

109109
A test is considered `FAILED` if it does not satisfy one or more assertions or if the request prematurely failed. In some cases, the test can fail without testing the assertions against the endpoint.
110110

111-
These reasons include the following:
112-
113-
`DNS`
114-
: DNS entry not found for the test URL. Possible causes include misconfigured test URL or the wrong configuration of your DNS entries.
111+
For a complete list of error codes, see [API Testing Errors][11].
115112

116113
## Permissions
117114

@@ -137,3 +134,4 @@ If you are using the [custom role feature][10], add your user to any custom role
137134
[8]: /synthetics/settings/#global-variables
138135
[9]: /account_management/rbac/
139136
[10]: /account_management/rbac#custom-roles
137+
[11]: /synthetics/api_tests/errors/#icmp-errors

‎content/en/synthetics/api_tests/ssl_tests.md‎

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -125,25 +125,7 @@ To display your list of variables, type `{{` in your desired field.
125125
126126
A test is considered `FAILED` if it does not satisfy one or more assertions or if the request prematurely failed. In some cases, the test can fail without testing the assertions against the endpoint.
127127
128-
These reasons include the following:
129-
130-
`CONNRESET`
131-
: The connection was abruptly closed by the remote server. Possible causes include the web server encountering an error or crashing while responding, or loss of connectivity of the web server.
132-
133-
`DNS`
134-
: DNS entry not found for the test URL. Possible causes include misconfigured test URL or the wrong configuration of your DNS entries.
135-
136-
`INVALID_REQUEST`
137-
: The configuration of the test is invalid (for example, a typo in the URL).
138-
139-
`SSL`
140-
: The SSL connection couldn't be performed. [See the dedicated error page for more information][10].
141-
142-
`TIMEOUT`
143-
: The request couldn't be completed in a reasonable time. Two types of `TIMEOUT` can happen:
144-
- `TIMEOUT: The request couldn't be completed in a reasonable time.` indicates that the request duration hit the test defined timeout (default is set to 60s).
145-
For each request only the completed stages for the request are displayed in the network waterfall. For example, in the case of `Total response time` only being displayed, the timeout occurred during the DNS resolution.
146-
- `TIMEOUT: Overall test execution couldn't be completed in a reasonable time.` indicates that the test duration (request + assertions) hits the maximum duration (60.5s).
128+
For a complete list of SSL error codes, see [API Testing Errors][10].
147129
148130
## Permissions
149131
@@ -168,6 +150,6 @@ If you are using the [custom role feature][12], add your user to any custom role
168150
[7]: /monitors/notify/?tab=is_recoveryis_alert_recovery#conditional-variables
169151
[8]: /synthetics/guide/synthetic-test-monitors
170152
[9]: /synthetics/settings/#global-variables
171-
[10]: /synthetics/api_tests/errors/#ssl-errors
153+
[10]: /synthetics/api_tests/errors/
172154
[11]: /account_management/rbac/
173155
[12]: /account_management/rbac#custom-roles

‎content/en/synthetics/api_tests/tcp_tests.md‎

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -106,22 +106,7 @@ To display your list of variables, type `{{` in your desired field.
106106

107107
A test is considered `FAILED` if it does not satisfy one or more assertions or if the request prematurely failed. In some cases, the test can fail without testing the assertions against the endpoint.
108108

109-
These reasons include the following:
110-
111-
`CONNRESET`
112-
: The connection was abruptly closed by the remote server. Possible causes include the web server encountering an error or crashing while responding, or loss of connectivity of the web server.
113-
114-
`DNS`
115-
: DNS entry not found for the test URL. Possible causes include misconfigured test URL or the wrong configuration of your DNS entries.
116-
117-
`INVALID_REQUEST`
118-
: The configuration of the test is invalid (for example, a typo in the URL).
119-
120-
`TIMEOUT`
121-
: The request couldn't be completed in a reasonable time. Two types of `TIMEOUT` can happen:
122-
- `TIMEOUT: The request couldn't be completed in a reasonable time.` indicates that the request duration hit the test defined timeout (default is set to 60s).
123-
For each request only the completed stages for the request are displayed in the network waterfall. For example, in the case of `Total response time` only being displayed, the timeout occurred during the DNS resolution.
124-
- `TIMEOUT: Overall test execution couldn't be completed in a reasonable time.` indicates that the test duration (request + assertions) hits the maximum duration (60.5s).
109+
For a complete list of error codes, see [API Testing Errors][11].
125110

126111
## Permissions
127112

@@ -147,3 +132,4 @@ If you are using the [custom role feature][10], add your user to any custom role
147132
[8]: /synthetics/settings/#global-variables
148133
[9]: /account_management/rbac/
149134
[10]: /account_management/rbac#custom-roles
135+
[11]: /synthetics/api_tests/errors/#tcp-errors

‎content/en/synthetics/api_tests/udp_tests.md‎

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -104,22 +104,7 @@ To display your list of variables, type `{{` in your desired field.
104104

105105
A test is considered `FAILED` if it does not satisfy one or more assertions or if the request prematurely failed. In some cases, the test can fail without testing the assertions against the endpoint.
106106

107-
These reasons include the following:
108-
109-
`CONNRESET`
110-
: The connection was abruptly closed by the remote server. Possible causes include the web server encountering an error or crashing while responding, or loss of connectivity of the web server.
111-
112-
`DNS`
113-
: DNS entry not found for the test URL. Possible causes include misconfigured test URL or the wrong configuration of your DNS entries.
114-
115-
`INVALID_REQUEST`
116-
: The configuration of the test is invalid (for example, a typo in the URL).
117-
118-
`TIMEOUT`
119-
: The request couldn't be completed in a reasonable time. Two types of `TIMEOUT` can happen:
120-
- `TIMEOUT: The request couldn't be completed in a reasonable time.` indicates that the request duration hit the test defined timeout (default is set to 60s).
121-
For each request only the completed stages for the request are displayed in the network waterfall. For example, in the case of `Total response time` only being displayed, the timeout occurred during the DNS resolution.
122-
- `TIMEOUT: Overall test execution couldn't be completed in a reasonable time.` indicates that the test duration (request + assertions) hits the maximum duration (60.5s).
107+
For a complete list of error codes, see [API Testing Errors][11].
123108

124109
## Permissions
125110

@@ -145,3 +130,4 @@ If you are using the [custom role feature][10], add your user to any custom role
145130
[8]: /synthetics/guide/synthetic-test-monitors
146131
[9]: /account_management/rbac/
147132
[10]: /account_management/rbac#custom-roles
133+
[11]: /synthetics/api_tests/errors/#udp-errors

‎content/en/synthetics/api_tests/websocket_tests.md‎

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -124,29 +124,7 @@ To display your list of variables, type `{{` in your desired field.
124124

125125
A test is considered `FAILED` if it does not satisfy one or more assertions or if the request prematurely failed. In some cases, the test can fail without testing the assertions against the endpoint.
126126

127-
These reasons include the following:
128-
129-
`CONNRESET`
130-
: The connection was abruptly closed by the remote server. Possible causes include the web server encountering an error or crashing while responding, or loss of connectivity of the web server.
131-
132-
`DNS`
133-
: DNS entry not found for the test URL. Possible causes include misconfigured test URL or the wrong configuration of your DNS entries.
134-
135-
`INVALID_REQUEST`
136-
: The configuration of the test is invalid (for example, a typo in the URL).
137-
138-
`SSL`
139-
: The SSL connection couldn't be performed. [See the dedicated error page for more information][9].
140-
141-
`TIMEOUT`
142-
: The request couldn't be completed in a reasonable time. Two types of `TIMEOUT` errors can happen:
143-
- `TIMEOUT: The request couldn't be completed in a reasonable time.` indicates that the request duration hit the test defined timeout (default is set to 60s).
144-
For each request only the completed stages for the request are displayed in the network waterfall. For example, in the case of `Total response time` only being displayed, the timeout occurred during the DNS resolution.
145-
- `TIMEOUT: Overall test execution couldn't be completed in a reasonable time.` indicates that the test duration (request + assertions) hits the maximum duration (60.5s).
146-
147-
`WEBSOCKET`
148-
: The WebSocket connection was closed or cannot be opened. One type of `WEBSOCKET` error can happen:
149-
- `WEBSOCKET: Received message longer than the maximum supported length.` indicates that the response message length hits the maximum length (50kb).
127+
For a complete list of WebSocket error codes, see [API Testing Errors][9].
150128

151129
## Permissions
152130

@@ -170,6 +148,6 @@ If you are using the [custom role feature][11], add your user to any custom role
170148
[6]: https://www.markdownguide.org/basic-syntax/
171149
[7]: /monitors/notify/?tab=is_recoveryis_alert_recovery#conditional-variables
172150
[8]: /synthetics/guide/synthetic-test-monitors
173-
[9]: /synthetics/api_tests/errors/#ssl-errors
151+
[9]: /synthetics/api_tests/errors/#websocket-errors
174152
[10]: /account_management/rbac/
175153
[11]: /account_management/rbac#custom-roles

0 commit comments

Comments
 (0)