variables

Variables of a collector

variable() declares a setting of the collector, that the administrator gives on the probe. Here, a web page and the words it must hold, in the five forms.

How to read it

• variable('example:page:url', 'text', array('label' => …, 'help' => …)): a name of 2 to 8 parts separated by :, a form, a label and a help sentence, both required. The families host, acl, protocol and probe are banshee's.
• The five forms: text (one line), multiline (several, read here with text.lines), integer (a number), boolean (true or false) and choice (one of choices).
• Required unless 'required' => false: a required variable left empty stops the collector, misconfigured. An optional one reads ''.
• 'default' => …: the value of a new probe, until the administrator changes it.
• 'secret' => true makes it a secret, never written in a value or a message, and never given a default (see examples/api/signed-request).
• A variable of a collector is set on its probe only: two collectors may use the same name without meeting.

To adapt it

• What belongs to the connection (an address, a port, an account, a TLS setting) is a standard variable of the tree, by need, not a variable of the collector.