Dialtesting

The collector collects the data of network dialing test results, and all the data generated by dialing test are reported to TrueWatch.

Configuration¶

[[inputs.dialtesting]]
  # We can also configure a JSON path like "file:///your/dir/json-file-name"
  server = "https://dflux-dial.truewatch.com"

  # [require] node ID
  region_id = "default"

  # if server are dflux-dial.truewatch.com, ak/sk required
  ak = ""
  sk = ""

  # The interval to pull the tasks.
  pull_interval = "1m"

  # The timeout for the HTTP request.
  time_out = "30s"

  # The number of the workers.
  workers = 6

  # Collect related metric when job execution time error interval is larger than task_exec_time_interval
  task_exec_time_interval = "5s"

  # Stop the task when the task failed to send data to dataway over max_send_fail_count.
  max_send_fail_count = 16

  # The max sleep time when send data to dataway failed.
  max_send_fail_sleep_time = "30m"

  # The max number of jobs sending data to dataway in parallel. Default 10.
  max_job_number = 10

  # The max number of job chan. Default 1000.
  max_job_chan_number = 1000

  # The max number of icmp packets sent at one time. Default 0, no limit.
  max_icmp_concurrency = 0

  # The max number of points in cache for each type of task. Default 10000.
  max_cache_points_number = 10000

  # Disable internal network task.
  disable_internal_network_task = true

  # Disable internal network cidr list.
  disabled_internal_network_cidr_list = []

  # Set true to enable election
  election = false

  [inputs.dialtesting.browser]
    # Enable browser dialtesting on Linux nodes. Enabled by default.
    enabled = true

    # Browser engine used for browser dialtesting.
    # Supported engine: lightpanda.
    engine = "lightpanda"

    # Optional browser engine executable path.
    # If empty, the embedded browser runner will use LIGHTPANDA_EXECUTABLE_PATH or PATH.
    engine_path = ""

    # Max browser dialtesting tasks running at the same time. 0 means no limit.
    max_concurrency = 0

  # Custom tags.
  [inputs.dialtesting.tags]
  # some_tag = "some_value"
  # more_tag = "some_other_value"
  # ...

Dialtesting Node Deployment¶

The following is a network deployment topology for dialtesting nodes, which includes two deployment methods for dialtesting nodes:

• Public Network Nodes: Directly use the nodes deployed globally to check the healthy of public network services.
• Private Network Nodes: If you need to check private network services, you need to deploy private nodes. Of course, if the network allows, these private nodes can also check services deployed on the public network.

Whether it is a public or private node, they can both create probe tasks through the Web page.

If a dialtesting node needs to run browser dial testing tasks, make sure the node environment meets the following requirements:

• Lightpanda can be accessed by the DataKit process.
• The node can access the target site and the Dataway specified by task post_url, which is used to report dial testing results.

graph TD
  %% node definitions
  dt_web(Probe Web UI)
  dt_db(Public Task Storage)
  dt_pub(Public DataKit Node)
  dt_pri(Private DataKit Node)
  site_inner(Private Site)
  site_pub(Public Site)
  dw_inner(Private Dataway)
  dw_pub(Public Dataway)
  server(TrueWatch)

  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  dt_web -->|Create Task| dt_db;
  dt_db -->|Pull Tasks| dt_pub -->|Results| dw_pub --> server;
  dt_db -->|Pull Tasks| dt_pri;
  dt_pub <-->|Checking...| site_pub;

  dt_pri <-.->|Checking...| site_pub;
  dw_inner --> server;
  subgraph "User's Private Network"
  dt_pri <-->|Checking...| site_inner;
  dt_pri -->|Results| dw_inner;
  end

Log¶

All of the following data collections are appended with a global tag named host by default (the tag value is the host name of the DataKit), or can be named in the configuration by [[inputs.dialtesting.tags]] alternative host.

http_dial_testing¶

tcp_dial_testing¶

icmp_dial_testing¶

websocket_dial_testing¶

multi_dial_testing¶

grpc_dial_testing¶

browser_dial_testing¶

traceroute¶

traceroute is the JSON text of the "route trace" data, and the entire data is an array object in which each array element records a route probe, as shown in the following example:

[
    {
        "total": 2,
        "failed": 0,
        "loss": 0,
        "avg_cost": 12700395,
        "min_cost": 11902041,
        "max_cost": 13498750,
        "std_cost": 1129043,
        "items": [
            {
                "ip": "10.8.9.1",
                "response_time": 13498750
            },
            {
                "ip": "10.8.9.1",
                "response_time": 11902041
            }
        ]
    },
    {
        "total": 2,
        "failed": 0,
        "loss": 0,
        "avg_cost": 13775021,
        "min_cost": 13740084,
        "max_cost": 13809959,
        "std_cost": 49409,
        "items": [
            {
                "ip": "10.12.168.218",
                "response_time": 13740084
            },
            {
                "ip": "10.12.168.218",
                "response_time": 13809959
            }
        ]
    }
]

Field description:

items

Metric¶

The dialtesting collector exposes Prometheus metrics. By default, the DataKit collector collects and uploads these datakit_dialtesting_* metrics to TrueWatch without additional configuration.