TCP

The TCP check verifies that a network port is reachable.

tcp.yaml
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
  name: tcp-check
spec:
  schedule: "*/1 * * * *"
  tcp:
    - name: "flanksource website"
      endpoint: www.flanksource.com:443
      icon: https://flanksource.com/docs/img/flanksource-icon.png
      thresholdMillis: 1200
      display:
        template: Success

Field	Description	Scheme
endpoint*	Hostname or IPv4 address and port in HOST:PORT format. Do not include a URL scheme or path. IPv6 literals are not supported	string
name*	Name of the check, must be unique within the canary	string
thresholdMillis	Connection timeout in milliseconds. When unset or 0, the check does not set an explicit timeout	int64
dependsOn	Checks that must complete before this check runs	[]string
description	Description for the check	string
display	Expression to change the formatting of the display	Expression
icon	Icon for overwriting default icon on the dashboard	Icon
labels	Labels for check	[map[string]string]
markFailOnEmpty	If a transformation or datasource returns empty results, the check should fail	boolean
metrics	Metrics to export from	[]Metrics
namespace	Namespace to insert the check result into when it differs from the canary namespace	string
relationships	Relationships that link check results to components or configs	Relationship
test	Evaluate whether a check is healthy	Expression
transform	Transform data from a check into multiple individual checks	Expression
transformDeleteStrategy	Status to apply to transformed checks when the source check no longer returns them	string