Forge Home

ganglia

Manages ganglia gmond & gmetad daemons + web front end

90,006 downloads

8,453 latest version

4.7 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

  • 5.0.0 (latest)
  • 4.0.0
  • 3.0.4
  • 3.0.3
  • 2.2.0
  • 2.1.0
  • 2.0.0
  • 1.5.0
  • 1.4.1
  • 1.4.0
  • 1.3.0
  • 1.2.2
  • 1.2.1
  • 1.2.0
  • 1.1.0
  • 1.0.2
  • 1.0.1
  • 1.0.0
  • 0.0.2
  • 0.0.1
released Jun 23rd 2023
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
  • Puppet >= 7.0.0 < 9.0.0
  • , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'jhoblitt-ganglia', '5.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install jhoblitt-ganglia --version 5.0.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.

Download

Documentation

jhoblitt/ganglia — version 5.0.0 Jun 23rd 2023

Puppet ganglia Module

CI markdownlint shellcheck yamllint

Table of Contents

  1. Overview
  2. Description
  3. Usage
  1. Limitations
  1. Versioning
  2. Support
  3. Contributing
  4. See Also

Overview

Manages ganglia gmond & gmetad daemons + web front end

Description

This is a puppet module for installation and configuration of the ganglia gmond & gmetad daemons + web front end.

Usage

Examples

  # unicast
  $udp_recv_channel = [
    { port => 8649, bind => 'localhost' },
    { port => 8649, bind => '0.0.0.0' },
  ]
  $udp_send_channel = [
    { port => 8649, host => 'test1.example.org', ttl => 2 },
    { port => 8649, host => 'test2.example.org', ttl => 2 },
    { bind_hostname => "yes", host => 'test3.example.org', ttl => 1 },
  ]
  $tcp_accept_channel = [
    { port => 8649 },
  ]

  # multicast
  $udp_recv_channel = [
    { mcast_join => '239.2.11.71', mcast_if => 'eth0', port => 8649, ttl => 1 }
  ]
  $udp_send_channel = [
    { mcast_join => '239.2.11.71', port => 8649, bind => '239.2.11.71' }
  ]
  $tcp_accept_channel = [
    { port => 8649 },
  ]

  $gmond_package_name = [ 'ganglia-gmond', 'ganglia-gmond-python' ]

  class{ 'ganglia::gmond':
    globals_deaf                   => 'yes',
    globals_host_dmax              => '691200',
    globals_send_metadata_interval => '60',
    globals_override_hostname      => 'web.example.org',
    cluster_name                   => 'example grid',
    cluster_owner                  => 'ACME, Inc.',
    cluster_latlong                => 'N32.2332147 W110.9481163',
    cluster_url                    => 'www.example.org',
    host_location                  => 'example computer room',
    udp_recv_channel               => $udp_recv_channel,
    udp_send_channel               => $udp_send_channel,
    tcp_accept_channel             => $tcp_accept_channel,
    gmond_package_name             => $gmond_package_name,
  }
  $clusters = [
    {
      name     => 'test',
      address  => ['test1.example.org', 'test2.example.org'],
    },
  ]

  $rras = [
    {
      cf      => 'AVERAGE',
      xff     => 0.5,
      steps   => 1,
      rows    => 5856
    },
    {
      cf      => 'AVERAGE',
      xff     => 0.5,
      steps   => 4,
      rows    => 20160
    },
    {
      cf      => 'AVERAGE',
      xff     => 0.5,
      steps   => 40,
      rows    => 52704
    },
  ]

  class { 'ganglia::gmetad':
    clusters      => $clusters,
    gridname      => 'my grid',
    rras          => $rras,
    all_trusted   => false,
    trusted_hosts => [],
  }
  class{ 'ganglia::web':
    ganglia_ip => '192.168.0.1',
    ganglia_port => 8652,
  }

Classes

ganglia::gmond

This class manages the configurtion of the Ganglia gmond daemon.

