Connector Design Guide

Detection

Documentation under construction...

The detection's goal is to see if the connector will be of use, given the specified system type and the protocol enabled in your configuration.

Format

connector:
  # ...
  detection:
    connectionTypes: # <enum-array> | possible values: [ remote, local ] | default: local
    disableAutoDetection: # <boolean> | default: false
    onLastResort: # <string>
    appliesTo: # <enum-array> | possible values: [ vms, osf1, hp, rs6000, linux, oob, nt, network, storage, solaris, sunos ]
    supersedes: # <string-array>
    criteria: # <criteria-object-array>
    - #...

Properties

Property	Description
`connectionTypes`	The types of the connection `local` and/or `remote`: `remote` the connector can be used to monitor a remote system `local` the connector can be used to monitor the system the agent is running on. If the connector cannot be used locally (because the targeted system is something which you cannot install an agent on) use only `remote`.
`appliesTo`	Comma-separated list of OSes the connector can be used on. Possible values: HP = HP-UX NT = Microsoft Windows Linux = Linux OSF1 = HP Tru64 Solaris = Sun Solaris SunOS = Sun Solaris SOLARIS = Sun Solaris RS6000 = IBM AIX Storage = Storage Device VMS = HP OpenVMS OOB = Out-of-band, management cards, VMware ESX, etc.
`supersedes`	Comma-separated list of connectors that are superseded by this connector. In automatic detection, this connector will prevail on the listed connectors if they happen to be detected too.
`disableAutoDetection`	When set to true prevent the connector from running a detection.
`onLastResort`	Specifies that the connector is to be used as “last resort” only. The connector may be applied to monitor the system if no other connectors discovering the specified device type matches the system. Example: `onLastResort: enclosure` The connector will be activated if and only if no other connector matches and has an `$monitors.enclosure.discovery.mapping.source` or `$monitors.enclosure.simple.mapping.source`.
`criteria`	Array of criterion objects that the engine executes to decide whether the connector should be staged to monitor the host or not. These criteria are also executed by the engine if the user selects specific connectors. See specification in the Criteria Section^[1].

In order for a connector to match a system, some criterion must be met. They are defined in the Detection Section^[2] of the connector and checked during the discovery. If all criterion are met, the connector matches and will be used to monitor the system. If a criteria is not met, MetricsHub stops processing the detection and as far as the target system is concerned, the connector will not be used.

A maximum number of 99 detection criterion may be defined in a connector.