This commit is contained in:
gardar 2023-12-12 13:19:34 +00:00
parent f8482fb9d2
commit c837a7fcff
17 changed files with 918 additions and 60 deletions

View file

@ -90,10 +90,12 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role Deploy and manage Prometheus blackbox exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="chrony_exporter_role.html">prometheus.prometheus.chrony_exporter role Prometheus Chrony Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="memcached_exporter_role.html">prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role Prometheus Node Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role Installs and configures prometheus</a></li>
<li class="toctree-l1"><a class="reference internal" href="pushgateway_role.html">prometheus.prometheus.pushgateway role Prometheus Pushgateway</a></li>
<li class="toctree-l1"><a class="reference internal" href="smartctl_exporter_role.html">prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="smokeping_prober_role.html">prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober</a></li>
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role Prometheus SNMP exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role Prometheus Systemd Exporter</a></li>
@ -129,7 +131,7 @@
<h1>prometheus.prometheus.alertmanager role Prometheus Alertmanager service<a class="headerlink" href="#prometheus-prometheus-alertmanager-role-prometheus-alertmanager-service" title="Link to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.6.0).</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.9.1).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
@ -363,7 +365,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Alertmanager package version. Also accepts `latest` as parameter.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;0.25.0&quot;</span></code></p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;0.26.0&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
@ -390,10 +392,10 @@ To check whether it is installed, run <code class="code docutils literal notrans
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--alertmanager_web_listen_address"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-alertmanager-role-parameter-main-alertmanager-web-listen-address"><strong>alertmanager_web_listen_address</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_web_listen_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
<a class="ansibleOptionLink" href="#parameter-main--alertmanager_web_listen_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Address/addresses on which alertmanager will be listening</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">[&quot;0.0.0.0:9093&quot;]</span></code></p>
<td><div class="ansible-option-cell"><p>Address on which alertmanager will be listening</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;0.0.0.0:9093&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">

View file

@ -90,10 +90,12 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="chrony_exporter_role.html">prometheus.prometheus.chrony_exporter role Prometheus Chrony Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="memcached_exporter_role.html">prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role Prometheus Node Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role Installs and configures prometheus</a></li>
<li class="toctree-l1"><a class="reference internal" href="pushgateway_role.html">prometheus.prometheus.pushgateway role Prometheus Pushgateway</a></li>
<li class="toctree-l1"><a class="reference internal" href="smartctl_exporter_role.html">prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="smokeping_prober_role.html">prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober</a></li>
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role Prometheus SNMP exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role Prometheus Systemd Exporter</a></li>
@ -129,7 +131,7 @@
<h1>prometheus.prometheus.blackbox_exporter role Deploy and manage Prometheus blackbox exporter<a class="headerlink" href="#prometheus-prometheus-blackbox-exporter-role-deploy-and-manage-prometheus-blackbox-exporter" title="Link to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.6.0).</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.9.1).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
@ -164,6 +166,24 @@ To check whether it is installed, run <code class="code docutils literal notrans
</thead>
<tbody>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--blackbox_exporter_binary_install_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-binary-install-dir"><strong>blackbox_exporter_binary_install_dir</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--blackbox_exporter_binary_install_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
<p>Directory to install blackbox_exporter binary</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;/usr/local/bin&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--blackbox_exporter_binary_local_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-binary-local-dir"><strong>blackbox_exporter_binary_local_dir</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--blackbox_exporter_binary_local_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Enables the use of local packages instead of those distributed on github.</p>
<p>The parameter may be set to a directory where the <code class="docutils literal notranslate"><span class="pre">blackbox_exporter</span></code> binary is stored on the host where ansible is run.</p>
<p>This overrides the <em>blackbox_exporter_version</em> parameter</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--blackbox_exporter_binary_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-binary-url"><strong>blackbox_exporter_binary_url</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--blackbox_exporter_binary_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@ -172,13 +192,21 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--blackbox_exporter_checksums_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-checksums-url"><strong>blackbox_exporter_checksums_url</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--blackbox_exporter_checksums_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>URL of the blackbox exporter checksums file</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;https://github.com/{{</span> <span class="pre">_blackbox_exporter_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">blackbox_exporter_version</span> <span class="pre">}}/sha256sums.txt&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--blackbox_exporter_cli_flags"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-cli-flags"><strong>blackbox_exporter_cli_flags</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--blackbox_exporter_cli_flags" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Additional configuration flags passed to blackbox exporter binary at startup</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--blackbox_exporter_config_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-config-dir"><strong>blackbox_exporter_config_dir</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--blackbox_exporter_config_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@ -186,7 +214,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;/etc&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--blackbox_exporter_configuration_modules"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-configuration-modules"><strong>blackbox_exporter_configuration_modules</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--blackbox_exporter_configuration_modules" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
@ -194,7 +222,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">{&quot;http_2xx&quot;:</span> <span class="pre">{&quot;http&quot;:</span> <span class="pre">{&quot;method&quot;:</span> <span class="pre">&quot;GET&quot;,</span> <span class="pre">&quot;valid_status_codes&quot;:</span> <span class="pre">[]},</span> <span class="pre">&quot;prober&quot;:</span> <span class="pre">&quot;http&quot;,</span> <span class="pre">&quot;timeout&quot;:</span> <span class="pre">&quot;5s&quot;}}</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--blackbox_exporter_group"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-group"><strong>blackbox_exporter_group</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--blackbox_exporter_group" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@ -202,7 +230,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;blackbox-exp&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--blackbox_exporter_skip_install"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-skip-install"><strong>blackbox_exporter_skip_install</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--blackbox_exporter_skip_install" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td>
@ -214,7 +242,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</ul>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--blackbox_exporter_user"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-user"><strong>blackbox_exporter_user</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--blackbox_exporter_user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@ -222,15 +250,15 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;blackbox-exp&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--blackbox_exporter_version"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-version"><strong>blackbox_exporter_version</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--blackbox_exporter_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Blackbox exporter package version</p>
<td><div class="ansible-option-cell"><p>Blackbox exporter package version. Also accepts latest as parameter.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;0.24.0&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--blackbox_exporter_web_listen_address"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-web-listen-address"><strong>blackbox_exporter_web_listen_address</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--blackbox_exporter_web_listen_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>

View file

