REFERENCE.md

Reference

Table of Contents

Classes

• profile_monitoring: Configure default NCSA monitoring of this host
• profile_monitoring::register_ping_check: Register the node for ping monitoring Ping checks happen from other nodes via profile_monitoring::telegraf_ping_check This class is used to register a given node with external ping checking node(s) This class does not depend on telegraf being installed on the node
• profile_monitoring::telegraf: Setup telegraf on a node
• profile_monitoring::telegraf_ping_check: Setup telegraf input for ping monitoring of hosts
• profile_monitoring::telegraf_sslcert_check: Setup telegraf input for monitoring ssl certificates
• profile_monitoring::telegraf_user_resource_usage: Report (via telegraf) resource usage per user
• profile_monitoring::telegraf_website_check: Setup telegraf input for monitoring websites

Classes

profile_monitoring

Configure default NCSA monitoring of this host

Examples

include profile_monitoring

profile_monitoring::register_ping_check

Register the node for ping monitoring Ping checks happen from other nodes via profile_monitoring::telegraf_ping_check This class is used to register a given node with external ping checking node(s) This class does not depend on telegraf being installed on the node

Examples

include profile_monitoring::register_ping_check

Parameters

The following parameters are available in the profile_monitoring::register_ping_check class:

• domain_name
• hostname_prefix
• hostname_suffix

domain_name

Data type: String

Optionally override the domain name portion of the hostname that was automatically pulled in via facter.

hostname_prefix

Data type: String

Optionally prepend a prefix onto the hostname that was automatically pulled in via facter.

hostname_suffix

Data type: String

Optionally append a suffix onto the hostname that was automatically pulled in via facter.

profile_monitoring::telegraf

Setup telegraf on a node

Examples

include profile_monitoring::telegraf

Parameters

The following parameters are available in the profile_monitoring::telegraf class:

• enabled
• config_dirs
• config_dirs_default_group
• config_dirs_default_mode
• config_dirs_default_owner
• gid
• group
• homedir
• inputs_extra
• inputs_extra_scripts
• ipmi_sensor_plugin_enabled
• ipmi_sensor_telegraf_plugin_options
• outputs
• required_pkgs
• uid
• user
• user_comment

enabled

Data type: Boolean

boolean flag to enable telegraf on the node

config_dirs

Data type: Hash

Hash of file resources for the telegraf config directories

config_dirs_default_group

Data type: String

String of the telegraf config directories default group permissions

config_dirs_default_mode

Data type: String

String of the telegraf config directories default mode permissions

config_dirs_default_owner

Data type: String

String of the telegraf config directories default owner permissions

gid

Data type: Optional[String]

Optional string of the GID of the local telegraf user If this is NOT defined then the package install assigns the GID for the telegraf user.

group

Data type: String

String of the group name of the local telegraf user

homedir

Data type: String

String of the home directory path of the local telegraf user

inputs_extra

Data type: Hash

Define extra input types and parameters for each. See data/common.yaml for samples Inputs defined here are all named, therefore allow parameter merging across multiple layers of hiera

inputs_extra_scripts

Data type: Hash

Define extra input script files See data/common.yaml for samples Files defined here are all named, therefore allow parameter merging across multiple layers of hiera

ipmi_sensor_plugin_enabled

Data type: Boolean

Enable or disable the ipmi_sensor telegraf plugin A seperate puppet fact is also used to only activate this plugin on nodes that are hardware So safe to enable this on virtual hosts too (will just be a noop)

ipmi_sensor_telegraf_plugin_options

Data type: Hash

Config that defines the options for the ipmi_sensor telegraf plugin Hash is passed directly to the telegraf::input class as the $options key

outputs

Data type: Hash

Define output types and parameters for each. See data/common.yaml for samples Outputs defined here are all named, therefore allow parameter merging across multiple layers of hiera

required_pkgs

Data type: Hash

OS packages that should be installed for this service to operate Hash format is:

pkg_name: {pkg_options}

where pkg_options are valid Puppet package attributes.

uid

Data type: String

String of the UID of the local telegraf user

user

Data type: String

String of the username of the local telegraf user

user_comment

Data type: String

String of the comment in passwd file of the local telegraf user

profile_monitoring::telegraf_ping_check

Setup telegraf input for ping monitoring of hosts

Examples

include profile_monitoring::telegraf_ping_check

Parameters

The following parameters are available in the profile_monitoring::telegraf_ping_check class:

• content
• count
• interval

content

Data type: String

string content of telegraf input file template

count

Data type: Integer

integer of count attempts for each ping test

interval

Data type: String

string of interval used by telegraf input

profile_monitoring::telegraf_sslcert_check

Setup telegraf input for monitoring ssl certificates

Examples

include profile_monitoring::telegraf_sslcert_check

Parameters

The following parameters are available in the profile_monitoring::telegraf_sslcert_check class:

• content
• interval

content

Data type: String

string content of telegraf input file template

interval

Data type: String

string of interval used by telegraf input

profile_monitoring::telegraf_user_resource_usage

Report (via telegraf) resource usage per user

Examples

include profile_monitoring::telegraf_user_resource_usage

Parameters

The following parameters are available in the profile_monitoring::telegraf_user_resource_usage class:

• enable
• telegraf_cfg

enable

Data type: Boolean

Turn on/off reporting of resource usage per user

telegraf_cfg

Data type: Hash

Config that defines the options for the user_resource_usage telegraf plugin Hash is passed directly to the telegraf::input class as the $options key

profile_monitoring::telegraf_website_check

Setup telegraf input for monitoring websites

Examples

include profile_monitoring::telegraf_website_check

Parameters

The following parameters are available in the profile_monitoring::telegraf_website_check class:

• content
• interval

content

Data type: String

string content of telegraf input file template

interval

Data type: String

string of interval used by telegraf input