Forge Home


A module for managing LogicMonitor devices, device groups, and collectors


5,731 latest version

4.6 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 2.1.0 (latest)
  • 2.0.8
  • 2.0.6
  • 2.0.5
  • 2.0.4
  • 2.0.3
  • 2.0.2
  • 2.0.1
  • 2.0.0
  • 1.0.2
  • 1.0.0
  • 0.9.3
  • 0.9.2
  • 0.9.1
released Sep 20th 2018
This version is compatible with:
  • , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'logicmonitor-logicmonitor', '2.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add logicmonitor-logicmonitor
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install logicmonitor-logicmonitor --version 2.1.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.



logicmonitor/logicmonitor — version 2.1.0 Sep 20th 2018


LogicMonitor is a Cloud-based, full stack, IT infrastructure monitoring solution that allows you to manage your infrastructure monitoring from the Cloud. LogicMonitor-Puppet-v4 is a Puppet module for automating and managing your LogicMonitor (SaaS based, full stack, datacenter monitoring) portal via Puppet, specifically for version 4.

##LogicMonitor's Puppet module overview LogicMonitor's Puppet module defines 5 classes and 4 custom resource types. For additional documentation visit


  • logicmonitor: Handles setting credentials needed for interacting with the LogicMonitor API.
  • logicmonitor::master: Collects the exported lm_host resources and lm_hostgroup resources. Communicates with the LogicMonitor API
  • logicmonitor::collector: Handles LogicMonitor collector management for the device. Declares an instance of lm_collector and lm_installer resources.
  • logicmonitor::device: Declares an exported lm_device resource.
  • logicmonitor::device_group: Declares an export lm_device_group resource.

Resource Types:

  • lm_device_group: Defines the behavior of the handling of LogicMonitor device groups. Recommend using exported resources.
  • lm_device: Defines the handling behavior of LogicMonitor devices. Used only within logicmonitor::device class.
  • lm_collector: Defines the handling behavior of LogicMonitor collectors. Used only with logicmonitor::collector class.
  • lm_installer: Defines the handling behavior of LogicMonitor collector installation binaries. Used only within logicmonitor::collector class.

So far, we've implemented the following features:

  • Collector Management
  • Device Management
    • Ensurable (present/absent)
    • Managed parameters:
      • Display name
      • Description
      • Collector
      • Disable Alerting
      • Group membership
        • Creation of groups/paths which do not yet exist
      • Properties
  • Device Group Management
    • Ensurable (present/absent)
    • Managed parameters:
      • Display name
      • Description
      • Collector
      • Disable Alerting
      • Creation of parent groups/paths which do not yet exist
      • Properties

Upcoming features:

  • User management
    • Add and remove users
    • Assign user roles


Ruby (1.9.3, 2.0.X, 2.1.X) and Puppet 3.X OR 4.X

This is a module written for Puppet 4

Ruby Gems JSON Gem

This module interacts with LogicMonitor's API which is JSON based. The JSON gem needed to parse responses from the LogicMonitor API. Our Gemfile enforces json ruby gem version 1.7.7, which may be installed via

$ bundle install


This module uses exported resources extensively. Exported resources require storeconfigs = true.


Using the Module Tool

$ puppet module install logicmonitor-logicmonitor

Installing via GitHub

$ cd /etc/puppet/modules
$ git clone git://
$ mv logicmonitor-puppet-v4 logicmonitor


Add a LogicMonitor class with your LogicMonitor account information

class { 'logicmonitor':
        account    => 'puppettest',
        access_id  => 'XXX',
        access_key => 'XXX',

Logicmonitor::Master Node

The LogicMonitor module uses the the "logicmonitor::master" class as trigger to decide which device in your infrastructure will be used to modify your LogicMonitor account via API calls. This device must be able to communicate via SSL with your LogicMonitor account.

node "puppet-master.lax6.chimpco" {
  # the puppet master is where API calls to the LogicMonitor server are sent from
  include logicmonitor::master

  # In this example, the master will also have a collector installed.  This is optional - the
  # collector can be installed anywhere.
  # NOTE:  this collector will be identied by the facter derived FQDN, eg
  # "puppet-master.lax6.chimpco" in this case.
  include logicmonitor::collector

  # Define default properties and some device groups
  # Managing the properties on the root device group ("/") will set the properties for the entire
  # LogicMonitor account.  These properties can be over-written by setting them on a child
  # group, or on an individual device.
  # There are 2 methods for defining device groups.
  # If you are only defining a single device group resource per node definition,
  # You can use the class syntax.
  # e.g.
  # class { 'logicmonitor::device_group' :
  #   full_path  => "/",
  #   properties => {
  #     ""  => "public",
  #     "tomcat.jmxports" => "9000",
  #     "mysql.user"      => "monitoring",
  #     "mysql.pass"      => "MyMysqlPW"
  #   },
  # }
  # Otherwise, you will need to define device groups using the device_group resource
  # notation.
  # We recommend defining device groups as exported resources.

  # create "Development" and "Operations" device groups
  @@device_group { "/Development":
    full_path  => ,
    description => 'This is the top level puppet managed device group',

  @@device_group {"/Operations":}
  # Create US-West device group, as well as a sub-group "production".
  # The "production" group will have use a different SNMP community


    properties => { ""=>"secret_community_RO" },

  # Your puppet master node should be monitored too of course!  Add it in,
  # place it in two device groups, and set device specific custom properties
  # that you might use for a custom datasource
  class {'logicmonitor::device':
    collector => "puppet-master.lax6.chimpco",
    groups => ["/Operations", "/US-West"],
    properties => {"test.prop" => "test2", "test.port" => 12345 },

Add all appX.lax6 nodes into monitoring

node /^app\d+.lax6/ {
  $lm_collector = "puppet-master.lax6.chimpco"

  class {'logicmonitor::device':
    collector => $lm_collector,
    groups => ["/US-West/production"],
    properties => {"jmx.pass" => "MonitorMEEEE_pw_", "jmx.port" => 12345 },

Additional collector and East Coast nodes

# Install a collector on a dedicated machine for monitoring the East Coast
# data center
node "collector1.dc7.chimpco" {

  # install a collector on this machine.  It is identified
  # by the facter derived fqdn
  include logicmonitor::collector

  # and add it into monitoring
  class {'logicmonitor::device':
    collector  => "collector1.dc7.chimpco",
    groups     => ["/US-East","Operations"]

# All East coast nodes will be monitored by the previously defined collector
node /^app\d+.dc7/ {
  class {"logicmonitor::device":
    collector => "collector1.dc7.chimpco",
    groups => ["/US-East"],