confdroid/confdroid_alloy
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Compare commits

base: confdroid:master
Branches Tags
confdroid:master
confdroid:1.1.0 confdroid:1.0.0
..
compare: confdroid:4f73562b6096ba3c1d5ec0571bab712bec937fc1
Branches Tags
confdroid:master
confdroid:1.1.0 confdroid:1.0.0

1 Commits
master ... 4f73562b60

Author SHA1 Message Date
Jenkins Server
4f73562b60 Merge remote-tracking branch 'origin/master' into jenkins-build-7 2026-09-01 11:00:02 +02:00
20 changed files with 148 additions and 1068 deletions
Expand all files Collapse all files

14
README.md
View File

@@ -37,6 +37,7 @@ Then you can use Grafana itself to visualize those logs and metrics and built an
INSTALLATION INSTALLATION
- installs alloy binaries - installs alloy binaries
- installs node exporter (optional, set `ay_manage_ne`to `true`)
CONFIGURATION CONFIGURATION
@@ -44,7 +45,6 @@ CONFIGURATION
- manages the main alloy pipeline for loki and prometheus - manages the main alloy pipeline for loki and prometheus
- manages log rotation for rsyslog to allow adm membership - manages log rotation for rsyslog to allow adm membership
- manage service - manage service
- optional: include nagios target for the alloy service (set `ay_manage_nagios`to `true`)
## Repo Documentation ## Repo Documentation
@@ -54,9 +54,6 @@ See the full Puppet documentation including parameters in `docs/index.html`
All dependencies must be included in the catalogue. All dependencies must be included in the catalogue.
- [confdroid_nagios](https://sourcecode.confdroid.com/confdroid/confdroid_nagios) if nagios monitoring is desired
- [puppetlabs/concat](https://forge.puppet.com/modules/puppetlabs/concat) for composing the Alloy configuration
## Deployment ## Deployment
- native Puppet deployment - native Puppet deployment
@@ -69,15 +66,6 @@ node 'example.example.net' {
} }
``` ```
External modules can add log files to Alloy's `path_targets` list with the
`confdroid_alloy::log_targets` defined type:
```puppet
confdroid_alloy::log_targets { 'my_application':
targets => ['/var/log/my_application/*.log', '/var/log/my_application/audit.log'],
}
```
- through Foreman: - through Foreman:
In order to apply parameters through Foreman, the params.pp must be added to the host or host group in question. In order to apply parameters through Foreman, the params.pp must be added to the host or host group in question.

29
doc/_index.html
View File

@@ -103,11 +103,6 @@
</li> </li>
<li>
<span class='object_link'><a href="puppet_classes/confdroid_alloy_3A_3Amonitoring_3A_3Atarget.html" title="puppet_classes::confdroid_alloy::monitoring::target (puppet_class)">confdroid_alloy::monitoring::target</a></span>
</li>
<li> <li>
<span class='object_link'><a href="puppet_classes/confdroid_alloy_3A_3Aparams.html" title="puppet_classes::confdroid_alloy::params (puppet_class)">confdroid_alloy::params</a></span> <span class='object_link'><a href="puppet_classes/confdroid_alloy_3A_3Aparams.html" title="puppet_classes::confdroid_alloy::params (puppet_class)">confdroid_alloy::params</a></span>
@@ -122,30 +117,6 @@
<h2>Defined Type Listing A-Z</h2>
<table>
<tr>
<td valign='top' width="33%">
<ul id="alpha_C" class="alpha">
<li class="letter">C</li>
<ul>
<li>
<span class='object_link'><a href="puppet_defined_types/confdroid_alloy_3A_3Amonitoring_3A_3Alog_targets.html" title="puppet_defined_types::confdroid_alloy::monitoring::log_targets (puppet_defined_type)">confdroid_alloy::monitoring::log_targets</a></span>
</li>
</ul>
</ul>
</td>
</tr>
</table>

16
doc/file.README.html
View File

@@ -108,6 +108,8 @@
<p>INSTALLATION</p> <p>INSTALLATION</p>
<ul><li> <ul><li>
<p>installs alloy binaries</p> <p>installs alloy binaries</p>
</li><li>
<p>installs node exporter (optional, set <code>ay_manage_ne</code>to <code>true</code>)</p>
</li></ul> </li></ul>
<p>CONFIGURATION</p> <p>CONFIGURATION</p>
@@ -119,8 +121,6 @@
<p>manages log rotation for rsyslog to allow adm membership</p> <p>manages log rotation for rsyslog to allow adm membership</p>
</li><li> </li><li>
<p>manage service</p> <p>manage service</p>
</li><li>
<p>optional: include nagios target for the alloy service (set <code>ay_manage_nagios</code>to <code>true</code>)</p>
</li></ul> </li></ul>
<h2 id="label-Repo+Documentation">Repo Documentation</h2> <h2 id="label-Repo+Documentation">Repo Documentation</h2>
@@ -130,11 +130,6 @@
<h2 id="label-Dependencies">Dependencies</h2> <h2 id="label-Dependencies">Dependencies</h2>
<p>All dependencies must be included in the catalogue.</p> <p>All dependencies must be included in the catalogue.</p>
<ul><li>
<p><a href="https://sourcecode.confdroid.com/confdroid/confdroid_nagios">confdroid_nagios</a> if nagios monitoring is desired</p>
</li><li>
<p><a href="https://forge.puppet.com/modules/puppetlabs/concat">puppetlabs/concat</a> for composing the Alloy configuration</p>
</li></ul>
<h2 id="label-Deployment">Deployment</h2> <h2 id="label-Deployment">Deployment</h2>
<ul><li> <ul><li>
@@ -147,13 +142,6 @@
include confdroid_alloy include confdroid_alloy
} }
</code></pre> </code></pre>
<p>External modules can add log files to Alloy’s <code>path_targets</code> list with the <code>confdroid_alloy::log_targets</code> defined type:</p>
<pre class="code ruby"><code class="ruby">confdroid_alloy::log_targets { &#39;my_application&#39;:
targets =&gt; [&#39;/var/log/my_application/*.log&#39;, &#39;/var/log/my_application/audit.log&#39;],
}
</code></pre>
<ul><li> <ul><li>
<p>through Foreman:</p> <p>through Foreman:</p>
</li></ul> </li></ul>

16
doc/index.html
View File

@@ -108,6 +108,8 @@
<p>INSTALLATION</p> <p>INSTALLATION</p>
<ul><li> <ul><li>
<p>installs alloy binaries</p> <p>installs alloy binaries</p>
</li><li>
<p>installs node exporter (optional, set <code>ay_manage_ne</code>to <code>true</code>)</p>
</li></ul> </li></ul>
<p>CONFIGURATION</p> <p>CONFIGURATION</p>
@@ -119,8 +121,6 @@
<p>manages log rotation for rsyslog to allow adm membership</p> <p>manages log rotation for rsyslog to allow adm membership</p>
</li><li> </li><li>
<p>manage service</p> <p>manage service</p>
</li><li>
<p>optional: include nagios target for the alloy service (set <code>ay_manage_nagios</code>to <code>true</code>)</p>
</li></ul> </li></ul>
<h2 id="label-Repo+Documentation">Repo Documentation</h2> <h2 id="label-Repo+Documentation">Repo Documentation</h2>
@@ -130,11 +130,6 @@
<h2 id="label-Dependencies">Dependencies</h2> <h2 id="label-Dependencies">Dependencies</h2>
<p>All dependencies must be included in the catalogue.</p> <p>All dependencies must be included in the catalogue.</p>
<ul><li>
<p><a href="https://sourcecode.confdroid.com/confdroid/confdroid_nagios">confdroid_nagios</a> if nagios monitoring is desired</p>
</li><li>
<p><a href="https://forge.puppet.com/modules/puppetlabs/concat">puppetlabs/concat</a> for composing the Alloy configuration</p>
</li></ul>
<h2 id="label-Deployment">Deployment</h2> <h2 id="label-Deployment">Deployment</h2>
<ul><li> <ul><li>
@@ -147,13 +142,6 @@
include confdroid_alloy include confdroid_alloy
} }
</code></pre> </code></pre>
<p>External modules can add log files to Alloy’s <code>path_targets</code> list with the <code>confdroid_alloy::log_targets</code> defined type:</p>
<pre class="code ruby"><code class="ruby">confdroid_alloy::log_targets { &#39;my_application&#39;:
targets =&gt; [&#39;/var/log/my_application/*.log&#39;, &#39;/var/log/my_application/audit.log&#39;],
}
</code></pre>
<ul><li> <ul><li>
<p>through Foreman:</p> <p>through Foreman:</p>
</li></ul> </li></ul>

13
doc/puppet_class_list.html
View File

@@ -28,10 +28,6 @@
Puppet Classes Puppet Classes
</a></span> </a></span>
<span><a target="_self" href="puppet_defined_type_list.html">
Defined Types
</a></span>
</div> </div>
<div id="search">Search: <input type="text" /></div> <div id="search">Search: <input type="text" /></div>
@@ -89,14 +85,7 @@
</li> </li>
<li id="object_puppet_classes::confdroid_alloy::monitoring::target" class="even"> <li id="object_puppet_classes::confdroid_alloy::params" class="even">
<div class="item">
<span class='object_link'><a href="puppet_classes/confdroid_alloy_3A_3Amonitoring_3A_3Atarget.html" title="puppet_classes::confdroid_alloy::monitoring::target (puppet_class)">confdroid_alloy::monitoring::target</a></span>
</div>
</li>
<li id="object_puppet_classes::confdroid_alloy::params" class="odd">
<div class="item"> <div class="item">
<span class='object_link'><a href="puppet_classes/confdroid_alloy_3A_3Aparams.html" title="puppet_classes::confdroid_alloy::params (puppet_class)">confdroid_alloy::params</a></span> <span class='object_link'><a href="puppet_classes/confdroid_alloy_3A_3Aparams.html" title="puppet_classes::confdroid_alloy::params (puppet_class)">confdroid_alloy::params</a></span>
</div> </div>

10
doc/puppet_classes/confdroid_alloy_3A_3Amain_3A_3Aconfig.html
View File

@@ -105,11 +105,7 @@
7 7
8 8
9 9
10 10</pre>
11
12
13
14</pre>
</td> </td>
<td> <td>
<pre class="code"><span class="info file"># File 'manifests/main/config.pp', line 6</span> <pre class="code"><span class="info file"># File 'manifests/main/config.pp', line 6</span>
@@ -118,10 +114,6 @@ class confdroid_alloy::main::config (
) inherits confdroid_alloy::params { ) inherits confdroid_alloy::params {
include confdroid_alloy::main::service include confdroid_alloy::main::service
if $ay_manage_nagios == true {
include confdroid_alloy::monitoring::target
}
}</pre> }</pre>
</td> </td>
</tr> </tr>

