dropsonde
Version information
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, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
- Puppet >= 4.10.0 < 8.0.0
- , , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'puppetlabs-dropsonde', '0.2.0'Learn more about managing modules with a PuppetfileDocumentation
dropsonde
This module installs and manages the Dropsonde Puppet telemetry client. See the documentation on its repository page for information about the project.
Table of Contents
- Description
- Usage - Configuration options
- Limitations
- Development - Guide for contributing to the project
Description
We both know that you hate telemetry as much as I do. So what makes this different? At its core, the purpose and design of this module is for your own benefit as much as it is for ours. Think back to the time you last visited the Forge to find a module. Chances are that you discovered many modules that claimed to solve your problem and it was relatively difficult choosing between them. Surfacing usage data in a way that lets you signal approval simply by using a module is the primary goal of this project.
This means that the best way for you to help yourself find new modules is to install this telemetry tool and, along with your peers, share your module usage data.
Managed resources:
- Installs the
dropsondegem. - Manages configuration at
/etc/puppetlabs/telemetry.yaml. - Manages a weekly cronjob to submit the report at a time randomized for each infrastructure.
Usage
The simplest use case is just to declare the module and accept defaults:
include dropsonde
If you prefer, you can configure several settings, such as:
class { 'dropsonde':
disable => ['puppetfiles', 'modules'],
seed => 'banana pancakes'
}
The full list of options is:
disable- An array of metrics that you don't want to report. See the available settings
by running
/opt/puppetlabs/puppet/bin/dropsonde list.
- An array of metrics that you don't want to report. See the available settings
by running
enable- An array of metrics that you allow to report on. All other metrics will be skipped.
See the available settings by running
/opt/puppetlabs/puppet/bin/dropsonde list.
- An array of metrics that you allow to report on. All other metrics will be skipped.
See the available settings by running
update- Set to
falseto prevent the tool from automatically updating its list of names of public Forge modules. Only do this if you're behind a firewall that blocks access to the Forge and you're planning on manually updating this periodically yourself.
- Set to
cachepath- The list of public Forge modules is normally stored in Puppet's
vardir. You may set the path to a different directory here if you'd like.
- The list of public Forge modules is normally stored in Puppet's
ttl- How many days before the tool updates the list of public Forge modules.
seed- If you'd like to change your Site ID then make up and enter a random number or string here.
use_cron parameter- Enable/disable cron functionality(true/false enable/disable cron job creation)
Note: The use_cron parameter is set to true by default as the module will configure and set a cron job for the dropsonde gem to gather the required information periodically. We have decided to allow users to disable the cron functionality to be able to use this module and the dropsonde gem with different other schedulers. In the example bellow we disable cron as we decided to install the gem on a puppetserver machine where the integrated scheduler will assure the required functionality. Here is how you disable the cron functionality:
class { 'dropsonde': use_cron => false, }.include dropsondeorclass { 'dropsonde': }will set a cron job for dropsonde gem.
- Enable/disable cron functionality(true/false enable/disable cron job creation)
Limitations
This module is currently only tested on Puppet supported platforms.
Development
There's very little interesting development going on with the module, but we'd love to get your help on gathering the right metrics and aggregating them in ways that provide the most community benefits without compromising privacy.
Reference
Table of Contents
Classes
dropsonde: Manages the Dropsonde Puppet telementry client and cron job.
Functions
Classes
dropsonde
In general, you'll just want to include the class, but there are a few
settings you might care about. If you want to remove any of the computed
metrics from the report, list them as an array in $disable and if you
want to change the generated site ID, enter a random string as the $seed.
Examples
include dropsonde
Parameters
The following parameters are available in the dropsonde class:
enabled
Data type: Boolean
Set the cron job for dropsonde weekly report submit
Default value: true
enable
Data type: Optional[Array]
Only load these metrics. For example:
class { 'dropsonde':
enable => ['dependencies', 'modules'],
}
Default value: undef
disable
Data type: Optional[Array]
List of metrics to omit. For example:
class { 'dropsonde':
disable => ['puppetfiles', 'environments'],
}
Default value: undef
cachepath
Data type: Optional[String]
Path to cache directory
Default value: undef
ttl
Data type: Optional[Integer]
Forge module cache ttl in days
Default value: undef
update
Data type: Optional[Boolean]
Auto update the Forge module name cache if expired
Default value: undef
seed
Data type: Optional[String]
Any number or string used to generate the randomized site ID
Default value: undef
Functions
dropsonde::to_symbolized_yaml
Type: Ruby 4.x API
}
dropsonde::to_symbolized_yaml(Any $data, Optional[Hash] $options)
}
Returns: String
data
Data type: Any
options
Data type: Optional[Hash]
Change log
All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
v0.2.0 (2021-12-16)
Added
- Allow module to work with bundled gem #20 (binford2k)
- Symbolize the config file keys #19 (binford2k)
v0.1.0 (2021-08-16)
Added
- [IAC-1730] - allow dropsonde to use other schedule services #16 (adrianiurca)
v0.0.5 (2021-08-02)
Fixed
- add compatibility for puppet 7 #14 (adrianiurca)
- (maint) document proper parameters enable/disable #8 (binford2k)
v0.0.4 (2020-06-11)
v0.0.3 (2020-05-29)
v0.0.2 (2020-04-16)
v0.0.1 (2020-04-16)
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs/hocon (>= 1.1.0 < 2.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
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.
Quality checks
We run a couple of automated scans to help you assess a module’s quality. Each module is given a score based on how well the author has formatted their code and documentation and select 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.
Malware scan results
The malware detection service on Puppet Forge is an automated process that identifies known malware in module releases before they’re published. It is not intended to replace your own virus scanning solution.
Learn more about malware scans- Module name:
- puppetlabs-dropsonde
- Module version:
- 0.2.0
- Scan initiated:
- December 16th 2021, 7:02:45
- Detections:
- 0 / 57
- Scan stats:
- 57 undetected
- 0 harmless
- 0 failures
- 0 timeouts
- 0 malicious
- 0 suspicious
- 15 unsupported
- Scan report:
- View the detailed scan report