Getting Started

zenpacklib is a single Python module designed to be packaged with every ZenPack. There is a single file, that must be distributed with each ZenPack.


Depending on what versions of Zenoss your ZenPack is supporting you may need to get a specific version of zenpacklib. See Compatibility for more information. Since the latest version of zenpacklib is usually compatible with recent versions of Zenoss it’s usually safe to get the most recent release. This can be done with the following commands.

su - zenoss
chmod 755

After downloading you can check the version by running the following command as the zenoss user.

./ version

Creating a ZenPack

There are two ways to get started with zenpacklib. You can either use it to create a new ZenPack from the command line, or you can copy it into an existing ZenPack. We’ll start by creating a ZenPack from the command line.

Run the following command to create a new ZenPack.

./ create ZenPacks.acme.Widgeter

This will print several lines to let you know what has been created. Note that the ZenPack’s source directory has been created, but it has not yet been installed.

Creating source directory for ZenPacks.acme.Widgeter:
  - making directory: ZenPacks.acme.Widgeter/ZenPacks/acme/Widgeter
  - creating file: ZenPacks.acme.Widgeter/
  - creating file: ZenPacks.acme.Widgeter/
  - creating file: ZenPacks.acme.Widgeter/ZenPacks/
  - creating file: ZenPacks.acme.Widgeter/ZenPacks/acme/
  - creating file: ZenPacks.acme.Widgeter/ZenPacks/acme/Widgeter/
  - creating file: ZenPacks.acme.Widgeter/ZenPacks/acme/Widgeter/zenpack.yaml
  - copying: ./ to ZenPacks.acme.Widgeter/ZenPacks/acme/Widgeter

Now let’s take a look at zenpack.yaml. This is the file that will define what our ZenPack does.

name: ZenPacks.acme.Widgeter

Add Monitoring

Let’s add a device class and a monitoring template to our ZenPack. Change zenpack.yaml to contain the following:

name: ZenPacks.acme.Widgeter

        - WidgeterHealth

          description: ACME Widgeter monitoring.

              type: COMMAND
              parser: Nagios
              commandTemplate: "echo OK|percent=100"

                  rrdtype: GAUGE
                  rrdmin: 0
                  rrdmax: 100

              dsnames: [health_percent]
              eventClass: /Status
              severity: Warning
              minval: 90

              units: percent
              miny: 0
              maxy: 0

                  dpName: health_percent
                  format: "%7.2lf%%"

Check for Correctness

Now that we have a more interesting zenpack.yaml, let’s have zenpacklib check that it’s correct. This can be done using the lint command.

cd ZenPacks.acme.Widgeter/ZenPacks/acme/Widgeter
./ lint zenpack.yaml

Lint will print information about errors it finds in the YAML file. If nothing is printed, lint thinks the YAML is correct.

What Next?

You can either start with some Tutorials or jump right into the YAML Reference.