@ -24,7 +24,7 @@
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter" href="mysqld_exporter_role.html" />
<link rel="next" title="prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter" href="memcached_exporter_role.html" />
<link rel="prev" title="prometheus.prometheus.blackbox_exporter role Deploy and manage Prometheus blackbox exporter" href="blackbox_exporter_role.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
@ -90,10 +90,12 @@
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="memcached_exporter_role.html">prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role Prometheus Node Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role Installs and configures prometheus</a></li>
<li class="toctree-l1"><a class="reference internal" href="pushgateway_role.html">prometheus.prometheus.pushgateway role Prometheus Pushgateway</a></li>
<li class="toctree-l1"><a class="reference internal" href="smartctl_exporter_role.html">prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="smokeping_prober_role.html">prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober</a></li>
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role Prometheus SNMP exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role Prometheus Systemd Exporter</a></li>
@ -129,7 +131,7 @@
<h1>prometheus.prometheus.chrony_exporter role Prometheus Chrony Exporter<a class="headerlink" href="#prometheus-prometheus-chrony-exporter-role-prometheus-chrony-exporter" title="Link to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.6.0).</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.9.1).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
@ -318,7 +320,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="blackbox_exporter_role.html" class="btn btn-neutral float-left" title="prometheus.prometheus.blackbox_exporter role Deploy and manage Prometheus blackbox exporter" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="mysqld_exporter_role.html" class="btn btn-neutral float-right" title="prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="memcached_exporter_role.html" class="btn btn-neutral float-right" title="prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>

View file

@ -77,10 +77,12 @@
<li class="toctree-l1"><a class="reference internal" href="alertmanager_role.html">prometheus.prometheus.alertmanager role Prometheus Alertmanager service</a></li>
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role Deploy and manage Prometheus blackbox exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="chrony_exporter_role.html">prometheus.prometheus.chrony_exporter role Prometheus Chrony Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="memcached_exporter_role.html">prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role Prometheus Node Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role Installs and configures prometheus</a></li>
<li class="toctree-l1"><a class="reference internal" href="pushgateway_role.html">prometheus.prometheus.pushgateway role Prometheus Pushgateway</a></li>
<li class="toctree-l1"><a class="reference internal" href="smartctl_exporter_role.html">prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="smokeping_prober_role.html">prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober</a></li>
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role Prometheus SNMP exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role Prometheus Systemd Exporter</a></li>

View file

@ -78,10 +78,12 @@
<li class="toctree-l1"><a class="reference internal" href="alertmanager_role.html">prometheus.prometheus.alertmanager role Prometheus Alertmanager service</a></li>
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role Deploy and manage Prometheus blackbox exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="chrony_exporter_role.html">prometheus.prometheus.chrony_exporter role Prometheus Chrony Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="memcached_exporter_role.html">prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role Prometheus Node Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role Installs and configures prometheus</a></li>
<li class="toctree-l1"><a class="reference internal" href="pushgateway_role.html">prometheus.prometheus.pushgateway role Prometheus Pushgateway</a></li>
<li class="toctree-l1"><a class="reference internal" href="smartctl_exporter_role.html">prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="smokeping_prober_role.html">prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober</a></li>
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role Prometheus SNMP exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role Prometheus Systemd Exporter</a></li>
@ -115,7 +117,7 @@
<section id="prometheus-prometheus">
<span id="plugins-in-prometheus-prometheus"></span><h1>Prometheus.Prometheus<a class="headerlink" href="#prometheus-prometheus" title="Link to this heading"></a></h1>
<p>Collection version 0.6.0</p>
<p>Collection version 0.9.1</p>
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#description" id="id1">Description</a></p></li>
@ -135,7 +137,7 @@
<p><strong>Supported ansible-core versions:</strong></p>
<ul class="simple">
<li><p>2.9.0 or newer</p></li>
<li><p>2.15.0 or older</p></li>
<li><p>older than 2.17.0</p></li>
</ul>
<ul class="ansible-links">
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/prometheus-community/ansible/issues" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
@ -156,10 +158,12 @@
<li><p><a class="reference internal" href="alertmanager_role.html#ansible-collections-prometheus-prometheus-alertmanager-role"><span class="std std-ref">alertmanager role</span></a> Prometheus Alertmanager service</p></li>
<li><p><a class="reference internal" href="blackbox_exporter_role.html#ansible-collections-prometheus-prometheus-blackbox-exporter-role"><span class="std std-ref">blackbox_exporter role</span></a> Deploy and manage Prometheus blackbox exporter</p></li>
<li><p><a class="reference internal" href="chrony_exporter_role.html#ansible-collections-prometheus-prometheus-chrony-exporter-role"><span class="std std-ref">chrony_exporter role</span></a> Prometheus Chrony Exporter</p></li>
<li><p><a class="reference internal" href="memcached_exporter_role.html#ansible-collections-prometheus-prometheus-memcached-exporter-role"><span class="std std-ref">memcached_exporter role</span></a> Prometheus memcached_exporter</p></li>
<li><p><a class="reference internal" href="mysqld_exporter_role.html#ansible-collections-prometheus-prometheus-mysqld-exporter-role"><span class="std std-ref">mysqld_exporter role</span></a> Prometheus MySQLd Exporter</p></li>
<li><p><a class="reference internal" href="node_exporter_role.html#ansible-collections-prometheus-prometheus-node-exporter-role"><span class="std std-ref">node_exporter role</span></a> Prometheus Node Exporter</p></li>
<li><p><a class="reference internal" href="prometheus_role.html#ansible-collections-prometheus-prometheus-prometheus-role"><span class="std std-ref">prometheus role</span></a> Installs and configures prometheus</p></li>
<li><p><a class="reference internal" href="pushgateway_role.html#ansible-collections-prometheus-prometheus-pushgateway-role"><span class="std std-ref">pushgateway role</span></a> Prometheus Pushgateway</p></li>
<li><p><a class="reference internal" href="smartctl_exporter_role.html#ansible-collections-prometheus-prometheus-smartctl-exporter-role"><span class="std std-ref">smartctl_exporter role</span></a> Prometheus Smartctl Exporter</p></li>
<li><p><a class="reference internal" href="smokeping_prober_role.html#ansible-collections-prometheus-prometheus-smokeping-prober-role"><span class="std std-ref">smokeping_prober role</span></a> Prometheus Smokeping Prober</p></li>
<li><p><a class="reference internal" href="snmp_exporter_role.html#ansible-collections-prometheus-prometheus-snmp-exporter-role"><span class="std std-ref">snmp_exporter role</span></a> Prometheus SNMP exporter</p></li>
<li><p><a class="reference internal" href="systemd_exporter_role.html#ansible-collections-prometheus-prometheus-systemd-exporter-role"><span class="std std-ref">systemd_exporter role</span></a> Prometheus Systemd Exporter</p></li>

View file

