Observatory

The Observatory component probes outbound connectivity via HTTP or TCP connect. The observation results can be used by other components such as the Load Balancer.

ObservatoryObject

json

{
  "subjectSelector": ["outbound"],
  "testUrl": "https://connectivitycheck.gstatic.com/generate_204",
  "interval": "10s",
  "failed": 2,
  "failedInterval": "2s",
  "tcping": false
}

subjectSelector: [ string ]

An array of strings, where each string is used for prefix matching against outbound proxy tags. Given the following outbound proxy tags: [ "a", "ab", "c", "ba" ], "subjectSelector": ["a"] will match [ "a", "ab" ].

testUrl: string

The URL used for probing. In HTTP mode, any response counts as success and the HTTP status code is ignored.
In TCP mode, host:port is derived from this URL for a TCP connect probe (http -> 80, https -> 443). You can also provide a direct host:port.

interval: string

Probe interval per outbound. The time format is number + unit, such as "10s", "2h45m". Supported time units are ns, us, ms, s, m, h.

failed: number

Mark the outbound as down after this many consecutive failures.

failedInterval: string

The interval between retries after the first failure. When consecutive failures reach failed, the outbound is marked down and will be re-checked on the next interval. Any success immediately marks it up.

tcping: true | false

Enable TCP ping mode. When true, a TCP connect probe is used; when false, HTTP GET is used.

TIP

Compatibility fields: probeURL can be used as an alias of testUrl, probeInterval as an alias of interval. failedInterval can also be written as failed-interval.

Observatory ​

ObservatoryObject ​

Observatory

ObservatoryObject