Skip to main content

TCP Connect

TCP Connect Collector

To collect information about the ability to connect to a specified TCP address, you can use the tcpConnect collector.

Parameters

In addition to the shared collector properties, the tcpConnect collector accepts the following parameters:

address (Required)

The address to check the connection to.

timeout (Optional)

Specifies the total timeout.

Example Collector Definition

apiVersion: troubleshoot.sh/v1beta2
kind: SupportBundle
metadata:
name: tcpConnect
spec:
hostCollectors:
- tcpConnect:
collectorName: kubernetes-api-tcp-conn-status
address: 10.128.0.29:6443
timeout: 10s

Included Resources

The results of the tcpConnect collector are stored in the host-collectors/connect directory of the support bundle.

[collector-name].json

If the collectorName field is unset, it will be named connect.json.

Example of the resulting file:

connection-refused

TCP Connect Analyzer

The tcpConnect analyzer supports multiple outcomes:

  • connection-refused: Connection to the address was refused.
  • connection-timeout: Timed out connecting to the address.
  • connected: Successfully connected to the address.
  • error: Unexpected error connecting to the address.

Example Analyzer Definition

apiVersion: troubleshoot.sh/v1beta2
kind: SupportBundle
metadata:
name: tcpConnect
spec:
hostCollectors:
- tcpConnect:
collectorName: kubernetes-api-tcp-conn-status
address: 10.128.0.29:6443
timeout: 10s
hostAnalyzers:
- tcpConnect:
checkName: "Kubernetes API TCP Connection Status"
collectorName: kubernetes-api-tcp-conn-status
outcomes:
- fail:
when: "connection-refused"
message: Connection to the Kubernetes API address was refused
- fail:
when: "connection-timeout"
message: Timed out connecting to the Kubernetes API address
- fail:
when: "error"
message: Unexpected error connecting to the Kubernetes API address
- pass:
when: "connected"
message: Successfully connected to the Kubernetes API address