@ -0,0 +1,354 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.6.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter &mdash; Prometheus.Prometheus Collection documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=c5b67dd2" />
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=7f41d439"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter" href="mysqld_exporter_role.html" />
<link rel="prev" title="prometheus.prometheus.chrony_exporter role Prometheus Chrony Exporter" href="chrony_exporter_role.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
</head>
<body class="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
<div class="DocSite-globalNav ansibleNav">
<ul>
<li><a href="https://www.ansible.com/blog" target="_blank">Blog</a></li>
<li><a href="https://forum.ansible.com/" target="_blank">Ansible community forum</a></li>
<li><a href="https://docs.ansible.com/" target="_blank">Documentation</a></li>
</ul>
</div>
<a class="DocSite-nav" href="https://prometheus-community.github.io/ansible/branch/main/" style="padding-bottom: 30px;">
<img class="DocSiteNav-logo"
src="_static/images/Ansible-Mark-RGB_White.png"
alt="Ansible Logo">
<div class="DocSiteNav-title">Prometheus.Prometheus Collection Docs</div>
</a>
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
Prometheus.Prometheus Collection
</a><!--- Based on https://github.com/rtfd/sphinx_rtd_theme/pull/438/files -->
<div class="version">
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<label class="sr-only" for="q">Search docs:</label>
<input type="text" class="st-default-search-input" id="q" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="alertmanager_role.html">prometheus.prometheus.alertmanager role Prometheus Alertmanager service</a></li>
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role Deploy and manage Prometheus blackbox exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="chrony_exporter_role.html">prometheus.prometheus.chrony_exporter role Prometheus Chrony Exporter</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#entry-point-main-prometheus-memcached-exporter">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> Prometheus memcached_exporter</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li>
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a></li>
<li class="toctree-l3"><a class="reference internal" href="#authors">Authors</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#collection-links">Collection links</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role Prometheus Node Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role Installs and configures prometheus</a></li>
<li class="toctree-l1"><a class="reference internal" href="pushgateway_role.html">prometheus.prometheus.pushgateway role Prometheus Pushgateway</a></li>
<li class="toctree-l1"><a class="reference internal" href="smartctl_exporter_role.html">prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="smokeping_prober_role.html">prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober</a></li>
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role Prometheus SNMP exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role Prometheus Systemd Exporter</a></li>
</ul>
<!-- extra nav elements for Ansible beyond RTD Sphinx Theme -->
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Prometheus.Prometheus Collection</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<span class="target" id="ansible-collections-prometheus-prometheus-memcached-exporter-role"></span><section id="prometheus-prometheus-memcached-exporter-role-prometheus-memcached-exporter">
<h1>prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter<a class="headerlink" href="#prometheus-prometheus-memcached-exporter-role-prometheus-memcached-exporter" title="Link to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.9.1).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">prometheus.prometheus.memcached_exporter</span></code>.</p>
</div>
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#entry-point-main-prometheus-memcached-exporter" id="id1">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> Prometheus memcached_exporter</a></p>
<ul>
<li><p><a class="reference internal" href="#synopsis" id="id2">Synopsis</a></p></li>
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
<li><p><a class="reference internal" href="#authors" id="id4">Authors</a></p></li>
</ul>
</li>
</ul>
</nav>
<section id="entry-point-main-prometheus-memcached-exporter">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> Prometheus memcached_exporter</a><a class="headerlink" href="#entry-point-main-prometheus-memcached-exporter" title="Link to this heading"></a></h2>
<section id="synopsis">
<h3><a class="toc-backref" href="#id2" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Deploy prometheus <a class="reference external" href="https://github.com/prometheus/memcached_exporter">memcached exporter</a> using ansible</p></li>
</ul>
</section>
<section id="parameters">
<h3><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link to this heading"></a></h3>
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
<thead>
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
<th class="head"><p>Comments</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--memcached_exporter_basic_auth_users"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-memcached-exporter-role-parameter-main-memcached-exporter-basic-auth-users"><strong>memcached_exporter_basic_auth_users</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--memcached_exporter_basic_auth_users" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--memcached_exporter_binary_install_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-memcached-exporter-role-parameter-main-memcached-exporter-binary-install-dir"><strong>memcached_exporter_binary_install_dir</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--memcached_exporter_binary_install_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
<p>Directory to install memcached_exporter binary</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;/usr/local/bin&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--memcached_exporter_binary_local_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-memcached-exporter-role-parameter-main-memcached-exporter-binary-local-dir"><strong>memcached_exporter_binary_local_dir</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--memcached_exporter_binary_local_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Enables the use of local packages instead of those distributed on github.</p>
<p>The parameter may be set to a directory where the <code class="docutils literal notranslate"><span class="pre">memcached_exporter</span></code> binary is stored on the host where ansible is run.</p>
<p>This overrides the <em>memcached_exporter_version</em> parameter</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--memcached_exporter_binary_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-memcached-exporter-role-parameter-main-memcached-exporter-binary-url"><strong>memcached_exporter_binary_url</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--memcached_exporter_binary_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>URL of the memcached_exporter binaries .tar.gz file</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;https://github.com/{{</span> <span class="pre">_memcached_exporter_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">memcached_exporter_version</span> <span class="pre">}}/memcached_exporter-{{</span> <span class="pre">memcached_exporter_version</span> <span class="pre">}}.linux-{{</span> <span class="pre">go_arch</span> <span class="pre">}}.tar.gz&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--memcached_exporter_checksums_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-memcached-exporter-role-parameter-main-memcached-exporter-checksums-url"><strong>memcached_exporter_checksums_url</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--memcached_exporter_checksums_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>URL of the memcached_exporter checksums file</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;https://github.com/{{</span> <span class="pre">_memcached_exporter_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">memcached_exporter_version</span> <span class="pre">}}/sha256sums.txt&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--memcached_exporter_http_server_config"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-memcached-exporter-role-parameter-main-memcached-exporter-http-server-config"><strong>memcached_exporter_http_server_config</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--memcached_exporter_http_server_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Config for HTTP/2 support.</p>
<p>Keys and values are the same as in <a class="reference external" href="https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md">memcached_exporter docs</a>.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--memcached_exporter_log_format"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-memcached-exporter-role-parameter-main-memcached-exporter-log-format"><strong>memcached_exporter_log_format</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--memcached_exporter_log_format" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Output format of log messages. One of: [logfmt, json]</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;logfmt&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--memcached_exporter_log_level"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-memcached-exporter-role-parameter-main-memcached-exporter-log-level"><strong>memcached_exporter_log_level</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--memcached_exporter_log_level" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Only log messages with the given severity or above. One of: [debug, info, warn, error]</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;info&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--memcached_exporter_memcached_pid_file"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-memcached-exporter-role-parameter-main-memcached-exporter-memcached-pid-file"><strong>memcached_exporter_memcached_pid_file</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--memcached_exporter_memcached_pid_file" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>The path to the memcached PID file for process monitoring</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--memcached_exporter_skip_install"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-memcached-exporter-role-parameter-main-memcached-exporter-skip-install"><strong>memcached_exporter_skip_install</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--memcached_exporter_skip_install" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>memcached_exporter installation tasks gets skipped when set to true.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
</ul>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--memcached_exporter_system_group"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-memcached-exporter-role-parameter-main-memcached-exporter-system-group"><strong>memcached_exporter_system_group</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--memcached_exporter_system_group" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
<p>System group for memcached_exporter</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;memcached-exp&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--memcached_exporter_system_user"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-memcached-exporter-role-parameter-main-memcached-exporter-system-user"><strong>memcached_exporter_system_user</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--memcached_exporter_system_user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
<p>memcached_exporter user</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;memcached-exp&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--memcached_exporter_tls_server_config"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-memcached-exporter-role-parameter-main-memcached-exporter-tls-server-config"><strong>memcached_exporter_tls_server_config</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--memcached_exporter_tls_server_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Configuration for TLS authentication.</p>
<p>Keys and values are the same as in <a class="reference external" href="https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md">memcached_exporter docs</a>.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--memcached_exporter_version"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-memcached-exporter-role-parameter-main-memcached-exporter-version"><strong>memcached_exporter_version</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--memcached_exporter_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>memcached_exporter package version. Also accepts latest as parameter.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;0.14.1&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--memcached_exporter_web_listen_address"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-memcached-exporter-role-parameter-main-memcached-exporter-web-listen-address"><strong>memcached_exporter_web_listen_address</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--memcached_exporter_web_listen_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Address on which memcached exporter will listen</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;0.0.0.0:9150&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--memcached_exporter_web_telemetry_path"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-memcached-exporter-role-parameter-main-memcached-exporter-web-telemetry-path"><strong>memcached_exporter_web_telemetry_path</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--memcached_exporter_web_telemetry_path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Path under which to expose metrics</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;/metrics&quot;</span></code></p>
</div></td>
</tr>
</tbody>
</table>
</section>
<section id="authors">
<h3><a class="toc-backref" href="#id4" role="doc-backlink">Authors</a><a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Prometheus Community</p></li>
</ul>
<section id="collection-links">
<h4>Collection links<a class="headerlink" href="#collection-links" title="Link to this heading"></a></h4>
<ul class="ansible-links">
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/prometheus-community/ansible/issues" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
<li><span><a aria-role="button" class="ansible-link reference external" href="https://prometheus.io" rel="noopener external" target="_blank">Homepage</a></span></li>
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/prometheus-community/ansible" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
</ul>
</section>
</section>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="chrony_exporter_role.html" class="btn btn-neutral float-left" title="prometheus.prometheus.chrony_exporter role Prometheus Chrony Exporter" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="mysqld_exporter_role.html" class="btn btn-neutral float-right" title="prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright Prometheus.Prometheus Contributors.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script><!-- extra footer elements for Ansible beyond RTD Sphinx Theme -->
</body>
</html>

