ZenPack:Zentrospect

From Zenoss Wiki
This is the approved revision of this page, as well as being the most recent.
Jump to: navigation, search
Author(s)
Chet Luther
License
GNU General Public License, Version 2, or later
ZenPack name
ZenPacks.zenoss.Zentrospect
More Information
GitHub page/HomePage
Git sources (for cloning)
Link


Applications Monitored: 



Zentrospect ZenPack

Monitoring Zenoss servers using zenoss-snmp-module.

Warning

The ZenPack Catalog has moved to its new home at https://www.zenoss.com/product/zenpacks as of January 17, 2017. The following information may be out of date, and this page will eventually be removed.

Support

This ZenPack is developed by the Zenoss user community and supported via our online forums. Zenoss, Inc. does not provide direct support for this ZenPack.

Releases

Version 1.2.0- Download
Summary of changes: Added ability to ignore systems and processes during modeling.
Released on 2013/09/06
Compatible with Zenoss Core 4.2.x, Zenoss Resource Manager 4.1.x, Zenoss Resource Manager 4.2.x
Incompatible with Zenoss Core 2.5.x, Zenoss Core 3.1.x, Zenoss Core 3.2.x
Version 1.1.0- Download
Summary of changes: Support ignoring of metrics and more configurable monitoring of metrics.
Released on 2013/08/24
Compatible with Zenoss Core 4.2.x, Zenoss Resource Manager 4.1.x, Zenoss Resource Manager 4.2.x
Incompatible with Zenoss Core 2.5.x
Version 1.0.0- Download
Summary of changes: First stable release.
Released on 2013/08/23
Compatible with Zenoss Core 4.2.x, Zenoss Resource Manager 4.1.x, Zenoss Resource Manager 4.2.x
Incompatible with Zenoss Core 2.5.x

Background

This ZenPack provides support for monitoring Zenoss servers. Specifically at this point this means monitoring Zenoss servers that have the zenoss-snmp-module extension to Net-SNMP installed to expose internal process metrics via SNMP.

Gallery

Features

The features added by this ZenPack can be summarized as follows. They are detailed further below.

  • Discovery of Zenoss systems, processes and metrics thereof.
  • Monitoring of process metric values.
  • Monitoring of process metric freshness.

Discovery

The following entities will be automatically discovered from server devices that are running Zenoss, have the zenoss.snmp.ZenossSNMP modeler plugin assigned, and have the zenoss-snmp-module extension to Net-SNMP installed and configured properly.

Zenoss Systems
Attributes: Name
Collections: Zenoss Processes, Zenoss Metrics
Zenoss Processes
Attributes: Name, System
Collections: Zenoss Metrics
Zenoss Metrics
Attributes: Name, System, Process

Monitoring

The following metrics will be collected every 5 minutes by default.

Metrics
Metrics: zenProcessMetricValue, zenProcessMetricCyclesSinceUpdate

zenProcessMetricValue is the most recent value recorded for the metric. It will be NaN in cases where a value hasn't been recorded recently.

zenProcessMetricCyclesSinceUpdate is how many "cycle intervals" it has been since the value was successfully recorded. This measure is used because some metrics are updated on different cycle intervals. For example, if the localhost-zenperfsnmp-devices metric is updated every 300 seconds and was last updated 30 seconds ago, the zenProcessMetricCyclesSinceUpdate value will be 0.1.

By default a maximum threshold of 2 is set for zenProcessMetricCyclesSinceUpdate on all discovered metrics. This can be used to identify Zenoss processes that are not functioning properly.

Service Impact

When combined with the Zenoss Service Dynamics product, this ZenPack adds service impact capability for the entities it discovers. The following service impact relationships are automatically added. These will be included in any services that contain one or more of the explicitly mentioned entities.

Service Impact Relationships
A Device failure impacts all associated Zenoss Systems.
A Zenoss System failure impacts all associated Zenoss Processes.
A Zenoss Process failure impacts all associated Zenoss Metrics.

Usage

To make use of this ZenPack you must first install zenoss-snmp-module on your Zenoss server(s). It provides valuable information on any server running Zenoss processes. This includes masters, hubs and collectors.

You must then assign the zenoss.snmp.ZenossSNMP modeler plugin that comes with this ZenPack to any devices that have zenoss-snmp-module installed. The devices must then be remodeled.

Configuring Metric Modeling

Sometimes it is not desirable to model every system, process and metrics reported by zenoss-snmp-module. One very common case is the zendisc process. Ordinarily zendisc does not run frequently or as a daemon, so its metrics will always be stale and result in a stale metric threshold warning events.

