- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
WebSocket tests allow you to proactively open WebSocket connections on your endpoints to verify responses and defined conditions, such as overall response times or expected headers.
WebSocket tests can run from both managed and private locations depending on your preference for running the test from outside or inside your network. WebSocket tests can run on a schedule, on-demand, or directly within your CI/CD pipelines.
After choosing to create an WebSocket
test, define your test’s request.
Specify the URL to run your test on.
Enter the string you want to send in your test.
Add Advanced Options (optional) to your test:
user-agent
header).<COOKIE_NAME1>=<COOKIE_VALUE1>; <COOKIE_NAME2>=<COOKIE_VALUE2>
.env
Tags as well as any other tag to your WebSocket test. You can then use these tags to filter through your Synthetic tests on the Synthetic Monitoring & Continuous Testing page.Click Test URL to try out the request configuration. A response preview is displayed on the right side of your screen.
Assertions define what an expected test result is. When you click Test URL, a basic assertion on response time
is added. You must define at least one assertion for your test to monitor.
Type | Operator | Value Type |
---|---|---|
response time | is less than | Integer (ms) |
string response | contains , does not contain , is , is not ,matches , does not match | String Regex |
header | contains , does not contain , is , is not ,matches , does not match | String Regex |
Select the response preview directly or click New Assertion to create an assertion. You can create up to 20 assertions per WebSocket test.
To perform OR
logic in an assertion, use the matches regex
or does not match regex
comparators to define a regex with multiple expected values for the same assertion type like (0|100)
. The test result is successful if the string response or header assertions’ value is 0 or 100.
If a test does not contain an assertion on the response body, the body payload drops and returns an associated response time for the request within the timeout limit set by the Synthetics Worker.
If a test contains an assertion on the response body and the timeout limit is reached, an Assertions on the body/response cannot be run beyond this limit
error appears.
Select the Locations to run your WebSocket test from. WebSocket tests can run from both managed and private locations depending on your preference for running the test from outside or inside your network.
Datadog’s out-of-the-box managed locations allow you to test public-facing websites and endpoints from regions where your customers are located.
Americas | APAC | EMEA |
---|---|---|
Canada Central (AWS) | Hong Kong (AWS) | Cape Town (AWS) |
Northern California (AWS) | Mumbai (AWS) | Frankfurt (AWS) |
Northern Virginia (AWS) | Seoul (AWS) | Ireland (AWS) |
Ohio (AWS) | Singapore (AWS) | London (AWS) |
Oregon (AWS) | Sydney (AWS) | Paris (AWS) |
São Paulo (AWS) | Tokyo (AWS) | Stockholm (AWS) |
Virginia (Azure) | Osaka (AWS) | Milan (AWS) |
Jakarta (AWS) | Bahrain (AWS) |
The Datadog for Government site (US1-FED) uses the following managed location:
Americas |
---|
US-West |
WebSocket tests can run:
Set alert conditions to determine the circumstances under which you want a test to fail and trigger an alert.
When you set the alert conditions to: An alert is triggered if any assertion fails for X minutes from any n of N locations
, an alert is triggered only if these two conditions are true:
Your test can trigger retries X
times after Y
ms in case of a failed test result. Customize the retry interval to suit your alerting sensibility.
Location uptime is computed on a per-evaluation basis (whether the last test result before evaluation was up or down). The total uptime is computed based on the configured alert conditions. Notifications sent are based on the total uptime.
A notification is sent by your test based on the alerting conditions previously defined. Use this section to define how and what to message your team.
Similar to how you configure monitors, select users and/or services that should receive notifications either by adding an @notification
to the message or by searching for team members and connected integrations with the dropdown menu.
Enter the notification message for your test. This field allows standard Markdown formatting and supports the following conditional variables:
Conditional Variable | Description |
---|---|
{{ #is_alert }} | Show when the test alerts. |
{{ ^is_alert }} | Show unless the test alerts. |
{{ #is_recovery }} | Show when the test recovers from alert. |
{{ ^is_recovery }} | Show unless the test recovers from alert. |
{{ #is_renotify }} | Show when the monitor renotifies. |
{{ ^is_renotify }} | Show unless the monitor renotifies. |
{{ #is_priority }} | Show when the monitor matches priority (P1 to P5). |
{{ ^is_priority }} | Show unless the monitor matches priority (P1 to P5). |
Specify how often you want your test to re-send the notification message in case of test failure. To prevent renotification on failing tests, leave the option as Never renotify if the monitor has not been resolved
.
Click Create to save your test configuration and monitor.
For more information, see Using Synthetic Test Monitors.
To create a local variable, click Create a Local Variable. You can select one of the following available builtins to add to your variable string:
n
digits.n
letters.n
characters.n
units.n
units.To obfuscate local variable values in test results, select Hide and obfuscate variable value. Once you have defined the variable string, click Add Variable.
You can use the global variables defined on the Settings page in the URL, advanced options, and assertions of your WebSocket tests.
To display your list of variables, type {{
in your desired field.
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.
These reasons include the following:
CONNRESET
DNS
INVALID_REQUEST
SSL
TIMEOUT
TIMEOUT
errors can happen: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).
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.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).WEBSOCKET
WEBSOCKET
error can happen:WEBSOCKET: Received message longer than the maximum supported length.
indicates that the response message length hits the maximum length (50kb).By default, only users with the Datadog Admin and Datadog Standard roles can create, edit, and delete Synthetic WebSocket tests. To get create, edit, and delete access to Synthetic WebSocket tests, upgrade your user to one of those two default roles.
If you are using the custom role feature, add your user to any custom role that includes synthetics_read
and synthetics_write
permissions.
Access restriction is available for customers using custom roles on their accounts.
You can restrict access to a WebSocket test based on the roles in your organization. When creating a WebSocket test, choose which roles (in addition to your user) can read and write your test.