View file

@ -25,7 +25,7 @@
<script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="prometheus.prometheus.node_exporter role Prometheus Node Exporter" href="node_exporter_role.html" />
<link rel="prev" title="prometheus.prometheus.chrony_exporter role Prometheus Chrony Exporter" href="chrony_exporter_role.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
<link rel="prev" title="prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter" href="memcached_exporter_role.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
@ -79,6 +79,7 @@
<li class="toctree-l1"><a class="reference internal" href="alertmanager_role.html">prometheus.prometheus.alertmanager role Prometheus Alertmanager service</a></li>
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role Deploy and manage Prometheus blackbox exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="chrony_exporter_role.html">prometheus.prometheus.chrony_exporter role Prometheus Chrony Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="memcached_exporter_role.html">prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#entry-point-main-prometheus-mysqld-exporter">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> Prometheus MySQLd Exporter</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li>
@ -94,6 +95,7 @@
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role Prometheus Node Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role Installs and configures prometheus</a></li>
<li class="toctree-l1"><a class="reference internal" href="pushgateway_role.html">prometheus.prometheus.pushgateway role Prometheus Pushgateway</a></li>
<li class="toctree-l1"><a class="reference internal" href="smartctl_exporter_role.html">prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="smokeping_prober_role.html">prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober</a></li>
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role Prometheus SNMP exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role Prometheus Systemd Exporter</a></li>
@ -129,7 +131,7 @@
<h1>prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter<a class="headerlink" href="#prometheus-prometheus-mysqld-exporter-role-prometheus-mysqld-exporter" title="Link to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.6.0).</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.9.1).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
@ -371,7 +373,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="chrony_exporter_role.html" class="btn btn-neutral float-left" title="prometheus.prometheus.chrony_exporter role Prometheus Chrony Exporter" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="memcached_exporter_role.html" class="btn btn-neutral float-left" title="prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="node_exporter_role.html" class="btn btn-neutral float-right" title="prometheus.prometheus.node_exporter role Prometheus Node Exporter" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

View file

@ -79,6 +79,7 @@
<li class="toctree-l1"><a class="reference internal" href="alertmanager_role.html">prometheus.prometheus.alertmanager role Prometheus Alertmanager service</a></li>
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role Deploy and manage Prometheus blackbox exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="chrony_exporter_role.html">prometheus.prometheus.chrony_exporter role Prometheus Chrony Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="memcached_exporter_role.html">prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">prometheus.prometheus.node_exporter role Prometheus Node Exporter</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#entry-point-main-prometheus-node-exporter">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> Prometheus Node Exporter</a><ul>
@ -94,6 +95,7 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role Installs and configures prometheus</a></li>
<li class="toctree-l1"><a class="reference internal" href="pushgateway_role.html">prometheus.prometheus.pushgateway role Prometheus Pushgateway</a></li>
<li class="toctree-l1"><a class="reference internal" href="smartctl_exporter_role.html">prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="smokeping_prober_role.html">prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober</a></li>
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role Prometheus SNMP exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role Prometheus Systemd Exporter</a></li>
@ -129,7 +131,7 @@
<h1>prometheus.prometheus.node_exporter role Prometheus Node Exporter<a class="headerlink" href="#prometheus-prometheus-node-exporter-role-prometheus-node-exporter" title="Link to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.6.0).</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.9.1).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
@ -282,7 +284,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<a class="ansibleOptionLink" href="#parameter-main--node_exporter_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Node exporter package version. Also accepts latest as parameter.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;1.6.1&quot;</span></code></p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;1.7.0&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">

Binary file not shown.

View file

