Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

graphite_powershell

Module to send system metrics to graphite from windows
Project URLRSS FeedReport issues

17,855 downloads

7,576 latest version

4.9 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.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 3.0.2 (latest)
  • 3.0.1
  • 3.0.0
  • 2.1.0
  • 2.0.1
  • 1.0.1
released Oct 20th 2018
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
  • Puppet >= 4.10.0 < 7.0.0

Start using this module

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

Add this module to your Puppetfile:

mod 'puppet-graphite_powershell', '3.0.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install puppet-graphite_powershell --version 3.0.2

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
Tags: windows, graphite, powershell

Documentation

puppet/graphite_powershell — version 3.0.2 Oct 20th 2018

Graphite PowerShell module for Puppet

Build Status Code Coverage Puppet Forge Puppet Forge - downloads Puppet Forge - endorsement Puppet Forge - scores

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with graphite_powershell
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

Overview

Module to send metrics to graphite from windows

Module Description

Installs a windows service that reports system metrics to graphite

Setup

What graphite_powershell affects

  • Powershell file and xml config file
  • windows service

Beginning with graphite_powershell

Install with defaults:

  class { 'graphite_powershell':
    server => 'graphite.mycorp.com'
  }

Install and just send network counters:

  class { 'graphite_powershell':
    server               => 'graphite.mycorp.com',
    performance_counters => [
      '\Network Interface(*)\Bytes Received/sec',
      '\Network Interface(*)\Bytes Sent/sec',
      '\Network Interface(*)\Packets Received Unicast/sec',
      '\Network Interface(*)\Packets Sent Unicast/sec',
      '\Network Interface(*)\Packets Received Non-Unicast/sec',
      '\Network Interface(*)\Packets Sent Non-Unicast/sec',
    ]
  }

Usage

Classes and Defined Types

Class: graphite_powershell

Parameters within graphite_powershell:

server

The graphite server in which to send the configured metrics

install_url

The url from which to download the graphite powershell script

install_dir

The location in which to install the graphite powershell script

port

The port that the graphite server is running on.

metric_path

The graphite namespece in which the stats will be sent to

metric_send_interval

The time inveral (in seconds) in which to send metrics to the graphite server

timezone

The timezone of your graphite server.

performance_counters

A list of the performance counters that you want to be sent to graphite.

metric_filters

A list of names you want to filter out of the performance counter list

verbose_logging

If enabled, will log each of the metrics that were sent to the graphite server.

Reference

Classes

Pulic Classes

  • graphite_powershell: Guides the install of graphite powershell and creates the windows service

Limitations

This module is tested on the following platforms:

  • Windows 2008
  • Windows 2008 R2
  • Windows 2012
  • Windows 2012 R2

It is tested with the OSS version of Puppet only.

Contributing

Please read CONTRIBUTING.md for full details on contributing to this project.