Add Custom-Monitored Programs

Although you can add any UNIX program to Pepperdata custom program monitoring, monitoring works best for programs that are long-running—at least 10 seconds, and optimally minutes. If a program finishes in less than 10 seconds, its reported status and data might be incomplete due to the Pepperdata sample rate.


  1. If Pepperdata is already performing custom monitoring or extended JMX metrics collection, skip to step 2 to add new rules. Otherwise, configure the rules file as described in this step.

    Add the property to specify the filename and location for your rules file, pepperdata.agent.program.monitor.configPath, to the Pepperdata site file, pepperdata-site.xml. Be sure to replace your-file-path-and-name with the name you want for your yaml rules file.

    By default, the Pepperdata site file, pepperdata-site.xml, is located in /etc/pepperdata. If you customized the location, the file is specified by the PD_CONF_DIR environment variable. See Change the Location of pepperdata-site.xml for details.

    Malformed XML files can cause operational errors that can be difficult to debug. To prevent such errors, we recommend that you use a linter, such as xmllint, after you edit any .xml configuration file.
  2. Configure your program matching rules.

    1. Open the rules file for editing.

      • If Pepperdata is already performing custom program monitoring or extended JMX metrics collection, open the existing yaml rules file.

      • Otherwise, create a text file for the filename and location that you specified for the pepperdata.agent.program.monitor.configPath property.

    2. Add, delete, or revise the program matching rules; see Syntax: Program Matching Rules.

    3. Save your changes and close the file.

  3. Verify that your program matching rules are valid; see Verify and Validate Program Matching Rules.

  4. Load the program matching rules into the PepAgent by restarting the PepAgent process on the host.

    You can use either the service (if provided by your OS) or systemctl command:

    • sudo service pepagentd restart
    • sudo systemctl restart pepagentd
  5. Repeat steps 1 to 4 on every host where Pepperdata is running.

Next: Syntax: Program Matching Rules