@ -79,6 +79,7 @@
<li class="toctree-l1"><a class="reference internal" href="alertmanager_role.html">prometheus.prometheus.alertmanager role Prometheus Alertmanager service</a></li>
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role Deploy and manage Prometheus blackbox exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="chrony_exporter_role.html">prometheus.prometheus.chrony_exporter role Prometheus Chrony Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="memcached_exporter_role.html">prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role Prometheus Node Exporter</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">prometheus.prometheus.prometheus role Installs and configures prometheus</a><ul>
@ -94,6 +95,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pushgateway_role.html">prometheus.prometheus.pushgateway role Prometheus Pushgateway</a></li>
<li class="toctree-l1"><a class="reference internal" href="smartctl_exporter_role.html">prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="smokeping_prober_role.html">prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober</a></li>
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role Prometheus SNMP exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role Prometheus Systemd Exporter</a></li>
@ -129,7 +131,7 @@
<h1>prometheus.prometheus.prometheus role Installs and configures prometheus<a class="headerlink" href="#prometheus-prometheus-prometheus-role-installs-and-configures-prometheus" title="Link to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.6.0).</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.9.1).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
@ -164,6 +166,19 @@ To check whether it is installed, run <code class="code docutils literal notrans
</thead>
<tbody>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_agent_mode"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-agent-mode"><strong>prometheus_agent_mode</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_agent_mode" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>The Agent mode optimizes Prometheus for the remote write use case. It disables querying, alerting, and local storage, and replaces it with a customized TSDB WAL. <a class="reference external" href="https://prometheus.io/docs/prometheus/latest/feature_flags/#prometheus-agent">Everything</a> else stays the same.</p>
<p>This feature is available starting from Prometheus v2.32.0.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
</ul>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_alert_relabel_configs"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-alert-relabel-configs"><strong>prometheus_alert_relabel_configs</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_alert_relabel_configs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
</div></td>
@ -171,7 +186,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>It is compatible with the official <a class="reference external" href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs">alert_relabel_configs</a></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_alert_rules"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-alert-rules"><strong>prometheus_alert_rules</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_alert_rules" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span></p>
</div></td>
@ -180,7 +195,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>Please see default values in role defaults/main.yml</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_alert_rules_files"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-alert-rules-files"><strong>prometheus_alert_rules_files</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_alert_rules_files" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
</div></td>
@ -189,7 +204,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">[&quot;prometheus/rules/*.rules&quot;]</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_alertmanager_config"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-alertmanager-config"><strong>prometheus_alertmanager_config</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_alertmanager_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
</div></td>
@ -197,7 +212,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>It is compatible with the official <a class="reference external" href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config">alertmanager_config</a></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_binary_local_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-binary-local-dir"><strong>prometheus_binary_local_dir</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_binary_local_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@ -206,7 +221,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>This overrides <em>prometheus_version</em> parameter</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_binary_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-binary-url"><strong>prometheus_binary_url</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_binary_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@ -214,7 +229,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;https://github.com/{{</span> <span class="pre">_prometheus_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">prometheus_version</span> <span class="pre">}}/</span> <span class="pre">prometheus-{{</span> <span class="pre">prometheus_version</span> <span class="pre">}}.linux-{{</span> <span class="pre">go_arch</span> <span class="pre">}}.tar.gz&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_checksums_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-checksums-url"><strong>prometheus_checksums_url</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_checksums_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@ -222,7 +237,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;https://github.com/{{</span> <span class="pre">_prometheus_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">prometheus_version</span> <span class="pre">}}/sha256sums.txt&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_config_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-config-dir"><strong>prometheus_config_dir</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_config_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@ -230,7 +245,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;/etc/prometheus&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_config_file"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-config-file"><strong>prometheus_config_file</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_config_file" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@ -238,7 +253,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;prometheus.yml.j2&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_config_flags_extra"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-config-flags-extra"><strong>prometheus_config_flags_extra</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_config_flags_extra" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
@ -246,7 +261,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>Example: prometheus_config_flags_extra: { storage.tsdb.retention: 15d, alertmanager.timeout: 10s }</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_db_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-db-dir"><strong>prometheus_db_dir</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_db_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@ -254,7 +269,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;/var/lib/prometheus&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_external_labels"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-external-labels"><strong>prometheus_external_labels</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_external_labels" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
@ -262,7 +277,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">{&quot;environment&quot;:</span> <span class="pre">&quot;{{</span> <span class="pre">ansible_fqdn</span> <span class="pre">|</span> <span class="pre">default(ansible_host)</span> <span class="pre">|</span> <span class="pre">default(inventory_hostname)</span> <span class="pre">}}&quot;}</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_global"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-global"><strong>prometheus_global</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_global" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
@ -270,7 +285,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">{&quot;evaluation_interval&quot;:</span> <span class="pre">&quot;15s&quot;,</span> <span class="pre">&quot;scrape_interval&quot;:</span> <span class="pre">&quot;60s&quot;,</span> <span class="pre">&quot;scrape_timeout&quot;:</span> <span class="pre">&quot;15s&quot;}</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_metrics_path"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-metrics-path"><strong>prometheus_metrics_path</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_metrics_path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@ -278,28 +293,28 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;/{{</span> <span class="pre">(prometheus_web_external_url</span> <span class="pre">+</span> <span class="pre">'/metrics')</span> <span class="pre">|</span> <span class="pre">regex_replace('^(.*://)?(.*?)/')</span> <span class="pre">}}&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_read_only_dirs"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-read-only-dirs"><strong>prometheus_read_only_dirs</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_read_only_dirs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Additional paths that Prometheus is allowed to read (useful for SSL certs outside of the config directory)</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_remote_read"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-remote-read"><strong>prometheus_remote_read</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_remote_read" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Remote read. It is compatible with the <a class="reference external" href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_read">official configuration</a></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_remote_write"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-remote-write"><strong>prometheus_remote_write</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_remote_write" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Remote write. Compatible with the <a class="reference external" href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write">official configuration</a></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_scrape_configs"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-scrape-configs"><strong>prometheus_scrape_configs</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_scrape_configs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span></p>
</div></td>
@ -307,7 +322,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">[{&quot;job_name&quot;:</span> <span class="pre">&quot;prometheus&quot;,</span> <span class="pre">&quot;metrics_path&quot;:</span> <span class="pre">&quot;{{</span> <span class="pre">prometheus_metrics_path</span> <span class="pre">}}&quot;,</span> <span class="pre">&quot;static_configs&quot;:</span> <span class="pre">[{&quot;targets&quot;:</span> <span class="pre">[&quot;{{</span> <span class="pre">ansible_fqdn</span> <span class="pre">|</span> <span class="pre">default(ansible_host)</span> <span class="pre">|</span> <span class="pre">default('localhost')</span> <span class="pre">}}:9090&quot;]}]},</span> <span class="pre">{&quot;file_sd_configs&quot;:</span> <span class="pre">[{&quot;files&quot;:</span> <span class="pre">[&quot;{{</span> <span class="pre">prometheus_config_dir</span> <span class="pre">}}/file_sd/node.yml&quot;]}],</span> <span class="pre">&quot;job_name&quot;:</span> <span class="pre">&quot;node&quot;}]</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_skip_install"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-skip-install"><strong>prometheus_skip_install</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_skip_install" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td>
@ -319,7 +334,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</ul>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_static_targets_files"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-static-targets-files"><strong>prometheus_static_targets_files</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_static_targets_files" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
</div></td>
@ -327,6 +342,14 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">[&quot;prometheus/targets/*.yml&quot;,</span> <span class="pre">&quot;prometheus/targets/*.json&quot;]</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_stop_timeout"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-stop-timeout"><strong>prometheus_stop_timeout</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_stop_timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>How long to wait for Prometheus to shutdown. This is passed as a systemd TimeoutStopSec time spec.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;600s&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--prometheus_storage_retention"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-prometheus-role-parameter-main-prometheus-storage-retention"><strong>prometheus_storage_retention</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--prometheus_storage_retention" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
@ -358,7 +381,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-cell"><p>Prometheus package version. Also accepts <code class="docutils literal notranslate"><span class="pre">latest</span></code> as parameter.</p>
<p>Only prometheus 2.x is supported</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;2.46.0&quot;</span></code></p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;2.48.1&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">

