Forge Home

carbon

Puppet Carbon management module

12,855 downloads

8,785 latest version

3.1 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

  • 0.0.12 (latest)
  • 0.0.11
  • 0.0.10
  • 0.0.9 (deleted)
  • 0.0.8
  • 0.0.7
  • 0.0.6
  • 0.0.5
  • 0.0.4
  • 0.0.3
  • 0.0.2
  • 0.0.1
released Jun 29th 2015
This version is compatible with:
  • Puppet 3.x
  • ,

Start using this module

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

Add this module to your Puppetfile:

mod 'jbussdieker-carbon', '0.0.12'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install jbussdieker-carbon --version 0.0.12

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

jbussdieker/carbon — version 0.0.12 Jun 29th 2015

Carbon

Puppet Forge Build Status

Usage

To install Carbon with the default parameters

class { 'carbon': }

Installing a specific version

class { 'carbon':
  revision => '0.9.11',
}

Installing and configuring using Hiera

classes:
 - carbon
carbon::revision: 0.9.11

Resources

Same resources can be order dependent in which case the order property should be specified.

Aggregation Rules

carbon::aggregation_rule { 'rollup':
  output_template => 'foo.*',
  frequency       => '60',
  method          => 'sum',
  input_pattern   => 'bar.*',
}

Storage Schema

carbon::storage_schema { 'carbon':
  pattern    => '^carbon\.',
  retentions => '60:90d',
  order      => 1,
}

carbon::storage_schema { 'default':
  pattern    => '.*',
  retentions => '60:90d',
  order      => 99,
}

Storage Aggregation

carbon::storage_aggregation { 'sum':
  pattern            => '\.count$',
  x_files_factor     => 0,
  aggregation_method => 'sum',
}

Relay Rules

carbon::relay_rule { 'auditing':
  pattern      => 'auditing.*',
  destinations => '1.2.3.4:2004:a',
  order        => 1,
}

carbon::relay_rule { 'default':
  destinations => '127.0.0.1:2004:a',
  order        => 99,
}

Advanced Example

Most resources can be passed into the main class as a hash to support Hiera usage.

class { 'carbon':
  revision => 'master',
  caches      => {
    'a' => {
      line_receiver_port   => 2003,
      pickle_receiver_port => 2004,
      cache_query_port     => 7002,
    },
    'b' => {
      line_receiver_port   => 2103,
      pickle_receiver_port => 2104,
      cache_query_port     => 7102,
    }
  },
  relays      => {
    'a' => {
      relay_method         => 'consistent-hashing',
      line_receiver_port   => 2013,
      pickle_receiver_port => 2014,
    },
    'b' => {
      relay_method         => 'consistent-hashing',
      line_receiver_port   => 2113,
      pickle_receiver_port => 2114,
    }
  },
  aggregators => {
    'a' => {
      line_receiver_port   => 2023,
      pickle_receiver_port => 2024,
    },
    'b' => {
      line_receiver_port   => 2123,
      pickle_receiver_port => 2124,
    }
  },
  storage_schemas => {
    'carbon' => {
      pattern    => '^carbon\.',
      retentions => '60:90d',
      order      => 1,
    },
    'default_1min_for_1day' => {
      pattern    => '.*',
      retentions => '60s:1d',
      order      => 99,
    },
  },
  storage_aggregations => {
    'carbon_agg_test' => {
      pattern            => '^carbon\.',
      x_files_factor     => '0.7',
      aggregation_method => 'sum',
    },
  },
  aggregation_rules => {
    'rollups' => {
      output_template => 'foo.*',
      frequency       => '60',
      method          => 'sum',
      input_pattern   => 'bar.*',
    }
  },
  relay_rules => {
    'test1' => {
      pattern      => 'test1.*',
      destinations => '127.0.0.1:2004',
      continue     => true,
      order        => 1,
    },
    'default' => {
      destinations => '127.0.0.1:2004',
      continue     => false,
      order        => 99,
    },
  },
}