Version information
This version is compatible with:
- CentOS,OracleLinux,RedHat,Scientific,Debian,Ubuntu
Start using this module
Add this module to your Puppetfile:
mod 'puppet-otelcol', '2.0.0'Learn more about managing modules with a PuppetfileDocumentation
Table of Contents
- Description
- Setup
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
This Module allows you to install and manage OpenTelemetry Collector https://opentelemetry.io/docs/collector/
Detailed Reference to all classparameters can be found in (https://github.com/voxpupuli/puppet-otelcol/blob/master/REFERENCE.md)
Setup
The module allows you to address parts of configuration via hiera. Due to complexity there is currently no check of validity of the Otel configuration.
If you don't have any kind of Package distribution System, you could use the Files directly from Github with the param manage_archive.
class { 'otelcol':
manage_archive => true
}
Otelcol vs. Otelcol-contrib
It is quite common to use Otelcol-Contrib, to do that it is enough to change the package_name to otelcol-contrib3
class { 'otelcol':
package_name => 'otelcol-contrib'
}
Limitations
Due to complexity there is currently no check of validity of the Otelcol configuration.
Development
Please report bugs and feature request using GitHub issue tracker.
For pull requests, it is very much appreciated to check your Puppet manifest with puppet-lint to follow the recommended Puppet style guidelines from the Puppet Labs style guide
Reference
Table of Contents
Classes
Public Classes
otelcolotelcol::config: == Class: otelcol::config Templated generation of otelcol.confotelcol::install: == Class: otelcol::install Conditionally handle repos or package paths and install the necessary otelcol package.
Private Classes
otelcol::service: Manages the Otelcol service
Defined types
Public Defined types
otelcol::exporter: Define a OpenTelemetry Collector exporterotelcol::extension: Add an extension to the OpenTelemetry Collector configurationotelcol::pipeline: Add a pipeline to the OpenTelemetry Collector configurationotelcol::processor: Add a processor to the OpenTelemetry Collector configurationotelcol::receiver: Add a receiver to the OpenTelemetry Collector configuration
Private Defined types
otelcol::component: Define a component for the OpenTelemetry Collector Configuration
Data types
Otelcol::Component::Name: Type for name of Otel Collector RessourcesOtelcol::Telemetry_exporterOtelcol::Telemetry_exporter::PeriodicOtelcol::Telemetry_exporter::Periodic::OtlpOtelcol::Telemetry_exporter::PullOtelcol::Telemetry_exporter::Pull::Prometheus
Classes
otelcol
The otelcol class.
Parameters
The following parameters are available in the otelcol class:
package_namepackage_ensureservice_nameservice_configcheckenvironment_filerun_optionsconfig_fileconfig_file_ownerconfig_file_groupconfig_file_modeconfigsreceiversprocessorsexporterspipelinesextensionslog_optionsmetrics_leveltelemetry_exportersservice_ensureservice_enablemanage_servicemanage_archivelocalpath_archivearchive_versionarchive_locationproxy_hostproxy_port
package_name
Data type: String
Name of the package used
Default value: 'otelcol'
package_ensure
Data type: Enum['present','absent','installed','latest']
Ensure for the package
Default value: 'installed'
service_name
Data type: String
Name of the service used
Default value: $package_name
service_configcheck
Data type: Boolean
Check config before service reloads
Default value: true
environment_file
Data type: String
path of the environment file used for service
Default value: "/etc/${package_name}/${package_name}.conf"
run_options
Data type: Optional[String]
additional options for service
Default value: undef
config_file
Data type: String
path to config file
Default value: "/etc/${package_name}/config.yaml"
config_file_owner
Data type: Optional[String]
owner of config_file
Default value: undef
config_file_group
Data type: Optional[String]
group of config_file
Default value: undef
config_file_mode
Data type: Stdlib::Filemode
mode of config_file
Default value: '0600'
configs
Data type: Array[String]
additional config files or resources to add. Since this can be environment variables, http urls or files you are required to ensure the existence of a file!
Default value: []
receivers
Data type: Hash[String, Hash]
Hash for receivers config
Default value: {}
processors
Data type: Hash[String, Hash]
Hash for processors config
Default value: {}
exporters
Data type: Hash[String, Hash]
Hash for exporters config
Default value: {}
pipelines
Data type: Hash[String, Hash]
Hash for pipelines config
Default value: {}
extensions
Data type: Hash[String, Hash]
Hash for extensions config
Default value: {}
log_options
Data type: Variant[Hash,String[1]]
Hash for log_options config
Default value: {}
metrics_level
Data type: Enum['none','basic','normal','detailed']
Level for metrics config
Default value: 'basic'
telemetry_exporters
Data type: Array[Otelcol::Telemetry_exporter]
Hash for telemetry exporters config. Currently support pull prometheus and periodic with otlp
Default value: [{ 'prometheus' => { 'host' => '0.0.0.0', 'port' => 8888 } }]
service_ensure
Data type: Stdlib::Ensure::Service
Ensure for service
Default value: 'running'
service_enable
Data type: Boolean
Enable the service on boot
Default value: true
manage_service
Data type: Boolean
If service is managed by module
Default value: true
manage_archive
Data type: Boolean
If archive should be managed by module of will be provided by packagemanager
Default value: false
localpath_archive
Data type: String[1]
Path where archive will be stored if managed
Default value: '/tmp'
archive_version
Data type: String[1]
Version of otelcol that will be used, param is not used if archive_location is set
Default value: '0.135.0'
archive_location
Data type: String[1]
Path to archive without filetype extension
Default value: "https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v${archive_version}/${package_name}_${archive_version}_linux_amd64"
proxy_host
Data type: Optional[Stdlib::Host]
Default value: undef
proxy_port
Data type: Stdlib::Port
Default value: 8888
otelcol::config
== Class: otelcol::config
Templated generation of otelcol.conf
otelcol::install
== Class: otelcol::install
Conditionally handle repos or package paths and install the necessary otelcol package.
Defined types
otelcol::exporter
Create a OpenTelemetry Collector exporter in the configuration file.
Examples
Basic usage
otelcol::exporter { 'namevar': }
Define a exporter and attach it to a pipeline
otelcol::exporter { 'prometheus':
pipelines => ['metrics'],
}
Parameters
The following parameters are available in the otelcol::exporter defined type:
name
The name of the exporter.
config
Data type: Hash
The configuration of the exporter.
Default value: {}
order
Data type: Integer[0,999]
The order of the exporter.
Default value: 0
pipelines
Data type: Array[String[1]]
The pipelines to attach the exporter to.
Default value: []
otelcol::extension
Add an extension to the OpenTelemetry Collector configuration
Examples
Basic usage
otelcol::extension { 'namevar': }
Parameters
The following parameters are available in the otelcol::extension defined type:
name
The name of the extension
config
Data type: Hash
The configuration for the extension
Default value: {}
order
Data type: Integer[0,999]
The order in which the extension should be loaded
Default value: 0
otelcol::pipeline
Used for explicitly configuring a pipeline in the OpenTelemetry Collector. This is useful for configuring a pipeline that is not automatically configured by its Components.
Examples
Configure a pipeline
otelcol::pipeline { 'namevar': }
Parameters
The following parameters are available in the otelcol::pipeline defined type:
name
The name of the pipeline to configure.
config
Data type: Hash
The configuration for the pipeline.
Default value: {}
order
Data type: Integer[0,999]
The order in which the pipeline should be configured.
Default value: 0
otelcol::processor
Add a processor to the OpenTelemetry Collector configuration
Examples
Basic usage
otelcol::processor { 'namevar': }
Define a processor and attach it to a pipeline
otelcol::processor { 'batch':
pipelines => ['metrics'],
}
Parameters
The following parameters are available in the otelcol::processor defined type:
name
The name of the processor
config
Data type: Hash
The configuration of the processor
Default value: {}
order
Data type: Integer[0,999]
The order of the processor
Default value: 10
pipelines
Data type: Array[String[1]]
The pipelines to attach the processor to
Default value: []
otelcol::receiver
Add a receiver to the OpenTelemetry Collector configuration
Examples
basic receiver
otelcol::receiver { 'namevar': }
Define a receiver and attach it to a pipeline
otelcol::receiver { 'otlp':
pipelines => ['metrics'],
}
Parameters
The following parameters are available in the otelcol::receiver defined type:
name
The name of the receiver
config
Data type: Hash
The configuration of the receiver
Default value: {}
order
Data type: Integer[0,999]
The order of the receiver
Default value: 0
pipelines
Data type: Array[String[1]]
The pipelines the receiver is part of
Default value: []
Data types
Otelcol::Component::Name
Type for name of Otel Collector Ressources
Alias of Pattern[/\A[a-z0-9_-]+(\/[a-z0-9_-]+)?\z/]
Otelcol::Telemetry_exporter
The Otelcol::Telemetry_exporter data type.
Alias of Variant[Struct[{ 'prometheus' => Otelcol::Telemetry_exporter::Pull }], Struct[{ 'otlp' => Otelcol::Telemetry_exporter::Periodic }]]
Otelcol::Telemetry_exporter::Periodic
The Otelcol::Telemetry_exporter::Periodic data type.
Alias of Variant[Otelcol::Telemetry_exporter::Periodic::Otlp]
Otelcol::Telemetry_exporter::Periodic::Otlp
The Otelcol::Telemetry_exporter::Periodic::Otlp data type.
Alias of
Struct[{
endpoint => Stdlib::HTTPSUrl,
protocol => String
}]
Otelcol::Telemetry_exporter::Pull
The Otelcol::Telemetry_exporter::Pull data type.
Alias of Variant[Otelcol::Telemetry_exporter::Pull::Prometheus]
Otelcol::Telemetry_exporter::Pull::Prometheus
The Otelcol::Telemetry_exporter::Pull::Prometheus data type.
Alias of
Struct[{
host => Stdlib::Host,
port => Stdlib::Port,
}]
Changelog
All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not affect the functionality of the module.
v2.0.0 (2025-09-12)
Breaking changes:
- telemetry: switch to using data structure list for telemetry #34 (b4ldr)
- Drop puppet, update openvox minimum version to 8.19 #32 (TheMeier)
- Change the default value for
$otelcol::processors::orderto 10 #22 (cyberkov)
Implemented enhancements:
- the used Internal Telemetry format is deprecated since otelcol 0.128.0 #31
- update to most uptodate version for default #40 (voxel01)
- metadata.json: Add OpenVox #28 (jstraw)
- Feature: support multiple configs #26 (cyberkov)
- Set Default file mode to 0600 and User to default in package #21 (voxel01)
- Add support for Puppet 8 #20 (voxel01)
- implement configfile validation #18 (cyberkov)
Fixed bugs:
Merged pull requests:
- types/component/name.pp: allow sub names to have - and __ #39 (b4ldr)
- otelcol::config: Add proxy support #35 (b4ldr)
v1.0.0 (2023-11-24)
Breaking changes:
- Drop Support for Ubuntu 18.04 #14 (voxel01)
- Refactor Module to allow definition of types #11 (voxel01)
Implemented enhancements:
- Add support for Debian 12 #9 (voxel01)
- Add acceptance tests #6 (voxel01)
- Add includefile #5 (voxel01)
- Add service config #4 (voxel01)
Fixed bugs:
Closed issues:
- default configuration file/owner/group #8
Merged pull requests:
- Drop broken OL 7 testing #13 (bastelfreak)
- fixtures.yml: Pull dependencies from git #12 (bastelfreak)
- Initial implementation #1 (cyberkov)
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs/stdlib (>= 9.0.0 < 10.0.0)
- puppetlabs/concat (>= 9.0.0 < 10.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.