# defaults
class { 'ganglia::gmond':
  globals_deaf                     => 'no',
  globals_host_dmax                =>'0',
  globals_send_metadata_interval   => '300',
  globals_override_hostname        => undef,
  cluster_name                     => 'unspecified',
  cluster_owner                    => 'unspecified',
  cluster_latlong                  => 'unspecified',
  cluster_url                      => 'unspecified',
  host_location                    => 'unspecified',
  udp_send_channel                 => [
    { mcast_join => '239.2.11.71', port => 8649, ttl => 1 }
  ],
  udp_recv_channel                 => [
    { mcast_join => '239.2.11.71', port => 8649, bind => '239.2.11.71' }
  ],
  tcp_accept_channel               => [ { port => 8659 } ],
  gmond_package_name               => $::ganglia::params::gmond_package_name,
}
globals_deaf

String defaults to: no

globals_host_dmax

String defaults to: 0

globals_send_metadata_interval

String defaults to: 300

globals_override_hostname

String defaults to: undef

cluster_name

String defaults to: unspecified

cluster_owner

String defaults to: unspecified

cluster_latlong

String defaults to: unspecified

cluster_url

String defaults to: unspecified

host_location

String defaults to: unspecified

udp_send_channel

Array of Hash defaults to:

[ { mcast_join => '239.2.11.71', port => 8649, ttl => 1 } ]

Supported hash keys are (all optional):

  • bind_hostname
  • mcast_join
  • mcast_if
  • host
  • port
  • ttl
udp_recv_channel

Array of Hash defaults to:

[ { mcast_join => '239.2.11.71', port => 8649, bind => '239.2.11.71' } ]

Supported hash keys are (all optional):

  • mcast_join
  • mcast_if
  • port
  • bind
  • family
tcp_accept_channel

Array of Hash defaults to:

[ { port => 8659 } ]

Supported hash keys are (all optional):

  • port
  • family
gmond_package_name

String or Array defaults to: $::ganglia::params::gmond_package_name

ganglia::gmetad

install and configure the ganglia gmetad daemon.

# defaults
class { 'ganglia::gmetad':
  all_trusted                     => false,
  clusters                        => [
    { 'name' => 'my cluster', 'address' => 'localhost' },
  ],
  gridname                        => undef,
  rras                            => $::ganglia::params::rras,
  trusted_hosts                   => [],
  gmetad_package_name             => $::ganglia::params::gmetad_package_name,
  gmetad_service_name             => $::ganglia::params::gmetad_service_name,
  gmetad_service_config           => $::ganglia::params::gmetad_service_config,
  gmetad_user                     => $::ganglia::params::gmetad_user,
  gmetad_case_sensitive_hostnames =>
    $::ganglia::params::gmetad_case_sensitive_hostnames
}
all_trusted

Boolean defaults to: false

If set to true, will allow any host to query ganglia data via the XML query port. Corresponds to the all_trusted field in gmetad.conf.

clusters

Array of Hash defaults to:

[ { 'name' => 'my cluster', 'address' => 'localhost' } ]

