HttpCollector

The HttpCollector collects performance data via HTTP and HTTPS. Attributes are extracted from the HTTP responses using a regular expression.

Collector facts

Class Name

org.opennms.netmgt.collectd.HttpCollector

Package

core

Supported on Minion

Yes

Configuration Files

$OPENNMS_HOME/etc/http-datacollection-config.xml

Configuration and use

Table 1. Collector-specific parameters for the HttpCollector
Parameter	Description	Default
Required
collection	The name of the HTTP Collection to use.	n/a
Optional
thresholding-enabled	Whether collected performance data should be tested against thresholds.	true
port	Override the default port in all of the URIs.	80
timeout	Connection and socket timeout in milliseconds	3000
retry	Number of retries	2
use-system-proxy	Should the system-wide proxy settings be used? Configure system proxy settings via system properties.	false

HTTP collection configuration

Understanding resource types helps when editing collector-specific configuration files.

Define HTTP Collections in etc/http-datacollection-config.xml.

This snippet provides a collection definition named opennms-copyright:

<http-collection name="opennms-copyright">
  <rrd step="300">
    <rra>RRA:AVERAGE:0.5:1:2016</rra>
    <rra>RRA:AVERAGE:0.5:12:1488</rra>
    <rra>RRA:AVERAGE:0.5:288:366</rra>
    <rra>RRA:MAX:0.5:288:366</rra>
    <rra>RRA:MIN:0.5:288:366</rra>
  </rrd>
  <uris>
    <uri name="login-page">
      <url path="/opennms/login.jsp" matches=".*2002\-([0-9]+).*" response-range="100-399" dotall="true" >
      </url>
      <attributes>
        <attrib alias="copyrightYear" match-group="1" type="gauge"/>
      </attributes>
    </uri>
  </uris>
</http-collection>

Metadata expressions can also be used in attributes of the http-datacollection-config.xml configuration file. This lets the user to also reference credentials stored in the secure credentials.

Once added to etc/http-datacollection-config.xml, you can use the collect command available in the Karaf Shell to test it:

opennms:collect org.opennms.netmgt.collectd.HttpCollector 127.0.0.1 collection=opennms-copyright port=8980