Skip to main content

Summary

Send puppet reports to ElasticSearch.

Usage

Command

send_report_to_es [-h|--help] <directory>

Options

-h/--help   Show this help text and exit

Parameters

directory   A directory containing JSON reports. The script will
            walk the directory recursively, process all JSON files
            it finds, and submit the report data to ElasticSearch
            in a single bulk transaction.

Configuring

Configuration is read from the file specified in the environment variable PUPPET_ES_CONFIG (defaults to /etc/puppet_es.conf) and uses ConfigParser syntax. A sample configuration file is included as etc/puppet_es.conf.example.

Section: base

``on_error`` (optional) What to do with the report files when we encounter a parse error or an ElasticSearch error. Possible values:

  • delete Delete the file off disk

  • archive Move the file to the directory specified in archive_dir

  • ignore Leave the file as-is (default)

``on_success`` (optional) What to do with the report file after successfully posting to ElasticSearch. Possible values:

  • delete Delete the file off disk

  • archive Move the file to the directory specified in archive_dir

  • ignore Leave the file as-is (default)

``archive_dir`` (conditionally required) The directory to move files into when archive is set for on_error or on_success. Has no effect if neither of those is set to archive, and is required if either is set to archive.

Section: elasticsearch

``host`` (required) The fully qualified domain name for connecting to ElasticSearch over HTTP.

``port`` (required) The port for connecting to ElasticSearch over HTTP.

``index`` (optional) The index name to send data to. This can be a Python formatted string in the Formatter style, with the following available variables:

  • certname the certname the report is from

  • fqdn the fqdn of the node this script is running on

  • isoday the ISO day number for the report

  • isoweek the ISO week number for the report

  • isoyear the ISO year number for the report

  • day the numerical day of the year for the report

  • month the numerical month of the year for the report

  • year the year for the report

Defaults to 'puppet-{isoyear}.{isoweek}'

Section: logging

``level`` (optional) What message level to log. Valid options are those defined by the Python 2.7 logging module. Defaults to WARNING.

``stderr`` (optional) Boolean value about whether to print log messages to stderr. Defaults to false.

``syslog`` (optional) Boolean value about whether to print log messages to syslog. Defaults to true.

``file`` (optional) Filename for a file to write log messages into. Defaults to an empty value, meaning do not log to a file.

Configuring ElasticSearch

An example ElasticSearch template that supports the format this script uses can be found at etc/puppet_template.json.

Metadata

Release files for puppet-es 0.8.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for puppet-es 0.8.1
File Size Uploaded
puppet_es-0.8.1.tar.gz 7.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for puppet-es 0.8.1
File Interpreter ABI Platform
puppet_es-0.8.1-py2-none-any.whl Python 2 none any Details

Total release size: 14.6 kB

Release files / puppet_es-0.8.1.tar.gz

Download URL puppet_es-0.8.1.tar.gz
Size 7.5 kB
Tags Source
SHA-256 checksum
How to use checksums
0cffb8442a99a40e0806cf8e68fee07e7a6708f6f0780f4cfe28ee5f0a47fbaf
BLAKE2b-256 checksum
How to use checksums
f91e5994684ed2f72553111b9030c2b07fb3658e678af1cc0402290cff39b64f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / puppet_es-0.8.1-py2-none-any.whl

Download URL puppet_es-0.8.1-py2-none-any.whl
Size 7.1 kB
Tags Python 2
SHA-256 checksum
How to use checksums
4abdbf5c25b3011d9f61b9b3599b403a071355bd40f45c804339ade1fe40950e
BLAKE2b-256 checksum
How to use checksums
19041322cb55c95f4aeb2efcd82a4241da0e3966fe9861323f5c8eb0bfd502c7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.8.1 This release

2 release files

0.7.2

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page