From Observium

These are the available configuration options for Observium. They can be set in config.php.

Contents 1 Installation Directories 2 Location of Executables 3 rrdcached Settings 4 Web Interface Settings 4.1 Sections 4.2 Device Traffic Graph 4.2.1 Filters 4.3 Authentication 4.3.1 LDAP Authentication 4.4 External Integration 4.4.1 Rancid 4.4.2 CollectD 4.4.3 NfSen 5 SNMP Settings 6 Auto Discovery Settings 7 Alert Settings 8 Cosmetics 9 Poller and Discovery Modules 9.1 Ports 9.1.1 Filters 9.2 Processors 9.2.1 Filters 9.3 Storage 9.3.1 Filters 9.4 Billing 10 Syslog Settings 11 Virtualization 12 Misc Settings

Installation Directories

$config['temp_dir']      = "/tmp";
$config['install_dir']   = "/opt/observium";
$config['html_dir']      = $config['install_dir'] . "/html";
$config['rrd_dir']       = $config['install_dir'] . "/rrd";
$config['log_file']      = $config['install_dir'] . "/observium.log";

Define directories used by Observium. temp_dir is used to store temporary graphs by the web interface.

Location of Executables

$config['rrdtool']        = "/usr/bin/rrdtool";
$config['fping']          = "/usr/bin/fping";
$config['fping6']         = "/usr/bin/fping6";
$config['snmpwalk']       = "/usr/bin/snmpwalk";
$config['snmpget']        = "/usr/bin/snmpget";
$config['snmpbulkwalk']   = "/usr/bin/snmpbulkwalk";
$config['whois']          = "/usr/bin/whois";
$config['ping']           = "/bin/ping";
$config['mtr']            = "/usr/bin/mtr";
$config['nmap']           = "/usr/bin/nmap";
$config['nagios_plugins'] = "/usr/lib/nagios/plugins";
$config['ipmitool']       = "/usr/bin/ipmitool";
$config['virsh']          = "/usr/bin/virsh";

Define the locations of various executables used by Observium. These should be changed if they don't match your system.

rrdcached Settings

$config['rrdcached']    = "unix:/var/run/rrdcached.sock";

Defines the location of the rrdcached socket. Can be a UNIX socket or a TCP socket. If this is left undefined rrdcached won't be used.

Web Interface Settings

$config['base_url']         = "http://" . $_SERVER["SERVER_NAME"] .":".$_SERVER["SERVER_PORT"];

This is autoset based on the hostname and port used to connect to the web server. This should not normally be changed.

$config['title_image']      = "images/observium-logo.png";

This can be changed to use an alternative header image.

$config['stylesheet']       = "css/styles.css";

This can be changed to use an alternative CSS stylesheet.

$config['mono_font']        = "DejaVuSansMono";

This option is currently unused and should not be modified.

$config['favicon']          = "images/observium-icon.png";

This option can be changed to use an alternative favicon

$config['header_color']     = "#1F334E";

This option controls the colour of the small bar at the top of the web interface

$config['page_refresh']     = "300";  ## Refresh the page every xx seconds

Defines an autorefresh for pages in the web interface. If it's unset pages won't auto refresh.

$config['front_page']       = "pages/front/default.php";

Defines which front page should be used. Custom pages can be created and used via this variable.

$config['page_title']       = "Observium :: Network Observation and Monitoring";

Defines the <title> of pages in the web interface.

$config['timestamp_format'] = 'd-m-Y H:i:s';

Define the timestamp format for printed dates (not used everywhere?)

$config['page_gen']         = 1;

Enable or disable the page generation time at the bottom of the page

$config['web_header']       = "header.inc.php";  # in html/includes

Define the header file to be used at the top of the web interface.

$config['login_message']    = "Unauthorised access or use shall render the user liable to criminal and/or civil prosecution.";

Define the login message shown on the login page

Sections

$config['int_customers']           = 1;  # Enable Customer Port Parsing
$config['int_transit']             = 1;  # Enable Transit Types
$config['int_peering']             = 1;  # Enable Peering Types
$config['int_core']                = 1;  # Enable Core Port Types
$config['int_l2tp']                = 0;  # Enable L2TP Port Types
$config['show_locations']          = 1;  # Enable Locations on menu
$config['show_locations_dropdown'] = 1;  # Enable Locations dropdown on menu
$config['show_services']           = 1;  # Enable Services on menu

Define wether to enable or disable various dropdown menus and sections in the web interface

$config['ports_page_default']      = "details/"; ## eg "details/" "graphs/bits/"