46
doc/puppet_classes/confdroid_alloy_3A_3Amain_3A_3Afiles.html
View File

@@ -151,25 +151,7 @@
53 53
54 54
55 55
56 56</pre>
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74</pre>
</td> </td>
<td> <td>
<pre class="code"><span class="info file"># File 'manifests/main/files.pp', line 6</span> <pre class="code"><span class="info file"># File 'manifests/main/files.pp', line 6</span>
@@ -179,10 +161,11 @@ class confdroid_alloy::main::files (
) inherits confdroid_alloy::params { ) inherits confdroid_alloy::params {
require confdroid_alloy::main::dirs require confdroid_alloy::main::dirs
# Ensure log_targets is always an array
$log_targets_array = Array($confdroid_alloy::params::ay_log_targets, true) $log_targets_array = Array($confdroid_alloy::params::ay_log_targets, true)
concat { $ay_main_file: file { $ay_main_file:
ensure =&gt; present, ensure =&gt; file,
owner =&gt; &#39;root&#39;, owner =&gt; &#39;root&#39;,
group =&gt; &#39;root&#39;, group =&gt; &#39;root&#39;,
mode =&gt; &#39;0644&#39;, mode =&gt; &#39;0644&#39;,
@@ -190,27 +173,8 @@ class confdroid_alloy::main::files (
selrole =&gt; object_r, selrole =&gt; object_r,
seltype =&gt; etc_t, seltype =&gt; etc_t,
seluser =&gt; system_u, seluser =&gt; system_u,
notify =&gt; Service[$ay_service],
}
concat::fragment { &#39;confdroid_alloy_config_header&#39;:
target =&gt; $ay_main_file,
content =&gt; template(&#39;confdroid_alloy/config.alloy.erb&#39;), content =&gt; template(&#39;confdroid_alloy/config.alloy.erb&#39;),
order =&gt; &#39;001&#39;, notify =&gt; Service[$ay_service],
}
if $ay_manage_loki == true {
concat::fragment { &#39;confdroid_alloy_log_targets_default&#39;:
target =&gt; $ay_main_file,
content =&gt; template(&#39;confdroid_alloy/log_targets.alloy.erb&#39;),
order =&gt; &#39;010&#39;,
}
}
concat::fragment { &#39;confdroid_alloy_config_tail&#39;:
target =&gt; $ay_main_file,
content =&gt; template(&#39;confdroid_alloy/config.alloy.tail.erb&#39;),
order =&gt; &#39;999&#39;,
} }
# manage logrotate for rsyslog to allow adm group membership # manage logrotate for rsyslog to allow adm group membership

156
doc/puppet_classes/confdroid_alloy_3A_3Amonitoring_3A_3Atarget.html
View File

@@ -1,156 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Puppet Class: confdroid_alloy::monitoring::target
&mdash; Documentation by YARD 0.9.36
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "puppet_classes::confdroid_alloy::monitoring::target";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../puppet_class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (c)</a> &raquo;
<span class='title'><span class='object_link'>Puppet Classes</span></span>
&raquo;
<span class="title">confdroid_alloy::monitoring::target</span>
</div>
<div id="search">
<a class="full_list_link" id="puppet_class_list_link"
href="../puppet_class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Puppet Class: confdroid_alloy::monitoring::target</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd><span class='object_link'><a href="confdroid_alloy_3A_3Aparams.html" title="puppet_classes::confdroid_alloy::params (puppet_class)">confdroid_alloy::params</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>
manifests/monitoring/target.pp
</dd>
</dl>
</div>
<h2>Summary</h2>
class manages exports for nagios monitoring
<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>confdroid_alloy::monitoring::target.pp Module name: confdroid_alloy Author: 12ww1160 (12ww1160@puppetsoft.com)</p>
</div>
</div>
<div class="tags">
</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/monitoring/target.pp', line 6</span>
class confdroid_alloy::monitoring::target (
) inherits confdroid_alloy::params {
if $ay_manage_nagios == true {
@@nagios_service { &quot;check_alloy_${fqdn}&quot;:
check_command =&gt; &quot;check_nrpe!check_alloy!${ay_procs_allowed}!alloy&quot;,
use =&gt; &#39;generic-service&#39;,
host_name =&gt; $fqdn,
notification_period =&gt; &#39;24x7&#39;,
service_description =&gt; &quot;${fqdn}_check_alloy&quot;,
target =&gt; $ay_target_service,
owner =&gt; &#39;nagios&#39;,
group =&gt; &#39;nagios&#39;,
mode =&gt; &#39;0640&#39;,
contacts =&gt; $ay_target_contacts,
}
}
}</pre>
</td>
</tr>
</table>
</div>
</div>
<div id="footer">
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
</div>
</div>
</body>
</html>

230
doc/puppet_classes/confdroid_alloy_3A_3Aparams.html
View File

@@ -79,8 +79,6 @@
<span class='object_link'><a href="confdroid_alloy_3A_3Amain_3A_3Ayumrepo.html" title="puppet_classes::confdroid_alloy::main::yumrepo (puppet_class)">confdroid_alloy::main::yumrepo</a></span><br/> <span class='object_link'><a href="confdroid_alloy_3A_3Amain_3A_3Ayumrepo.html" title="puppet_classes::confdroid_alloy::main::yumrepo (puppet_class)">confdroid_alloy::main::yumrepo</a></span><br/>
<span class='object_link'><a href="confdroid_alloy_3A_3Amonitoring_3A_3Atarget.html" title="puppet_classes::confdroid_alloy::monitoring::target (puppet_class)">confdroid_alloy::monitoring::target</a></span><br/>
</dd> </dd>
</dl> </dl>
@@ -236,6 +234,24 @@
</li> </li>
<li>
<span class='name'>ay_manage_ne</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to manage metric forwarding for the node exporter (external)</p>
</div>
</li>
<li> <li>
<span class='name'>ay_prom_url</span> <span class='name'>ay_prom_url</span>
@@ -268,168 +284,6 @@
&mdash; &mdash;
<div class='inline'> <div class='inline'>
<p>the logging targets</p> <p>the logging targets</p>
</div>
</li>
<li>
<span class='name'>ay_prom_honor_timestamps</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to honor timestamps in prometheus metrics</p>
</div>
</li>
<li>
<span class='name'>ay_prom_track_timestamps_staleness</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to track timestamps staleness in prometheus metrics</p>
</div>
</li>
<li>
<span class='name'>ay_prom_max_shards</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;10&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the maximum number of shards to use for prometheus metrics</p>
</div>
</li>
<li>
<span class='name'>ay_prom_max_samples_per_send</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;2000&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the maximum number of samples to send</p>
</div>
</li>
<li>
<span class='name'>ay_prom_batch_send_deadline</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;5s&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the maximum time to wait before sending</p>
</div>
</li>
<li>
<span class='name'>ay_manage_nagios</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to manage nagios service exports</p>
</div>
</li>
<li>
<span class='name'>ay_target_service</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/etc/nagios/conf.d/alloy_service.cfg&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the target file for nagios service exports</p>
</div>
</li>
<li>
<span class='name'>ay_target_contacts</span>
<span class='type'>(<tt>Array</tt>)</span>
<em class="default">(defaults to: <tt>[&#39;nagiosadmin&#39;]</tt>)</em>
&mdash;
<div class='inline'>
<p>the contacts for nagios service exports</p>
</div>
</li>
<li>
<span class='name'>ay_procs_allowed</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1:&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the allowed number of processes for nagios service exports</p>
</div> </div>
</li> </li>
@@ -445,6 +299,15 @@
<pre class="lines"> <pre class="lines">
17
18
19
20
21
22
23
24
25
26 26
27 27
28 28
@@ -467,30 +330,10 @@
45 45
46 46
47 47
48 48</pre>
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68</pre>
</td> </td>
<td> <td>
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 26</span> <pre class="code"><span class="info file"># File 'manifests/params.pp', line 17</span>
class confdroid_alloy::params ( class confdroid_alloy::params (
@@ -507,22 +350,11 @@ class confdroid_alloy::params (
# prometheus # prometheus
Boolean $ay_manage_prom = true, Boolean $ay_manage_prom = true,
String $ay_prom_url = &#39;https://prometheus.example.net/api/v1/write&#39;, String $ay_prom_url = &#39;https://prometheus.example.net/api/v1/write&#39;,
Boolean $ay_prom_honor_timestamps = true,
Boolean $ay_prom_track_timestamps_staleness = true,
String $ay_prom_max_shards = &#39;10&#39;,
String $ay_prom_max_samples_per_send = &#39;2000&#39;,
String $ay_prom_batch_send_deadline = &#39;5s&#39;,
# nagios # node exporter (external)
Boolean $ay_manage_nagios = false, Boolean $ay_manage_ne = false,
String $ay_target_service = &#39;/etc/nagios/conf.d/alloy_service.cfg&#39;,
Array $ay_target_contacts = [&#39;nagiosadmin&#39;],
String $ay_procs_allowed = &#39;1:&#39;
) { ) {
# defaults
$fqdn = $facts[&#39;networking&#39;][&#39;fqdn&#39;]
# service # service
$ay_service = &#39;alloy&#39; $ay_service = &#39;alloy&#39;

54
doc/puppet_defined_type_list.html
View File

@@ -1,54 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta charset="utf-8" />
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
<title>Defined Type List</title>
<base id="base_target" target="_parent" />
</head>
<body>
<div id="content">
<div class="fixed_header">
<h1 id="full_list_header">Defined Type List</h1>
<div id="full_list_nav">
<span><a target="_self" href="puppet_class_list.html">
Puppet Classes
</a></span>
<span><a target="_self" href="puppet_defined_type_list.html">
Defined Types
</a></span>
</div>
<div id="search">Search: <input type="text" /></div>
</div>
<ul id="full_list" class="puppet_defined_type">
<li id="object_puppet_defined_types::confdroid_alloy::monitoring::log_targets" class="odd">
<div class="item">
<span class='object_link'><a href="puppet_defined_types/confdroid_alloy_3A_3Amonitoring_3A_3Alog_targets.html" title="puppet_defined_types::confdroid_alloy::monitoring::log_targets (puppet_defined_type)">confdroid_alloy::monitoring::log_targets</a></span>
</div>
</li>
</ul>
</div>
</body>
</html>

165
doc/puppet_defined_types/confdroid_alloy_3A_3Alog_targets.html
View File

@@ -1,165 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Defined Type: confdroid_alloy::log_targets
&mdash; Documentation by YARD 0.9.36
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "puppet_defined_types::confdroid_alloy::log_targets";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../puppet_defined_type_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (c)</a> &raquo;
<span class='title'><span class='object_link'>Defined Types</span></span>
&raquo;
<span class="title">confdroid_alloy::log_targets</span>
</div>
<div id="search">
<a class="full_list_link" id="puppet_class_list_link"
href="../puppet_class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Defined Type: confdroid_alloy::log_targets</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>
manifests/log_targets.pp
</dd>
</dl>
</div>
<h2>Summary</h2>
Adds log file targets to the Alloy configuration.
<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>confdroid_alloy::log_targets.pp Module name: confdroid_alloy</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>targets</span>
<span class='type'>(<tt>Array[String]</tt>)</span>
<em class="default">(defaults to: <tt>[]</tt>)</em>
&mdash;
<div class='inline'>
<p>Paths to log files to scrape.</p>
</div>
</li>
</ul>
</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/log_targets.pp', line 6</span>
define confdroid_alloy::log_targets (
Array[String] $targets = [],
) {
if $confdroid_alloy::params::ay_manage_loki == true and $targets != [] {
$log_targets_array = $targets
concat::fragment { &quot;log_targets_${name}&quot;:
target =&gt; $confdroid_alloy::params::ay_main_file,
content =&gt; template(&#39;confdroid_alloy/log_targets.alloy.erb&#39;),
order =&gt; &#39;020&#39;,
}
}
}</pre>
</td>
</tr>
</table>
</div>
</div>
<div id="footer">
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
</div>
</div>
</body>
</html>

165
doc/puppet_defined_types/confdroid_alloy_3A_3Amonitoring_3A_3Alog_targets.html
View File

@@ -1,165 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Defined Type: confdroid_alloy::monitoring::log_targets
&mdash; Documentation by YARD 0.9.36
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "puppet_defined_types::confdroid_alloy::monitoring::log_targets";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../puppet_defined_type_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (c)</a> &raquo;
<span class='title'><span class='object_link'>Defined Types</span></span>
&raquo;
<span class="title">confdroid_alloy::monitoring::log_targets</span>
</div>
<div id="search">
<a class="full_list_link" id="puppet_class_list_link"
href="../puppet_class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Defined Type: confdroid_alloy::monitoring::log_targets</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>
manifests/monitoring/log_targets.pp
</dd>
</dl>
</div>
<h2>Summary</h2>
Adds log file targets to the Alloy configuration.
<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>confdroid_alloy::monitoring::log_targets.pp Module name: confdroid_alloy</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>targets</span>
<span class='type'>(<tt>Array[String]</tt>)</span>
<em class="default">(defaults to: <tt>[]</tt>)</em>
&mdash;
<div class='inline'>
<p>Paths to log files to scrape.</p>
</div>
</li>
</ul>
</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/monitoring/log_targets.pp', line 6</span>
define confdroid_alloy::monitoring::log_targets (
Array[String] $targets = [],
) {
if $confdroid_alloy::params::ay_manage_loki == true and $targets != [] {
$log_targets_array = $targets
concat::fragment { &quot;log_targets_${name}&quot;:
target =&gt; $confdroid_alloy::params::ay_main_file,
content =&gt; template(&#39;confdroid_alloy/log_targets.alloy.erb&#39;),
order =&gt; &#39;020&#39;,
}
}
}</pre>
</td>
</tr>
</table>
</div>
</div>
<div id="footer">
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
</div>
</div>
</body>
</html>

4
manifests/main/config.pp
View File

@@ -7,8 +7,4 @@ class confdroid_alloy::main::config (
) inherits confdroid_alloy::params { ) inherits confdroid_alloy::params {
include confdroid_alloy::main::service include confdroid_alloy::main::service
if $ay_manage_nagios == true {
include confdroid_alloy::monitoring::target
}
} }

26
manifests/main/files.pp
View File

@@ -8,10 +8,11 @@ class confdroid_alloy::main::files (
) inherits confdroid_alloy::params { ) inherits confdroid_alloy::params {
require confdroid_alloy::main::dirs require confdroid_alloy::main::dirs
# Ensure log_targets is always an array
$log_targets_array = Array($confdroid_alloy::params::ay_log_targets, true) $log_targets_array = Array($confdroid_alloy::params::ay_log_targets, true)
concat { $ay_main_file: file { $ay_main_file:
ensure => present, ensure => file,
owner => 'root', owner => 'root',
group => 'root', group => 'root',
mode => '0644', mode => '0644',
@@ -19,27 +20,8 @@ class confdroid_alloy::main::files (
selrole => object_r, selrole => object_r,
seltype => etc_t, seltype => etc_t,
seluser => system_u, seluser => system_u,
notify => Service[$ay_service],
}
concat::fragment { 'confdroid_alloy_config_header':
target => $ay_main_file,
content => template('confdroid_alloy/config.alloy.erb'), content => template('confdroid_alloy/config.alloy.erb'),
order => '001', notify => Service[$ay_service],
}
if $ay_manage_loki == true {
concat::fragment { 'confdroid_alloy_log_targets_default':
target => $ay_main_file,
content => template('confdroid_alloy/log_targets.alloy.erb'),
order => '010',
}
}
concat::fragment { 'confdroid_alloy_config_tail':
target => $ay_main_file,
content => template('confdroid_alloy/config.alloy.tail.erb'),
order => '999',
} }
# manage logrotate for rsyslog to allow adm group membership # manage logrotate for rsyslog to allow adm group membership

20
manifests/monitoring/log_targets.pp
View File

@@ -1,20 +0,0 @@
## confdroid_alloy::monitoring::log_targets.pp
# Module name: confdroid_alloy
# @summary Adds log file targets to the Alloy configuration.
# @param [Array[String]] targets Paths to log files to scrape.
###############################################################################
define confdroid_alloy::monitoring::log_targets (
Array[String] $targets = [],
) {
if $confdroid_alloy::params::ay_manage_loki == true and $targets != [] {
$log_targets_array = $targets
concat::fragment { "log_targets_${name}":
target => $confdroid_alloy::params::ay_main_file,
content => template('confdroid_alloy/log_targets.alloy.erb'),
order => '020',
}
}
}

23
manifests/monitoring/target.pp
View File

@@ -1,23 +0,0 @@
## confdroid_alloy::monitoring::target.pp
# Module name: confdroid_alloy
# Author: 12ww1160 (12ww1160@puppetsoft.com)
# @summary class manages exports for nagios monitoring
##############################################################################
class confdroid_alloy::monitoring::target (
) inherits confdroid_alloy::params {
if $ay_manage_nagios == true {
@@nagios_service { "check_alloy_${fqdn}":
check_command => "check_nrpe!check_alloy!${ay_procs_allowed}!alloy",
use => 'generic-service',
host_name => $fqdn,
notification_period => '24x7',
service_description => "${fqdn}_check_alloy",
target => $ay_target_service,
owner => 'nagios',
group => 'nagios',
mode => '0640',
contacts => $ay_target_contacts,
}
}
}

28
manifests/params.pp
View File

@@ -8,19 +8,10 @@
# @param [String] ay_loki_userpass the password to logon to loki # @param [String] ay_loki_userpass the password to logon to loki
# @param [Boolean] ay_manage_loki whether to manage log forwarding to loki # @param [Boolean] ay_manage_loki whether to manage log forwarding to loki
# @param [Boolean] ay_manage_prom whether to manage metric forwarding # @param [Boolean] ay_manage_prom whether to manage metric forwarding
# @param [Boolean] ay_manage_ne whether to manage metric forwarding for
# the node exporter (external)
# @param [String] ay_prom_url the url where alloy will send metrics # @param [String] ay_prom_url the url where alloy will send metrics
# @param [Array] ay_log_targets the logging targets # @param [Array] ay_log_targets the logging targets
# @param [Boolean] ay_prom_honor_timestamps whether to honor
# timestamps in prometheus metrics
# @param [Boolean] ay_prom_track_timestamps_staleness whether to track timestamps
# staleness in prometheus metrics
# @param [String] ay_prom_max_shards the maximum number of shards to use for prometheus metrics
# @param [String] ay_prom_max_samples_per_send the maximum number of samples to send
# @param [String] ay_prom_batch_send_deadline the maximum time to wait before sending
# @param [Boolean] ay_manage_nagios whether to manage nagios service exports
# @param [String] ay_target_service the target file for nagios service exports
# @param [Array] ay_target_contacts the contacts for nagios service exports
# @param [String] ay_procs_allowed the allowed number of processes for nagios service exports
# @summary Class contains all parameters for the confdroid_alloy module. # @summary Class contains all parameters for the confdroid_alloy module.
############################################################################## ##############################################################################
class confdroid_alloy::params ( class confdroid_alloy::params (
@@ -38,22 +29,11 @@ class confdroid_alloy::params (
# prometheus # prometheus
Boolean $ay_manage_prom = true, Boolean $ay_manage_prom = true,
String $ay_prom_url = 'https://prometheus.example.net/api/v1/write', String $ay_prom_url = 'https://prometheus.example.net/api/v1/write',
Boolean $ay_prom_honor_timestamps = true,
Boolean $ay_prom_track_timestamps_staleness = true,
String $ay_prom_max_shards = '10',
String $ay_prom_max_samples_per_send = '2000',
String $ay_prom_batch_send_deadline = '5s',
# nagios # node exporter (external)
Boolean $ay_manage_nagios = false, Boolean $ay_manage_ne = false,
String $ay_target_service = '/etc/nagios/conf.d/alloy_service.cfg',
Array $ay_target_contacts = ['nagiosadmin'],
String $ay_procs_allowed = '1:'
) { ) {
# defaults
$fqdn = $facts['networking']['fqdn']
# service # service
$ay_service = 'alloy' $ay_service = 'alloy'

78
templates/config.alloy.erb
View File

@@ -18,4 +18,82 @@ loki.process "alloy" {
// Define file discovery for your logs // Define file discovery for your logs
local.file_match "system_logs" { local.file_match "system_logs" {
path_targets = [ path_targets = [
<% @log_targets_array.each do |target| -%>
{__path__ = "<%= target %>"},
<% end -%> <% end -%>
]
sync_period = "5s"
}
// Scrape the logs from the matched files
loki.source.file "system_logs" {
targets = local.file_match.system_logs.targets
forward_to = [loki.process.syslog.receiver]
}
loki.process "syslog" {
stage.static_labels {
values = {
fqdn = constants.hostname,
service = "linux_logs",
}
}
forward_to = [loki.write.loki.receiver]
}
loki.write "loki" {
endpoint {
url = "<%= @ay_loki_url %>"
basic_auth {
username = "<%= @ay_loki_username %>"
password = "<%= @ay_loki_userpass %>"
}
}
}
<% end -%>
<% if @ay_manage_prom == true -%>
// 1. Exporter (or keep your existing node_exporter binary)
prometheus.exporter.unix "node" {
// optional: disable unused collectors
// disable_collectors = ["ipvs", "btrfs", ...]
}
// 2. Relabel the targets so instance = real hostname
discovery.relabel "node_exporter" {
targets = prometheus.exporter.unix.node.targets
rule {
target_label = "instance"
replacement = constants.hostname
}
rule {
target_label = "job"
replacement = "integrations/node_exporter"
}
}
// 3. Scrape the properly labeled targets
prometheus.scrape "node_exporter" {
targets = discovery.relabel.node_exporter.output
forward_to = [prometheus.remote_write.prometheus.receiver]
scrape_interval = "15s"
honor_timestamps = true
track_timestamps_staleness = true
}
prometheus.remote_write "prometheus" {
external_labels = {
// makes every series from this Alloy unmistakably unique
alloy_instance = constants.hostname,
}
endpoint {
url = "<%= @ay_prom_url %>"
basic_auth {
username = "<%= @ay_loki_username %>"
password = "<%= @ay_loki_userpass %>"
}
}
}
<% end %>

82
templates/config.alloy.tail.erb
View File

@@ -1,82 +0,0 @@
<% if @ay_manage_loki == true -%>
]
sync_period = "5s"
}
// Scrape the logs from the matched files
loki.source.file "system_logs" {
targets = local.file_match.system_logs.targets
forward_to = [loki.process.syslog.receiver]
}
loki.process "syslog" {
stage.static_labels {
values = {
fqdn = constants.hostname,
service = "linux_logs",
}
}
forward_to = [loki.write.loki.receiver]
}
loki.write "loki" {
endpoint {
url = "<%= @ay_loki_url %>"
basic_auth {
username = "<%= @ay_loki_username %>"
password = "<%= @ay_loki_userpass %>"
}
}
}
<% end -%>
<% if @ay_manage_prom == true -%>
// 1. Exporter (or keep your existing node_exporter binary)
prometheus.exporter.unix "node" {
// optional: disable unused collectors
// disable_collectors = ["ipvs", "btrfs", ...]
}
// 2. Relabel the targets so instance = real hostname
discovery.relabel "node_exporter" {
targets = prometheus.exporter.unix.node.targets
rule {
target_label = "instance"
replacement = constants.hostname
}
rule {
target_label = "job"
replacement = "integrations/node_exporter"
}
}
// 3. Scrape the properly labeled targets
prometheus.scrape "node_exporter" {
targets = discovery.relabel.node_exporter.output
forward_to = [prometheus.remote_write.prometheus.receiver]
scrape_interval = "15s"
honor_timestamps = <%= @ay_prom_honor_timestamps %>
track_timestamps_staleness = <%= @ay_prom_track_timestamps_staleness %>
}
prometheus.remote_write "prometheus" {
external_labels = {
// makes every series from this Alloy unmistakably unique
alloy_instance = constants.hostname,
}
endpoint {
url = "<%= @ay_prom_url %>"
basic_auth {
username = "<%= @ay_loki_username %>"
password = "<%= @ay_loki_userpass %>"
}
queue_config {
max_shards = <%= @ay_prom_max_shards %>
max_samples_per_send = <%= @ay_prom_max_samples_per_send %>
batch_send_deadline = "<%= @ay_prom_batch_send_deadline %>"
}
}
}
<% end -%>

3
templates/log_targets.alloy.erb
View File

@@ -1,3 +0,0 @@
<% @log_targets_array.each do |target| -%>
{__path__ = "<%= target %>"},
<% end -%>