Network Dial Testing

This collector gathers data from network dial testing results. All data generated by dial testing is reported to Guance.

Configuration¶

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

  # [require] node ID
  region_id = "default"

  # If the server is dflux-dial.guance.com, ak/sk are required
  ak = ""
  sk = ""

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

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

  # The number of workers.
  workers = 6

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

  # Stop the task when the task fails to send data to DataWay over max_send_fail_count.
  max_send_fail_count = 16

  # The maximum sleep time when sending data to DataWay fails.
  max_send_fail_sleep_time = "30m"

  # The maximum number of jobs sending data to DataWay in parallel. Default 10.
  max_job_number = 10

  # The maximum number of job channels. Default 1000.
  max_job_chan_number = 1000

  # Disable internal network tasks.
  disable_internal_network_task = true

  # Disable internal network CIDR list.
  disabled_internal_network_cidr_list = []

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

Dial Testing Node Deployment¶

The following diagram shows the network topology for deploying dial testing nodes. There are two ways to deploy dial testing nodes:

• Public Network Dial Testing Nodes: Directly use the globally deployed dial testing nodes provided by Guance to monitor services on the public internet.
• Private Network Dial Testing Nodes: If you need to test services within your internal network, you must deploy private dial testing nodes yourself. Of course, if the network allows, these private dial testing nodes can also test services on the public internet.

Regardless of whether they are public or private dial testing nodes, they can all create dial testing tasks through the web interface.

graph TD
  %% node definitions
  dt_web(Dial Testing Web UI);
  dt_db(Public Storage for Dial Testing Tasks);
  dt_pub(DataKit Public Dial Testing Node);
  dt_pri(DataKit Private Dial Testing Node);
  site_inner(Internal Site);
  site_pub(Public Site);
  dw_inner(Internal Dataway);
  dw_pub(Public Dataway);
  guance(Guance);

  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  dt_web -->|Create Dial Testing Task| dt_db;
  dt_db -->|Fetch Dial Testing Task| dt_pub -->|Dial Testing Results| dw_pub --> guance;
  dt_db -->|Fetch Dial Testing Task| dt_pri;
  dt_pub <-->|Perform Dial Testing| site_pub;

  dt_pri <-.->|Perform Dial Testing| site_pub;
  dw_inner --> guance;
  subgraph "User Internal Network"
  dt_pri <-->|Perform Dial Testing| site_inner;
  dt_pri -->|Dial Testing Results| dw_inner;
  end

Logging¶

http_dial_testing¶

• Tags

• Metrics List

tcp_dial_testing¶

• Tags

• Metrics List

icmp_dial_testing¶

• Tags

• Metrics List

websocket_dial_testing¶

• Tags

• Metrics List

multi_dial_testing¶

• Tags

• Metrics List

traceroute¶

traceroute is the JSON text of "route tracing" data. The entire data is an array object, where each element records the relevant details of one route probe. Example as follows:

[
    {
        "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 Descriptions:

items Field Description

Self-Monitoring Metrics Collection for Dial Testing Collector¶

The dial testing collector exposes Prometheus metrics. If you need to report these metrics to Guance, you can collect them using the DataKit collector. Refer to the following configuration example:

[[inputs.dk]]
  ......

  metric_name_filter = [

  ### others...

  ### dialtesting
  "datakit_dialtesting_.*",

  ]

  ......