TCP Send Plugin Configuration Guide
1. Overview
CONFIG_XXX) of the TCP Send monitoring plug-in and their impact on monitoring result metric calculation. All settings are passed in as key=value text, with one setting per line.2. settings Options
2.1 Basic Connection settings
| Setting | Required | Default | Description |
|---|---|---|---|
host | yes | - | Domain name or IP address of the monitoring target. IPv4 and IPv6 addresses are supported. |
port | no | 80 | Port number of the monitoring target. |
ipVersion | no | IPv4 | IP protocol version. Optional values: IPv4, IPv6. The name must be ipVersion. |
Impact
host is empty, the task exits directly with an error (error code 699000).2.2 Data Sending settings
| Setting | Required | Default | Description |
|---|---|---|---|
content | no | - | Raw data sent to the server. Hexadecimal strings starting with hex: are supported, such as hex:474554202f...; they are automatically decoded into binary data before sending. |
Impact
content is empty or does not exist, the plug-in only establishes the connection.40960 bytes is truncated to this upper limit.2.3 Response Receiving and Verification settings
| Setting | Required | Default | Description |
|---|---|---|---|
recv | no | - | Rule used to verify the server response. • If it starts with hex:, inclusion verification is used: the response content must include the byte sequence decoded from the hexadecimal value. • Otherwise, it is treated as a regular expression: the response content must match the regex, case-insensitively. |
wait | no | 0 | Maximum time to wait for receiving the server response, in milliseconds (ms). • 0 means no waiting for response reception. If wait is not set or is less than 1, but recv is set, 5000 ms is used. • The actual effective value does not exceed the task timeout setting. |
Impact
recv and wait must be set; otherwise, response data is not received.recv verification fails, error code 699003 is set (data verification failed). If the regular expression is invalid, error code 699004 is set.wait determines the maximum Wait Time during the data receiving stage and affects the collection integrity of Time to First Byte (TTFB) (first) and Time to Last Byte (remain). If no data is received before timeout, the corresponding metric may be 0 or missing.3. Result Metric Descriptions
| Indicator index | Metric name | Collection stage | Calculation method | Affected settings |
|---|---|---|---|---|
0 | Total task time (total) | Overall | task end time - task start time | task timeout (timeout upper limit), wait (receive wait) |
1 | DNS Lookup Time (DNS) | Domain resolution | DNS resolution end time - DNS resolution start time | host, ipversion |
2 | Connection Establishment Time (connect) | TCP handshake | connect return time - connect start time | host, port, ipversion, task timeout |
3 | Sending data time (send) | Data sending | send return time - send start time | content, task timeout |
4 | Time to First Byte (TTFB) (first) | Data receiving | first data received time - send end time | wait, recv, task timeout |
5 | Time to Last Byte (remain) | Data receiving | last data received time - first data received time | wait, recv, task timeout |
3.1 Metric Calculation Details
1.
host is already an IP address, DNS resolution is skipped and the metric value is 0.2.
connect system call.3.
699002 is set, and the metric still records the elapsed time.4.
recv return.0.5.
0.4. Error Code Description
| Error code | Meaning | Trigger scenario |
|---|---|---|
699000 | Basic/protocol error | host is empty, uncaught exception, etc. |
612029 | Connection error | TCP connect failed |
699002 | Data sending failed | Actual bytes sent are less than expected. |
699003 | Data verification failed | Inclusion verification or regex matching configured by recv failed. |
699004 | Exception during data verification | Regular expression syntax error or another exception. |
612007 | Domain resolution failed | ERROR_INTERNET_NAME_NOT_RESOLVED; DNS cannot resolve host. |
5. settings Examples
5.1 Basic TCP Monitoring (HTTP request)
host=www.example.com
port=80
content=hex:474554202f20485454502f312e310d0a0d0a
recv=HTTP/1\.1\s+200
wait=5000www.example.com:80, waits up to 5 seconds, and verifies whether the response includes HTTP/1.1 200.5.2 TCP Port Connectivity Monitoring (No Send, No Verification)
host=192.168.1.1
port=4435.3 IPv6 Monitoring
host=2403:a200:a200:13f1::1
port=80
ipversion=IPv6
wait=50006. Notes
1.
host, HOST, and Host are case-insensitive.2.
# and blank lines are allowed in the settings text and are automatically ignored by the plug-in.3.
hex: must be continuous hexadecimal characters, such as hex:48656c6c6f, and is case-insensitive.4.
recv does not start with hex:, regex matching is used and is case-sensitive by default.5.
40960 bytes. Excess data is truncated.