Supported hash keys are:

  • name (required)
  • polling_interval (optional)
  • address (may be a String or Array of String
gridname

String defaults to: undef

rras

Array of Hash defaults to:

  [
    {
      cf      => 'AVERAGE',
      xff     => 0.5,
      steps   => 1,
      rows    => 5856
    },
    {
      cf      => 'AVERAGE',
      xff     => 0.5,
      steps   => 4,
      rows    => 20160
    },
    {
      cf      => 'AVERAGE',
      xff     => 0.5,
      steps   => 40,
      rows    => 52704
    },
  ]

Supported hash keys (all keys are required) are:

  • cf

consolidation function (cf) can be AVERAGE | MIN | MAX | LAST

  • xff

xfiles factor (xff) defines what part of a consolidation interval may be made up from UNKNOWN data while the consolidated value is still regarded as known. It is given as the ratio of allowed UNKNOWN PDPs to the number of PDPs in the interval. Thus, it ranges from 0 to 1 (exclusive).

  • steps

steps defines how many of these primary data points are used to build a consolidated data point which then goes into the archive.

  • rows

rows defines how many generations of data values are kept in an RRA. Obviously, this has to be greater than zero.

trusted_hosts

Array of Strings defaults to: '[]'

Each string matches a hostname that is allowed to query ganglia data via the XML query port. Corresponds to the all_trusted field in gmetad.conf.

gmetad_package_name

String defaults to: $::ganglia::params::gmetad_package_name

gmetad_service_name

String defaults to: $::ganglia::params::gmetad_service_name

gmetad_service_config

String defaults to: $::ganglia::params::gmetad_service_config

gmetad_user

String defaults to: $::ganglia::params::gmetad_user

gmetad_case_sensitive_hostnames

Integer defaults to: $::ganglia::params::gmetad_case_sensitive_hostnames

Accepted values are 0 or 1.

ganglia::web

Install and configure the ganglia web front end.

# defaults
class{ 'ganglia::web':
  ganglia_ip   => '127.0.0.1',
  ganglia_port => 8652,
}
ganglia_ip

String defaults to: 127.0.0.1

ganglia_port

String or Integer defaults to: Integer: 8652

Passing a String to $ganglia_port is deprecated. Please use an Integer value.

Limitations

Puppet Version Compatibility

Versions Puppet 2.7 Puppet 3.x Puppet 4.x Puppet 5.x Puppet 6.x
1.x yes yes no no no
2.x no yes yes no no
3.x no no no yes yes

$::osfamily == RedHat and EPEL packages

As of 2012-11-16, the stable EPEL repos for el5 and el6 contain, respectively, packages for ganglia 3.0.7 and 3.1.7. The ganglia UDP protocol for communication between gmond daemons changed incompatibly between 3.0.x and 3.1.x. However, the TCP based protocol gmetad uses to poll gmond agents has remained compatible.

If it's desirable to stick with the EPEL packages, a possible way of dealing with this is divide a group of hosts into two clusters based on $::lsbmajdistrelease (which should imply gmond version without having to install a custom fact). The example below divides the previous "mycluster" into "mycluster_el5" and "mycluster_el6". Note that you will also have to configure gmetad to pull a gmond agent from each of these new clusters.

    $udp_recv_channel = [
      { port => 8649, bind => 'localhost' },
      { port => 8649, bind => '0.0.0.0' },
    ]
    case $::lsbmajdistrelease {
      5: {
        # epel for el5.x has 3.0.x, which will not work with gmond in 3.1.x
        $udp_send_channel = [
          { port => 8649, host => 'gmond-3-0_host1.example.org', ttl => 2 },
          { port => 8649, host => 'gmond-3-0_host2.example.org', ttl => 2 },
        ]
        $cluster_name = 'mycluster_el5'
      }
      6, default: {
        # epel for el6.x has 3.1.x
        $udp_send_channel = [
          { port => 8649, host => 'gmond-3-1_host1.example.org', ttl => 2 },
          { port => 8649, host => 'gmond-3-1_host2.example.org', ttl => 2 },
        ]
        $cluster_name = 'mycluster_el6'
      }
    }
    $tcp_accept_channel = [
      {port => 8649},
    ]

    class{ 'ganglia::gmond':
      cluster_name       => 'example grid',
      cluster_owner      => 'ACME, Inc.',
      cluster_latlong    => 'N32.2332147 W110.9481163',
      cluster_url        => 'www.example.org',
      host_location      => 'example computer room',
      udp_recv_channel   => $udp_recv_channel,
      udp_send_channel   => $udp_send_channel,
      tcp_accept_channel => $tcp_accept_channel,
    }

Versioning

This module is versioned according to the Semantic Versioning 2.0.0 specification.

Support

Please log tickets and issues at github

Contributing

  1. Fork it on github
  2. Make a local clone of your fork
  3. Create a topic branch. Eg, feature/mousetrap
  4. Make/commit changes
  • Commit messages should be in imperative tense
  • Check that linter warnings or errors are not introduced - pdk validate [-a]
  • Check that Rspec unit tests are not broken and coverage is added for new features - pdk test unit
  • Documentation of API/features is updated as appropriate in the README
  • If present, beaker acceptance tests should be run and potentially updated - pdk bundle exec rake beaker
  1. When the feature is complete, rebase / squash the branch history as necessary to remove "fix typo", "oops", "whitespace" and other trivial commits
  2. Push the topic branch to github
  3. Open a Pull Request (PR) from the topic branch onto parent repo's master branch

See Also