View file

@ -24,7 +24,7 @@
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober" href="smokeping_prober_role.html" />
<link rel="next" title="prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter" href="smartctl_exporter_role.html" />
<link rel="prev" title="prometheus.prometheus.prometheus role Installs and configures prometheus" href="prometheus_role.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
@ -79,6 +79,7 @@
<li class="toctree-l1"><a class="reference internal" href="alertmanager_role.html">prometheus.prometheus.alertmanager role Prometheus Alertmanager service</a></li>
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role Deploy and manage Prometheus blackbox exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="chrony_exporter_role.html">prometheus.prometheus.chrony_exporter role Prometheus Chrony Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="memcached_exporter_role.html">prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role Prometheus Node Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role Installs and configures prometheus</a></li>
@ -94,6 +95,7 @@
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="smartctl_exporter_role.html">prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="smokeping_prober_role.html">prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober</a></li>
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role Prometheus SNMP exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role Prometheus Systemd Exporter</a></li>
@ -129,7 +131,7 @@
<h1>prometheus.prometheus.pushgateway role Prometheus Pushgateway<a class="headerlink" href="#prometheus-prometheus-pushgateway-role-prometheus-pushgateway" title="Link to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.6.0).</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.9.1).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
@ -255,7 +257,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<a class="ansibleOptionLink" href="#parameter-main--pushgateway_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Pushgateway package version. Also accepts latest as parameter.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;1.1.2&quot;</span></code></p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;1.6.2&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
@ -301,7 +303,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="prometheus_role.html" class="btn btn-neutral float-left" title="prometheus.prometheus.prometheus role Installs and configures prometheus" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="smokeping_prober_role.html" class="btn btn-neutral float-right" title="prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="smartctl_exporter_role.html" class="btn btn-neutral float-right" title="prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>

View file

