Version information
This version is compatible with:
- Puppet Enterprise 2025.3.x, 2025.2.x, 2025.1.x, 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x
- Puppet >= 7.9.0 < 9.0.0
- Debian,Ubuntu
Start using this module
Add this module to your Puppetfile:
mod 'attachmentgenie-loki', '3.0.0'Learn more about managing modules with a PuppetfileDocumentation
attachmentgenie-loki
Deploy and configure loki on a node.
Description
It primarily:
- Discovers targets
- Attaches labels to log streams
- Pushes them to the Loki instance.
Currently, Loki can tail logs from two sources: local log files and the systemd journal (on AMD64 machines only).
Usage
All options and configuration can be done through interacting with the parameters on the main loki class. These are now documented via Puppet Strings
You can view example usage in REFERENCE.
## Reference
See [REFERENCE](REFERENCE.md).
## Limitations
This is where you list OS compatibility, version compatibility, etc.
## Development
### Running tests
This project contains tests for both rspec-puppet and litmus to verify functionality. For detailed information on using these tools, please see their respective documentation.
#### Testing quickstart:
pdk bundle install pdk bundle exec rake 'litmus:provision_list[puppet8]' pdk bundle exec rake 'litmus:install_agent[puppet8]' pdk bundle exec rake 'litmus:install_module' pdk bundle exec rake 'litmus:acceptance:parallel' pdk bundle exec rake 'litmus:tear_down'
Reference
Table of Contents
Classes
Public Classes
loki: A short summary of the purpose of this class
Private Classes
loki::config: A short summary of the purpose of this classloki::install: A short summary of the purpose of this classloki::service: A short summary of the purpose of this class
Functions
loki::strip_yaml_header: A function to strip the --- from the beginning of a string
Data types
Loki::Target: List of loki components
Classes
loki
A description of what this class does
Examples
Minimal example, creates a standalone loki instance (not desinged for production).
class{ 'loki':
auth_enabled => false,
common_config_hash => {'common' => {
'path_prefix' => '/var/lib/loki',
}},
schema_config_hash => {'schema_config' => {
'configs' => [{
'from' => '2020-05-15',
'store' => 'boltdb',
'object_store' => 'filesystem',
'schema' => 'v11',
'index' => {'prefix' => 'index_', 'period' => '168h'},
}]
}},
storage_config_hash => {'storage_config' => {
'boltdb' => { 'directory' => '/var/lib/loki/index'},
'filesystem' => {'directory' => '/var/lib/loki/chunks'},
}},
server_config_hash => {'server' => {
'http_listen_port' => 3100,
'http_listen_address' => $facts['networking']['ip']},
},
ingester_client_config_hash => {'ingester' => {
'lifecycler' => {
'interface_names' => [$facts['networking']['primary']],
'address' => '127.0.0.1',
'ring' => {'kvstore' =>{'store' => 'inmemory'}, 'replication_factor' => 1},
}
}},
}
Parameters
The following parameters are available in the loki class:
bin_dirconfig_dirconfig_filedata_dirgroupinstall_methodmanage_servicepackage_namepackage_versionschema_config_hashservice_nameservice_providerservice_ensurestorage_config_hashuserversionauth_enabledchunk_store_config_hashcompactor_config_hashdistributor_config_hashfrontend_worker_config_hashingester_client_config_hashingester_config_hashlimits_config_hashmanage_usermanage_unit_filequerier_config_hashquery_scheduler_config_hashquery_frontend_config_hashquery_range_config_hashruler_config_hashruntime_config_hashserver_config_hashtable_manager_config_hashtargettracing_config_hashmemberlist_config_hashcommon_config_hashpattern_ingester_config_hashindex_gateway_config_hash
bin_dir
Data type: Stdlib::Absolutepath
path to install binary file.
config_dir
Data type: Stdlib::Absolutepath
path to install configuration file.
config_file
Data type: String[1]
file to install configuration in.
data_dir
Data type: Stdlib::Absolutepath
path where loki data will be stored.
group
Data type: String[1]
Group that owns loki files.
install_method
Data type: Enum['archive','package']
How to install loki.
manage_service
Data type: Boolean
Manage the loki service.
package_name
Data type: String[1]
Name of package to install.
package_version
Data type: String[1]
Version of package to install.
schema_config_hash
Data type: Hash
Configures the chunk index schema
service_name
Data type: String[1]
Name of service to manage.
service_provider
Data type: Enum['systemd']
Init system that is used.
service_ensure
Data type: Enum['running','stopped']
The state of the service.
storage_config_hash
Data type: Hash
The storage_config block configures one of many possible stores for both the index and chunks.
user
Data type: String[1]
User that owns example files.
version
Data type: String[1]
Version to install.
auth_enabled
Data type: Boolean
Enables authentication
Default value: true
chunk_store_config_hash
Data type: Optional[Hash]
The chunk_store_config block configures how chunks will be cached
Default value: undef
compactor_config_hash
Data type: Optional[Hash]
Configures the compactor component which compacts index shards for performance.
Default value: undef
distributor_config_hash
Data type: Optional[Hash]
Configures the distributor.
Default value: undef
frontend_worker_config_hash
Data type: Optional[Hash]
The frontend_worker_config configures the worker
Default value: undef
ingester_client_config_hash
Data type: Optional[Hash]
Configures how the distributor will connect to ingesters.
Default value: undef
ingester_config_hash
Data type: Optional[Hash]
The ingester_client block configures how the distributor will connect to ingesters.
Default value: undef
limits_config_hash
Data type: Optional[Hash]
The limits_config block configures global and per-tenant limits in Loki.
Default value: undef
manage_user
Data type: Boolean
Manage loki user and group.
Default value: $install_method ? { 'archive' => true, 'package' => false
manage_unit_file
Data type: Boolean
Manage unit file for service
Default value: $install_method ? { 'archive' => true, 'package' => false
querier_config_hash
Data type: Optional[Hash]
Configures the querier.
Default value: undef
query_scheduler_config_hash
Data type: Optional[Hash]
The query_scheduler block configures the Loki query scheduler.
Default value: undef
query_frontend_config_hash
Data type: Optional[Hash]
The query_frontend block configures the Loki query address.
Default value: undef
query_range_config_hash
Data type: Optional[Hash]
The query_range block configures the query splitting and caching in the Loki query-frontend.
Default value: undef
ruler_config_hash
Data type: Optional[Hash]
The ruler block configures the Loki ruler.
Default value: undef
runtime_config_hash
Data type: Optional[Hash]
Configuration for 'runtime config' module, responsible for reloading runtime configuration file.
Default value: undef
server_config_hash
Data type: Optional[Hash]
Configures the server of the launched module(s).
Default value: undef
table_manager_config_hash
Data type: Optional[Hash]
The table_manager block configures the table manager for retention.
Default value: undef
target
Data type: Optional[Loki::Target]
A comma-separated list of components to run.
Default value: undef
tracing_config_hash
Data type: Optional[Hash]
Configuration for tracing.,
Default value: undef
memberlist_config_hash
Data type: Optional[Hash]
Configuration for memberlist client. Only applies if the selected kvstore is memberlist
Default value: undef
common_config_hash
Data type: Optional[Hash]
Common configuration to be shared between multiple modules.
Default value: undef
pattern_ingester_config_hash
Data type: Optional[Hash]
The pattern_ingester block configures the pattern ingester.
Default value: undef
index_gateway_config_hash
Data type: Optional[Hash]
The index_gateway block configures the index gateway.
Default value: undef
Functions
loki::strip_yaml_header
Type: Ruby 4.x API
A function to strip the --- from the beginning of a string
Examples
concat::fragment { 'loki_common_config':
target => $config_file,
content => $loki::common_config_hash.stdlib::to_yaml.loki::strip_yaml_header,
order => '09',
}
loki::strip_yaml_header(String $yaml_string)
A function to strip the --- from the beginning of a string
Returns: String Returns the string with the leading header stripped off
Examples
concat::fragment { 'loki_common_config':
target => $config_file,
content => $loki::common_config_hash.stdlib::to_yaml.loki::strip_yaml_header,
order => '09',
}
yaml_string
Data type: String
A string that may start with the ---'s used to denote a YAML file
Data types
Loki::Target
List of loki components
Alias of
Array[Enum[
'all',
'analytics',
'backend',
'bloom-builder',
'bloom-compactor',
'bloom-gateway',
'bloom-planner',
'bloom-store',
'cache-generation-loader',
'compactor',
'distributor',
'index-gateway',
'ingester',
'ingester-querier',
'overrides-exporter',
'pattern-ingester',
'querier',
'query-frontend',
'query-scheduler',
'ruler',
'read',
'table-manager',
'write' # lint:ignore:trailing_comma
]]
Changelog
All notable changes to this project will be documented in this file.
Release 1.0.0
- added logcli support
- Adding Loki 2.* support
- Adding Loki 2.2.* support (BDelacour)
- Update to PDK 2.2
- Set better default for managing the loki user and service file (bastelfreak)
- Adding minimal viable Example (bastelfreak)
- Adding Litmus acceptance tests for MVE.
Release 0.1.0
Features
Initial support for Grafan Loki 1.5.*
Dependencies
- puppet/archive (>= 4.2.0 < 8.0.0)
- puppetlabs/concat (>= 6.0.0 < 10.0.0)
- puppetlabs/stdlib (>= 9.0.0 < 10.0.0)
- puppet/systemd (>= 1.1.1 < 9.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.