TCP

Checks if 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*	Host to ping	string
name*	Name of the check, must be unique within the canary	string
relationships	Link check results to components and configs	Relationships
thresholdMillis	Maximum response time in milliseconds	integer
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
test	Evaluate whether a check is healthy	Expression
transform	Transform data from a check into multiple individual checks	Expression