Defines the default view on the /device/*/ports/ page.

$config['show_overview_tab'] = true;

Toggles whether to display the 'overview' tab on the device page.

$config['overview_show_sysDescr'] = true;

Toggles whether to display the device sysDescr on the overview page.

$config['warn']['ifdown'] = false;

Toggles wether to warn about disconnected interfaces on the default front page.

Device Traffic Graph

Filters

$config['device_traffic_iftype']  = array('/loopback/','/tunnel/','/virtual/','/mpls/');
$config['device_traffic_descr']   = array('/loopback/','/vlan/','/tunnel/','/:\d+/');

Defines lists of ifTypes and ifDescrs which should be excluded from the device total traffic graph.

Authentication

$config['allow_unauth_graphs']    = 0; ## Allow graphs to be viewed by anyone

Disables authentication for graphs. This should be used with caution

$config['allow_unauth_graphs_cidr'] = array();

Disables authentication for graphs if the request IP is in a certain CIDR range. (i.e. = array('192.168.0.0/16', '10.0.0.0/8'))

$config['auth_mechanism']         = "mysql";   # Available mechanisms: mysql (default), ldap, http-auth

Sets the authentication mechanism. Currently supported mechanisms are mysql, ldap and http-auth.

LDAP Authentication

$config['auth_ldap_version'] = 3; # v2 or v3
$config['auth_ldap_server'] = "ldap.yourserver.com";
$config['auth_ldap_port']   = 389;

$config['auth_ldap_starttls'] = FALSE; Set to "optional" if you want to enable TLS but don't want to depend on it being supported. 
                                                    Set to "require" if you want to ensure that your LDAP connection supports TLS.

LDAP server configuration.

$config['auth_ldap_prefix'] = "uid=";
$config['auth_ldap_suffix'] = ",ou=People,dc=example,dc=com";

How users are identified in your LDAP server, prefix+username+suffix will form the complete user DN.

$config['auth_ldap_group']  = "cn=observium,ou=groups,dc=example,dc=com";

Required group to be able to access Observium. Unset if you don't want to use this feature.

$config['auth_ldap_groupbase'] = "ou=group,dc=example,dc=com";

The LDAP base DN for your groups.

$config['auth_ldap_groups']['admin']['level'] = 10;
$config['auth_ldap_groups']['pfy']['level'] = 7;
$config['auth_ldap_groups']['support']['level'] = 1;

Configure the user levels people get when they are in a certain LDAP group.

External Integration

Rancid

$config['rancid_configs'][]              = '/var/lib/rancid/network/configs/';

Defines rancid configuration directories. This is an array, multiple rancid groups are supported. For performance, put your largest/most likely group in front. Configurations should have the same hostname as used in Observium.

$config['rancid_ignorecomments']        = 0; # Ignore lines starting with #

Toggles whether or not to filter out RANCID comments.

CollectD

$config['collectd_dir']                = '/var/lib/collectd/rrd';

Defines collectd directory. Hosts should be set to use the same hostname in collectd.conf as is used in Observium.

NfSen

$config['nfsen_enable']                 = 0;

Allows you to read RRD files created by NfSen.

$config['nfsen_rrds']                   = "/var/nfsen/profiles-stat/live/";

Local path to where nfsen created RRDs live.

$config['nfsen_split_char']             = "_";
$config['nfsen_suffix']                 = "_yourdomain_com";

According to nfsen.conf: Ident strings must be 1 to 19 characters long only, containing characters [a-zA-Z0-9_]. The above options are to overcome these limitations. nfsen_split_char will be converted to dots (router1_foo -> router1.foo) and nfsen_suffix will be appended (router01_foo_yourdomain_com - > router01.foo.yourdomain.com).

SNMP Settings

$config['snmp']['timeout'] = 300;          # timeout in ms
$config['snmp']['retries'] = 6;            # how many times to retry the query

Define the number of retries and timeout for SNMP queries. These are currently not set by default and should be changed with caution. Depending on your Net-SNMP version the timeout could be in seconds as well, do take care!

$config['snmp']['community'][] = "public"; # Communities to try during discovery (dangerous)

Defines a list of communities to be used during autodetection.

Auto Discovery Settings

$config['dp_autocreate']         = false; ## Autodiscover unknown hosts seen via discovery protocols

This enables autodiscovery of neighbouring devices via discovery protocols, such as CDP, LLDP or FDP. Note that this doesn't enable or disable the discovery protocol tracking features, but controls whether Observium should try to auto-add devices it sees via those protocols.

$config['snmp_autodiscovery']     = false; ## Autodiscover hosts on new subnets

SNMP autodiscovery is currently not working.

$config['discover_services']      = false; ## Autodiscover services via SNMP on devices of type "server"

When enabled, checks for open ports through SNMP and adds them to the services list.

Alert Settings

$config['alerts']['email']['default']      = NULL;    ## Default alert recipient

Defines a default alert recipient.

$config['alerts']['email']['default_only'] = FALSE;   ## Only use default recipient

Forces all alerts to the default recipient only.

$config['alerts']['email']['enable']       = TRUE;    ## Enable email alerts

Enables email alerts.

$config['uptime_warning']                  = "84600";

Time in seconds to display a "Device Rebooted" warning, defualts to 1 day. Set to 0 to disable warnings.

$config['alerts']['port']['ifdown']        = FALSE;

Generate an alert for ports which enter the ifdown state.

Cosmetics

$config['rrdgraph_def_text']  = "-c BACK#EEEEEE00 -c SHADEA#EEEEEE00 -c SHADEB#EEEEEE00 -c FONT#000000 -c CANVAS#FFFFFF -c GRID#a5a5a5";
$config['rrdgraph_def_text'] .= " -c MGRID#FF9999 -c FRAME#5e5e5e -c ARROW#5e5e5e -R normal";
$config['overlib_defaults']   = ",FGCOLOR,'#ffffff', BGCOLOR, '#e5e5e5', BORDER, 5, CELLPAD, 4, CAPCOLOR, '#555555', TEXTCOLOR, '#3e3e3e'";

Define the look and feel of rrdtool graphs and overlib popups. Should usually not be changed.

$config['rrdgraph_real_95th'] = FALSE;

Set this to TRUE if you want real 95th percentile numbers based on the highest value.

$list_colour_a   = "#ffffff";
$list_colour_b   = "#eeeeee";
$list_colour_a_a = "#f9f9f9";
$list_colour_a_b = "#f0f0f0";
$list_colour_b_a = "#f0f0f0";
$list_colour_b_b = "#e3e3e3";
$list_highlight  = "#ffcccc";
$warn_colour_a   = "#ffeeee";
$warn_colour_b   = "#ffcccc";

Define the row colours of various lists used in the web interface.

$config['graph_colours']['mixed']   = array('CC0000','008C00','4096EE','73880A','D01F3C','36393D','FF0084');
$config['graph_colours']['greens']  = array('B6D14B','91B13C','6D912D','48721E','24520F','003300');
$config['graph_colours']['pinks']   = array('D0558F','B34773','943A57','792C38','5C1F1E','401F10');
$config['graph_colours']['blues']   = array('A0A0E5','8080BD','606096','40406F','202048','000033');
$config['graph_colours']['purples'] = array('CC7CCC','AF63AF','934A93','773177','5B185B','3F003F');
$config['graph_colours']['default'] = $config['graph_colours']['blues'];

Define the colour schemes used by some graphs.

Poller and Discovery Modules

$config['enable_bgp']                   = 1; # Enable BGP session collection and display

Enable polling of BGP statistics via BGP4-MIB (and CISCO-BGP4-MIB / BGP4V2-MIB-JUNIPER)

$config['enable_syslog']                = 0; # Enable Syslog

Enable parsing of syslog. Currently unused.

$config['enable_inventory']             = 1; # Enable Inventory

Enable collection of inventory via ENTITY-MIB and HOST-RESOURCES-MIB

$config['enable_pseudowires']           = 1; # Enable Pseudowires

Enable collection of pseudowire statistics on supported hardware

$config['enable_vrfs']                  = 1; # Enable VRFs

Enable collection of VRF statistics on supported hardware

$config['enable_printers']              = 0; # Enable Printer support

Enable collection of printer (toner) statistics.

$config['enable_sla']                   = 0; # Enable Cisco SLA collection and display

Enable collection of Cisco IP SLA data.

Ports

$config['port_descr_parser']            = "includes/port-descr-parser.inc.php"; # Parse port descriptions into fields

Define the port ifDescr parser. Custom parsers can be used to support alternate port labelling schemes.

$config['enable_ports_Xbcmc']           = 1; # Enable ifXEntry broadcast/multicast

Toggles the collection of separate broadcast/multicast statistics (alongside of standard nonunicast)

$config['enable_ports_etherlike']       = 0; # Enable Polling EtherLike-MIB (doubles interface processing time)

Toggles collection of EtherLike-MIB interface error statistics. This is heavy I/O performance hit as it virtually doubles RRD writing load per interface.

$config['enable_ports_junoseatmvp']     = 0; # Enable JunOSe ATM VC Discovery/Poller

Toggles collection and graphing of ATM VCs on Juniper JunOSe

$config['enable_ports_adsl']            = 1; # Enable ADSL-LINE-MIB

Toggles collection and graphing of ADSL statistics via ADSL-LINE-MIB

Filters

$config['bad_if'] = array("voip-null", "virtual-", "unrouted", "eobc", "mpls", "sl0", "lp0", "faith0",
            "-atm layer", "-atm subif", "-shdsl", "-adsl", "-aal5", "-atm", "container",
            "async", "plip", "-physical", "-signalling", "control", "container", "unrouted",
            "bri", "-bearer", "bluetooth", "isatap", "ras", "qos", "miniport", "sonet/sdh",
            "span rp", "span sp", "sslvpn");

Defines a list of interfaces to ignore. Interfaces are ignored if the string is present in ifDescr. Extra entries should be added to the list with this format :

$config['bad_if_'][] = "STRING";
$config['bad_if_regexp'][] = "/serial[0-9]:/";

Defines a list of interfaces to ignore based on regular expression. Interfaces are ignored if ifDescr matches the regular expression

Processors

Filters

$config['processor_filter'][] = "An electronic chip that makes the computer work.";

Defines a set of strings to filter processors. If the processor description matches, the processor will be ignored.

Storage

Filters

$config['ignore_mount_removable'] = 1; # Ignore removable disk storage
$config['ignore_mount_network']   = 1; # Ignore network mounted storage
$config['ignore_mount_optical']   = 1; # Ignore mounted optical discs

Toggles ignoring of various types of storage devices

$config['ignore_mount'] = array("/kern", "/mnt/cdrom", "/proc", "/dev");
$config['ignore_mount_string'] = array("packages", "devfs", "procfs", "UMA", "MALLOC");
$config['ignore_mount_regexp'] = array("/on: \/packages/", "/on: \/dev/", "/on: \/proc/", "/on: \/junos^/",           ## JunOS Drives
                                      "/on: \/junos\/dev/", "/on: \/jail\/dev/", "/^(dev|proc)fs/", "/^\/dev\/md0/", ## JunOS Drives
                                      "/^\/var\/dhcpd\/dev,/", "/UMA/"                                               ## BSD Drives
                                      );

Billing

$config['enable_billing']               = 0; # Enable Billing
$config['billing']['customer_autoadd']  = 0; # Enable Auto-add bill per customer
$config['billing']['circuit_autoadd']   = 0; # Enable Auto-add bill per circuit_id
$config['billing']['bill_autoadd']      = 0; # Enable Auto-add bill per bill_id

Enables billing and various schemes for autocreating bills from port descriptions. These are currently unimplemented

Syslog Settings

$config['enable_syslog']   = 1;
$config['syslog_age']       = "1 month";        ## Entries older than this will be removed
$config['syslog_filter'] = array("last message repeated", "Connection from UDP: [",
                                "ipSystemStatsTable node ipSystemStatsOutFragOKs not implemented",
                                "diskio.c: don't know how to handle");  ## Ignore some crappy stuff from SNMP daemon

Virtualization

$config['enable_libvirt']               = 0; # Enable Libvirt VM support

Enable collection of Libvirt virtual machines on Linux machines.

$config['libvirt_protocols']    = array("qemu+ssh","xen+ssh"); # Mechanisms used, add or remove if not using this on any of your machines.

Use these protocols to discover virtual machines. If one fails, the code will try the next one, so put the one most likely to work in front. Once VMs are found, the remaining protocols are not tried.

Misc Settings

$config['astext'][65333] = "Cymru Bogon Feed";

This allows you to set a custom text for an ASN, in case it is not to your liking (i.e. you prefer UUnet to Verizon) or it simply does not exist in whois (Private ASN).

$config['allow_entity_sensor']['amperes'] = 1;
$config['allow_entity_sensor']['celsius'] = 1;
$config['allow_entity_sensor']['dBm'] = 1;
$config['allow_entity_sensor']['voltsDC'] = 1;
$config['allow_entity_sensor']['voltsAC'] = 1;
$config['allow_entity_sensor']['watts'] = 1;
$config['allow_entity_sensor']['truthvalue'] = 1;
$config['allow_entity_sensor']['specialEnum'] = 1;