Skip navigation
Currently Being Moderated

13.4 Creating ZenPacks

VERSION 4  Click to view document history
Created on: Oct 11, 2011 4:59 PM by Zenoss API - Last Modified:  Oct 11, 2011 5:17 PM by Zenoss API

 4. Creating ZenPacks

Read the following information and procedures to learn more about why you might want to create a ZenPack, and how to:

 4.1. Why Create a ZenPack?

Suppose you have developed a monitoring template for a new piece of hardware. You have created data sources for the OID's you think are worth monitoring, thresholds to make sure some of these values stay within reasonable limits, and several graph definitions to show this data graphically. Perhaps you also have created a new device class for this hardware. You can create a ZenPack to easily distribute your template and device class to other administrators. This ZenPack can be entirely created from within the user interface.

As another example, suppose you want to monitor a new piece of software running on one of your servers. You would like to monitor several performance metrics of this software, but they are available only via a programmatic API provided with the software. You could develop a new collector daemon to gather data via this API and provide it back to the system. You might also create a new type of data source to provide configuration data for the new collector. Obviously this effort would require development skills and intimate knowledge of the system not necessary for the previous example, but this functionality can be distributed as a ZenPack.

 4.2. Create a ZenPack

Use the following instructions and guidelines to create a ZenPack.

Note

You must be logged in as an administrator to create a ZenPack.

  1. From the Navigation menu, select Advanced > Settings.

  2. In the left panel, select ZenPacks.

  3. From (Action menu), select Create a ZenPack.

    The Create a ZenPack dialog appears.

  4. Enter the name of the ZenPack, which must be in the format:

    ZenPacks.Organization.Identifier

    where Organization is a name that identifies you or your organization and Identifier is a string that represents the intent of your ZenPack.

    Note

    Do not use underscores in ZenPack names. ZenPacks whose names include an underscore break on export.

  5. Click OK.

    The system creates the ZenPack object in the database and a new directory in the file system $ZENHOME/ZenPacks/YourZenPackID.

 4.3. Add a Database Object to a ZenPack

To add a database object (such as a device, service, or event class, event mapping, user command, device organizer, or monitoring template) to a ZenPack:

  1. Navigate to the object in the interface.

  2. From the Action menu, select Add to ZenPack.

     

    Figure 13.2. Add to ZenPack

    Add to ZenPack

    The Add to ZenPack dialog appears.

  3. Select a ZenPack from the list of installed ZenPacks, and then click Submit.

 4.4. View Database Objects in a ZenPack

To view the objects that are part of a ZenPack:

  1. From the Navigation menu, select Advanced > Settings.

  2. In the left panel, select ZenPacks.

  3. Click the name of a ZenPack in the list.

    The ZenPack Provides area of the page lists objects that are part of the ZenPack.

 4.5. Remove a Database Object from a ZenPack

To remove a database object from a ZenPack:

  1. From the Navigation menu, select Advanced > Settings.

  2. In the left panel, select ZenPacks.

  3. Click the name of a ZenPack in the list.

  4. Select an object in the ZenPack Provides area of the page.

  5. From the Action menu, select Delete from ZenPack.

 4.6. Adding Other Items to ZenPacks

ZenPacks can contain items that are not database items, such as:

  • Daemons

  • Data source types

  • Skins

You can add these to a ZenPack by placing them in the appropriate subdirectory in the ZenPack's directory.

Comments (0)