To prevent the zendisc process and all of its metrics from being modeled, the default value of the zZentrospectIgnoreProcesses property is zendisc.

Entire systems can be ignored during modeling by setting zZentrospectIgnoreSystems to a regular expression that matches the name of systems you wish to ignore. This will also prevent modeling of any processes and metrics from that system.

Individual metrics can be ignored with the zZentrospectIgnoreMetrics property.

Configuring Monitoring

By default you will find that the same ZentrospectMetric monitoring template is bound to every discovered metric. This results in all metrics being monitored in the same way. Any changes made to this monitoring template will apply to all metrics.

Sometimes it is desirable to monitor metrics differently. While this can be done using the normal process of creating local copies of the ZentrospectMetric monitoring template for each metric, that can become tedious and work can be lost if the metric in question is removed and replaced by modeling. In these cases you can create new monitoring templates to apply to as wide or narrow a subset of metrics as you want.

Take a metric named z-localhost-zenperfsnmp-devices as an example. Zenoss will attempt to bind monitoring templates by the following names in order until it finds a monitoring template that matches.

  1. ZentrospectMetric-localhost-zenperfsnmp-devices
  2. ZentrospectMetric-zenperfsnmp-devices
  3. ZentrospectMetric-localhost-devices
  4. ZentrospectMetric-localhost-zenperfsnmp
  5. ZentrospectMetric-devices
  6. ZentrospectMetric-zenperfsnmp
  7. ZentrospectMetric-localhost

As you can see, it goes from most specific to least specific. So if you want to change the way the devices metric for zenperfsnmp is monitored across all collectors, you'd copy the ZentrospectMetric template to ZentrospectMetric-zenperfsnmp-devices and make the desired adjustments on the new template.

Installed Items

Installing this ZenPack will add the following items to your Zenoss system.

Configuration Properties
  • zZentrospectIgnoreSystems: Regular expression of systems to ignore during modeling. All processes and metrics for matching systems will also be ignored. Defaults to an empty string which causes no systems to be ignored.
  • zZentrospectIgnoreProcesses: Regular expression of processes to ignore during modeling. All metrics for matching processes will also be ignored. Defaults to zendisc because zendisc is not a daemon and doesn't provide regular metrics.
  • zZentrospectIgnoreMetrics: Regular expression of metrics to ignore during modeling. Defaults to an empty string which causes no metrics to be ignored.
Modeler Plugins
  • zenoss.snmp.ZenossSNMP
Monitoring Templates
  • ZentrospectMetric (in /Devices)
Component Types
  • Zenoss Systems (on any device)
  • Zenoss Processes (on Zenoss System components)
  • Zenoss Metrics (on Zenoss Process components)

Changes

1.2.0 (2013-09-06)
  • Added zZentrospectIgnoreSystems property for filtering modeled systems.
  • Added zZentrospectIgnoreProcesses property for filtering modeler processes.
  • Changed default value of zZentrospectIgnoreMetrics from zendisc to nothing.
  • Set default value of zZentrospectIgnoreProcesses to zendisc.
1.1.0 (2013-08-23)
  • Added zZentrospectIgnoreMetrics property for filtering modeled metrics.
  • Added support for ZentrospectMetric-* monitoring templates for customizable monitoring per system, process or metric combination.
1.0.0 (2013-08-23)
  • Changed copyright.
1.0.0dev1 (2013-05-09)
  • Initial release.

Installation

Normal Installation (packaged egg)

  1. Download the appropriate egg file for the version of Zenoss you are running.
  2. Ensure you are logged in as the zenoss user:
    $ sudo su - zenoss
  3. Install the ZenPack:
    $ zenpack --install ZenPacks.zenoss.Zentrospect-*.egg
  4. Restart these services:
    $ zenoss restart

Developer Mode Installation

In order to do a development mode installation you will want to clone the existing git repository, and then use the --link flag with the zenpack command:

  1. Ensure you are logged in as the zenoss user:
    $ sudo su - zenoss
  2. Start by cloning the upstream repository:
    $ git clone git://github.com/zenoss/ZenPacks.zenoss.Zentrospect.git
  3. Next, perform the installation:
    $ zenpack --link --install ZenPacks.zenoss.Zentrospect
  4. Finally, restart these serivices:
    $ zenoss restart

Discuss

Purplemarker.png New: Don't forget to add yourself to the Zenoss User Map!

blog comments powered by Disqus