@ -78,10 +78,12 @@
<li class="toctree-l1"><a class="reference internal" href="alertmanager_role.html">prometheus.prometheus.alertmanager role Prometheus Alertmanager service</a></li>
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role Deploy and manage Prometheus blackbox exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="chrony_exporter_role.html">prometheus.prometheus.chrony_exporter role Prometheus Chrony Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="memcached_exporter_role.html">prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role Prometheus Node Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role Installs and configures prometheus</a></li>
<li class="toctree-l1"><a class="reference internal" href="pushgateway_role.html">prometheus.prometheus.pushgateway role Prometheus Pushgateway</a></li>
<li class="toctree-l1"><a class="reference internal" href="smartctl_exporter_role.html">prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="smokeping_prober_role.html">prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober</a></li>
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role Prometheus SNMP exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role Prometheus Systemd Exporter</a></li>

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,396 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.6.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter &mdash; Prometheus.Prometheus Collection documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
<link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=c5b67dd2" />
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=7f41d439"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober" href="smokeping_prober_role.html" />
<link rel="prev" title="prometheus.prometheus.pushgateway role Prometheus Pushgateway" href="pushgateway_role.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
</head>
<body class="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
<div class="DocSite-globalNav ansibleNav">
<ul>
<li><a href="https://www.ansible.com/blog" target="_blank">Blog</a></li>
<li><a href="https://forum.ansible.com/" target="_blank">Ansible community forum</a></li>
<li><a href="https://docs.ansible.com/" target="_blank">Documentation</a></li>
</ul>
</div>
<a class="DocSite-nav" href="https://prometheus-community.github.io/ansible/branch/main/" style="padding-bottom: 30px;">
<img class="DocSiteNav-logo"
src="_static/images/Ansible-Mark-RGB_White.png"
alt="Ansible Logo">
<div class="DocSiteNav-title">Prometheus.Prometheus Collection Docs</div>
</a>
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
Prometheus.Prometheus Collection
</a><!--- Based on https://github.com/rtfd/sphinx_rtd_theme/pull/438/files -->
<div class="version">
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<label class="sr-only" for="q">Search docs:</label>
<input type="text" class="st-default-search-input" id="q" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="alertmanager_role.html">prometheus.prometheus.alertmanager role Prometheus Alertmanager service</a></li>
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role Deploy and manage Prometheus blackbox exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="chrony_exporter_role.html">prometheus.prometheus.chrony_exporter role Prometheus Chrony Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="memcached_exporter_role.html">prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role Prometheus Node Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role Installs and configures prometheus</a></li>
<li class="toctree-l1"><a class="reference internal" href="pushgateway_role.html">prometheus.prometheus.pushgateway role Prometheus Pushgateway</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#entry-point-main-prometheus-smartctl-exporter">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> Prometheus Smartctl Exporter</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li>
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a></li>
<li class="toctree-l3"><a class="reference internal" href="#authors">Authors</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#collection-links">Collection links</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="smokeping_prober_role.html">prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober</a></li>
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role Prometheus SNMP exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role Prometheus Systemd Exporter</a></li>
</ul>
<!-- extra nav elements for Ansible beyond RTD Sphinx Theme -->
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Prometheus.Prometheus Collection</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<span class="target" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role"></span><section id="prometheus-prometheus-smartctl-exporter-role-prometheus-smartctl-exporter">
<h1>prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter<a class="headerlink" href="#prometheus-prometheus-smartctl-exporter-role-prometheus-smartctl-exporter" title="Link to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.9.1).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">prometheus.prometheus.smartctl_exporter</span></code>.</p>
</div>
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#entry-point-main-prometheus-smartctl-exporter" id="id1">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> Prometheus Smartctl Exporter</a></p>
<ul>
<li><p><a class="reference internal" href="#synopsis" id="id2">Synopsis</a></p></li>
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
<li><p><a class="reference internal" href="#authors" id="id4">Authors</a></p></li>
</ul>
</li>
</ul>
</nav>
<section id="entry-point-main-prometheus-smartctl-exporter">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> Prometheus Smartctl Exporter</a><a class="headerlink" href="#entry-point-main-prometheus-smartctl-exporter" title="Link to this heading"></a></h2>
<section id="synopsis">
<h3><a class="toc-backref" href="#id2" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Deploy prometheus <a class="reference external" href="https://github.com/prometheus-community/smartctl_exporter">smartctl exporter</a> using ansible</p></li>
</ul>
</section>
<section id="parameters">
<h3><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link to this heading"></a></h3>
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
<thead>
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
<th class="head"><p>Comments</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_basic_auth_users"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-basic-auth-users"><strong>smartctl_exporter_basic_auth_users</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_basic_auth_users" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_binary_install_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-binary-install-dir"><strong>smartctl_exporter_binary_install_dir</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_binary_install_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
<p>Directory to install smartctl_exporter binary</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;/usr/local/bin&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_binary_local_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-binary-local-dir"><strong>smartctl_exporter_binary_local_dir</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_binary_local_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Enables the use of local packages instead of those distributed on github.</p>
<p>The parameter may be set to a directory where the <code class="docutils literal notranslate"><span class="pre">smartctl_exporter</span></code> binary is stored on the host where ansible is run.</p>
<p>This overrides the <em>smartctl_exporter_version</em> parameter</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_binary_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-binary-url"><strong>smartctl_exporter_binary_url</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_binary_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>URL of the Smartctl exporter binaries .tar.gz file</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;https://github.com/{{</span> <span class="pre">_smartctl_exporter_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">smartctl_exporter_version</span> <span class="pre">}}/smartctl_exporter-{{</span> <span class="pre">smartctl_exporter_version</span> <span class="pre">}}.linux-{{</span> <span class="pre">go_arch</span> <span class="pre">}}.tar.gz&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_checksums_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-checksums-url"><strong>smartctl_exporter_checksums_url</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_checksums_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>URL of the Smartctl exporter checksums file</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;https://github.com/{{</span> <span class="pre">_smartctl_exporter_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">smartctl_exporter_version</span> <span class="pre">}}/sha256sums.txt&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_http_server_config"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-http-server-config"><strong>smartctl_exporter_http_server_config</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_http_server_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Config for HTTP/2 support.</p>
<p>Keys and values are the same as in <a class="reference external" href="https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md">smartctl_exporter docs</a>.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_log_format"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-log-format"><strong>smartctl_exporter_log_format</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_log_format" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Output format of log messages. One of: [logfmt, json]</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;logfmt&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_log_level"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-log-level"><strong>smartctl_exporter_log_level</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_log_level" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Only log messages with the given severity or above. One of: [debug, info, warn, error]</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;info&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_skip_install"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-skip-install"><strong>smartctl_exporter_skip_install</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_skip_install" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Smartctl exporter installation tasks gets skipped when set to true.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
</ul>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_smartctl_device_exclude"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-smartctl-device-exclude"><strong>smartctl_exporter_smartctl_device_exclude</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_smartctl_device_exclude" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Regexp of devices to exclude from automatic scanning. (mutually exclusive to smartctl_exporter_smartctl_device_include)</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_smartctl_device_include"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-smartctl-device-include"><strong>smartctl_exporter_smartctl_device_include</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_smartctl_device_include" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Regexp of devices to include in automatic scanning. (mutually exclusive to smartctl_exporter_smartctl_device_exclude)</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_smartctl_devices"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-smartctl-devices"><strong>smartctl_exporter_smartctl_devices</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_smartctl_devices" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>List of devices to be monitored by smartctl_exporter. Disables auto scan for available devices.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_smartctl_interval"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-smartctl-interval"><strong>smartctl_exporter_smartctl_interval</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_smartctl_interval" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>The interval between smartctl polls</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;60s&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_smartctl_path"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-smartctl-path"><strong>smartctl_exporter_smartctl_path</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_smartctl_path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
<p>The path to the smartctl binary</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;/usr/sbin/smartctl&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_smartctl_rescan"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-smartctl-rescan"><strong>smartctl_exporter_smartctl_rescan</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_smartctl_rescan" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>The interval between rescanning for new/disappeared devices.</p>
<p>If the interval is smaller than 1s norescanning takes place.</p>
<p>If any devices are configured with smartctl_exporter_smartctl_device also no rescanning takes place.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;10m&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_system_group"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-system-group"><strong>smartctl_exporter_system_group</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_system_group" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
<p>System group for Smartctl exporter</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;smartctl-exp&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_system_user"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-system-user"><strong>smartctl_exporter_system_user</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_system_user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
<p>Smartctl exporter user</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;smartctl-exp&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_tls_server_config"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-tls-server-config"><strong>smartctl_exporter_tls_server_config</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_tls_server_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Configuration for TLS authentication.</p>
<p>Keys and values are the same as in <a class="reference external" href="https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md">smartctl_exporter docs</a>.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_version"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-version"><strong>smartctl_exporter_version</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Smartctl exporter package version. Also accepts latest as parameter.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;0.11.0&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_web_listen_address"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-web-listen-address"><strong>smartctl_exporter_web_listen_address</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_web_listen_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Address on which smartctl exporter will listen</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;0.0.0.0:9633&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_web_telemetry_path"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-web-telemetry-path"><strong>smartctl_exporter_web_telemetry_path</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_web_telemetry_path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Path under which to expose metrics</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;/metrics&quot;</span></code></p>
</div></td>
</tr>
</tbody>
</table>
</section>
<section id="authors">
<h3><a class="toc-backref" href="#id4" role="doc-backlink">Authors</a><a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Prometheus Community</p></li>
</ul>
<section id="collection-links">
<h4>Collection links<a class="headerlink" href="#collection-links" title="Link to this heading"></a></h4>
<ul class="ansible-links">
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/prometheus-community/ansible/issues" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
<li><span><a aria-role="button" class="ansible-link reference external" href="https://prometheus.io" rel="noopener external" target="_blank">Homepage</a></span></li>
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/prometheus-community/ansible" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
</ul>
</section>
</section>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="pushgateway_role.html" class="btn btn-neutral float-left" title="prometheus.prometheus.pushgateway role Prometheus Pushgateway" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="smokeping_prober_role.html" class="btn btn-neutral float-right" title="prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright Prometheus.Prometheus Contributors.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script><!-- extra footer elements for Ansible beyond RTD Sphinx Theme -->
</body>
</html>

View file

