Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

prometheus_reporter

This module writes Puppet reports in a format suitable for prometheus node_exporter textfile collector
Project URLRSS FeedReport issues

243,470 downloads

88,234 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

  • 1.1.0 (latest)
  • 1.0.0
  • 0.3.1
  • 0.3.0
  • 0.2.0
  • 0.1.0
released May 2nd 2021
This version is compatible with:
  • Puppet Enterprise 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, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x
  • Puppet >= 6.1.0 < 8.0.0
  • , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'puppet-prometheus_reporter', '1.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install puppet-prometheus_reporter --version 1.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.

Download

Documentation

puppet/prometheus_reporter — version 1.1.0 May 2nd 2021

Puppet Prometheus Reports Processor

This module contains a Puppet reports processor that writes report metrics in a format that is accepted by Prometheus node_exporter Textfile Collector.

How to

Puppet setup

Include this module in your path, and create a file named prometheus.yaml in your Puppet configuration directory. Example:

---
textfile_directory: /var/lib/prometheus-dropzone

Configuration options include:

  • textfile_directory - [String] Location of the node_exporter collector.textfile.directory (Required)
  • report_filename - [String] If specified, saves all reports to a single file (must end with .prom)
  • environments - [Array] If specified, only creates metrics on reports from these environments
  • reports - [Array] If specified, only creates metrics from reports of this type (changes, events, resources, time)
  • stale_time - [Integer] If specified, delete metric files for nodes that haven't sent reports in X days

Include prometheus in your Puppet reports configuration; enable pluginsync:

[agent]
report = true
pluginsync = true

[master]
report = true
reports = prometheus
pluginsync = true

Note: you can use a comma separated list of reports processors:

reports = puppetdb,prometheus

Prometheus

Call the Prometheus node_exporter with the --collector.textfile.directory flag.

node_exporter --collector.textfile.directory=/var/lib/prometheus-dropzone

Note: The directory can be anywhere, but must be matched to the one set in prometheus.yml above.

Sample

puppet_report_resources{name="Changed",environment="production",host="node.example.com"} 0
puppet_report_resources{name="Failed",environment="production",host="node.example.com"} 0
puppet_report_resources{name="Failed to restart",environment="production",host="node.example.com"} 0
puppet_report_resources{name="Out of sync",environment="production",host="node.example.com"} 0
puppet_report_resources{name="Restarted",environment="production",host="node.example.com"} 0
puppet_report_resources{name="Scheduled",environment="production",host="node.example.com"} 0
puppet_report_resources{name="Skipped",environment="production",host="node.example.com"} 0
puppet_report_resources{name="Total",environment="production",host="node.example.com"} 519
puppet_report_time{name="Acl",environment="production",host="node.example.com"} 3.8629975709999984
puppet_report_time{name="Anchor",environment="production",host="node.example.com"} 0.002442332
puppet_report_time{name="Augeas",environment="production",host="node.example.com"} 10.629003954
puppet_report_time{name="Concat file",environment="production",host="node.example.com"} 0.0026740609999999997
puppet_report_time{name="Concat fragment",environment="production",host="node.example.com"} 0.012010700000000003
puppet_report_time{name="Config retrieval",environment="production",host="node.example.com"} 20.471957786
puppet_report_time{name="Cron",environment="production",host="node.example.com"} 0.000874118
puppet_report_time{name="Exec",environment="production",host="node.example.com"} 0.4114313850000001
puppet_report_time{name="File",environment="production",host="node.example.com"} 0.32955574000000015
puppet_report_time{name="File line",environment="production",host="node.example.com"} 0.002702939
puppet_report_time{name="Filebucket",environment="production",host="node.example.com"} 0.0003994
puppet_report_time{name="Grafana datasource",environment="production",host="node.example.com"} 0.187452552
puppet_report_time{name="Group",environment="production",host="node.example.com"} 0.0031514940000000003
puppet_report_time{name="Mysql datadir",environment="production",host="node.example.com"} 0.000422795
puppet_report_time{name="Package",environment="production",host="node.example.com"} 1.670733222
puppet_report_time{name="Service",environment="production",host="node.example.com"} 0.8740041969999999
puppet_report_time{name="Total",environment="production",host="node.example.com"} 38.468031933999995
puppet_report_time{name="User",environment="production",host="node.example.com"} 0.005163427
puppet_report_time{name="Yumrepo",environment="production",host="node.example.com"} 0.0010542610000000001
puppet_report_changes{name="Total",environment="production",host="node.example.com"} 0
puppet_report_events{name="Failure",environment="production",host="node.example.com"} 0
puppet_report_events{name="Success",environment="production",host="node.example.com"} 0
puppet_report_events{name="Total",environment="production",host="node.example.com"} 0
puppet_report{environment="production",host="node.example.com"} 1477054915347
puppet_transaction_completed{environment="production",host="node.example.com"} 1
puppet_cache_catalog_status{state="not_used",environment="production",host="node.example.com"} 0
puppet_cache_catalog_status{state="explicitly_requested",environment="production",host="node.example.com"} 1
puppet_cache_catalog_status{state="on_failure",environment="production",host="node.example.com"} 0
puppet_status{state="failed",environment="production",host="node.example.com"} 0
puppet_status{state="changed",environment="production",host="node.example.com"} 0
puppet_status{state="unchanged",environment="production",host="node.example.com"} 1

Contributors

See Github.

Special thanks to Puppet, Inc for Puppet, and its store reports processor, to EvenUp for their graphite reports processor, and to Vox Pupuli to provide a platform that allows us to develop of this module.

Copyright and License

Copyright © 2016 Puppet Inc

Copyright © 2016 EvenUp

Copyright © 2016 Multiple contributors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.