@ -25,7 +25,7 @@
<script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="prometheus.prometheus.snmp_exporter role Prometheus SNMP exporter" href="snmp_exporter_role.html" />
<link rel="prev" title="prometheus.prometheus.pushgateway role Prometheus Pushgateway" href="pushgateway_role.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
<link rel="prev" title="prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter" href="smartctl_exporter_role.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
@ -79,10 +79,12 @@
<li class="toctree-l1"><a class="reference internal" href="alertmanager_role.html">prometheus.prometheus.alertmanager role Prometheus Alertmanager service</a></li>
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role Deploy and manage Prometheus blackbox exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="chrony_exporter_role.html">prometheus.prometheus.chrony_exporter role Prometheus Chrony Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="memcached_exporter_role.html">prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role Prometheus Node Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role Installs and configures prometheus</a></li>
<li class="toctree-l1"><a class="reference internal" href="pushgateway_role.html">prometheus.prometheus.pushgateway role Prometheus Pushgateway</a></li>
<li class="toctree-l1"><a class="reference internal" href="smartctl_exporter_role.html">prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#entry-point-main-prometheus-smokeping-prober">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> Prometheus Smokeping Prober</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li>
@ -129,7 +131,7 @@
<h1>prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober<a class="headerlink" href="#prometheus-prometheus-smokeping-prober-role-prometheus-smokeping-prober" title="Link to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.6.0).</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.9.1).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
@ -323,7 +325,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="pushgateway_role.html" class="btn btn-neutral float-left" title="prometheus.prometheus.pushgateway role Prometheus Pushgateway" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="smartctl_exporter_role.html" class="btn btn-neutral float-left" title="prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="snmp_exporter_role.html" class="btn btn-neutral float-right" title="prometheus.prometheus.snmp_exporter role Prometheus SNMP exporter" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

View file

@ -79,10 +79,12 @@
<li class="toctree-l1"><a class="reference internal" href="alertmanager_role.html">prometheus.prometheus.alertmanager role Prometheus Alertmanager service</a></li>
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role Deploy and manage Prometheus blackbox exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="chrony_exporter_role.html">prometheus.prometheus.chrony_exporter role Prometheus Chrony Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="memcached_exporter_role.html">prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role Prometheus Node Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role Installs and configures prometheus</a></li>
<li class="toctree-l1"><a class="reference internal" href="pushgateway_role.html">prometheus.prometheus.pushgateway role Prometheus Pushgateway</a></li>
<li class="toctree-l1"><a class="reference internal" href="smartctl_exporter_role.html">prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="smokeping_prober_role.html">prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">prometheus.prometheus.snmp_exporter role Prometheus SNMP exporter</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#entry-point-main-prometheus-snmp-exporter">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> Prometheus SNMP exporter</a><ul>
@ -129,7 +131,7 @@
<h1>prometheus.prometheus.snmp_exporter role Prometheus SNMP exporter<a class="headerlink" href="#prometheus-prometheus-snmp-exporter-role-prometheus-snmp-exporter" title="Link to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.6.0).</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.9.1).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
@ -164,6 +166,24 @@ To check whether it is installed, run <code class="code docutils literal notrans
</thead>
<tbody>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--snmp_exporter_binary_install_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-snmp-exporter-role-parameter-main-snmp-exporter-binary-install-dir"><strong>snmp_exporter_binary_install_dir</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--snmp_exporter_binary_install_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
<p>Directory to install snmp_exporter binary</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;/usr/local/bin&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--snmp_exporter_binary_local_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-snmp-exporter-role-parameter-main-snmp-exporter-binary-local-dir"><strong>snmp_exporter_binary_local_dir</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--snmp_exporter_binary_local_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Enables the use of local packages instead of those distributed on github.</p>
<p>The parameter masnmp set to a directory where the <code class="docutils literal notranslate"><span class="pre">snmp_exporter</span></code> binary is stored on the host where ansible is run.</p>
<p>This overrides the <em>snmp_exporter_version</em> parameter</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--snmp_exporter_binary_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-snmp-exporter-role-parameter-main-snmp-exporter-binary-url"><strong>snmp_exporter_binary_url</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--snmp_exporter_binary_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@ -211,8 +231,8 @@ To check whether it is installed, run <code class="code docutils literal notrans
<div class="ansibleOptionAnchor" id="parameter-main--snmp_exporter_version"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-snmp-exporter-role-parameter-main-snmp-exporter-version"><strong>snmp_exporter_version</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--snmp_exporter_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>SNMP exporter package version</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;0.23.0&quot;</span></code></p>
<td><div class="ansible-option-cell"><p>SNMP exporter package version. Also accepts latest as parameter.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;0.25.0&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">

View file

@ -78,10 +78,12 @@
<li class="toctree-l1"><a class="reference internal" href="alertmanager_role.html">prometheus.prometheus.alertmanager role Prometheus Alertmanager service</a></li>
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role Deploy and manage Prometheus blackbox exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="chrony_exporter_role.html">prometheus.prometheus.chrony_exporter role Prometheus Chrony Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="memcached_exporter_role.html">prometheus.prometheus.memcached_exporter role Prometheus memcached_exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role Prometheus MySQLd Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role Prometheus Node Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role Installs and configures prometheus</a></li>
<li class="toctree-l1"><a class="reference internal" href="pushgateway_role.html">prometheus.prometheus.pushgateway role Prometheus Pushgateway</a></li>
<li class="toctree-l1"><a class="reference internal" href="smartctl_exporter_role.html">prometheus.prometheus.smartctl_exporter role Prometheus Smartctl Exporter</a></li>
<li class="toctree-l1"><a class="reference internal" href="smokeping_prober_role.html">prometheus.prometheus.smokeping_prober role Prometheus Smokeping Prober</a></li>
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role Prometheus SNMP exporter</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">prometheus.prometheus.systemd_exporter role Prometheus Systemd Exporter</a><ul>
@ -128,7 +130,7 @@
<h1>prometheus.prometheus.systemd_exporter role Prometheus Systemd Exporter<a class="headerlink" href="#prometheus-prometheus-systemd-exporter-role-prometheus-systemd-exporter" title="Link to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.6.0).</p>
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.9.1).</p>
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
@ -233,6 +235,13 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_log_level"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-log-level"><strong>systemd_exporter_log_level</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_log_level" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Only log messages with the given severity or above.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_skip_install"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-skip-install"><strong>systemd_exporter_skip_install</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_skip_install" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td>
@ -244,7 +253,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</ul>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_system_group"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-system-group"><strong>systemd_exporter_system_group</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_system_group" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@ -253,7 +262,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;systemd-exporter&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_system_user"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-system-user"><strong>systemd_exporter_system_user</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_system_user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@ -262,6 +271,14 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;systemd-exporter&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_tls_server_config"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-tls-server-config"><strong>systemd_exporter_tls_server_config</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_tls_server_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Configuration for TLS authentication.</p>
<p>Keys and values are the same as in <a class="reference external" href="https://prometheus.io/docs/prometheus/latest/configuration/https/">Prometheus docs</a>.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--systemd_exporter_unit_exclude"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-systemd-exporter-role-parameter-main-systemd-exporter-unit-exclude"><strong>systemd_exporter_unit_exclude</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_unit_exclude" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
@ -281,7 +298,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<a class="ansibleOptionLink" href="#parameter-main--systemd_exporter_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>SystemD exporter package version. Also accepts latest as parameter.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;0.5.0&quot;</span></code></p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;0.6.0&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">