+
+ Read the Docs
+ v: ${config.versions.current.slug}
+
+
+
+ ${renderLanguages(config)}
+ ${renderVersions(config)}
+ ${renderDownloads(config)}
+
+ On Read the Docs
+
+ Project Home
+
+
+ Builds
+
+
+ Downloads
+
+
+
+ Search
+
+
+
+
+
+
+ Hosted by Read the Docs
+
+
+
+ `;
+
+ // Inject the generated flyout into the body HTML element.
+ document.body.insertAdjacentHTML("beforeend", flyout);
+
+ // Trigger the Read the Docs Addons Search modal when clicking on the "Search docs" input from inside the flyout.
+ document
+ .querySelector("#flyout-search-form")
+ .addEventListener("focusin", () => {
+ const event = new CustomEvent("readthedocs-search-show");
+ document.dispatchEvent(event);
+ });
+ })
+}
+
+if (themeLanguageSelector || themeVersionSelector) {
+ function onSelectorSwitch(event) {
+ const option = event.target.selectedIndex;
+ const item = event.target.options[option];
+ window.location.href = item.dataset.url;
+ }
+
+ document.addEventListener("readthedocs-addons-data-ready", function (event) {
+ const config = event.detail.data();
+
+ const versionSwitch = document.querySelector(
+ "div.switch-menus > div.version-switch",
+ );
+ if (themeVersionSelector) {
+ let versions = config.versions.active;
+ if (config.versions.current.hidden || config.versions.current.type === "external") {
+ versions.unshift(config.versions.current);
+ }
+ const versionSelect = `
+
+ ${versions
+ .map(
+ (version) => `
+
+ ${version.slug}
+ `,
+ )
+ .join("\n")}
+
+ `;
+
+ versionSwitch.innerHTML = versionSelect;
+ versionSwitch.firstElementChild.addEventListener("change", onSelectorSwitch);
+ }
+
+ const languageSwitch = document.querySelector(
+ "div.switch-menus > div.language-switch",
+ );
+
+ if (themeLanguageSelector) {
+ if (config.projects.translations.length) {
+ // Add the current language to the options on the selector
+ let languages = config.projects.translations.concat(
+ config.projects.current,
+ );
+ languages = languages.sort((a, b) =>
+ a.language.name.localeCompare(b.language.name),
+ );
+
+ const languageSelect = `
+
+ ${languages
+ .map(
+ (language) => `
+
+ ${language.language.name}
+ `,
+ )
+ .join("\n")}
+
+ `;
+
+ languageSwitch.innerHTML = languageSelect;
+ languageSwitch.firstElementChild.addEventListener("change", onSelectorSwitch);
+ }
+ else {
+ languageSwitch.remove();
+ }
+ }
+ });
+}
+
+document.addEventListener("readthedocs-addons-data-ready", function (event) {
+ // Trigger the Read the Docs Addons Search modal when clicking on "Search docs" input from the topnav.
+ document
+ .querySelector("[role='search'] input")
+ .addEventListener("focusin", () => {
+ const event = new CustomEvent("readthedocs-search-show");
+ document.dispatchEvent(event);
+ });
+});
\ No newline at end of file
diff --git a/pr/441/_static/language_data.js b/pr/441/_static/language_data.js
new file mode 100644
index 00000000..c7fe6c6f
--- /dev/null
+++ b/pr/441/_static/language_data.js
@@ -0,0 +1,192 @@
+/*
+ * This script contains the language-specific data used by searchtools.js,
+ * namely the list of stopwords, stemmer, scorer and splitter.
+ */
+
+var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
+
+
+/* Non-minified version is copied as a separate JS file, if available */
+
+/**
+ * Porter Stemmer
+ */
+var Stemmer = function() {
+
+ var step2list = {
+ ational: 'ate',
+ tional: 'tion',
+ enci: 'ence',
+ anci: 'ance',
+ izer: 'ize',
+ bli: 'ble',
+ alli: 'al',
+ entli: 'ent',
+ eli: 'e',
+ ousli: 'ous',
+ ization: 'ize',
+ ation: 'ate',
+ ator: 'ate',
+ alism: 'al',
+ iveness: 'ive',
+ fulness: 'ful',
+ ousness: 'ous',
+ aliti: 'al',
+ iviti: 'ive',
+ biliti: 'ble',
+ logi: 'log'
+ };
+
+ var step3list = {
+ icate: 'ic',
+ ative: '',
+ alize: 'al',
+ iciti: 'ic',
+ ical: 'ic',
+ ful: '',
+ ness: ''
+ };
+
+ var c = "[^aeiou]"; // consonant
+ var v = "[aeiouy]"; // vowel
+ var C = c + "[^aeiouy]*"; // consonant sequence
+ var V = v + "[aeiou]*"; // vowel sequence
+
+ var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
+ var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
+ var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
+ var s_v = "^(" + C + ")?" + v; // vowel in stem
+
+ this.stemWord = function (w) {
+ var stem;
+ var suffix;
+ var firstch;
+ var origword = w;
+
+ if (w.length < 3)
+ return w;
+
+ var re;
+ var re2;
+ var re3;
+ var re4;
+
+ firstch = w.substr(0,1);
+ if (firstch == "y")
+ w = firstch.toUpperCase() + w.substr(1);
+
+ // Step 1a
+ re = /^(.+?)(ss|i)es$/;
+ re2 = /^(.+?)([^s])s$/;
+
+ if (re.test(w))
+ w = w.replace(re,"$1$2");
+ else if (re2.test(w))
+ w = w.replace(re2,"$1$2");
+
+ // Step 1b
+ re = /^(.+?)eed$/;
+ re2 = /^(.+?)(ed|ing)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ re = new RegExp(mgr0);
+ if (re.test(fp[1])) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1];
+ re2 = new RegExp(s_v);
+ if (re2.test(stem)) {
+ w = stem;
+ re2 = /(at|bl|iz)$/;
+ re3 = new RegExp("([^aeiouylsz])\\1$");
+ re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re2.test(w))
+ w = w + "e";
+ else if (re3.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ else if (re4.test(w))
+ w = w + "e";
+ }
+ }
+
+ // Step 1c
+ re = /^(.+?)y$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(s_v);
+ if (re.test(stem))
+ w = stem + "i";
+ }
+
+ // Step 2
+ re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step2list[suffix];
+ }
+
+ // Step 3
+ re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step3list[suffix];
+ }
+
+ // Step 4
+ re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
+ re2 = /^(.+?)(s|t)(ion)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ if (re.test(stem))
+ w = stem;
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1] + fp[2];
+ re2 = new RegExp(mgr1);
+ if (re2.test(stem))
+ w = stem;
+ }
+
+ // Step 5
+ re = /^(.+?)e$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ re2 = new RegExp(meq1);
+ re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
+ w = stem;
+ }
+ re = /ll$/;
+ re2 = new RegExp(mgr1);
+ if (re.test(w) && re2.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+
+ // and turn initial Y back to y
+ if (firstch == "y")
+ w = firstch.toLowerCase() + w.substr(1);
+ return w;
+ }
+}
+
diff --git a/pr/441/_static/minus.png b/pr/441/_static/minus.png
new file mode 100644
index 00000000..d96755fd
Binary files /dev/null and b/pr/441/_static/minus.png differ
diff --git a/pr/441/_static/plus.png b/pr/441/_static/plus.png
new file mode 100644
index 00000000..7107cec9
Binary files /dev/null and b/pr/441/_static/plus.png differ
diff --git a/pr/441/_static/pygments.css b/pr/441/_static/pygments.css
new file mode 100644
index 00000000..fddd1811
--- /dev/null
+++ b/pr/441/_static/pygments.css
@@ -0,0 +1,81 @@
+pre { line-height: 125%; }
+td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+.highlight .hll { background-color: #ffffcc; border: 1px solid #edff00; padding-top: 2px; border-radius: 3px; display: block }
+.highlight { background: #f8f8f8; }
+.highlight .c { color: #6a737d; font-style: italic } /* Comment */
+.highlight .err { color: #a61717; background-color: #e3d2d2; border: 1px solid #FF0000 } /* Error */
+.highlight .k { color: #007020; font-weight: bold } /* Keyword */
+.highlight .l { color: #032f62 } /* Literal */
+.highlight .n { color: #333333 } /* Name */
+.highlight .o { color: #666666; font-weight: bold } /* Operator */
+.highlight .p { font-weight: bold } /* Punctuation */
+.highlight .ch { color: #6a737d; font-style: italic } /* Comment.Hashbang */
+.highlight .cm { color: #6a737d; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #007020 } /* Comment.Preproc */
+.highlight .cpf { color: #6a737d; font-style: italic } /* Comment.PreprocFile */
+.highlight .c1 { color: #6a737d; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #999999; font-weight: bold; font-style: italic; background-color: #fff0f0 } /* Comment.Special */
+.highlight .gd { color: #A00000; background-color: #ffdddd } /* Generic.Deleted */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .gr { color: #aa0000 } /* Generic.Error */
+.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.highlight .gi { color: #00A000; background-color: #ddffdd } /* Generic.Inserted */
+.highlight .go { color: #333333 } /* Generic.Output */
+.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.highlight .gt { color: #0040D0 } /* Generic.Traceback */
+.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
+.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { color: #007020; font-weight: bold } /* Keyword.Pseudo */
+.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #902000; font-weight: bold } /* Keyword.Type */
+.highlight .ld { color: #032f62 } /* Literal.Date */
+.highlight .m { color: #208050 } /* Literal.Number */
+.highlight .s { color: #4070a0 } /* Literal.String */
+.highlight .na { color: #008080 } /* Name.Attribute */
+.highlight .nb { color: #0086b3 } /* Name.Builtin */
+.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
+.highlight .no { color: #008080 } /* Name.Constant */
+.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
+.highlight .ni { color: #800080; font-weight: bold } /* Name.Entity */
+.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
+.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
+.highlight .nn { color: #555555; font-weight: bold } /* Name.Namespace */
+.highlight .nx { color: #333333 } /* Name.Other */
+.highlight .py { color: #333333 } /* Name.Property */
+.highlight .nt { color: #22863a; font-weight: bold } /* Name.Tag */
+.highlight .nv { color: #9960b5; font-weight: bold } /* Name.Variable */
+.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
+.highlight .pm { font-weight: bold } /* Punctuation.Marker */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mb { color: #009999 } /* Literal.Number.Bin */
+.highlight .mf { color: #009999 } /* Literal.Number.Float */
+.highlight .mh { color: #009999 } /* Literal.Number.Hex */
+.highlight .mi { color: #009999 } /* Literal.Number.Integer */
+.highlight .mo { color: #009999 } /* Literal.Number.Oct */
+.highlight .sa { color: #dd1144 } /* Literal.String.Affix */
+.highlight .sb { color: #dd1144 } /* Literal.String.Backtick */
+.highlight .sc { color: #dd1144 } /* Literal.String.Char */
+.highlight .dl { color: #dd1144 } /* Literal.String.Delimiter */
+.highlight .sd { color: #dd1144; font-style: italic } /* Literal.String.Doc */
+.highlight .s2 { color: #dd1144 } /* Literal.String.Double */
+.highlight .se { color: #dd1144; font-weight: bold } /* Literal.String.Escape */
+.highlight .sh { color: #dd1144 } /* Literal.String.Heredoc */
+.highlight .si { color: #dd1144; font-style: italic } /* Literal.String.Interpol */
+.highlight .sx { color: #dd1144 } /* Literal.String.Other */
+.highlight .sr { color: #009926 } /* Literal.String.Regex */
+.highlight .s1 { color: #dd1144 } /* Literal.String.Single */
+.highlight .ss { color: #990073 } /* Literal.String.Symbol */
+.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
+.highlight .fm { color: #06287e; font-weight: bold } /* Name.Function.Magic */
+.highlight .vc { color: #008080; font-weight: bold } /* Name.Variable.Class */
+.highlight .vg { color: #008080; font-weight: bold } /* Name.Variable.Global */
+.highlight .vi { color: #008080; font-weight: bold } /* Name.Variable.Instance */
+.highlight .vm { color: #bb60d5; font-weight: bold } /* Name.Variable.Magic */
+.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */
\ No newline at end of file
diff --git a/pr/441/_static/searchtools.js b/pr/441/_static/searchtools.js
new file mode 100644
index 00000000..2c774d17
--- /dev/null
+++ b/pr/441/_static/searchtools.js
@@ -0,0 +1,632 @@
+/*
+ * Sphinx JavaScript utilities for the full-text search.
+ */
+"use strict";
+
+/**
+ * Simple result scoring code.
+ */
+if (typeof Scorer === "undefined") {
+ var Scorer = {
+ // Implement the following function to further tweak the score for each result
+ // The function takes a result array [docname, title, anchor, descr, score, filename]
+ // and returns the new score.
+ /*
+ score: result => {
+ const [docname, title, anchor, descr, score, filename, kind] = result
+ return score
+ },
+ */
+
+ // query matches the full name of an object
+ objNameMatch: 11,
+ // or matches in the last dotted part of the object name
+ objPartialMatch: 6,
+ // Additive scores depending on the priority of the object
+ objPrio: {
+ 0: 15, // used to be importantResults
+ 1: 5, // used to be objectResults
+ 2: -5, // used to be unimportantResults
+ },
+ // Used when the priority is not in the mapping.
+ objPrioDefault: 0,
+
+ // query found in title
+ title: 15,
+ partialTitle: 7,
+ // query found in terms
+ term: 5,
+ partialTerm: 2,
+ };
+}
+
+// Global search result kind enum, used by themes to style search results.
+class SearchResultKind {
+ static get index() { return "index"; }
+ static get object() { return "object"; }
+ static get text() { return "text"; }
+ static get title() { return "title"; }
+}
+
+const _removeChildren = (element) => {
+ while (element && element.lastChild) element.removeChild(element.lastChild);
+};
+
+/**
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
+ */
+const _escapeRegExp = (string) =>
+ string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
+
+const _displayItem = (item, searchTerms, highlightTerms) => {
+ const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
+ const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
+ const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
+ const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
+ const contentRoot = document.documentElement.dataset.content_root;
+
+ const [docName, title, anchor, descr, score, _filename, kind] = item;
+
+ let listItem = document.createElement("li");
+ // Add a class representing the item's type:
+ // can be used by a theme's CSS selector for styling
+ // See SearchResultKind for the class names.
+ listItem.classList.add(`kind-${kind}`);
+ let requestUrl;
+ let linkUrl;
+ if (docBuilder === "dirhtml") {
+ // dirhtml builder
+ let dirname = docName + "/";
+ if (dirname.match(/\/index\/$/))
+ dirname = dirname.substring(0, dirname.length - 6);
+ else if (dirname === "index/") dirname = "";
+ requestUrl = contentRoot + dirname;
+ linkUrl = requestUrl;
+ } else {
+ // normal html builders
+ requestUrl = contentRoot + docName + docFileSuffix;
+ linkUrl = docName + docLinkSuffix;
+ }
+ let linkEl = listItem.appendChild(document.createElement("a"));
+ linkEl.href = linkUrl + anchor;
+ linkEl.dataset.score = score;
+ linkEl.innerHTML = title;
+ if (descr) {
+ listItem.appendChild(document.createElement("span")).innerHTML =
+ " (" + descr + ")";
+ // highlight search terms in the description
+ if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
+ highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
+ }
+ else if (showSearchSummary)
+ fetch(requestUrl)
+ .then((responseData) => responseData.text())
+ .then((data) => {
+ if (data)
+ listItem.appendChild(
+ Search.makeSearchSummary(data, searchTerms, anchor)
+ );
+ // highlight search terms in the summary
+ if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
+ highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
+ });
+ Search.output.appendChild(listItem);
+};
+const _finishSearch = (resultCount) => {
+ Search.stopPulse();
+ Search.title.innerText = _("Search Results");
+ if (!resultCount)
+ Search.status.innerText = Documentation.gettext(
+ "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
+ );
+ else
+ Search.status.innerText = Documentation.ngettext(
+ "Search finished, found one page matching the search query.",
+ "Search finished, found ${resultCount} pages matching the search query.",
+ resultCount,
+ ).replace('${resultCount}', resultCount);
+};
+const _displayNextItem = (
+ results,
+ resultCount,
+ searchTerms,
+ highlightTerms,
+) => {
+ // results left, load the summary and display it
+ // this is intended to be dynamic (don't sub resultsCount)
+ if (results.length) {
+ _displayItem(results.pop(), searchTerms, highlightTerms);
+ setTimeout(
+ () => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
+ 5
+ );
+ }
+ // search finished, update title and status message
+ else _finishSearch(resultCount);
+};
+// Helper function used by query() to order search results.
+// Each input is an array of [docname, title, anchor, descr, score, filename, kind].
+// Order the results by score (in opposite order of appearance, since the
+// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically.
+const _orderResultsByScoreThenName = (a, b) => {
+ const leftScore = a[4];
+ const rightScore = b[4];
+ if (leftScore === rightScore) {
+ // same score: sort alphabetically
+ const leftTitle = a[1].toLowerCase();
+ const rightTitle = b[1].toLowerCase();
+ if (leftTitle === rightTitle) return 0;
+ return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
+ }
+ return leftScore > rightScore ? 1 : -1;
+};
+
+/**
+ * Default splitQuery function. Can be overridden in ``sphinx.search`` with a
+ * custom function per language.
+ *
+ * The regular expression works by splitting the string on consecutive characters
+ * that are not Unicode letters, numbers, underscores, or emoji characters.
+ * This is the same as ``\W+`` in Python, preserving the surrogate pair area.
+ */
+if (typeof splitQuery === "undefined") {
+ var splitQuery = (query) => query
+ .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu)
+ .filter(term => term) // remove remaining empty strings
+}
+
+/**
+ * Search Module
+ */
+const Search = {
+ _index: null,
+ _queued_query: null,
+ _pulse_status: -1,
+
+ htmlToText: (htmlString, anchor) => {
+ const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
+ for (const removalQuery of [".headerlink", "script", "style"]) {
+ htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
+ }
+ if (anchor) {
+ const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`);
+ if (anchorContent) return anchorContent.textContent;
+
+ console.warn(
+ `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.`
+ );
+ }
+
+ // if anchor not specified or not found, fall back to main content
+ const docContent = htmlElement.querySelector('[role="main"]');
+ if (docContent) return docContent.textContent;
+
+ console.warn(
+ "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template."
+ );
+ return "";
+ },
+
+ init: () => {
+ const query = new URLSearchParams(window.location.search).get("q");
+ document
+ .querySelectorAll('input[name="q"]')
+ .forEach((el) => (el.value = query));
+ if (query) Search.performSearch(query);
+ },
+
+ loadIndex: (url) =>
+ (document.body.appendChild(document.createElement("script")).src = url),
+
+ setIndex: (index) => {
+ Search._index = index;
+ if (Search._queued_query !== null) {
+ const query = Search._queued_query;
+ Search._queued_query = null;
+ Search.query(query);
+ }
+ },
+
+ hasIndex: () => Search._index !== null,
+
+ deferQuery: (query) => (Search._queued_query = query),
+
+ stopPulse: () => (Search._pulse_status = -1),
+
+ startPulse: () => {
+ if (Search._pulse_status >= 0) return;
+
+ const pulse = () => {
+ Search._pulse_status = (Search._pulse_status + 1) % 4;
+ Search.dots.innerText = ".".repeat(Search._pulse_status);
+ if (Search._pulse_status >= 0) window.setTimeout(pulse, 500);
+ };
+ pulse();
+ },
+
+ /**
+ * perform a search for something (or wait until index is loaded)
+ */
+ performSearch: (query) => {
+ // create the required interface elements
+ const searchText = document.createElement("h2");
+ searchText.textContent = _("Searching");
+ const searchSummary = document.createElement("p");
+ searchSummary.classList.add("search-summary");
+ searchSummary.innerText = "";
+ const searchList = document.createElement("ul");
+ searchList.setAttribute("role", "list");
+ searchList.classList.add("search");
+
+ const out = document.getElementById("search-results");
+ Search.title = out.appendChild(searchText);
+ Search.dots = Search.title.appendChild(document.createElement("span"));
+ Search.status = out.appendChild(searchSummary);
+ Search.output = out.appendChild(searchList);
+
+ const searchProgress = document.getElementById("search-progress");
+ // Some themes don't use the search progress node
+ if (searchProgress) {
+ searchProgress.innerText = _("Preparing search...");
+ }
+ Search.startPulse();
+
+ // index already loaded, the browser was quick!
+ if (Search.hasIndex()) Search.query(query);
+ else Search.deferQuery(query);
+ },
+
+ _parseQuery: (query) => {
+ // stem the search terms and add them to the correct list
+ const stemmer = new Stemmer();
+ const searchTerms = new Set();
+ const excludedTerms = new Set();
+ const highlightTerms = new Set();
+ const objectTerms = new Set(splitQuery(query.toLowerCase().trim()));
+ splitQuery(query.trim()).forEach((queryTerm) => {
+ const queryTermLower = queryTerm.toLowerCase();
+
+ // maybe skip this "word"
+ // stopwords array is from language_data.js
+ if (
+ stopwords.indexOf(queryTermLower) !== -1 ||
+ queryTerm.match(/^\d+$/)
+ )
+ return;
+
+ // stem the word
+ let word = stemmer.stemWord(queryTermLower);
+ // select the correct list
+ if (word[0] === "-") excludedTerms.add(word.substr(1));
+ else {
+ searchTerms.add(word);
+ highlightTerms.add(queryTermLower);
+ }
+ });
+
+ if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js
+ localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" "))
+ }
+
+ // console.debug("SEARCH: searching for:");
+ // console.info("required: ", [...searchTerms]);
+ // console.info("excluded: ", [...excludedTerms]);
+
+ return [query, searchTerms, excludedTerms, highlightTerms, objectTerms];
+ },
+
+ /**
+ * execute search (requires search index to be loaded)
+ */
+ _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => {
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const titles = Search._index.titles;
+ const allTitles = Search._index.alltitles;
+ const indexEntries = Search._index.indexentries;
+
+ // Collect multiple result groups to be sorted separately and then ordered.
+ // Each is an array of [docname, title, anchor, descr, score, filename, kind].
+ const normalResults = [];
+ const nonMainIndexResults = [];
+
+ _removeChildren(document.getElementById("search-progress"));
+
+ const queryLower = query.toLowerCase().trim();
+ for (const [title, foundTitles] of Object.entries(allTitles)) {
+ if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
+ for (const [file, id] of foundTitles) {
+ const score = Math.round(Scorer.title * queryLower.length / title.length);
+ const boost = titles[file] === title ? 1 : 0; // add a boost for document titles
+ normalResults.push([
+ docNames[file],
+ titles[file] !== title ? `${titles[file]} > ${title}` : title,
+ id !== null ? "#" + id : "",
+ null,
+ score + boost,
+ filenames[file],
+ SearchResultKind.title,
+ ]);
+ }
+ }
+ }
+
+ // search for explicit entries in index directives
+ for (const [entry, foundEntries] of Object.entries(indexEntries)) {
+ if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
+ for (const [file, id, isMain] of foundEntries) {
+ const score = Math.round(100 * queryLower.length / entry.length);
+ const result = [
+ docNames[file],
+ titles[file],
+ id ? "#" + id : "",
+ null,
+ score,
+ filenames[file],
+ SearchResultKind.index,
+ ];
+ if (isMain) {
+ normalResults.push(result);
+ } else {
+ nonMainIndexResults.push(result);
+ }
+ }
+ }
+ }
+
+ // lookup as object
+ objectTerms.forEach((term) =>
+ normalResults.push(...Search.performObjectSearch(term, objectTerms))
+ );
+
+ // lookup as search terms in fulltext
+ normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms));
+
+ // let the scorer override scores with a custom scoring function
+ if (Scorer.score) {
+ normalResults.forEach((item) => (item[4] = Scorer.score(item)));
+ nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item)));
+ }
+
+ // Sort each group of results by score and then alphabetically by name.
+ normalResults.sort(_orderResultsByScoreThenName);
+ nonMainIndexResults.sort(_orderResultsByScoreThenName);
+
+ // Combine the result groups in (reverse) order.
+ // Non-main index entries are typically arbitrary cross-references,
+ // so display them after other results.
+ let results = [...nonMainIndexResults, ...normalResults];
+
+ // remove duplicate search results
+ // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
+ let seen = new Set();
+ results = results.reverse().reduce((acc, result) => {
+ let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(',');
+ if (!seen.has(resultStr)) {
+ acc.push(result);
+ seen.add(resultStr);
+ }
+ return acc;
+ }, []);
+
+ return results.reverse();
+ },
+
+ query: (query) => {
+ const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query);
+ const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms);
+
+ // for debugging
+ //Search.lastresults = results.slice(); // a copy
+ // console.info("search results:", Search.lastresults);
+
+ // print the results
+ _displayNextItem(results, results.length, searchTerms, highlightTerms);
+ },
+
+ /**
+ * search for object names
+ */
+ performObjectSearch: (object, objectTerms) => {
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const objects = Search._index.objects;
+ const objNames = Search._index.objnames;
+ const titles = Search._index.titles;
+
+ const results = [];
+
+ const objectSearchCallback = (prefix, match) => {
+ const name = match[4]
+ const fullname = (prefix ? prefix + "." : "") + name;
+ const fullnameLower = fullname.toLowerCase();
+ if (fullnameLower.indexOf(object) < 0) return;
+
+ let score = 0;
+ const parts = fullnameLower.split(".");
+
+ // check for different match types: exact matches of full name or
+ // "last name" (i.e. last dotted part)
+ if (fullnameLower === object || parts.slice(-1)[0] === object)
+ score += Scorer.objNameMatch;
+ else if (parts.slice(-1)[0].indexOf(object) > -1)
+ score += Scorer.objPartialMatch; // matches in last name
+
+ const objName = objNames[match[1]][2];
+ const title = titles[match[0]];
+
+ // If more than one term searched for, we require other words to be
+ // found in the name/title/description
+ const otherTerms = new Set(objectTerms);
+ otherTerms.delete(object);
+ if (otherTerms.size > 0) {
+ const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase();
+ if (
+ [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0)
+ )
+ return;
+ }
+
+ let anchor = match[3];
+ if (anchor === "") anchor = fullname;
+ else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname;
+
+ const descr = objName + _(", in ") + title;
+
+ // add custom score for some objects according to scorer
+ if (Scorer.objPrio.hasOwnProperty(match[2]))
+ score += Scorer.objPrio[match[2]];
+ else score += Scorer.objPrioDefault;
+
+ results.push([
+ docNames[match[0]],
+ fullname,
+ "#" + anchor,
+ descr,
+ score,
+ filenames[match[0]],
+ SearchResultKind.object,
+ ]);
+ };
+ Object.keys(objects).forEach((prefix) =>
+ objects[prefix].forEach((array) =>
+ objectSearchCallback(prefix, array)
+ )
+ );
+ return results;
+ },
+
+ /**
+ * search for full-text terms in the index
+ */
+ performTermsSearch: (searchTerms, excludedTerms) => {
+ // prepare search
+ const terms = Search._index.terms;
+ const titleTerms = Search._index.titleterms;
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const titles = Search._index.titles;
+
+ const scoreMap = new Map();
+ const fileMap = new Map();
+
+ // perform the search on the required terms
+ searchTerms.forEach((word) => {
+ const files = [];
+ const arr = [
+ { files: terms[word], score: Scorer.term },
+ { files: titleTerms[word], score: Scorer.title },
+ ];
+ // add support for partial matches
+ if (word.length > 2) {
+ const escapedWord = _escapeRegExp(word);
+ if (!terms.hasOwnProperty(word)) {
+ Object.keys(terms).forEach((term) => {
+ if (term.match(escapedWord))
+ arr.push({ files: terms[term], score: Scorer.partialTerm });
+ });
+ }
+ if (!titleTerms.hasOwnProperty(word)) {
+ Object.keys(titleTerms).forEach((term) => {
+ if (term.match(escapedWord))
+ arr.push({ files: titleTerms[term], score: Scorer.partialTitle });
+ });
+ }
+ }
+
+ // no match but word was a required one
+ if (arr.every((record) => record.files === undefined)) return;
+
+ // found search word in contents
+ arr.forEach((record) => {
+ if (record.files === undefined) return;
+
+ let recordFiles = record.files;
+ if (recordFiles.length === undefined) recordFiles = [recordFiles];
+ files.push(...recordFiles);
+
+ // set score for the word in each file
+ recordFiles.forEach((file) => {
+ if (!scoreMap.has(file)) scoreMap.set(file, {});
+ scoreMap.get(file)[word] = record.score;
+ });
+ });
+
+ // create the mapping
+ files.forEach((file) => {
+ if (!fileMap.has(file)) fileMap.set(file, [word]);
+ else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word);
+ });
+ });
+
+ // now check if the files don't contain excluded terms
+ const results = [];
+ for (const [file, wordList] of fileMap) {
+ // check if all requirements are matched
+
+ // as search terms with length < 3 are discarded
+ const filteredTermCount = [...searchTerms].filter(
+ (term) => term.length > 2
+ ).length;
+ if (
+ wordList.length !== searchTerms.size &&
+ wordList.length !== filteredTermCount
+ )
+ continue;
+
+ // ensure that none of the excluded terms is in the search result
+ if (
+ [...excludedTerms].some(
+ (term) =>
+ terms[term] === file ||
+ titleTerms[term] === file ||
+ (terms[term] || []).includes(file) ||
+ (titleTerms[term] || []).includes(file)
+ )
+ )
+ break;
+
+ // select one (max) score for the file.
+ const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w]));
+ // add result to the result list
+ results.push([
+ docNames[file],
+ titles[file],
+ "",
+ null,
+ score,
+ filenames[file],
+ SearchResultKind.text,
+ ]);
+ }
+ return results;
+ },
+
+ /**
+ * helper function to return a node containing the
+ * search summary for a given text. keywords is a list
+ * of stemmed words.
+ */
+ makeSearchSummary: (htmlText, keywords, anchor) => {
+ const text = Search.htmlToText(htmlText, anchor);
+ if (text === "") return null;
+
+ const textLower = text.toLowerCase();
+ const actualStartPosition = [...keywords]
+ .map((k) => textLower.indexOf(k.toLowerCase()))
+ .filter((i) => i > -1)
+ .slice(-1)[0];
+ const startWithContext = Math.max(actualStartPosition - 120, 0);
+
+ const top = startWithContext === 0 ? "" : "...";
+ const tail = startWithContext + 240 < text.length ? "..." : "";
+
+ let summary = document.createElement("p");
+ summary.classList.add("context");
+ summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
+
+ return summary;
+ },
+};
+
+_ready(Search.init);
diff --git a/pr/441/_static/sphinx_highlight.js b/pr/441/_static/sphinx_highlight.js
new file mode 100644
index 00000000..8a96c69a
--- /dev/null
+++ b/pr/441/_static/sphinx_highlight.js
@@ -0,0 +1,154 @@
+/* Highlighting utilities for Sphinx HTML documentation. */
+"use strict";
+
+const SPHINX_HIGHLIGHT_ENABLED = true
+
+/**
+ * highlight a given string on a node by wrapping it in
+ * span elements with the given class name.
+ */
+const _highlight = (node, addItems, text, className) => {
+ if (node.nodeType === Node.TEXT_NODE) {
+ const val = node.nodeValue;
+ const parent = node.parentNode;
+ const pos = val.toLowerCase().indexOf(text);
+ if (
+ pos >= 0 &&
+ !parent.classList.contains(className) &&
+ !parent.classList.contains("nohighlight")
+ ) {
+ let span;
+
+ const closestNode = parent.closest("body, svg, foreignObject");
+ const isInSVG = closestNode && closestNode.matches("svg");
+ if (isInSVG) {
+ span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+ } else {
+ span = document.createElement("span");
+ span.classList.add(className);
+ }
+
+ span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+ const rest = document.createTextNode(val.substr(pos + text.length));
+ parent.insertBefore(
+ span,
+ parent.insertBefore(
+ rest,
+ node.nextSibling
+ )
+ );
+ node.nodeValue = val.substr(0, pos);
+ /* There may be more occurrences of search term in this node. So call this
+ * function recursively on the remaining fragment.
+ */
+ _highlight(rest, addItems, text, className);
+
+ if (isInSVG) {
+ const rect = document.createElementNS(
+ "http://www.w3.org/2000/svg",
+ "rect"
+ );
+ const bbox = parent.getBBox();
+ rect.x.baseVal.value = bbox.x;
+ rect.y.baseVal.value = bbox.y;
+ rect.width.baseVal.value = bbox.width;
+ rect.height.baseVal.value = bbox.height;
+ rect.setAttribute("class", className);
+ addItems.push({ parent: parent, target: rect });
+ }
+ }
+ } else if (node.matches && !node.matches("button, select, textarea")) {
+ node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
+ }
+};
+const _highlightText = (thisNode, text, className) => {
+ let addItems = [];
+ _highlight(thisNode, addItems, text, className);
+ addItems.forEach((obj) =>
+ obj.parent.insertAdjacentElement("beforebegin", obj.target)
+ );
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+const SphinxHighlight = {
+
+ /**
+ * highlight the search words provided in localstorage in the text
+ */
+ highlightSearchWords: () => {
+ if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight
+
+ // get and clear terms from localstorage
+ const url = new URL(window.location);
+ const highlight =
+ localStorage.getItem("sphinx_highlight_terms")
+ || url.searchParams.get("highlight")
+ || "";
+ localStorage.removeItem("sphinx_highlight_terms")
+ url.searchParams.delete("highlight");
+ window.history.replaceState({}, "", url);
+
+ // get individual terms from highlight string
+ const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
+ if (terms.length === 0) return; // nothing to do
+
+ // There should never be more than one element matching "div.body"
+ const divBody = document.querySelectorAll("div.body");
+ const body = divBody.length ? divBody[0] : document.querySelector("body");
+ window.setTimeout(() => {
+ terms.forEach((term) => _highlightText(body, term, "highlighted"));
+ }, 10);
+
+ const searchBox = document.getElementById("searchbox");
+ if (searchBox === null) return;
+ searchBox.appendChild(
+ document
+ .createRange()
+ .createContextualFragment(
+ '
' +
+ '' +
+ _("Hide Search Matches") +
+ "
"
+ )
+ );
+ },
+
+ /**
+ * helper function to hide the search marks again
+ */
+ hideSearchWords: () => {
+ document
+ .querySelectorAll("#searchbox .highlight-link")
+ .forEach((el) => el.remove());
+ document
+ .querySelectorAll("span.highlighted")
+ .forEach((el) => el.classList.remove("highlighted"));
+ localStorage.removeItem("sphinx_highlight_terms")
+ },
+
+ initEscapeListener: () => {
+ // only install a listener if it is really needed
+ if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
+
+ document.addEventListener("keydown", (event) => {
+ // bail for input elements
+ if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
+ // bail with special keys
+ if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
+ if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
+ SphinxHighlight.hideSearchWords();
+ event.preventDefault();
+ }
+ });
+ },
+};
+
+_ready(() => {
+ /* Do not call highlightSearchWords() when we are on the search page.
+ * It will highlight words from the *previous* search query.
+ */
+ if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
+ SphinxHighlight.initEscapeListener();
+});
diff --git a/pr/441/alertmanager_role.html b/pr/441/alertmanager_role.html
new file mode 100644
index 00000000..270f2537
--- /dev/null
+++ b/pr/441/alertmanager_role.html
@@ -0,0 +1,504 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.alertmanager role – Prometheus Alertmanager service — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.alertmanager role – Prometheus Alertmanager service
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.alertmanager role – Prometheus Alertmanager service
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.alertmanager
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
alertmanager_amtool_config_alertmanager_url
+
string
+
URL of the alertmanager
+
Default: "{{ alertmanager_web_external_url }}"
+
+
alertmanager_amtool_config_file
+
string
+
Template for amtool config
+
Default: "amtool.yml.j2"
+
+
alertmanager_amtool_config_output
+
string
+
Extended output, use ""
+
Default: "extended"
+
+
alertmanager_binary_install_dir
+
string
+
Advanced
+
Directory to install binaries
+
Default: "/usr/local/bin"
+
+
alertmanager_binary_url
+
string
+
URL of the alertmanager binaries .tar.gz file
+
Default: "https://github.com/{{ _alertmanager_repo }}/releases/download/v{{ alertmanager_version }}/alertmanager-{{ alertmanager_version }}.{{ ansible_system | lower }}-{{ _alertmanager_go_ansible_arch }}.tar.gz"
+
+
alertmanager_checksums_url
+
string
+
URL of the alertmanager checksums file
+
Default: "https://github.com/{{ _alertmanager_repo }}/releases/download/v{{ alertmanager_version }}/sha256sums.txt"
+
+
alertmanager_cluster
+
dictionary
+
HA cluster network configuration. Disabled by default.
+
More information in alertmanager readme
+
Default: {"listen-address": ""}
+
+
alertmanager_config_dir
+
string
+
Path to directory with alertmanager configuration
+
Default: "/etc/alertmanager"
+
+
alertmanager_config_file
+
string
+
Variable used to provide custom alertmanager configuration file in form of ansible template
+
Default: "alertmanager.yml.j2"
+
+
alertmanager_config_flags_extra
+
dictionary
+
Additional configuration flags passed to prometheus binary at startup
+
+
alertmanager_db_dir
+
string
+
Path to directory with alertmanager database
+
Default: "/var/lib/alertmanager"
+
+
alertmanager_hipchat_api_url
+
string
+
+
alertmanager_hipchat_auth_token
+
string
+
Hipchat authentication token
+
+
alertmanager_http_config
+
dictionary
+
Http config for using custom webhooks
+
+
alertmanager_inhibit_rules
+
list / elements=string
+
+
alertmanager_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/alertmanager-{{ ansible_system | lower }}-{{ _alertmanager_go_ansible_arch }}/{{ alertmanager_version }}"
+
+
alertmanager_opsgenie_api_key
+
string
+
+
alertmanager_opsgenie_api_url
+
string
+
+
alertmanager_pagerduty_url
+
string
+
+
alertmanager_receivers
+
list / elements=string
+
A list of notification receivers. Configuration same as in official docs
+
+
alertmanager_resolve_timeout
+
string
+
Time after which an alert is declared resolved
+
Default: "3m"
+
+
alertmanager_route
+
dictionary
+
+
alertmanager_slack_api_url
+
string
+
+
alertmanager_smtp
+
dictionary
+
SMTP (email) configuration
+
+
alertmanager_system_group
+
string
+
Advanced
+
System group for alertmanager
+
Default: "alertmanager"
+
+
alertmanager_system_user
+
string
+
Advanced
+
alertmanager system user
+
Default: "alertmanager"
+
+
alertmanager_template_files
+
list / elements=string
+
List of folders where ansible will look for template files which will be copied to "{{ alertmanager_config_dir }}/templates/"
+
Files must have *.tmpl
+
Default: ["alertmanager/templates/*.tmpl"]
+
+
alertmanager_time_intervals
+
list / elements=string
+
A list of time intervals. Configuration same as in official docs
+
+
alertmanager_version
+
string
+
Alertmanager package version. Also accepts `latest` as parameter.
+
Default: "0.27.0"
+
+
alertmanager_victorops_api_key
+
string
+
+
alertmanager_victorops_api_url
+
string
+
+
alertmanager_web_external_url
+
string
+
External address on which alertmanager is available. Useful when behind reverse proxy. Ex. example.org/alertmanager
+
Default: "http://localhost:9093/"
+
+
alertmanager_web_listen_address
+
string
+
Address on which alertmanager will be listening
+
Default: "0.0.0.0:9093"
+
+
alertmanager_wechat_corp_id
+
string
+
Enterprise WeChat corporation id
+
+
alertmanager_wechat_secret
+
string
+
Enterprise WeChat secret token
+
+
alertmanager_wechat_url
+
string
+
Enterprise WeChat webhook url
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/bind_exporter_role.html b/pr/441/bind_exporter_role.html
new file mode 100644
index 00000000..b456ddde
--- /dev/null
+++ b/pr/441/bind_exporter_role.html
@@ -0,0 +1,387 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.bind_exporter role – Prometheus BIND Exporter — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.bind_exporter role – Prometheus BIND Exporter
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.bind_exporter role – Prometheus BIND Exporter
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.bind_exporter
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
bind_exporter_basic_auth_users
+
dictionary
+
Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.
+
+
bind_exporter_binary_install_dir
+
string
+
Advanced
+
Directory to install bind_exporter binary
+
Default: "/usr/local/bin"
+
+
bind_exporter_binary_url
+
string
+
URL of the bind_exporter binaries .tar.gz file
+
Default: "https://github.com/{{ _bind_exporter_repo }}/releases/download/v{{ bind_exporter_version }}/bind_exporter-{{ bind_exporter_version }}.{{ ansible_system | lower }}-{{ _bind_exporter_go_ansible_arch }}.tar.gz"
+
+
bind_exporter_checksums_url
+
string
+
URL of the bind_exporter checksums file
+
Default: "https://github.com/{{ _bind_exporter_repo }}/releases/download/v{{ bind_exporter_version }}/sha256sums.txt"
+
+
bind_exporter_config_dir
+
string
+
Path to directory with bind_exporter configuration
+
Default: "/etc/bind_exporter"
+
+
bind_exporter_http_server_config
+
dictionary
+
Config for HTTP/2 support.
+
Keys and values are the same as in prometheus docs .
+
+
bind_exporter_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/bind_exporter-{{ ansible_system | lower }}-{{ _bind_exporter_go_ansible_arch }}/{{ bind_exporter_version }}"
+
+
bind_exporter_pid_file
+
string
+
Path to BIND’s pid file to export process information
+
Default: "/run/named/named.pid"
+
+
bind_exporter_stats_groups
+
list / elements=string
+
List of statistics to collect
+
Choices:
+
+"server"
"view"
"tasks"
+
Default: []
+
+
bind_exporter_stats_url
+
string
+
HTTP XML API address of BIND server
+
Default: "http://localhost:8053/"
+
+
bind_exporter_stats_version
+
string
+
BIND statistics version.
+
Choices:
+
+"auto" ← (default)
"json"
"xml"
"xml.v3"
+
+
bind_exporter_system_group
+
string
+
Advanced
+
System group for BIND Exporter
+
Default: "bind-exp"
+
+
bind_exporter_system_user
+
string
+
Advanced
+
BIND Exporter user
+
Default: "bind-exp"
+
+
bind_exporter_timeout
+
string
+
Timeout for trying to get stats from BIND server
+
Default: "10s"
+
+
bind_exporter_tls_server_config
+
dictionary
+
Configuration for TLS authentication.
+
Keys and values are the same as in prometheus docs .
+
+
bind_exporter_version
+
string
+
BIND exporter package version. Also accepts latest as parameter.
+
Default: "0.7.0"
+
+
bind_exporter_web_listen_address
+
string
+
Address on which bind_exporter will listen
+
Default: "0.0.0.0:9119"
+
+
bind_exporter_web_telemetry_path
+
string
+
Path under which to expose metrics
+
Default: "/metrics"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/blackbox_exporter_role.html b/pr/441/blackbox_exporter_role.html
new file mode 100644
index 00000000..69498fcb
--- /dev/null
+++ b/pr/441/blackbox_exporter_role.html
@@ -0,0 +1,317 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.blackbox_exporter
+
+
+
+
+
+
+
+
+Deploy and manage Prometheus blackbox exporter which allows blackbox probing of endpoints over HTTP, HTTPS, DNS, TCP and ICMP.
+
+
+
+
+
+Parameter
Comments
+
+
+
blackbox_exporter_binary_install_dir
+
string
+
Advanced
+
Directory to install blackbox_exporter binary
+
Default: "/usr/local/bin"
+
+
blackbox_exporter_binary_url
+
string
+
URL of the blackbox_exporter binaries .tar.gz file
+
Default: "https://github.com/{{ _blackbox_exporter_repo }}/releases/download/v{{ blackbox_exporter_version }}/blackbox_exporter-{{ blackbox_exporter_version }}.{{ ansible_system | lower }}-{{ _blackbox_exporter_go_ansible_arch }}.tar.gz"
+
+
blackbox_exporter_checksums_url
+
string
+
URL of the blackbox exporter checksums file
+
Default: "https://github.com/{{ _blackbox_exporter_repo }}/releases/download/v{{ blackbox_exporter_version }}/sha256sums.txt"
+
+
blackbox_exporter_cli_flags
+
dictionary
+
Additional configuration flags passed to blackbox exporter binary at startup
+
+
blackbox_exporter_config_dir
+
string
+
Path to directory with blackbox_exporter configuration
+
Default: "/etc/blackbox_exporter"
+
+
blackbox_exporter_configuration_modules
+
dictionary
+
Endpoints configuration
+
Default: {"http_2xx": {"http": {"method": "GET", "valid_status_codes": []}, "prober": "http", "timeout": "5s"}}
+
+
blackbox_exporter_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/blackbox_exporter-{{ ansible_system | lower }}-{{ _blackbox_exporter_go_ansible_arch }}/{{ blackbox_exporter_version }}"
+
+
blackbox_exporter_system_group
+
string
+
The group the exporter runs as
+
Default: "blackbox-exp"
+
+
blackbox_exporter_system_user
+
string
+
The user the exporter runs as
+
Default: "blackbox-exp"
+
+
blackbox_exporter_version
+
string
+
Blackbox exporter package version. Also accepts latest as parameter.
+
Default: "0.25.0"
+
+
blackbox_exporter_web_listen_address
+
string
+
Address on which blackbox exporter will be listening
+
Default: "0.0.0.0:9115"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/cadvisor_role.html b/pr/441/cadvisor_role.html
new file mode 100644
index 00000000..b2120cb2
--- /dev/null
+++ b/pr/441/cadvisor_role.html
@@ -0,0 +1,407 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.cadvisor role – cAdvisor — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.cadvisor role – cAdvisor
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.cadvisor role – cAdvisor
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.cadvisor
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
cadvisor_binary_install_dir
+
string
+
Advanced
+
Directory to install binaries
+
Default: "/usr/local/bin"
+
+
cadvisor_binary_url
+
string
+
URL of the cadvisor binary file
+
Default: "https://github.com/{{ _cadvisor_repo }}/releases/download/v{{ cadvisor_version }}/cadvisor-v{{ cadvisor_version }}-{{ ansible_system | lower }}-{{ _cadvisor_go_ansible_arch }}"
+
+
cadvisor_disable_metrics
+
list / elements=string
+
comma-separated list of metrics to be disabled
+
(default advtcp,cpu_topology,cpuset,hugetlb,memory_numa,process,referenced_memory,resctrl,sched,tcp,udp)
+
Choices:
+
+"advtcp"
"app"
"cpu"
"cpuLoad"
"cpu_topology"
"cpuset"
"disk"
"diskIO"
"hugetlb"
"memory"
"memory_numa"
"network"
"oom_event"
"percpu"
"perf_event"
"process"
"referenced_memory"
"resctrl"
"sched"
"tcp"
+
Default: []
+
+
cadvisor_docker_only
+
boolean
+
do not report raw cgroup metrics, except the root cgroup
+
Choices:
+
+false ← (default)
true
+
+
cadvisor_enable_metrics
+
list / elements=string
+
comma-separated list of metrics to be enabled. If set, overrides ‘cadvisor_disable_metrics’
+
Choices:
+
+"advtcp"
"app"
"cpu"
"cpuLoad"
"cpu_topology"
"cpuset"
"disk"
"diskIO"
"hugetlb"
"memory"
"memory_numa"
"network"
"oom_event"
"percpu"
"perf_event"
"process"
"referenced_memory"
"resctrl"
"sched"
"tcp"
+
Default: []
+
+
cadvisor_env_metadata_whitelist
+
list / elements=string
+
comma-separated list of env variables to be used as labels on prometheus metrics
+
Default: []
+
+
cadvisor_listen_ip
+
string
+
Address on which cadvisor will listen
+
Default: "0.0.0.0"
+
+
cadvisor_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/cadvisor-{{ ansible_system | lower }}-{{ _cadvisor_go_ansible_arch }}/{{ cadvisor_version }}"
+
Port on which cadvisor will listen
+
Default: "8080"
+
+
cadvisor_prometheus_endpoint
+
string
+
Path under which to expose metrics
+
Default: "/metrics"
+
+
cadvisor_store_container_labels
+
boolean
+
store all container labels
+
Choices:
+
+false
true ← (default)
+
+
cadvisor_system_group
+
string
+
Advanced
+
System group for cadvisor
+
Default: "root"
+
+
cadvisor_system_user
+
string
+
Advanced
+
cAdvisor user
+
Default: "root"
+
+
cadvisor_version
+
string
+
cAdvisor package version. Also accepts latest as parameter.
+
Default: "0.49.1"
+
+
cadvisor_whitelisted_container_labels
+
list / elements=string
+
comma-separated list of container labels to be used as labels on prometheus metrics
+
Default: []
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/chrony_exporter_role.html b/pr/441/chrony_exporter_role.html
new file mode 100644
index 00000000..81b47af9
--- /dev/null
+++ b/pr/441/chrony_exporter_role.html
@@ -0,0 +1,352 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.chrony_exporter role – Prometheus Chrony Exporter — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.chrony_exporter role – Prometheus Chrony Exporter
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.chrony_exporter role – Prometheus Chrony Exporter
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.chrony_exporter
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
chrony_exporter_basic_auth_users
+
dictionary
+
Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.
+
+
chrony_exporter_binary_install_dir
+
string
+
Advanced
+
Directory to install binaries
+
Default: "/usr/local/bin"
+
+
chrony_exporter_binary_url
+
string
+
URL of the chrony_exporter binaries .tar.gz file
+
Default: "https://github.com/{{ _chrony_exporter_repo }}/releases/download/v{{ chrony_exporter_version }}/chrony_exporter-{{ chrony_exporter_version }}.{{ ansible_system | lower }}-{{ _chrony_exporter_go_ansible_arch }}.tar.gz"
+
+
chrony_exporter_checksums_url
+
string
+
URL of the chrony_exporter checksums file
+
Default: "https://github.com/{{ _chrony_exporter_repo }}/releases/download/v{{ chrony_exporter_version }}/sha256sums.txt"
+
+
chrony_exporter_config_dir
+
string
+
Path to directory with chrony_exporter configuration
+
Default: "/etc/chrony_exporter"
+
+
chrony_exporter_disabled_collectors
+
list / elements=string
+
List of disabled collectors.
+
By default chrony_exporter disables collectors listed here .
+
+
chrony_exporter_enabled_collectors
+
list / elements=string
+
List of dicts defining additionally enabled collectors and their configuration.
+
It adds collectors to those enabled by default .
+
Default: ["tracking"]
+
+
chrony_exporter_http_server_config
+
dictionary
+
+
chrony_exporter_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/chrony_exporter-{{ ansible_system | lower }}-{{ _chrony_exporter_go_ansible_arch }}/{{ chrony_exporter_version }}"
+
+
chrony_exporter_system_group
+
string
+
Advanced
+
System group for chrony_exporter
+
Default: "chrony-exp"
+
+
chrony_exporter_system_user
+
string
+
Advanced
+
Chrony exporter user
+
Default: "chrony-exp"
+
+
chrony_exporter_tls_server_config
+
dictionary
+
+
chrony_exporter_version
+
string
+
Chrony exporter package version. Also accepts latest as parameter.
+
Default: "0.10.1"
+
+
chrony_exporter_web_listen_address
+
string
+
Address on which chrony_exporter will listen
+
Default: "0.0.0.0:9123"
+
+
chrony_exporter_web_telemetry_path
+
string
+
Path under which to expose metrics
+
Default: "/metrics"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/environment_variables.html b/pr/441/environment_variables.html
new file mode 100644
index 00000000..55abff78
--- /dev/null
+++ b/pr/441/environment_variables.html
@@ -0,0 +1,162 @@
+
+
+
+
+
+
+
+
+
+
Index of all Collection Environment Variables — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ Index of all Collection Environment Variables
+
+
+
+
+
+
+
+
+
+
+
+Index of all Collection Environment Variables
+The following index documents all environment variables declared by plugins in collections.
+Environment variables used by the ansible-core configuration are documented in Ansible Configuration Settings
+No environment variables have been defined.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/fail2ban_exporter_role.html b/pr/441/fail2ban_exporter_role.html
new file mode 100644
index 00000000..3d43012a
--- /dev/null
+++ b/pr/441/fail2ban_exporter_role.html
@@ -0,0 +1,320 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.fail2ban_exporter role – Prometheus fail2ban_exporter — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.fail2ban_exporter role – Prometheus fail2ban_exporter
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.fail2ban_exporter role – Prometheus fail2ban_exporter
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.fail2ban_exporter
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
fail2ban_exporter_binary_install_dir
+
string
+
Advanced
+
Directory to install fail2ban_exporter binary
+
Default: "/usr/local/bin"
+
+
fail2ban_exporter_binary_url
+
string
+
URL of the fail2ban_exporter binaries .tar.gz file
+
Default: "https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/-/releases/v{{ fail2ban_exporter_version }}/downloads/fail2ban_exporter_{{ fail2ban_exporter_version }}_{{ ansible_system | lower }}_{{ _fail2ban_exporter_go_ansible_arch }}.tar.gz"
+
+
fail2ban_exporter_checksums_url
+
string
+
URL of the fail2ban_exporter checksums file
+
Default: "https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/-/releases/v{{ fail2ban_exporter_version }}/downloads/fail2ban_exporter_{{ fail2ban_exporter_version }}_checksums.txt"
+
+
fail2ban_exporter_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/fail2ban_exporter-{{ ansible_system | lower }}-{{ _fail2ban_exporter_go_ansible_arch }}/{{ fail2ban_exporter_version }}"
+
+
fail2ban_exporter_password
+
string
+
Advanced
+
Password to use to protect endpoints with basic auth
+
+
fail2ban_exporter_socket
+
string
+
Path to the fail2ban server socket
+
Default: "/var/run/fail2ban/fail2ban.sock"
+
+
fail2ban_exporter_system_group
+
string
+
Advanced
+
System group for fail2ban exporter
+
Default: "root"
+
+
fail2ban_exporter_system_user
+
string
+
Advanced
+
fail2ban exporter system user
+
Default: "root"
+
+
fail2ban_exporter_username
+
string
+
Advanced
+
Username to use to protect endpoints with basic auth
+
+
fail2ban_exporter_version
+
string
+
fail2ban_exporter package version. Also accepts latest as parameter.
+
Default: "0.10.1"
+
+
fail2ban_exporter_web_listen_address
+
string
+
Address on which fail2ban exporter will listen
+
Default: "0.0.0.0:9191"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/index.html b/pr/441/index.html
new file mode 100644
index 00000000..b3eb8e3d
--- /dev/null
+++ b/pr/441/index.html
@@ -0,0 +1,228 @@
+
+
+
+
+
+
+
+
+
+
Prometheus.Prometheus — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ Prometheus.Prometheus
+
+
+
+
+
+
+
+
+
+
+
+Prometheus.Prometheus
+Collection version 0.21.0
+
+
+
+
+
+Ansible Collection for Prometheus
+Authors:
+
+Supported ansible-core versions:
+
+2.9.0 or newer
2.17.99 or older
+
+
+
+
+
+
+There are no plugins in the prometheus.prometheus collection with automatically generated documentation.
+
+
+
+These are the roles in the prometheus.prometheus collection:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/influxdb_exporter_role.html b/pr/441/influxdb_exporter_role.html
new file mode 100644
index 00000000..d44c1686
--- /dev/null
+++ b/pr/441/influxdb_exporter_role.html
@@ -0,0 +1,370 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.influxdb_exporter role – Prometheus Influxdb Exporter — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.influxdb_exporter role – Prometheus Influxdb Exporter
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.influxdb_exporter role – Prometheus Influxdb Exporter
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.influxdb_exporter
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
influxdb_exporter_binary_install_dir
+
string
+
Advanced
+
Directory to install influxdb_exporter binary
+
Default: "/usr/local/bin"
+
+
influxdb_exporter_binary_url
+
string
+
URL of the influxdb exporter binaries .tar.gz file
+
Default: "https://github.com/{{ _influxdb_exporter_repo }}/releases/download/v{{ influxdb_exporter_version }}/influxdb_exporter-{{ influxdb_exporter_version }}.{{ ansible_system | lower }}-{{ _influxdb_exporter_go_ansible_arch }}.tar.gz"
+
+
influxdb_exporter_checksums_url
+
string
+
URL of the influxdb exporter checksums file
+
Default: "https://github.com/{{ _influxdb_exporter_repo }}/releases/download/v{{ influxdb_exporter_version }}/sha256sums.txt"
+
+
influxdb_exporter_config_dir
+
string
+
Path to directory with influxdb_exporter configuration
+
Default: "/etc/influxdb_exporter"
+
+
influxdb_exporter_export_timestamps
+
string
+
Export timestamps of points
+
Default: true
+
+
influxdb_exporter_exporter_web_telemetry_path
+
string
+
Path under which to expose metrics
+
Default: "/metrics"
+
+
influxdb_exporter_influxdb_sample_expiry
+
string
+
How long a sample is valid for
+
Default: "5m"
+
+
influxdb_exporter_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/influxdb_exporter-{{ ansible_system | lower }}-{{ _influxdb_exporter_go_ansible_arch }}/{{ influxdb_exporter_version }}"
+
+
influxdb_exporter_log_format
+
string
+
Output format of log messages
+
Choices:
+
+"logfmt" ← (default)
"json"
+
+
influxdb_exporter_log_level
+
string
+
Only log messages with the given severity or above
+
Choices:
+
+"debug"
"info" ← (default)
"warn"
"error"
+
+
influxdb_exporter_system_group
+
string
+
Advanced
+
System group for influxdb exporter
+
Default: "influxdb-exp"
+
+
influxdb_exporter_system_user
+
string
+
Advanced
+
influxdb exporter user
+
Default: "influxdb-exp"
+
+
influxdb_exporter_udp_bind_address
+
string
+
Address on which to listen for udp packets
+
Default: "0.0.0.0:9122"
+
+
influxdb_exporter_version
+
string
+
influxdb exporter package version. Also accepts latest as parameter.
+
Default: "0.11.5"
+
+
influxdb_exporter_web_listen_address
+
string
+
Address on which influxdb exporter will listen
+
Default: "0.0.0.0:9122"
+
+
influxdb_exporter_web_telemetry_path
+
string
+
Path under which to expose metrics
+
Default: "/metrics"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/ipmi_exporter_role.html b/pr/441/ipmi_exporter_role.html
new file mode 100644
index 00000000..13266ff6
--- /dev/null
+++ b/pr/441/ipmi_exporter_role.html
@@ -0,0 +1,351 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.ipmi_exporter role – Prometheus ipmi_exporter — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.ipmi_exporter role – Prometheus ipmi_exporter
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.ipmi_exporter role – Prometheus ipmi_exporter
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.ipmi_exporter
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
ipmi_exporter_basic_auth_users
+
dictionary
+
Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.
+
+
ipmi_exporter_binary_install_dir
+
string
+
Advanced
+
Directory to install ipmi_exporter binary
+
Default: "/usr/local/bin"
+
+
ipmi_exporter_binary_url
+
string
+
URL of the ipmi_exporter binaries .tar.gz file
+
Default: "https://github.com/{{ _ipmi_exporter_repo }}/releases/download/v{{ ipmi_exporter_version }}/ipmi_exporter-{{ ipmi_exporter_version }}.{{ ansible_system | lower }}-{{ _ipmi_exporter_go_ansible_arch }}.tar.gz"
+
+
ipmi_exporter_checksums_url
+
string
+
URL of the ipmi_exporter checksums file
+
Default: "https://github.com/{{ _ipmi_exporter_repo }}/releases/download/v{{ ipmi_exporter_version }}/sha256sums.txt"
+
+
ipmi_exporter_config_dir
+
string
+
Path to directory with ipmi_exporter configuration
+
Default: "/etc/ipmi_exporter"
+
+
ipmi_exporter_http_server_config
+
dictionary
+
+
ipmi_exporter_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/ipmi_exporter-{{ ansible_system | lower }}-{{ _ipmi_exporter_go_ansible_arch }}/{{ ipmi_exporter_version }}"
+
+
ipmi_exporter_log_format
+
string
+
Output format of log messages. One of: [logfmt, json]
+
Default: "logfmt"
+
+
ipmi_exporter_log_level
+
string
+
Only log messages with the given severity or above. One of: [debug, info, warn, error]
+
Default: "info"
+
+
ipmi_exporter_modules
+
dictionary
+
+
ipmi_exporter_system_group
+
string
+
Advanced
+
System group for ipmi_exporter
+
Default: "ipmi-exp"
+
+
ipmi_exporter_system_user
+
string
+
Advanced
+
ipmi_exporter user
+
Default: "ipmi-exp"
+
+
ipmi_exporter_tls_server_config
+
dictionary
+
Configuration for TLS authentication.
+
Keys and values are the same as in ipmi_exporter docs .
+
+
ipmi_exporter_version
+
string
+
ipmi_exporter package version. Also accepts latest as parameter.
+
Default: "1.8.0"
+
+
ipmi_exporter_web_listen_address
+
string
+
Address on which ipmi exporter will listen
+
Default: "0.0.0.0:9290"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/memcached_exporter_role.html b/pr/441/memcached_exporter_role.html
new file mode 100644
index 00000000..fa9497f3
--- /dev/null
+++ b/pr/441/memcached_exporter_role.html
@@ -0,0 +1,367 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.memcached_exporter role – Prometheus memcached_exporter — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.memcached_exporter role – Prometheus memcached_exporter
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.memcached_exporter role – Prometheus memcached_exporter
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.memcached_exporter
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
memcached_exporter_basic_auth_users
+
dictionary
+
Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.
+
+
memcached_exporter_binary_install_dir
+
string
+
Advanced
+
Directory to install memcached_exporter binary
+
Default: "/usr/local/bin"
+
+
memcached_exporter_binary_url
+
string
+
URL of the memcached_exporter binaries .tar.gz file
+
Default: "https://github.com/{{ _memcached_exporter_repo }}/releases/download/v{{ memcached_exporter_version }}/memcached_exporter-{{ memcached_exporter_version }}.{{ ansible_system | lower }}-{{ _memcached_exporter_go_ansible_arch }}.tar.gz"
+
+
memcached_exporter_checksums_url
+
string
+
URL of the memcached_exporter checksums file
+
Default: "https://github.com/{{ _memcached_exporter_repo }}/releases/download/v{{ memcached_exporter_version }}/sha256sums.txt"
+
+
memcached_exporter_config_dir
+
string
+
Path to directory with memcached_exporter configuration
+
Default: "/etc/memcached_exporter"
+
+
memcached_exporter_http_server_config
+
dictionary
+
+
memcached_exporter_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/memcached_exporter-{{ ansible_system | lower }}-{{ _memcached_exporter_go_ansible_arch }}/{{ memcached_exporter_version }}"
+
+
memcached_exporter_log_format
+
string
+
Output format of log messages. One of: [logfmt, json]
+
Default: "logfmt"
+
+
memcached_exporter_log_level
+
string
+
Only log messages with the given severity or above. One of: [debug, info, warn, error]
+
Default: "info"
+
+
memcached_exporter_memcached_address
+
string
+
The ip to the memcached server to monitor
+
Default: ""
+
+
memcached_exporter_memcached_pid_file
+
string
+
The path to the memcached PID file for process monitoring
+
Default: ""
+
+
memcached_exporter_system_group
+
string
+
Advanced
+
System group for memcached_exporter
+
Default: "memcached-exp"
+
+
memcached_exporter_system_user
+
string
+
Advanced
+
memcached_exporter user
+
Default: "memcached-exp"
+
+
memcached_exporter_tls_server_config
+
dictionary
+
+
memcached_exporter_version
+
string
+
memcached_exporter package version. Also accepts latest as parameter.
+
Default: "0.14.4"
+
+
memcached_exporter_web_listen_address
+
string
+
Address on which memcached exporter will listen
+
Default: "0.0.0.0:9150"
+
+
memcached_exporter_web_telemetry_path
+
string
+
Path under which to expose metrics
+
Default: "/metrics"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/mongodb_exporter_role.html b/pr/441/mongodb_exporter_role.html
new file mode 100644
index 00000000..e69a0e2f
--- /dev/null
+++ b/pr/441/mongodb_exporter_role.html
@@ -0,0 +1,463 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.mongodb_exporter role – Prometheus mongodb_exporter — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.mongodb_exporter role – Prometheus mongodb_exporter
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.mongodb_exporter role – Prometheus mongodb_exporter
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.mongodb_exporter
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
mongodb_exporter_basic_auth_users
+
dictionary
+
Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.
+
+
mongodb_exporter_binary_install_dir
+
string
+
Advanced
+
Directory to install mongodb_exporter binary
+
Default: "/usr/local/bin"
+
+
mongodb_exporter_binary_url
+
string
+
URL of the mongodb_exporter binaries .tar.gz file
+
Default: "https://github.com/{{ _mongodb_exporter_repo }}/releases/download/v{{ mongodb_exporter_version }}/mongodb_exporter-{{ mongodb_exporter_version }}.{{ ansible_system | lower }}-{{ _mongodb_exporter_go_ansible_arch }}.tar.gz"
+
+
mongodb_exporter_checksums_url
+
string
+
URL of the mongodb_exporter checksums file
+
Default: "https://github.com/{{ _mongodb_exporter_repo }}/releases/download/v{{ mongodb_exporter_version }}/mongodb_exporter_{{ mongodb_exporter_version }}_checksums.txt"
+
+
mongodb_exporter_collectors
+
string
+
List collectors from documantation .
+
You can specify ‘all’ to enable all collectors
+
+
mongodb_exporter_collstats_colls
+
list / elements=string
+
List of databases.collections to get $collStats
+
+
mongodb_exporter_collstats_limit
+
integer
+
Disable collstats, dbstats, topmetrics and indexstats collector if there are more than <n> collections. 0=No limit
+
Default: 0
+
+
mongodb_exporter_compatible_mode
+
boolean
+
Enable old mongodb-exporter compatible metrics
+
Choices:
+
+false ← (default)
true
+
+
mongodb_exporter_config_dir
+
string
+
Path to directory with mongodb_exporter configuration
+
Default: "/etc/mongodb_exporter"
+
+
mongodb_exporter_direct_connect
+
boolean
+
Whether or not a direct connect should be made. Direct connections are not valid if multiple hosts are specified or an SRV URI is used
+
Choices:
+
+false ← (default)
true
+
+
mongodb_exporter_discovering_mode
+
boolean
+
Enable autodiscover collections
+
Choices:
+
+false ← (default)
true
+
+
mongodb_exporter_global_conn_pool
+
boolean
+
Use global connection pool instead of creating new pool for each http request
+
Choices:
+
+false ← (default)
true
+
+
mongodb_exporter_http_server_config
+
dictionary
+
+
mongodb_exporter_indexstats_colls
+
list / elements=string
+
List of databases.collections to get $indexStats
+
+
mongodb_exporter_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/mongodb_exporter-{{ ansible_system | lower }}-{{ _mongodb_exporter_go_ansible_arch }}/{{ mongodb_exporter_version }}"
+
+
mongodb_exporter_log_level
+
string
+
Only log messages with the given severity or above.
+
Choices:
+
+"debug"
"info"
"warn"
"error" ← (default)
"fatal"
+
+
mongodb_exporter_metrics_overridedescendingindex
+
boolean
+
Enable descending index name override to replace -1 with _DESC
+
Choices:
+
+false ← (default)
true
+
+
mongodb_exporter_profile_time_ts
+
integer
+
Set time for scrape slow queries
+
Default: 30
+
+
mongodb_exporter_system_group
+
string
+
Advanced
+
System group for mongodb_exporter
+
Default: "mongodb-exp"
+
+
mongodb_exporter_system_user
+
string
+
Advanced
+
mongodb_exporter user
+
Default: "mongodb-exp"
+
+
mongodb_exporter_timeout_offset
+
integer
+
Offset to subtract from the timeout in seconds
+
Default: 1
+
+
mongodb_exporter_tls_server_config
+
dictionary
+
+
mongodb_exporter_uri
+
string / required
+
+
mongodb_exporter_version
+
string
+
mongodb_exporter package version. Also accepts latest as parameter.
+
Default: "0.41.1"
+
+
mongodb_exporter_web_listen_address
+
string
+
Address on which mongodb exporter will listen
+
Default: "0.0.0.0:9216"
+
+
mongodb_exporter_web_telemetry_path
+
string
+
Path under which to expose metrics
+
Default: "/metrics"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/mysqld_exporter_role.html b/pr/441/mysqld_exporter_role.html
new file mode 100644
index 00000000..59c1f97f
--- /dev/null
+++ b/pr/441/mysqld_exporter_role.html
@@ -0,0 +1,398 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.mysqld_exporter
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
mysqld_exporter_basic_auth_users
+
dictionary
+
Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.
+
+
mysqld_exporter_binary_install_dir
+
string
+
Advanced
+
Directory to install mysqld_exporter binary
+
Default: "/usr/local/bin"
+
+
mysqld_exporter_binary_url
+
string
+
URL of the mysqld_exporter binaries .tar.gz file
+
Default: "https://github.com/{{ _mysqld_exporter_repo }}/releases/download/v{{ mysqld_exporter_version }}/mysqld_exporter-{{ mysqld_exporter_version }}.{{ ansible_system | lower }}-{{ _mysqld_exporter_go_ansible_arch }}.tar.gz"
+
+
mysqld_exporter_checksums_url
+
string
+
URL of the mysqld_exporter checksums file
+
Default: "https://github.com/{{ _mysqld_exporter_repo }}/releases/download/v{{ mysqld_exporter_version }}/sha256sums.txt"
+
+
mysqld_exporter_config_dir
+
string
+
Path to directory with mysqld_exporter configuration
+
Default: "/etc/mysqld_exporter"
+
+
mysqld_exporter_config_file
+
string
+
The filename of the exporter mysql config file
+
Default: "mysqld_exporter.cnf"
+
+
mysqld_exporter_disabled_collectors
+
list / elements=string
+
List of disabled collectors.
+
By default mysqld_exporter disables collectors listed here .
+
+
mysqld_exporter_enabled_collectors
+
list / elements=string
+
List of dicts defining additionally enabled collectors and their configuration.
+
It adds collectors to those enabled by default .
+
Default: []
+
+
mysqld_exporter_host
+
string
+
+
mysqld_exporter_http_server_config
+
dictionary
+
+
mysqld_exporter_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/mysqld_exporter-{{ ansible_system | lower }}-{{ _mysqld_exporter_go_ansible_arch }}/{{ mysqld_exporter_version }}"
+
+
mysqld_exporter_password
+
string
+
The password for MySQL login
+
Default: "secret"
+
+
mysqld_exporter_port
+
string
+
+
mysqld_exporter_socket
+
string
+
The target MySQL unix socket
+
Default: "/run/mysqld/mysqld.sock"
+
+
mysqld_exporter_system_group
+
string
+
Advanced
+
System group for MySQLd Exporter
+
Default: "mysqld-exp"
+
+
mysqld_exporter_system_user
+
string
+
Advanced
+
MySQLd Exporter user
+
Default: "mysqld-exp"
+
+
mysqld_exporter_tls_server_config
+
dictionary
+
+
mysqld_exporter_username
+
string
+
The username for MySQL login
+
Default: "exporter"
+
+
mysqld_exporter_version
+
string
+
MySQLd exporter package version. Also accepts latest as parameter.
+
Default: "0.15.1"
+
+
mysqld_exporter_web_listen_address
+
string
+
Address on which mysqld_exporter will listen
+
Default: "0.0.0.0:9104"
+
+
mysqld_exporter_web_telemetry_path
+
string
+
Path under which to expose metrics
+
Default: "/metrics"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/nginx_exporter_role.html b/pr/441/nginx_exporter_role.html
new file mode 100644
index 00000000..c7420cfd
--- /dev/null
+++ b/pr/441/nginx_exporter_role.html
@@ -0,0 +1,371 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.nginx_exporter role – Prometheus nginx_exporter — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.nginx_exporter role – Prometheus nginx_exporter
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.nginx_exporter role – Prometheus nginx_exporter
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.nginx_exporter
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
nginx_exporter_basic_auth_users
+
dictionary
+
Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.
+
+
nginx_exporter_binary_install_dir
+
string
+
Advanced
+
Directory to install nginx_exporter binary
+
Default: "/usr/local/bin"
+
+
nginx_exporter_binary_url
+
string
+
URL of the nginx_exporter binaries .tar.gz file
+
Default: "https://github.com/{{ _nginx_exporter_repo }}/releases/download/v{{ nginx_exporter_version }}/nginx-prometheus-exporter_{{ nginx_exporter_version }}_{{ ansible_system | lower }}_{{ _nginx_exporter_go_ansible_arch }}.tar.gz"
+
+
nginx_exporter_checksums_url
+
string
+
URL of the nginx_exporter checksums file
+
Default: "https://github.com/{{ _nginx_exporter_repo }}/releases/download/v{{ nginx_exporter_version }}/nginx-prometheus-exporter_{{ nginx_exporter_version }}_checksums.txt"
+
+
nginx_exporter_config_dir
+
string
+
Path to directory with nginx_exporter configuration
+
Default: "/etc/nginx_exporter"
+
+
nginx_exporter_http_server_config
+
dictionary
+
+
nginx_exporter_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/nginx_exporter-{{ ansible_system | lower }}-{{ _nginx_exporter_go_ansible_arch }}/{{ nginx_exporter_version }}"
+
+
nginx_exporter_log_format
+
string
+
Output format of log messages. One of: [logfmt, json]
+
Default: "logfmt"
+
+
nginx_exporter_log_level
+
string
+
Only log messages with the given severity or above. One of: [debug, info, warn, error]
+
Default: "info"
+
+
nginx_exporter_plus
+
boolean
+
Start the exporter for NGINX Plus.
+
Choices:
+
+false ← (default)
true
+
+
nginx_exporter_scrape_uri
+
string
+
A URI or unix domain socket path for scraping NGINX or NGINX Plus metrics. For NGINX, the stub_status page must be available through the URI.
+
Default: "http://127.0.0.1/stub_status"
+
+
nginx_exporter_system_group
+
string
+
Advanced
+
System group for nginx_exporter
+
Default: "nginx-exp"
+
+
nginx_exporter_system_user
+
string
+
Advanced
+
nginx_exporter user
+
Default: "nginx-exp"
+
+
nginx_exporter_tls_server_config
+
dictionary
+
Configuration for TLS authentication.
+
Keys and values are the same as in nginx_exporter docs .
+
+
nginx_exporter_version
+
string
+
nginx_exporter package version. Also accepts latest as parameter.
+
Default: "1.3.0"
+
+
nginx_exporter_web_listen_address
+
string
+
Address on which nginx exporter will listen
+
Default: "0.0.0.0:9113"
+
+
nginx_exporter_web_telemetry_path
+
string
+
Path under which to expose metrics
+
Default: "/metrics"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/node_exporter_role.html b/pr/441/node_exporter_role.html
new file mode 100644
index 00000000..79941059
--- /dev/null
+++ b/pr/441/node_exporter_role.html
@@ -0,0 +1,374 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.node_exporter role – Prometheus Node Exporter — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.node_exporter role – Prometheus Node Exporter
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.node_exporter role – Prometheus Node Exporter
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.node_exporter
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
node_exporter_basic_auth_users
+
dictionary
+
Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.
+
+
node_exporter_binary_install_dir
+
string
+
Advanced
+
Directory to install node_exporter binary
+
Default: "/usr/local/bin"
+
+
node_exporter_binary_url
+
string
+
URL of the node exporter binaries .tar.gz file
+
Default: "https://github.com/{{ _node_exporter_repo }}/releases/download/v{{ node_exporter_version }}/node_exporter-{{ node_exporter_version }}.{{ ansible_system | lower }}-{{ _node_exporter_go_ansible_arch }}.tar.gz"
+
+
node_exporter_checksums_url
+
string
+
URL of the node exporter checksums file
+
Default: "https://github.com/{{ _node_exporter_repo }}/releases/download/v{{ node_exporter_version }}/sha256sums.txt"
+
+
node_exporter_config_dir
+
string
+
Path to directory with node_exporter configuration
+
Default: "/etc/node_exporter"
+
+
node_exporter_disabled_collectors
+
list / elements=string
+
List of disabled collectors.
+
By default node_exporter disables collectors listed here .
+
+
node_exporter_enabled_collectors
+
list / elements=string
+
List of dicts defining additionally enabled collectors and their configuration.
+
It adds collectors to those enabled by default .
+
Default: ["systemd", {"textfile": {"directory": "{{ node_exporter_textfile_dir }}"}}]
+
+
node_exporter_http_server_config
+
dictionary
+
+
node_exporter_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/node_exporter-{{ ansible_system | lower }}-{{ _node_exporter_go_ansible_arch }}/{{ node_exporter_version }}"
+
+
node_exporter_system_group
+
string
+
Advanced
+
System group for node exporter
+
Default: "node-exp"
+
+
node_exporter_system_user
+
string
+
Advanced
+
Node exporter user
+
Default: "node-exp"
+
+
node_exporter_textfile_dir
+
string
+
Directory used by the Textfile Collector .
+
To get permissions to write metrics in this directory, users must be in node-exp
+
Note: More information in TROUBLESHOOTING.md guide.
+
Default: "/var/lib/node_exporter"
+
+
node_exporter_tls_server_config
+
dictionary
+
Configuration for TLS authentication.
+
Keys and values are the same as in node_exporter docs .
+
+
node_exporter_version
+
string
+
Node exporter package version. Also accepts latest as parameter.
+
Default: "1.8.2"
+
+
node_exporter_web_disable_exporter_metrics
+
boolean
+
Exclude metrics about the exporter itself (promhttp_*, process_*, go_*).
+
Choices:
+
+false ← (default)
true
+
+
node_exporter_web_listen_address
+
string
+
Address on which node exporter will listen
+
Default: "0.0.0.0:9100"
+
+
node_exporter_web_telemetry_path
+
string
+
Path under which to expose metrics
+
Default: "/metrics"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/nvidia_gpu_exporter_role.html b/pr/441/nvidia_gpu_exporter_role.html
new file mode 100644
index 00000000..e6a6fdb6
--- /dev/null
+++ b/pr/441/nvidia_gpu_exporter_role.html
@@ -0,0 +1,312 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.nvidia_gpu_exporter role – Prometheus Nvidia GPU Exporter — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.nvidia_gpu_exporter role – Prometheus Nvidia GPU Exporter
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.nvidia_gpu_exporter role – Prometheus Nvidia GPU Exporter
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.nvidia_gpu_exporter
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
nvidia_gpu_exporter_binary_install_dir
+
string
+
Advanced
+
Directory to install nvidia_gpu_exporter binary
+
Default: "/usr/local/bin"
+
+
nvidia_gpu_exporter_binary_url
+
string
+
URL of the Nvidia GPU exporter binaries .tar.gz file
+
Default: "https://github.com/{{ _nvidia_gpu_exporter_repo }}/releases/download/v{{ nvidia_gpu_exporter_version }}/nvidia_gpu_exporter_{{ nvidia_gpu_exporter_version }}_{{ ansible_system | lower }}_{{ _nvidia_gpu_exporter_go_ansible_arch }}.tar.gz"
+
+
nvidia_gpu_exporter_checksums_url
+
string
+
URL of the Nvidia GPU exporter checksums file
+
Default: "https://github.com/{{ _nvidia_gpu_exporter_repo }}/releases/download/v{{ nvidia_gpu_exporter_version }}/sha256sums.txt"
+
+
nvidia_gpu_exporter_config_dir
+
string
+
Path to directory with nvidia_gpu_exporter configuration
+
Default: "/etc/nvidia_gpu_exporter"
+
+
nvidia_gpu_exporter_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/nvidia_gpu_exporter-{{ ansible_system | lower }}-{{ _nvidia_gpu_exporter_go_ansible_arch }}/{{ nvidia_gpu_exporter_version }}"
+
+
nvidia_gpu_exporter_system_group
+
string
+
Advanced
+
System group for Nvidia GPU exporter
+
Default: "nvidia-gpu-exp"
+
+
nvidia_gpu_exporter_system_user
+
string
+
Advanced
+
Nvidia GPU exporter user
+
Default: "nvidia-gpu-exp"
+
+
nvidia_gpu_exporter_version
+
string
+
Nvidia GPU exporter package version. Also accepts latest as parameter.
+
Default: "1.2.1"
+
+
nvidia_gpu_exporter_web_listen_address
+
string
+
Address on which Nvidia GPU exporter will listen
+
Default: "0.0.0.0:9835"
+
+
nvidia_gpu_exporter_web_telemetry_path
+
string
+
Path under which to expose metrics
+
Default: "/metrics"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/objects.inv b/pr/441/objects.inv
new file mode 100644
index 00000000..6209317d
Binary files /dev/null and b/pr/441/objects.inv differ
diff --git a/pr/441/postgres_exporter_role.html b/pr/441/postgres_exporter_role.html
new file mode 100644
index 00000000..bf12ef34
--- /dev/null
+++ b/pr/441/postgres_exporter_role.html
@@ -0,0 +1,391 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.postgres_exporter role – Prometheus PostgreSQL Exporter — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.postgres_exporter role – Prometheus PostgreSQL Exporter
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.postgres_exporter role – Prometheus PostgreSQL Exporter
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.postgres_exporter
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
postgres_exporter_basic_auth_users
+
dictionary
+
Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.
+
+
postgres_exporter_binary_install_dir
+
string
+
Advanced
+
Directory to install postgres_exporter binary
+
Default: "/usr/local/bin"
+
+
postgres_exporter_binary_url
+
string
+
URL of the postgres_exporter binaries .tar.gz file
+
Default: "https://github.com/{{ _postgres_exporter_repo }}/releases/download/v{{ postgres_exporter_version }}/postgres_exporter-{{ postgres_exporter_version }}.{{ ansible_system | lower }}-{{ _postgres_exporter_go_ansible_arch }}.tar.gz"
+
+
postgres_exporter_checksums_url
+
string
+
URL of the postgres_exporter checksums file
+
Default: "https://github.com/{{ _postgres_exporter_repo }}/releases/download/v{{ postgres_exporter_version }}/sha256sums.txt"
+
+
postgres_exporter_config_dir
+
string
+
Path to directory with postgres_exporter configuration
+
Default: "/etc/postgres_exporter"
+
+
postgres_exporter_config_file
+
string
+
The filename of the postgres exporter config file
+
Default: "/etc/postgres_exporter/postgres_exporter.yml"
+
+
postgres_exporter_disabled_collectors
+
list / elements=string
+
List of disabled collectors.
+
By default postgres_exporter disables collectors listed here .
+
+
postgres_exporter_enabled_collectors
+
list / elements=string
+
List of dicts defining additionally enabled collectors and their configuration.
+
It adds collectors to those enabled by default .
+
Default: []
+
+
postgres_exporter_http_server_config
+
dictionary
+
Config for HTTP/2 support.
+
Keys and values are the same as in prometheus docs .
+
+
postgres_exporter_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/postgres_exporter-{{ ansible_system | lower }}-{{ _postgres_exporter_go_ansible_arch }}/{{ postgres_exporter_version }}"
+
+
postgres_exporter_name
+
string
+
The target PostgreSQL URI
+
Default: "postgresql:///postgres?host=/var/run/postgresql"
+
+
postgres_exporter_password
+
string
+
The password for PostgreSQL password, required for postgres_exporter_uri
+
Default: "secret"
+
+
postgres_exporter_system_group
+
string
+
Advanced
+
System group for PostgreSQL Exporter
+
Default: "postgres-exp"
+
+
postgres_exporter_system_user
+
string
+
Advanced
+
PostgreSQL Exporter user
+
Default: "postgres-exp"
+
+
postgres_exporter_tls_server_config
+
dictionary
+
Configuration for TLS authentication.
+
Keys and values are the same as in prometheus docs .
+
+
postgres_exporter_uri
+
string
+
The target PostgreSQL, alternative format, single target only is supported. You should set postgres_exporter_name to empty string to use it. Read more here
+
+
postgres_exporter_username
+
string
+
The username for PostgreSQL login, required for postgres_exporter_uri
+
Default: "exporter"
+
+
postgres_exporter_version
+
string
+
PostgreSQL exporter package version. Also accepts latest as parameter.
+
Default: "0.15.0"
+
+
postgres_exporter_web_listen_address
+
string
+
Address on which postgres_exporter will listen
+
Default: "0.0.0.0:9187"
+
+
postgres_exporter_web_telemetry_path
+
string
+
Path under which to expose metrics
+
Default: "/metrics"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/process_exporter_role.html b/pr/441/process_exporter_role.html
new file mode 100644
index 00000000..540b7f1b
--- /dev/null
+++ b/pr/441/process_exporter_role.html
@@ -0,0 +1,343 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.process_exporter role – Prometheus Process exporter — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.process_exporter role – Prometheus Process exporter
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.process_exporter role – Prometheus Process exporter
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.process_exporter
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
process_exporter_basic_auth_users
+
dictionary
+
Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.
+
+
process_exporter_binary_install_dir
+
string
+
Advanced
+
Directory to install process_exporter binary
+
Default: "/usr/local/bin"
+
+
process_exporter_binary_url
+
string
+
URL of the Process exporter binaries .tar.gz file
+
Default: "https://github.com/{{ _process_exporter_repo }}/releases/download/v{{ process_exporter_version }}/process-exporter-{{ process_exporter_version }}.{{ ansible_system | lower }}-{{ _process_exporter_go_ansible_arch }}.tar.gz"
+
+
process_exporter_checksums_url
+
string
+
URL of the Process exporter checksums file
+
Default: "https://github.com/{{ _process_exporter_repo }}/releases/download/v{{ process_exporter_version }}/checksums.txt"
+
+
process_exporter_config_dir
+
string
+
Path to directory with process_exporter configuration
+
Default: "/etc/process_exporter"
+
+
process_exporter_http_server_config
+
dictionary
+
Config for HTTP/2 support.
+
+
process_exporter_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/process_exporter-{{ ansible_system | lower }}-{{ _process_exporter_go_ansible_arch }}/{{ process_exporter_version }}"
+
+
process_exporter_names
+
string
+
+
process_exporter_system_group
+
string
+
Advanced
+
System group for Process exporter
+
Default: "process-exp"
+
+
process_exporter_system_user
+
string
+
Advanced
+
Process exporter user
+
Default: "process-exp"
+
+
process_exporter_tls_server_config
+
dictionary
+
Configuration for TLS authentication.
+
+
process_exporter_version
+
string
+
Process exporter package version. Also accepts latest as parameter.
+
Default: "0.8.3"
+
+
process_exporter_web_listen_address
+
string
+
Address on which Process exporter will listen
+
Default: "0.0.0.0:9256"
+
+
process_exporter_web_telemetry_path
+
string
+
Path under which to expose metrics
+
Default: "/metrics"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/prometheus_role.html b/pr/441/prometheus_role.html
new file mode 100644
index 00000000..4df110c8
--- /dev/null
+++ b/pr/441/prometheus_role.html
@@ -0,0 +1,491 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.prometheus role – Installs and configures prometheus — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.prometheus role – Installs and configures prometheus
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/pushgateway_role.html b/pr/441/pushgateway_role.html
new file mode 100644
index 00000000..1361697f
--- /dev/null
+++ b/pr/441/pushgateway_role.html
@@ -0,0 +1,335 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.pushgateway role – Prometheus Pushgateway — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.pushgateway role – Prometheus Pushgateway
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.pushgateway role – Prometheus Pushgateway
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.pushgateway
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
pushgateway_basic_auth_users
+
dictionary
+
Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.
+
+
pushgateway_binary_install_dir
+
string
+
Advanced
+
Directory to install pushgateway binary
+
Default: "/usr/local/bin"
+
+
pushgateway_binary_url
+
string
+
URL of the Pushgateway binaries .tar.gz file
+
Default: "https://github.com/{{ _pushgateway_repo }}/releases/download/v{{ pushgateway_version }}/pushgateway-{{ pushgateway_version }}.{{ ansible_system | lower }}-{{ _pushgateway_go_ansible_arch }}.tar.gz"
+
+
pushgateway_checksums_url
+
string
+
URL of the Pushgateway checksums file
+
Default: "https://github.com/{{ _pushgateway_repo }}/releases/download/v{{ pushgateway_version }}/sha256sums.txt"
+
+
pushgateway_config_dir
+
string
+
Path to directory with pushgateway configuration
+
Default: "/etc/pushgateway"
+
+
pushgateway_http_server_config
+
dictionary
+
Config for HTTP/2 support.
+
Keys and values are the same as in pushgateway docs .
+
+
pushgateway_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/pushgateway-{{ ansible_system | lower }}-{{ _pushgateway_go_ansible_arch }}/{{ pushgateway_version }}"
+
+
pushgateway_system_group
+
string
+
Advanced
+
System group for Pushgateway
+
Default: "pushgateway"
+
+
pushgateway_system_user
+
string
+
Advanced
+
Pushgateway user
+
Default: "pushgateway"
+
+
pushgateway_tls_server_config
+
dictionary
+
Configuration for TLS authentication.
+
Keys and values are the same as in pushgateway docs .
+
+
pushgateway_version
+
string
+
Pushgateway package version. Also accepts latest as parameter.
+
Default: "1.10.0"
+
+
pushgateway_web_listen_address
+
string
+
Address on which Pushgateway will listen
+
Default: "0.0.0.0:9091"
+
+
pushgateway_web_telemetry_path
+
string
+
Path under which to expose metrics
+
Default: "/metrics"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/redis_exporter_role.html b/pr/441/redis_exporter_role.html
new file mode 100644
index 00000000..ca91e5d7
--- /dev/null
+++ b/pr/441/redis_exporter_role.html
@@ -0,0 +1,649 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.redis_exporter role – Prometheus redis_exporter — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.redis_exporter role – Prometheus redis_exporter
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.redis_exporter role – Prometheus redis_exporter
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.redis_exporter
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
redis_exporter_addr
+
string
+
Address of the Redis instance
+
Default: "redis://localhost:6379"
+
+
redis_exporter_binary_install_dir
+
string
+
Advanced
+
Directory to install redis_exporter binary
+
Default: "/usr/local/bin"
+
+
redis_exporter_binary_url
+
string
+
URL of the redis_exporter binaries .tar.gz file
+
Default: "https://github.com/{{ _redis_exporter_repo }}/releases/download/v{{ redis_exporter_version }}/redis_exporter-v{{ redis_exporter_version }}.{{ ansible_system | lower }}-{{ _redis_exporter_go_ansible_arch }}.tar.gz"
+
+
redis_exporter_check_key_groups
+
list / elements=string
+
List of LUA regexes for classifying keys into groups. The regexes are applied in specified order to individual keys, and the group name is generated by concatenating all capture groups of the first regex that matches a key. A key will be tracked under the unclassified group if none of the specified regexes matches it.
+
Default: []
+
+
redis_exporter_check_keys
+
list / elements=string
+
List of key patterns to export value and length/size, eg: db3=user_count will export key user_count from db 3. db defaults to 0 if omitted. The key patterns specified with this flag will be found using SCAN. Use this option if you need glob pattern matching; check-single-keys is faster for non-pattern keys. Warning: using –check-keys to match a very large number of keys can slow down the exporter to the point where it doesn’t finish scraping the redis instance.
+
Default: []
+
+
redis_exporter_check_keys_batch_size
+
integer
+
Approximate number of keys to process in each execution. This is basically the COUNT option that will be passed into the SCAN command as part of the execution of the key or key group metrics, see COUNT option. Larger value speeds up scanning. Still Redis is a single-threaded app, huge COUNT can affect production environment.
+
Default: 1000
+
+
redis_exporter_check_single_keys
+
list / elements=string
+
List of keys to export value and length/size, eg: db3=user_count will export key user_count from db 3. db defaults to 0 if omitted. The keys specified with this flag will be looked up directly without any glob pattern matching. Use this option if you don’t need glob pattern matching; it is faster than check-keys.
+
Default: []
+
+
redis_exporter_check_single_streams
+
list / elements=string
+
List of streams to export info about streams, groups and consumers. The streams specified with this flag will be looked up directly without any glob pattern matching. Use this option if you don’t need glob pattern matching; it is faster than check-streams.
+
Default: []
+
+
redis_exporter_check_streams
+
list / elements=string
+
List of stream-patterns to export info about streams, groups and consumers. Syntax is the same as check-keys.
+
Default: []
+
+
redis_exporter_checksums_url
+
string
+
URL of the redis_exporter checksums file
+
Default: "https://github.com/{{ _redis_exporter_repo }}/releases/download/v{{ redis_exporter_version }}/sha256sums.txt"
+
+
redis_exporter_config_command
+
string
+
What to use for the CONFIG command
+
Default: "CONFIG"
+
+
redis_exporter_config_dir
+
string
+
Path to directory with redis_exporter configuration
+
Default: "/etc/redis_exporter"
+
+
redis_exporter_connection_timeout
+
string
+
Timeout for connection to Redis instance
+
Default: "15s"
+
+
redis_exporter_count_keys
+
list / elements=string
+
List of patterns to count, eg: db3=sessions:* will count all keys with prefix sessions: from db 3. db defaults to 0 if omitted. Warning: The exporter runs SCAN to count the keys. This might not perform well on large databases.
+
Default: []
+
+
redis_exporter_debug
+
boolean
+
Verbose debug output
+
Choices:
+
+false ← (default)
true
+
+
redis_exporter_export_client_list
+
boolean
+
Whether to scrape Client List specific metrics
+
Choices:
+
+false ← (default)
true
+
+
redis_exporter_export_client_port
+
boolean
+
Whether to include the client’s port when exporting the client list. Warning: including the port increases the number of metrics generated and will make your Prometheus server take up more memory
+
Choices:
+
+false ← (default)
true
+
+
redis_exporter_incl_config_metrics
+
boolean
+
Whether to include all config settings as metrics
+
Choices:
+
+false ← (default)
true
+
+
redis_exporter_incl_system_metrics
+
boolean
+
Whether to include system metrics like total_system_memory_bytes
+
Choices:
+
+false ← (default)
true
+
+
redis_exporter_is_cluster
+
boolean
+
Whether this is a redis cluster (Enable this if you need to fetch key level data on a Redis Cluster).
+
Choices:
+
+false ← (default)
true
+
+
redis_exporter_is_tile38
+
boolean
+
Whether to scrape Tile38 specific metrics
+
Choices:
+
+false ← (default)
true
+
+
redis_exporter_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/redis_exporter-{{ ansible_system | lower }}-{{ _redis_exporter_go_ansible_arch }}/{{ redis_exporter_version }}"
+
+
redis_exporter_log_format
+
string
+
Output format of log messages. One of: [txt, json]
+
Default: "txt"
+
+
redis_exporter_max_distinct_key_groups
+
integer
+
Maximum number of distinct key groups that can be tracked independently per Redis database. If exceeded, only key groups with the highest memory consumption within the limit will be tracked separately, all remaining key groups will be tracked under a single overflow key group.
+
Default: 100
+
+
redis_exporter_namespace
+
string
+
Namespace for the metrics
+
Default: "redis"
+
+
redis_exporter_password
+
string
+
Password of the Redis instance
+
Default: ""
+
+
redis_exporter_passwords
+
dictionary
+
Dictionary with passwords for instances.
+
Read more official documentation
+
Default: {}
+
+
redis_exporter_ping_on_connect
+
boolean
+
Whether to ping the redis instance after connecting and record the duration as a metric.
+
Choices:
+
+false ← (default)
true
+
+
redis_exporter_redact_config_metrics
+
boolean
+
Whether to redact config settings that include potentially sensitive information like passwords.
+
Choices:
+
+false ← (default)
true
+
+
redis_exporter_redis_only_metrics
+
boolean
+
Whether to also export go runtime metrics
+
Choices:
+
+false ← (default)
true
+
+
redis_exporter_script
+
list / elements=string
+
List of path(s) to Redis Lua script(s) for gathering extra metrics.
+
Default: []
+
+
redis_exporter_set_client_name
+
boolean
+
Whether to set client name to redis_exporter
+
Choices:
+
+false
true ← (default)
+
+
redis_exporter_skip_tls_verification
+
boolean
+
Whether to to skip TLS verification when the exporter connects to a Redis instance
+
Choices:
+
+false ← (default)
true
+
+
redis_exporter_system_group
+
string
+
Advanced
+
System group for redis_exporter
+
Default: "redis-exp"
+
+
redis_exporter_system_user
+
string
+
Advanced
+
redis_exporter user
+
Default: "redis-exp"
+
+
redis_exporter_tls_ca_cert_file
+
string
+
Name of the CA certificate file (including full path) if the server requires TLS client authentication
+
Default: ""
+
+
redis_exporter_tls_client_cert_file
+
string
+
Name the client cert file (including full path) if the server requires TLS client authentication
+
Default: ""
+
+
redis_exporter_tls_client_key_file
+
string
+
Name of the client key file (including full path) if the server requires TLS client authentication
+
Default: ""
+
+
redis_exporter_tls_server_ca_cert_file
+
string
+
Name of the CA certificate file (including full path) if the web interface and telemetry should use TLS
+
Default: ""
+
+
redis_exporter_tls_server_cert_file
+
string
+
Name of the server certificate file (including full path) if the web interface and telemetry should use TLS
+
Default: ""
+
+
redis_exporter_tls_server_key_file
+
string
+
Name of the server key file (including full path) if the web interface and telemetry should use TLS
+
Default: ""
+
+
redis_exporter_tls_server_min_version
+
string
+
Minimum TLS version that is acceptable by the web interface and telemetry when using TLS
+
Default: "TLS1.2"
+
+
redis_exporter_user
+
string
+
User name to use for authentication (Redis ACL for Redis 6.0 and newer)
+
Default: ""
+
+
redis_exporter_version
+
string
+
redis_exporter package version. Also accepts latest as parameter.
+
Default: "1.63.0"
+
+
redis_exporter_web_listen_address
+
string
+
Address to listen on for web interface and telemetry
+
Default: "0.0.0.0:9121"
+
+
redis_exporter_web_telemetry_path
+
string
+
Path under which to expose metrics
+
Default: "/metrics"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/search.html b/pr/441/search.html
new file mode 100644
index 00000000..668256c8
--- /dev/null
+++ b/pr/441/search.html
@@ -0,0 +1,175 @@
+
+
+
+
+
+
+
+
Search — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Please activate JavaScript to enable the search functionality.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/searchindex.js b/pr/441/searchindex.js
new file mode 100644
index 00000000..5ea29263
--- /dev/null
+++ b/pr/441/searchindex.js
@@ -0,0 +1 @@
+Search.setIndex({"alltitles": {"Authors": [[0, "authors"], [0, "id3"], [0, "id6"], [0, "id9"], [1, "authors"], [2, "authors"], [3, "authors"], [4, "authors"], [5, "authors"], [7, "authors"], [9, "authors"], [10, "authors"], [11, "authors"], [12, "authors"], [13, "authors"], [14, "authors"], [15, "authors"], [16, "authors"], [17, "authors"], [18, "authors"], [19, "authors"], [20, "authors"], [21, "authors"], [22, "authors"], [23, "authors"], [24, "authors"], [25, "authors"]], "Collection links": [[0, "collection-links"], [1, "collection-links"], [2, "collection-links"], [3, "collection-links"], [4, "collection-links"], [5, "collection-links"], [7, "collection-links"], [9, "collection-links"], [10, "collection-links"], [11, "collection-links"], [12, "collection-links"], [13, "collection-links"], [14, "collection-links"], [15, "collection-links"], [16, "collection-links"], [17, "collection-links"], [18, "collection-links"], [19, "collection-links"], [20, "collection-links"], [21, "collection-links"], [22, "collection-links"], [23, "collection-links"], [24, "collection-links"], [25, "collection-links"]], "Description": [[8, "description"]], "Entry point configure \u2013 Internal only - common configuration tasks": [[0, "entry-point-configure-internal-only-common-configuration-tasks"]], "Entry point install \u2013 Internal only - common installation tasks": [[0, "entry-point-install-internal-only-common-installation-tasks"]], "Entry point main \u2013 Deploy and manage Prometheus blackbox exporter": [[3, "entry-point-main-deploy-and-manage-prometheus-blackbox-exporter"]], "Entry point main \u2013 Installs and configures prometheus": [[19, "entry-point-main-installs-and-configures-prometheus"]], "Entry point main \u2013 Prometheus Alertmanager service": [[1, "entry-point-main-prometheus-alertmanager-service"]], "Entry point main \u2013 Prometheus BIND Exporter": [[2, "entry-point-main-prometheus-bind-exporter"]], "Entry point main \u2013 Prometheus Chrony Exporter": [[5, "entry-point-main-prometheus-chrony-exporter"]], "Entry point main \u2013 Prometheus Influxdb Exporter": [[9, "entry-point-main-prometheus-influxdb-exporter"]], "Entry point main \u2013 Prometheus MySQLd Exporter": [[13, "entry-point-main-prometheus-mysqld-exporter"]], "Entry point main \u2013 Prometheus Node Exporter": [[15, "entry-point-main-prometheus-node-exporter"]], "Entry point main \u2013 Prometheus Nvidia GPU Exporter": [[16, "entry-point-main-prometheus-nvidia-gpu-exporter"]], "Entry point main \u2013 Prometheus PostgreSQL Exporter": [[17, "entry-point-main-prometheus-postgresql-exporter"]], "Entry point main \u2013 Prometheus Process exporter": [[18, "entry-point-main-prometheus-process-exporter"]], "Entry point main \u2013 Prometheus Pushgateway": [[20, "entry-point-main-prometheus-pushgateway"]], "Entry point main \u2013 Prometheus SNMP exporter": [[24, "entry-point-main-prometheus-snmp-exporter"]], "Entry point main \u2013 Prometheus Smartctl Exporter": [[22, "entry-point-main-prometheus-smartctl-exporter"]], "Entry point main \u2013 Prometheus Smokeping Prober": [[23, "entry-point-main-prometheus-smokeping-prober"]], "Entry point main \u2013 Prometheus Systemd Exporter": [[25, "entry-point-main-prometheus-systemd-exporter"]], "Entry point main \u2013 Prometheus fail2ban_exporter": [[7, "entry-point-main-prometheus-fail2ban-exporter"]], "Entry point main \u2013 Prometheus ipmi_exporter": [[10, "entry-point-main-prometheus-ipmi-exporter"]], "Entry point main \u2013 Prometheus memcached_exporter": [[11, "entry-point-main-prometheus-memcached-exporter"]], "Entry point main \u2013 Prometheus mongodb_exporter": [[12, "entry-point-main-prometheus-mongodb-exporter"]], "Entry point main \u2013 Prometheus nginx_exporter": [[14, "entry-point-main-prometheus-nginx-exporter"]], "Entry point main \u2013 Prometheus redis_exporter": [[21, "entry-point-main-prometheus-redis-exporter"]], "Entry point main \u2013 cAdvisor": [[4, "entry-point-main-cadvisor"]], "Entry point preflight \u2013 Internal only - common preflight tasks": [[0, "entry-point-preflight-internal-only-common-preflight-tasks"]], "Entry point selinux \u2013 Internal only - common selinux configuration tasks": [[0, "entry-point-selinux-internal-only-common-selinux-configuration-tasks"]], "Index of all Collection Environment Variables": [[6, null]], "Parameters": [[0, "parameters"], [0, "id2"], [0, "id5"], [0, "id8"], [1, "parameters"], [2, "parameters"], [3, "parameters"], [4, "parameters"], [5, "parameters"], [7, "parameters"], [9, "parameters"], [10, "parameters"], [11, "parameters"], [12, "parameters"], [13, "parameters"], [14, "parameters"], [15, "parameters"], [16, "parameters"], [17, "parameters"], [18, "parameters"], [19, "parameters"], [20, "parameters"], [21, "parameters"], [22, "parameters"], [23, "parameters"], [24, "parameters"], [25, "parameters"]], "Plugin Index": [[8, "plugin-index"]], "Prometheus.Prometheus": [[8, null]], "Role Index": [[8, "role-index"]], "Synopsis": [[0, "synopsis"], [0, "id1"], [0, "id4"], [0, "id7"], [1, "synopsis"], [2, "synopsis"], [3, "synopsis"], [4, "synopsis"], [5, "synopsis"], [7, "synopsis"], [9, "synopsis"], [10, "synopsis"], [11, "synopsis"], [12, "synopsis"], [13, "synopsis"], [14, "synopsis"], [15, "synopsis"], [16, "synopsis"], [17, "synopsis"], [18, "synopsis"], [19, "synopsis"], [20, "synopsis"], [21, "synopsis"], [22, "synopsis"], [23, "synopsis"], [24, "synopsis"], [25, "synopsis"]], "prometheus.prometheus._common role": [[0, null]], "prometheus.prometheus.alertmanager role \u2013 Prometheus Alertmanager service": [[1, null]], "prometheus.prometheus.bind_exporter role \u2013 Prometheus BIND Exporter": [[2, null]], "prometheus.prometheus.blackbox_exporter role \u2013 Deploy and manage Prometheus blackbox exporter": [[3, null]], "prometheus.prometheus.cadvisor role \u2013 cAdvisor": [[4, null]], "prometheus.prometheus.chrony_exporter role \u2013 Prometheus Chrony Exporter": [[5, null]], "prometheus.prometheus.fail2ban_exporter role \u2013 Prometheus fail2ban_exporter": [[7, null]], "prometheus.prometheus.influxdb_exporter role \u2013 Prometheus Influxdb Exporter": [[9, null]], "prometheus.prometheus.ipmi_exporter role \u2013 Prometheus ipmi_exporter": [[10, null]], "prometheus.prometheus.memcached_exporter role \u2013 Prometheus memcached_exporter": [[11, null]], "prometheus.prometheus.mongodb_exporter role \u2013 Prometheus mongodb_exporter": [[12, null]], "prometheus.prometheus.mysqld_exporter role \u2013 Prometheus MySQLd Exporter": [[13, null]], "prometheus.prometheus.nginx_exporter role \u2013 Prometheus nginx_exporter": [[14, null]], "prometheus.prometheus.node_exporter role \u2013 Prometheus Node Exporter": [[15, null]], "prometheus.prometheus.nvidia_gpu_exporter role \u2013 Prometheus Nvidia GPU Exporter": [[16, null]], "prometheus.prometheus.postgres_exporter role \u2013 Prometheus PostgreSQL Exporter": [[17, null]], "prometheus.prometheus.process_exporter role \u2013 Prometheus Process exporter": [[18, null]], "prometheus.prometheus.prometheus role \u2013 Installs and configures prometheus": [[19, null]], "prometheus.prometheus.pushgateway role \u2013 Prometheus Pushgateway": [[20, null]], "prometheus.prometheus.redis_exporter role \u2013 Prometheus redis_exporter": [[21, null]], "prometheus.prometheus.smartctl_exporter role \u2013 Prometheus Smartctl Exporter": [[22, null]], "prometheus.prometheus.smokeping_prober role \u2013 Prometheus Smokeping Prober": [[23, null]], "prometheus.prometheus.snmp_exporter role \u2013 Prometheus SNMP exporter": [[24, null]], "prometheus.prometheus.systemd_exporter role \u2013 Prometheus Systemd Exporter": [[25, null]]}, "docnames": ["_common_role", "alertmanager_role", "bind_exporter_role", "blackbox_exporter_role", "cadvisor_role", "chrony_exporter_role", "environment_variables", "fail2ban_exporter_role", "index", "influxdb_exporter_role", "ipmi_exporter_role", "memcached_exporter_role", "mongodb_exporter_role", "mysqld_exporter_role", "nginx_exporter_role", "node_exporter_role", "nvidia_gpu_exporter_role", "postgres_exporter_role", "process_exporter_role", "prometheus_role", "pushgateway_role", "redis_exporter_role", "smartctl_exporter_role", "smokeping_prober_role", "snmp_exporter_role", "systemd_exporter_role"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "filenames": ["_common_role.rst", "alertmanager_role.rst", "bind_exporter_role.rst", "blackbox_exporter_role.rst", "cadvisor_role.rst", "chrony_exporter_role.rst", "environment_variables.rst", "fail2ban_exporter_role.rst", "index.rst", "influxdb_exporter_role.rst", "ipmi_exporter_role.rst", "memcached_exporter_role.rst", "mongodb_exporter_role.rst", "mysqld_exporter_role.rst", "nginx_exporter_role.rst", "node_exporter_role.rst", "nvidia_gpu_exporter_role.rst", "postgres_exporter_role.rst", "process_exporter_role.rst", "prometheus_role.rst", "pushgateway_role.rst", "redis_exporter_role.rst", "smartctl_exporter_role.rst", "smokeping_prober_role.rst", "snmp_exporter_role.rst", "systemd_exporter_role.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [2, 21], "0": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "1": [4, 5, 7, 10, 12, 13, 14, 15, 16, 19, 20, 21, 22, 23], "10": [2, 5, 7, 19, 20], "100": 21, "1000": 21, "10m": 22, "11": 9, "12": 22, "127": 14, "14": 11, "15": [13, 17, 19, 21], "17": 8, "2": [0, 2, 5, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23], "21": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "235": 25, "25": 3, "26": 24, "27": 1, "3": [0, 14, 18, 21], "30": 12, "30d": 19, "32": 19, "3m": 1, "4": 11, "41": 12, "43": 19, "49": 4, "5": [3, 9], "54": 19, "5m": 9, "6": [21, 25], "60": [19, 22], "600": 19, "63": 21, "6379": 21, "7": 2, "8": [10, 15, 18, 23], "8053": 2, "8080": 4, "9": 8, "9090": 19, "9091": 20, "9093": 1, "9100": 15, "9104": 13, "9113": 14, "9115": 3, "9116": 24, "9119": 2, "9121": 21, "9122": 9, "9123": 5, "9150": 11, "9187": 17, "9191": 7, "9216": 12, "9256": 18, "9290": 10, "9374": 23, "9558": 25, "9633": 22, "9835": 16, "99": 8, "A": [1, 14, 19, 21], "By": [5, 13, 15, 17], "For": 14, "If": [4, 21, 22, 24], "It": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "No": [6, 12], "One": [10, 11, 14, 21, 22], "The": [3, 6, 11, 13, 17, 19, 21, 22, 23], "There": 8, "These": 8, "To": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "_": [7, 14, 16], "__common_binary_basenam": 0, "_alertmanager_go_ansible_arch": 1, "_alertmanager_repo": 1, "_bind_exporter_go_ansible_arch": 2, "_bind_exporter_repo": 2, "_blackbox_exporter_go_ansible_arch": 3, "_blackbox_exporter_repo": 3, "_cadvisor_go_ansible_arch": 4, "_cadvisor_repo": 4, "_checksum": [7, 12, 14], "_chrony_exporter_go_ansible_arch": 5, "_chrony_exporter_repo": 5, "_common": 8, "_common_binari": 0, "_common_binary_install_dir": 0, "_common_binary_nam": 0, "_common_binary_unarchive_opt": 0, "_common_binary_url": 0, "_common_checksums_url": 0, "_common_common_basic_auth_us": 0, "_common_config_dir": 0, "_common_depend": 0, "_common_http_server_config": 0, "_common_local_cache_path": 0, "_common_selinux_port": 0, "_common_service_nam": 0, "_common_system_group": 0, "_common_system_us": 0, "_common_tls_server_config": 0, "_desc": 12, "_fail2ban_exporter_go_ansible_arch": 7, "_influxdb_exporter_go_ansible_arch": 9, "_influxdb_exporter_repo": 9, "_ipmi_exporter_go_ansible_arch": 10, "_ipmi_exporter_repo": 10, "_memcached_exporter_go_ansible_arch": 11, "_memcached_exporter_repo": 11, "_mongodb_exporter_go_ansible_arch": 12, "_mongodb_exporter_repo": 12, "_mysqld_exporter_go_ansible_arch": 13, "_mysqld_exporter_repo": 13, "_nginx_exporter_go_ansible_arch": 14, "_nginx_exporter_repo": 14, "_node_exporter_go_ansible_arch": 15, "_node_exporter_repo": 15, "_nvidia_gpu_exporter_go_ansible_arch": 16, "_nvidia_gpu_exporter_repo": 16, "_postgres_exporter_go_ansible_arch": 17, "_postgres_exporter_repo": 17, "_process_exporter_go_ansible_arch": 18, "_process_exporter_repo": 18, "_prometheus_go_ansible_arch": 19, "_prometheus_repo": 19, "_pushgateway_go_ansible_arch": 20, "_pushgateway_repo": 20, "_redis_exporter_go_ansible_arch": 21, "_redis_exporter_repo": 21, "_smartctl_exporter_go_ansible_arch": 22, "_smartctl_exporter_repo": 22, "_smokeping_prober_go_ansible_arch": 23, "_smokeping_prober_repo": 23, "_snmp_exporter_go_ansible_arch": 24, "_snmp_exporter_repo": 24, "_systemd_exporter_go_ansible_arch": 25, "_systemd_exporter_repo": 25, "about": [15, 21], "abov": [9, 10, 11, 12, 14, 22, 25], "accept": [1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "access": 25, "account": 25, "acl": 21, "ad": 19, "add": [5, 13, 15, 17], "addit": [1, 3, 19], "addition": [5, 13, 15, 17], "address": [1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "advanc": [1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "advtcp": 4, "affect": 21, "after": [1, 21], "agent": 19, "alert": [1, 19], "alert_relabel_config": 19, "alertmanag": [8, 19], "alertmanager_amtool_config_alertmanager_url": 1, "alertmanager_amtool_config_fil": 1, "alertmanager_amtool_config_output": 1, "alertmanager_binary_install_dir": 1, "alertmanager_binary_url": 1, "alertmanager_checksums_url": 1, "alertmanager_clust": 1, "alertmanager_config": 19, "alertmanager_config_dir": 1, "alertmanager_config_fil": 1, "alertmanager_config_flags_extra": 1, "alertmanager_db_dir": 1, "alertmanager_hipchat_api_url": 1, "alertmanager_hipchat_auth_token": 1, "alertmanager_http_config": 1, "alertmanager_inhibit_rul": 1, "alertmanager_local_cache_path": 1, "alertmanager_opsgenie_api_kei": 1, "alertmanager_opsgenie_api_url": 1, "alertmanager_pagerduty_url": 1, "alertmanager_receiv": 1, "alertmanager_resolve_timeout": 1, "alertmanager_rout": 1, "alertmanager_slack_api_url": 1, "alertmanager_smtp": 1, "alertmanager_system_group": 1, "alertmanager_system_us": 1, "alertmanager_template_fil": 1, "alertmanager_time_interv": 1, "alertmanager_vers": 1, "alertmanager_victorops_api_kei": 1, "alertmanager_victorops_api_url": 1, "alertmanager_web_external_url": 1, "alertmanager_web_listen_address": 1, "alertmanager_wechat_corp_id": 1, "alertmanager_wechat_secret": 1, "alertmanager_wechat_url": 1, "all": [4, 12, 21], "allow": [0, 3, 19], "also": [1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "altern": 17, "amtool": 1, "an": [1, 12], "ani": [19, 21, 22], "ansibl": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "ansible_collection_nam": 0, "ansible_fqdn": 19, "ansible_host": 19, "ansible_manag": 19, "ansible_parent_role_nam": 0, "ansible_pkg_mgr": 0, "ansible_python_vers": 0, "ansible_system": [1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "api": 2, "app": [4, 21], "appli": 21, "approxim": 21, "apt": 0, "ar": [0, 2, 5, 6, 8, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23, 25], "archiv": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "arnarsson": 8, "auth": [7, 19], "authent": [0, 1, 2, 5, 10, 11, 12, 13, 14, 15, 17, 18, 20, 21, 22, 23, 25], "author": 8, "auto": [2, 22], "autodiscov": 12, "automat": [0, 2, 5, 8, 10, 11, 12, 13, 14, 15, 17, 18, 20, 22, 23], "avail": [1, 14, 19, 22], "basic": [0, 2, 5, 7, 10, 11, 12, 13, 14, 15, 17, 18, 20, 21, 22, 23], "bcrypt": [0, 2, 5, 10, 11, 12, 13, 14, 15, 17, 18, 20, 22, 23], "been": 6, "behind": [1, 19], "ben": 8, "between": 22, "bin": [1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "binari": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "bind": 8, "bind_export": 8, "bind_exporter_basic_auth_us": 2, "bind_exporter_binary_install_dir": 2, "bind_exporter_binary_url": 2, "bind_exporter_checksums_url": 2, "bind_exporter_config_dir": 2, "bind_exporter_http_server_config": 2, "bind_exporter_local_cache_path": 2, "bind_exporter_pid_fil": 2, "bind_exporter_stats_group": 2, "bind_exporter_stats_url": 2, "bind_exporter_stats_vers": 2, "bind_exporter_system_group": 2, "bind_exporter_system_us": 2, "bind_exporter_timeout": 2, "bind_exporter_tls_server_config": 2, "bind_exporter_vers": 2, "bind_exporter_web_listen_address": 2, "bind_exporter_web_telemetry_path": 2, "blackbox": 8, "blackbox_export": 8, "blackbox_exporter_binary_install_dir": 3, "blackbox_exporter_binary_url": 3, "blackbox_exporter_checksums_url": 3, "blackbox_exporter_cli_flag": 3, "blackbox_exporter_config_dir": 3, "blackbox_exporter_configuration_modul": 3, "blackbox_exporter_local_cache_path": 3, "blackbox_exporter_system_group": 3, "blackbox_exporter_system_us": 3, "blackbox_exporter_vers": 3, "blackbox_exporter_web_listen_address": 3, "block": 19, "boolean": [4, 12, 14, 15, 19, 21, 25], "byte": 19, "ca": 21, "cadvisor": 8, "cadvisor_binary_install_dir": 4, "cadvisor_binary_url": 4, "cadvisor_disable_metr": 4, "cadvisor_docker_onli": 4, "cadvisor_enable_metr": 4, "cadvisor_env_metadata_whitelist": 4, "cadvisor_listen_ip": 4, "cadvisor_local_cache_path": 4, "cadvisor_port": 4, "cadvisor_prometheus_endpoint": 4, "cadvisor_store_container_label": 4, "cadvisor_system_group": 4, "cadvisor_system_us": 4, "cadvisor_vers": 4, "cadvisor_whitelisted_container_label": 4, "can": [12, 19, 21], "captur": 21, "case": 19, "caus": 25, "cert": [19, 21], "certif": 21, "cgroup": 4, "check": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "checksum": [0, 1, 2, 3, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "choic": [2, 4, 9, 12, 14, 15, 19, 21, 25], "chroni": 8, "chrony_export": 8, "chrony_exporter_basic_auth_us": 5, "chrony_exporter_binary_install_dir": 5, "chrony_exporter_binary_url": 5, "chrony_exporter_checksums_url": 5, "chrony_exporter_config_dir": 5, "chrony_exporter_disabled_collector": 5, "chrony_exporter_enabled_collector": 5, "chrony_exporter_http_server_config": 5, "chrony_exporter_local_cache_path": 5, "chrony_exporter_system_group": 5, "chrony_exporter_system_us": 5, "chrony_exporter_tls_server_config": 5, "chrony_exporter_vers": 5, "chrony_exporter_web_listen_address": 5, "chrony_exporter_web_telemetry_path": 5, "classifi": 21, "client": 21, "cluster": [1, 21], "cmdline": 18, "cnf": 13, "collect": 8, "collector": [5, 12, 13, 15, 17], "collstat": 12, "com": [1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "comm": 18, "comma": 4, "command": 21, "comment": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "commun": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "compat": [12, 19], "concaten": 21, "config": [1, 2, 5, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23], "configur": [1, 2, 3, 5, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 20, 21, 22, 23, 24, 25], "connect": [12, 21], "consist": 18, "consum": 21, "consumpt": 21, "contain": [4, 19, 24], "copi": [1, 19], "core": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "corpor": 1, "count": [21, 25], "cpu": 4, "cpu_topologi": 4, "cpuload": 4, "cpuset": 4, "creat": 12, "custom": [1, 19, 24], "data": [19, 21], "databas": [1, 12, 19, 21], "db": 21, "db3": 21, "dbstat": 12, "deb": 18, "debug": [9, 10, 11, 12, 14, 21, 22], "declar": [1, 6], "default": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "defin": [5, 6, 13, 15, 17], "depend": 0, "deploi": [1, 2, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 20, 21, 22, 23, 24, 25], "descend": 12, "descriptor": 25, "devic": 22, "dict": [5, 13, 15, 17], "dictionari": [0, 1, 2, 3, 5, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23, 25], "dir": 0, "direct": 12, "directli": 21, "directori": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "disabl": [1, 4, 5, 12, 13, 15, 17, 19, 22], "disappear": 22, "disk": 4, "diskio": 4, "distinct": 21, "dn": 3, "do": 4, "doc": [1, 2, 5, 10, 11, 12, 13, 14, 15, 17, 19, 20, 22, 23, 25], "documant": 12, "document": [6, 8, 21], "doesn": 21, "domain": 14, "don": 21, "down": 21, "download": [1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "durat": 21, "each": [12, 21], "eg": 21, "element": [0, 1, 2, 4, 5, 12, 13, 15, 17, 19, 21, 22, 23], "els": [0, 19], "email": 1, "empti": [17, 24], "enabl": [4, 5, 12, 13, 15, 17, 21, 25], "endif": 0, "endpoint": [3, 7], "enterpris": 1, "env": 4, "environ": [19, 21], "error": [9, 10, 11, 12, 14, 22], "etc": [1, 2, 3, 5, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "evaluation_interv": 19, "everyth": 19, "ex": [1, 19], "exampl": [1, 19], "exceed": 21, "except": 4, "exclud": [15, 22, 25], "exclus": 22, "execut": 21, "exp": [2, 3, 5, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 21, 22, 24], "expect": 25, "export": [7, 8, 10, 11, 12, 14, 21], "exporter_": 14, "expos": [2, 4, 5, 9, 11, 12, 13, 14, 15, 16, 17, 18, 20, 21, 22], "extend": 1, "extens": [1, 19], "extern": [1, 19], "extra": [0, 21], "extract": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "fail2ban": 7, "fail2ban_export": 8, "fail2ban_exporter_": 7, "fail2ban_exporter_binary_install_dir": 7, "fail2ban_exporter_binary_url": 7, "fail2ban_exporter_checksums_url": 7, "fail2ban_exporter_local_cache_path": 7, "fail2ban_exporter_password": 7, "fail2ban_exporter_socket": 7, "fail2ban_exporter_system_group": 7, "fail2ban_exporter_system_us": 7, "fail2ban_exporter_usernam": 7, "fail2ban_exporter_vers": 7, "fail2ban_exporter_web_listen_address": 7, "fals": [4, 12, 14, 15, 19, 21, 25], "faster": 21, "fatal": 12, "fd": 25, "featur": [19, 25], "fetch": 21, "file": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "file_sd": 19, "file_sd_config": 19, "filenam": [13, 17, 23], "finish": 21, "first": [0, 21], "flag": [1, 3, 19, 21], "folder": [1, 19], "follow": 6, "form": [1, 19], "format": [9, 10, 11, 14, 17, 19, 21, 22], "found": 21, "from": [2, 12, 19, 21, 22, 24], "full": [19, 21], "galaxi": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "gardar": 8, "gar\u00f0ar": 8, "gather": 21, "gb": 19, "gener": [8, 21], "get": [2, 3, 12, 15], "github": [1, 2, 3, 4, 5, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "gitlab": 7, "given": [9, 10, 11, 12, 14, 22, 25], "glob": 21, "global": [12, 19], "go": 21, "go_": 15, "gpu": 8, "group": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "guid": 15, "gz": [1, 2, 3, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "ha": 1, "hash": [0, 2, 5, 10, 11, 12, 13, 14, 15, 17, 18, 20, 22, 23], "have": [1, 6, 19], "hectorjsmith": 7, "here": [5, 13, 15, 17], "highest": 21, "hipchat": 1, "homepag": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "host": [12, 13, 17], "how": [9, 19], "http": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "http_2xx": 3, "huge": 21, "hugetlb": 4, "i": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "icmp": 3, "id": 1, "includ": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "increas": 21, "independ": 21, "index": 12, "indexstat": 12, "individu": 21, "influxdb": 8, "influxdb_export": 8, "influxdb_exporter_binary_install_dir": 9, "influxdb_exporter_binary_url": 9, "influxdb_exporter_checksums_url": 9, "influxdb_exporter_config_dir": 9, "influxdb_exporter_export_timestamp": 9, "influxdb_exporter_exporter_web_telemetry_path": 9, "influxdb_exporter_influxdb_sample_expiri": 9, "influxdb_exporter_local_cache_path": 9, "influxdb_exporter_log_format": 9, "influxdb_exporter_log_level": 9, "influxdb_exporter_system_group": 9, "influxdb_exporter_system_us": 9, "influxdb_exporter_udp_bind_address": 9, "influxdb_exporter_vers": 9, "influxdb_exporter_web_listen_address": 9, "influxdb_exporter_web_telemetry_path": 9, "info": [9, 10, 11, 12, 14, 21, 22, 24], "inform": [1, 2, 15, 21], "inhibit": 1, "instal": [1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 20, 21, 22, 23, 24, 25], "instanc": 21, "instead": 12, "integ": [12, 21], "interfac": 21, "interv": [1, 22], "inventory_hostnam": 19, "ip": [11, 25], "ipmi": 10, "ipmi_export": 8, "ipmi_exporter_basic_auth_us": 10, "ipmi_exporter_binary_install_dir": 10, "ipmi_exporter_binary_url": 10, "ipmi_exporter_checksums_url": 10, "ipmi_exporter_config_dir": 10, "ipmi_exporter_http_server_config": 10, "ipmi_exporter_local_cache_path": 10, "ipmi_exporter_log_format": 10, "ipmi_exporter_log_level": 10, "ipmi_exporter_modul": 10, "ipmi_exporter_system_group": 10, "ipmi_exporter_system_us": 10, "ipmi_exporter_tls_server_config": 10, "ipmi_exporter_vers": 10, "ipmi_exporter_web_listen_address": 10, "issu": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "its": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "itself": 15, "j2": [1, 19], "job": 19, "job_nam": 19, "json": [2, 9, 10, 11, 14, 19, 21, 22], "kb": 19, "kei": [1, 2, 5, 10, 11, 12, 13, 14, 15, 17, 20, 21, 22, 23, 25], "kochi": 8, "krupa": 8, "label": [4, 19], "larg": 21, "larger": 21, "latest": [1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "length": 21, "level": [21, 24], "lib": [1, 15, 19], "like": 21, "limit": [12, 21], "list": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "listen": [1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "local": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "localhost": [1, 2, 19, 21], "locat": 19, "log": [9, 10, 11, 12, 14, 21, 22, 24, 25], "logfmt": [9, 10, 11, 14, 22], "login": [13, 17], "long": [9, 19], "look": [1, 19, 21], "lower": [1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "lua": 21, "made": 12, "main": 0, "make": 21, "manag": [1, 8, 19, 24], "map": 19, "match": [0, 21], "maximum": [19, 21], "mb": 19, "md": 15, "memcach": 11, "memcached_export": 8, "memcached_exporter_basic_auth_us": 11, "memcached_exporter_binary_install_dir": 11, "memcached_exporter_binary_url": 11, "memcached_exporter_checksums_url": 11, "memcached_exporter_config_dir": 11, "memcached_exporter_http_server_config": 11, "memcached_exporter_local_cache_path": 11, "memcached_exporter_log_format": 11, "memcached_exporter_log_level": 11, "memcached_exporter_memcached_address": 11, "memcached_exporter_memcached_pid_fil": 11, "memcached_exporter_system_group": 11, "memcached_exporter_system_us": 11, "memcached_exporter_tls_server_config": 11, "memcached_exporter_vers": 11, "memcached_exporter_web_listen_address": 11, "memcached_exporter_web_telemetry_path": 11, "memori": [4, 21], "memory_numa": 4, "messag": [9, 10, 11, 12, 14, 21, 22, 25], "method": 3, "metric": [2, 4, 5, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 25], "metrics_path": 19, "might": 21, "minimum": 21, "mode": 19, "modul": 10, "mongodb": 12, "mongodb_export": 8, "mongodb_exporter_": 12, "mongodb_exporter_basic_auth_us": 12, "mongodb_exporter_binary_install_dir": 12, "mongodb_exporter_binary_url": 12, "mongodb_exporter_checksums_url": 12, "mongodb_exporter_collector": 12, "mongodb_exporter_collstats_col": 12, "mongodb_exporter_collstats_limit": 12, "mongodb_exporter_compatible_mod": 12, "mongodb_exporter_config_dir": 12, "mongodb_exporter_direct_connect": 12, "mongodb_exporter_discovering_mod": 12, "mongodb_exporter_global_conn_pool": 12, "mongodb_exporter_http_server_config": 12, "mongodb_exporter_indexstats_col": 12, "mongodb_exporter_local_cache_path": 12, "mongodb_exporter_log_level": 12, "mongodb_exporter_metrics_overridedescendingindex": 12, "mongodb_exporter_profile_time_t": 12, "mongodb_exporter_system_group": 12, "mongodb_exporter_system_us": 12, "mongodb_exporter_timeout_offset": 12, "mongodb_exporter_tls_server_config": 12, "mongodb_exporter_uri": 12, "mongodb_exporter_vers": 12, "mongodb_exporter_web_listen_address": 12, "mongodb_exporter_web_telemetry_path": 12, "monitor": [11, 18, 19, 22], "more": [1, 12, 15, 17, 21, 25], "multipl": 12, "must": [1, 14, 15, 19], "mutual": 22, "mysql": 13, "mysqld": 8, "mysqld_export": 8, "mysqld_exporter_basic_auth_us": 13, "mysqld_exporter_binary_install_dir": 13, "mysqld_exporter_binary_url": 13, "mysqld_exporter_checksums_url": 13, "mysqld_exporter_config_dir": 13, "mysqld_exporter_config_fil": 13, "mysqld_exporter_disabled_collector": 13, "mysqld_exporter_enabled_collector": 13, "mysqld_exporter_host": 13, "mysqld_exporter_http_server_config": 13, "mysqld_exporter_local_cache_path": 13, "mysqld_exporter_password": 13, "mysqld_exporter_port": 13, "mysqld_exporter_socket": 13, "mysqld_exporter_system_group": 13, "mysqld_exporter_system_us": 13, "mysqld_exporter_tls_server_config": 13, "mysqld_exporter_usernam": 13, "mysqld_exporter_vers": 13, "mysqld_exporter_web_listen_address": 13, "mysqld_exporter_web_telemetry_path": 13, "n": 12, "name": [0, 2, 12, 18, 21], "namespac": 21, "need": [21, 25], "network": [1, 4], "new": [12, 22], "newer": [8, 21], "nginx": 14, "nginx_export": 8, "nginx_exporter_basic_auth_us": 14, "nginx_exporter_binary_install_dir": 14, "nginx_exporter_binary_url": 14, "nginx_exporter_checksums_url": 14, "nginx_exporter_config_dir": 14, "nginx_exporter_http_server_config": 14, "nginx_exporter_local_cache_path": 14, "nginx_exporter_log_format": 14, "nginx_exporter_log_level": 14, "nginx_exporter_plu": 14, "nginx_exporter_scrape_uri": 14, "nginx_exporter_system_group": 14, "nginx_exporter_system_us": 14, "nginx_exporter_tls_server_config": 14, "nginx_exporter_vers": 14, "nginx_exporter_web_listen_address": 14, "nginx_exporter_web_telemetry_path": 14, "node": [8, 19], "node_export": 8, "node_exporter_basic_auth_us": 15, "node_exporter_binary_install_dir": 15, "node_exporter_binary_url": 15, "node_exporter_checksums_url": 15, "node_exporter_config_dir": 15, "node_exporter_disabled_collector": 15, "node_exporter_enabled_collector": 15, "node_exporter_http_server_config": 15, "node_exporter_local_cache_path": 15, "node_exporter_system_group": 15, "node_exporter_system_us": 15, "node_exporter_textfile_dir": 15, "node_exporter_tls_server_config": 15, "node_exporter_vers": 15, "node_exporter_web_disable_exporter_metr": 15, "node_exporter_web_listen_address": 15, "node_exporter_web_telemetry_path": 15, "non": 21, "none": 21, "norescan": 22, "note": 15, "notif": 1, "number": [19, 21], "nvidia": 8, "nvidia_gpu_export": 8, "nvidia_gpu_exporter_": 16, "nvidia_gpu_exporter_binary_install_dir": 16, "nvidia_gpu_exporter_binary_url": 16, "nvidia_gpu_exporter_checksums_url": 16, "nvidia_gpu_exporter_config_dir": 16, "nvidia_gpu_exporter_local_cache_path": 16, "nvidia_gpu_exporter_system_group": 16, "nvidia_gpu_exporter_system_us": 16, "nvidia_gpu_exporter_vers": 16, "nvidia_gpu_exporter_web_listen_address": 16, "nvidia_gpu_exporter_web_telemetry_path": 16, "offici": [1, 19, 21], "offset": 12, "old": 12, "older": 8, "omit": 21, "onli": [9, 10, 11, 12, 14, 17, 19, 21, 22, 25], "oom_ev": 4, "opsgeni": 1, "optim": 19, "option": [0, 21], "order": 21, "org": [1, 19], "other": 19, "otherwis": 24, "output": [1, 9, 10, 11, 14, 21, 22], "outsid": 19, "over": 3, "overflow": 21, "overrid": [4, 12], "packag": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "packet": 9, "page": 14, "pagerduti": 1, "part": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "pass": [0, 1, 3, 19, 21], "password": [0, 2, 5, 7, 10, 11, 12, 13, 14, 15, 17, 18, 20, 21, 22, 23], "path": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "pattern": 21, "paulfantom": 8, "pawe\u0142": 8, "pb": 19, "per": 21, "percpu": 4, "perf_ev": 4, "perform": 21, "period": 19, "permiss": 15, "pid": [2, 11], "ping": 21, "place": 22, "playbook": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "pleas": 19, "plu": 14, "plugin": 6, "poll": 22, "pool": 12, "port": [0, 4, 13, 21], "postgr": 17, "postgres_export": 8, "postgres_exporter_basic_auth_us": 17, "postgres_exporter_binary_install_dir": 17, "postgres_exporter_binary_url": 17, "postgres_exporter_checksums_url": 17, "postgres_exporter_config_dir": 17, "postgres_exporter_config_fil": 17, "postgres_exporter_disabled_collector": 17, "postgres_exporter_enabled_collector": 17, "postgres_exporter_http_server_config": 17, "postgres_exporter_local_cache_path": 17, "postgres_exporter_nam": 17, "postgres_exporter_password": 17, "postgres_exporter_system_group": 17, "postgres_exporter_system_us": 17, "postgres_exporter_tls_server_config": 17, "postgres_exporter_uri": 17, "postgres_exporter_usernam": 17, "postgres_exporter_vers": 17, "postgres_exporter_web_listen_address": 17, "postgres_exporter_web_telemetry_path": 17, "postgresql": 8, "potenti": 21, "prefix": 21, "probe": [3, 23], "prober": [3, 8], "proc": 25, "process": [2, 4, 8, 11, 21], "process_": 15, "process_export": 8, "process_exporter_basic_auth_us": 18, "process_exporter_binary_install_dir": 18, "process_exporter_binary_url": 18, "process_exporter_checksums_url": 18, "process_exporter_config_dir": 18, "process_exporter_http_server_config": 18, "process_exporter_local_cache_path": 18, "process_exporter_nam": 18, "process_exporter_system_group": 18, "process_exporter_system_us": 18, "process_exporter_tls_server_config": 18, "process_exporter_vers": 18, "process_exporter_web_listen_address": 18, "process_exporter_web_telemetry_path": 18, "product": 21, "prometheus_agent_mod": 19, "prometheus_alert_relabel_config": 19, "prometheus_alert_rul": 19, "prometheus_alert_rules_fil": 19, "prometheus_alertmanager_config": 19, "prometheus_binary_install_dir": 19, "prometheus_binary_url": 19, "prometheus_checksums_url": 19, "prometheus_config_dir": 19, "prometheus_config_fil": 19, "prometheus_config_flags_extra": 19, "prometheus_db_dir": 19, "prometheus_external_label": 19, "prometheus_glob": 19, "prometheus_local_cache_path": 19, "prometheus_metrics_path": 19, "prometheus_read_only_dir": 19, "prometheus_remote_read": 19, "prometheus_remote_writ": 19, "prometheus_scrape_config": 19, "prometheus_scrape_config_fil": 19, "prometheus_static_targets_fil": 19, "prometheus_stop_timeout": 19, "prometheus_storage_retent": 19, "prometheus_storage_retention_s": 19, "prometheus_system_group": 19, "prometheus_system_us": 19, "prometheus_target": 19, "prometheus_vers": 19, "prometheus_web_config": 19, "prometheus_web_external_url": 19, "prometheus_web_listen_address": 19, "promhttp_": 15, "protect": 7, "provid": [1, 19], "proxi": [1, 19], "pushgatewai": 8, "pushgateway_basic_auth_us": 20, "pushgateway_binary_install_dir": 20, "pushgateway_binary_url": 20, "pushgateway_checksums_url": 20, "pushgateway_config_dir": 20, "pushgateway_http_server_config": 20, "pushgateway_local_cache_path": 20, "pushgateway_system_group": 20, "pushgateway_system_us": 20, "pushgateway_tls_server_config": 20, "pushgateway_vers": 20, "pushgateway_web_listen_address": 20, "pushgateway_web_telemetry_path": 20, "python": 0, "python3": 0, "queri": [12, 19], "raw": 4, "read": [17, 19, 21], "readm": 1, "receiv": 1, "record": 21, "redact": 21, "redi": 21, "redis_export": 8, "redis_exporter_addr": 21, "redis_exporter_binary_install_dir": 21, "redis_exporter_binary_url": 21, "redis_exporter_check_kei": 21, "redis_exporter_check_key_group": 21, "redis_exporter_check_keys_batch_s": 21, "redis_exporter_check_single_kei": 21, "redis_exporter_check_single_stream": 21, "redis_exporter_check_stream": 21, "redis_exporter_checksums_url": 21, "redis_exporter_config_command": 21, "redis_exporter_config_dir": 21, "redis_exporter_connection_timeout": 21, "redis_exporter_count_kei": 21, "redis_exporter_debug": 21, "redis_exporter_export_client_list": 21, "redis_exporter_export_client_port": 21, "redis_exporter_incl_config_metr": 21, "redis_exporter_incl_system_metr": 21, "redis_exporter_is_clust": 21, "redis_exporter_is_tile38": 21, "redis_exporter_local_cache_path": 21, "redis_exporter_log_format": 21, "redis_exporter_max_distinct_key_group": 21, "redis_exporter_namespac": 21, "redis_exporter_password": 21, "redis_exporter_ping_on_connect": 21, "redis_exporter_redact_config_metr": 21, "redis_exporter_redis_only_metr": 21, "redis_exporter_script": 21, "redis_exporter_set_client_nam": 21, "redis_exporter_skip_tls_verif": 21, "redis_exporter_system_group": 21, "redis_exporter_system_us": 21, "redis_exporter_tls_ca_cert_fil": 21, "redis_exporter_tls_client_cert_fil": 21, "redis_exporter_tls_client_key_fil": 21, "redis_exporter_tls_server_ca_cert_fil": 21, "redis_exporter_tls_server_cert_fil": 21, "redis_exporter_tls_server_key_fil": 21, "redis_exporter_tls_server_min_vers": 21, "redis_exporter_us": 21, "redis_exporter_vers": 21, "redis_exporter_web_listen_address": 21, "redis_exporter_web_telemetry_path": 21, "referenced_memori": 4, "regex": [21, 25], "regex_replac": [0, 19], "regexp": 22, "relabel": 19, "releas": [1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "remain": 21, "remot": 19, "replac": [12, 19], "report": 4, "repositori": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "request": 12, "requir": [0, 12, 17, 21], "rescan": 22, "resctrl": 4, "resolv": 1, "respons": 19, "restart": 25, "retent": 19, "revers": [1, 19], "root": [4, 7, 25], "rout": 1, "rpm": 18, "rule": [1, 19], "run": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "runtim": 21, "same": [1, 2, 5, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23, 25], "sampl": 9, "sbin": 22, "scan": [21, 22], "sched": 4, "scrape": [12, 14, 19, 21], "scrape_config": 19, "scrape_interv": 19, "scrape_timeout": 19, "script": 21, "second": 12, "secret": [1, 13, 17], "see": [19, 21, 23], "sensit": 21, "separ": [4, 21], "seri": 19, "server": [2, 7, 11, 21], "servic": [0, 8, 24, 25], "session": 21, "set": [4, 6, 12, 17, 21], "sever": [9, 10, 11, 12, 14, 22, 25], "sha256sum": [1, 2, 3, 5, 9, 10, 11, 13, 15, 16, 17, 19, 20, 21, 22, 23, 24, 25], "should": [12, 17, 18, 19, 21, 24], "shutdown": 19, "simpl": 1, "singl": [17, 21], "size": [19, 21, 25], "skip": 21, "slack": 1, "slow": [12, 21], "smaller": 22, "smartctl": 8, "smartctl_export": 8, "smartctl_exporter_basic_auth_us": 22, "smartctl_exporter_binary_install_dir": 22, "smartctl_exporter_binary_url": 22, "smartctl_exporter_checksums_url": 22, "smartctl_exporter_config_dir": 22, "smartctl_exporter_http_server_config": 22, "smartctl_exporter_local_cache_path": 22, "smartctl_exporter_log_format": 22, "smartctl_exporter_log_level": 22, "smartctl_exporter_smartctl_devic": 22, "smartctl_exporter_smartctl_device_exclud": 22, "smartctl_exporter_smartctl_device_includ": 22, "smartctl_exporter_smartctl_interv": 22, "smartctl_exporter_smartctl_path": 22, "smartctl_exporter_smartctl_rescan": 22, "smartctl_exporter_system_group": 22, "smartctl_exporter_system_us": 22, "smartctl_exporter_tls_server_config": 22, "smartctl_exporter_vers": 22, "smartctl_exporter_web_listen_address": 22, "smartctl_exporter_web_telemetry_path": 22, "smokep": 8, "smokeping_prob": 8, "smokeping_prober_basic_auth_us": 23, "smokeping_prober_binary_install_dir": 23, "smokeping_prober_binary_url": 23, "smokeping_prober_checksums_url": 23, "smokeping_prober_config_dir": 23, "smokeping_prober_config_fil": 23, "smokeping_prober_http_server_config": 23, "smokeping_prober_local_cache_path": 23, "smokeping_prober_system_group": 23, "smokeping_prober_system_us": 23, "smokeping_prober_target": 23, "smokeping_prober_tls_server_config": 23, "smokeping_prober_vers": 23, "smokeping_prober_web_listen_address": 23, "smtp": 1, "snmp": 8, "snmp_export": 8, "snmp_exporter_binary_install_dir": 24, "snmp_exporter_binary_url": 24, "snmp_exporter_checksums_url": 24, "snmp_exporter_config_dir": 24, "snmp_exporter_config_fil": 24, "snmp_exporter_local_cache_path": 24, "snmp_exporter_log_level": 24, "snmp_exporter_system_group": 24, "snmp_exporter_system_us": 24, "snmp_exporter_vers": 24, "snmp_exporter_web_listen_address": 24, "sock": [7, 13], "socket": [7, 13, 14], "some": 25, "sourc": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "spec": 19, "specif": 21, "specifi": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "speed": 21, "srv": 12, "ssl": 19, "stai": 19, "start": [14, 19], "startup": [1, 3, 19], "stash": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "stat": 2, "static": 19, "static_config": 19, "statist": 2, "still": 21, "storag": 19, "store": [4, 19], "stream": 21, "string": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "stub_statu": 14, "subtract": 12, "superq": [8, 23], "support": [0, 2, 5, 8, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 22, 23], "syntax": [18, 21], "system": [0, 1, 2, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "systemd": [0, 8, 15, 19], "systemd_export": 8, "systemd_exporter_binary_install_dir": 25, "systemd_exporter_binary_url": 25, "systemd_exporter_checksums_url": 25, "systemd_exporter_config_dir": 25, "systemd_exporter_enable_file_descriptor_s": 25, "systemd_exporter_enable_ip_account": 25, "systemd_exporter_enable_restart_count": 25, "systemd_exporter_local_cache_path": 25, "systemd_exporter_log_level": 25, "systemd_exporter_system_group": 25, "systemd_exporter_system_us": 25, "systemd_exporter_tls_server_config": 25, "systemd_exporter_unit_exclud": 25, "systemd_exporter_unit_includ": 25, "systemd_exporter_vers": 25, "systemd_exporter_web_listen_address": 25, "t": 21, "take": [21, 22], "tar": [1, 2, 3, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "target": [13, 17, 19, 23], "task": 2, "tb": 19, "tcp": [3, 4], "telemetri": 21, "templat": [1, 19], "textfil": 15, "than": [12, 21, 22], "thi": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "those": [5, 13, 15, 17], "thread": 21, "through": 14, "tile38": 21, "time": [1, 12, 19], "timeout": [2, 3, 12, 19, 21], "timeoutstopsec": 19, "timestamp": 9, "tl": [0, 2, 5, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23, 25], "tls1": 21, "tmp": [1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "tmpl": 1, "token": 1, "topmetr": 12, "total_system_memory_byt": 21, "track": [5, 21], "tracker": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "troubleshoot": 15, "true": [4, 9, 12, 14, 15, 19, 21, 25], "try": 2, "tsdb": 19, "txt": [1, 2, 3, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "udp": [4, 9], "unarch": 0, "unclassifi": 21, "under": [2, 4, 5, 9, 11, 12, 13, 14, 15, 16, 17, 18, 20, 21, 22], "unit": [19, 25], "unix": [13, 14], "up": 21, "uri": [12, 14, 17], "url": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "us": [0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "user": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "user_count": 21, "usernam": [7, 13, 17], "usr": [1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "usual": 0, "v": [1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "v2": 19, "v3": 2, "valid": [9, 12], "valid_status_cod": 3, "valu": [2, 5, 10, 11, 12, 13, 14, 15, 17, 19, 20, 21, 22, 23, 25], "var": [1, 7, 15, 17, 19], "variabl": [1, 4, 19], "verbos": 21, "veri": 21, "verif": 21, "version": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "victorop": 1, "view": 2, "wait": 19, "wal": 19, "warn": [9, 10, 11, 12, 14, 21, 22], "web": [19, 21], "webhook": 1, "wechat": 1, "well": 21, "what": 21, "when": [1, 19, 21], "where": [1, 19, 21], "whether": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "which": [1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "within": 21, "without": 21, "work": 25, "write": [15, 19], "x": [19, 25], "xml": 2, "yaml": 19, "yml": [1, 17, 19, 23, 24], "you": [12, 17, 21], "your": 21}, "titles": ["prometheus.prometheus._common role", "prometheus.prometheus.alertmanager role \u2013 Prometheus Alertmanager service", "prometheus.prometheus.bind_exporter role \u2013 Prometheus BIND Exporter", "prometheus.prometheus.blackbox_exporter role \u2013 Deploy and manage Prometheus blackbox exporter", "prometheus.prometheus.cadvisor role \u2013 cAdvisor", "prometheus.prometheus.chrony_exporter role \u2013 Prometheus Chrony Exporter", "Index of all Collection Environment Variables", "prometheus.prometheus.fail2ban_exporter role \u2013 Prometheus fail2ban_exporter", "Prometheus.Prometheus", "prometheus.prometheus.influxdb_exporter role \u2013 Prometheus Influxdb Exporter", "prometheus.prometheus.ipmi_exporter role \u2013 Prometheus ipmi_exporter", "prometheus.prometheus.memcached_exporter role \u2013 Prometheus memcached_exporter", "prometheus.prometheus.mongodb_exporter role \u2013 Prometheus mongodb_exporter", "prometheus.prometheus.mysqld_exporter role \u2013 Prometheus MySQLd Exporter", "prometheus.prometheus.nginx_exporter role \u2013 Prometheus nginx_exporter", "prometheus.prometheus.node_exporter role \u2013 Prometheus Node Exporter", "prometheus.prometheus.nvidia_gpu_exporter role \u2013 Prometheus Nvidia GPU Exporter", "prometheus.prometheus.postgres_exporter role \u2013 Prometheus PostgreSQL Exporter", "prometheus.prometheus.process_exporter role \u2013 Prometheus Process exporter", "prometheus.prometheus.prometheus role \u2013 Installs and configures prometheus", "prometheus.prometheus.pushgateway role \u2013 Prometheus Pushgateway", "prometheus.prometheus.redis_exporter role \u2013 Prometheus redis_exporter", "prometheus.prometheus.smartctl_exporter role \u2013 Prometheus Smartctl Exporter", "prometheus.prometheus.smokeping_prober role \u2013 Prometheus Smokeping Prober", "prometheus.prometheus.snmp_exporter role \u2013 Prometheus SNMP exporter", "prometheus.prometheus.systemd_exporter role \u2013 Prometheus Systemd Exporter"], "titleterms": {"_common": 0, "alertmanag": 1, "all": 6, "author": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "bind": 2, "bind_export": 2, "blackbox": 3, "blackbox_export": 3, "cadvisor": 4, "chroni": 5, "chrony_export": 5, "collect": [0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "common": 0, "configur": [0, 19], "deploi": 3, "descript": 8, "entri": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "environ": 6, "export": [2, 3, 5, 9, 13, 15, 16, 17, 18, 22, 24, 25], "fail2ban_export": 7, "gpu": 16, "index": [6, 8], "influxdb": 9, "influxdb_export": 9, "instal": [0, 19], "intern": 0, "ipmi_export": 10, "link": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "main": [1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "manag": 3, "memcached_export": 11, "mongodb_export": 12, "mysqld": 13, "mysqld_export": 13, "nginx_export": 14, "node": 15, "node_export": 15, "nvidia": 16, "nvidia_gpu_export": 16, "onli": 0, "paramet": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "plugin": 8, "point": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "postgres_export": 17, "postgresql": 17, "preflight": 0, "prober": 23, "process": 18, "process_export": 18, "prometheu": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "pushgatewai": 20, "redis_export": 21, "role": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "selinux": 0, "servic": 1, "smartctl": 22, "smartctl_export": 22, "smokep": 23, "smokeping_prob": 23, "snmp": 24, "snmp_export": 24, "synopsi": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "systemd": 25, "systemd_export": 25, "task": 0, "variabl": 6}})
\ No newline at end of file
diff --git a/pr/441/smartctl_exporter_role.html b/pr/441/smartctl_exporter_role.html
new file mode 100644
index 00000000..9eae9e99
--- /dev/null
+++ b/pr/441/smartctl_exporter_role.html
@@ -0,0 +1,401 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.smartctl_exporter role – Prometheus Smartctl Exporter — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.smartctl_exporter role – Prometheus Smartctl Exporter
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.smartctl_exporter role – Prometheus Smartctl Exporter
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.smartctl_exporter
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
smartctl_exporter_basic_auth_users
+
dictionary
+
Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.
+
+
smartctl_exporter_binary_install_dir
+
string
+
Advanced
+
Directory to install smartctl_exporter binary
+
Default: "/usr/local/bin"
+
+
smartctl_exporter_binary_url
+
string
+
URL of the Smartctl exporter binaries .tar.gz file
+
Default: "https://github.com/{{ _smartctl_exporter_repo }}/releases/download/v{{ smartctl_exporter_version }}/smartctl_exporter-{{ smartctl_exporter_version }}.{{ ansible_system | lower }}-{{ _smartctl_exporter_go_ansible_arch }}.tar.gz"
+
+
smartctl_exporter_checksums_url
+
string
+
URL of the Smartctl exporter checksums file
+
Default: "https://github.com/{{ _smartctl_exporter_repo }}/releases/download/v{{ smartctl_exporter_version }}/sha256sums.txt"
+
+
smartctl_exporter_config_dir
+
string
+
Path to directory with smartctl_exporter configuration
+
Default: "/etc/smartctl_exporter"
+
+
smartctl_exporter_http_server_config
+
dictionary
+
+
smartctl_exporter_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/smartctl_exporter-{{ ansible_system | lower }}-{{ _smartctl_exporter_go_ansible_arch }}/{{ smartctl_exporter_version }}"
+
+
smartctl_exporter_log_format
+
string
+
Output format of log messages. One of: [logfmt, json]
+
Default: "logfmt"
+
+
smartctl_exporter_log_level
+
string
+
Only log messages with the given severity or above. One of: [debug, info, warn, error]
+
Default: "info"
+
+
smartctl_exporter_smartctl_device_exclude
+
string
+
Regexp of devices to exclude from automatic scanning. (mutually exclusive to smartctl_exporter_smartctl_device_include)
+
Default: ""
+
+
smartctl_exporter_smartctl_device_include
+
string
+
Regexp of devices to include in automatic scanning. (mutually exclusive to smartctl_exporter_smartctl_device_exclude)
+
Default: ""
+
+
smartctl_exporter_smartctl_devices
+
list / elements=string
+
List of devices to be monitored by smartctl_exporter. Disables auto scan for available devices.
+
+
smartctl_exporter_smartctl_interval
+
string
+
The interval between smartctl polls
+
Default: "60s"
+
+
smartctl_exporter_smartctl_path
+
string
+
Advanced
+
The path to the smartctl binary
+
Default: "/usr/sbin/smartctl"
+
+
smartctl_exporter_smartctl_rescan
+
string
+
The interval between rescanning for new/disappeared devices.
+
If the interval is smaller than 1s norescanning takes place.
+
If any devices are configured with smartctl_exporter_smartctl_device also no rescanning takes place.
+
Default: "10m"
+
+
smartctl_exporter_system_group
+
string
+
Advanced
+
System group for Smartctl exporter
+
Default: "smartctl-exp"
+
+
smartctl_exporter_system_user
+
string
+
Advanced
+
Smartctl exporter user
+
Default: "smartctl-exp"
+
+
smartctl_exporter_tls_server_config
+
dictionary
+
+
smartctl_exporter_version
+
string
+
Smartctl exporter package version. Also accepts latest as parameter.
+
Default: "0.12.0"
+
+
smartctl_exporter_web_listen_address
+
string
+
Address on which smartctl exporter will listen
+
Default: "0.0.0.0:9633"
+
+
smartctl_exporter_web_telemetry_path
+
string
+
Path under which to expose metrics
+
Default: "/metrics"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/smokeping_prober_role.html b/pr/441/smokeping_prober_role.html
new file mode 100644
index 00000000..19b4c9f7
--- /dev/null
+++ b/pr/441/smokeping_prober_role.html
@@ -0,0 +1,342 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.smokeping_prober role – Prometheus Smokeping Prober — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.smokeping_prober role – Prometheus Smokeping Prober
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.smokeping_prober role – Prometheus Smokeping Prober
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.smokeping_prober
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
smokeping_prober_basic_auth_users
+
dictionary
+
Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.
+
+
smokeping_prober_binary_install_dir
+
string
+
Advanced
+
Directory to install smokeping_prober binary
+
Default: "/usr/local/bin"
+
+
smokeping_prober_binary_url
+
string
+
URL of the Smokeping Prober binaries .tar.gz file
+
Default: "https://github.com/{{ _smokeping_prober_repo }}/releases/download/v{{ smokeping_prober_version }}/smokeping_prober-{{ smokeping_prober_version }}.{{ ansible_system | lower }}-{{ _smokeping_prober_go_ansible_arch }}.tar.gz"
+
+
smokeping_prober_checksums_url
+
string
+
URL of the Smokeping Prober checksums file
+
Default: "https://github.com/{{ _smokeping_prober_repo }}/releases/download/v{{ smokeping_prober_version }}/sha256sums.txt"
+
+
smokeping_prober_config_dir
+
string
+
Path to directory with smokeping_prober configuration
+
Default: "/etc/smokeping_prober"
+
+
smokeping_prober_config_file
+
string
+
The filename of the smokeping_prober probes config file
+
Default: "probes.yml"
+
+
smokeping_prober_http_server_config
+
dictionary
+
+
smokeping_prober_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/smokeping_prober-{{ ansible_system | lower }}-{{ _smokeping_prober_go_ansible_arch }}/{{ smokeping_prober_version }}"
+
+
smokeping_prober_system_group
+
string
+
Advanced
+
System group for Smokeping Prober
+
Default: "smokeping"
+
+
smokeping_prober_system_user
+
string
+
Advanced
+
Smokeping Prober user
+
Default: "smokeping"
+
+
smokeping_prober_targets
+
list / elements=string
+
+
smokeping_prober_tls_server_config
+
dictionary
+
+
smokeping_prober_version
+
string
+
Smokeping Prober package version. Also accepts latest as parameter.
+
Default: "0.8.1"
+
+
smokeping_prober_web_listen_address
+
string
+
Address on which Smokeping Prober will listen
+
Default: "0.0.0.0:9374"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/snmp_exporter_role.html b/pr/441/snmp_exporter_role.html
new file mode 100644
index 00000000..1d712e62
--- /dev/null
+++ b/pr/441/snmp_exporter_role.html
@@ -0,0 +1,320 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.snmp_exporter
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
snmp_exporter_binary_install_dir
+
string
+
Advanced
+
Directory to install snmp_exporter binary
+
Default: "/usr/local/bin"
+
+
snmp_exporter_binary_url
+
string
+
URL of the snmp exporter binaries .tar.gz file
+
Default: "https://github.com/{{ _snmp_exporter_repo }}/releases/download/v{{ snmp_exporter_version }}/snmp_exporter-{{ snmp_exporter_version }}.{{ ansible_system | lower }}-{{ _snmp_exporter_go_ansible_arch }}.tar.gz"
+
+
snmp_exporter_checksums_url
+
string
+
URL of the snmp exporter checksums file
+
Default: "https://github.com/{{ _snmp_exporter_repo }}/releases/download/v{{ snmp_exporter_version }}/sha256sums.txt"
+
+
snmp_exporter_config_dir
+
string
+
Path to directory with snmp_exporter configuration
+
Default: "/etc/snmp_exporter"
+
+
snmp_exporter_config_file
+
string
+
+
snmp_exporter_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/snmp_exporter-{{ ansible_system | lower }}-{{ _snmp_exporter_go_ansible_arch }}/{{ snmp_exporter_version }}"
+
+
snmp_exporter_log_level
+
string
+
SNMP exporter service log level
+
Default: "info"
+
+
snmp_exporter_system_group
+
string
+
Advanced
+
System group for snmp_exporter
+
Default: "snmp-exp"
+
+
snmp_exporter_system_user
+
string
+
Advanced
+
snmp_exporter system user
+
Default: "snmp-exp"
+
+
snmp_exporter_version
+
string
+
SNMP exporter package version. Also accepts latest as parameter.
+
Default: "0.26.0"
+
+
snmp_exporter_web_listen_address
+
string
+
Address on which SNMP exporter will be listening
+
Default: "0.0.0.0:9116"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/pr/441/systemd_exporter_role.html b/pr/441/systemd_exporter_role.html
new file mode 100644
index 00000000..c13c4352
--- /dev/null
+++ b/pr/441/systemd_exporter_role.html
@@ -0,0 +1,367 @@
+
+
+
+
+
+
+
+
+
+
prometheus.prometheus.systemd_exporter role – Prometheus Systemd Exporter — Prometheus.Prometheus Collection documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection Docs
+
+
+
+
+
+
+
+ Prometheus.Prometheus Collection
+
+
+
+
+
+
+ prometheus.prometheus.systemd_exporter role – Prometheus Systemd Exporter
+
+
+
+
+
+
+
+
+
+
+
+prometheus.prometheus.systemd_exporter role – Prometheus Systemd Exporter
+
+
Note
+
This role is part of the prometheus.prometheus collection (version 0.21.0).
+
It is not included in ansible-core ansible-galaxy collection list
+
To install it use: ansible-galaxy collection install prometheus.prometheus
+
To use it in a playbook, specify: prometheus.prometheus.systemd_exporter
+
+
+
+
+
+
+
+
+
+
+Parameter
Comments
+
+
+
systemd_exporter_binary_install_dir
+
string
+
Advanced
+
Directory to install systemd_exporter binary
+
Default: "/usr/local/bin"
+
+
systemd_exporter_binary_url
+
string
+
URL of the systemd exporter binaries .tar.gz file”
+
Default: "https://github.com/{{ _systemd_exporter_repo }}/releases/download/v{{ systemd_exporter_version }}/systemd_exporter-{{ systemd_exporter_version }}.{{ ansible_system | lower }}-{{ _systemd_exporter_go_ansible_arch }}.tar.gz"
+
+
systemd_exporter_checksums_url
+
string
+
URL of the systemd exporter checksums file
+
Default: "https://github.com/{{ _systemd_exporter_repo }}/releases/download/v{{ systemd_exporter_version }}/sha256sums.txt"
+
+
systemd_exporter_config_dir
+
string
+
Path to directory with systemd_exporter configuration
+
Default: "/etc/systemd_exporter"
+
+
systemd_exporter_enable_file_descriptor_size
+
boolean
+
Enables file descriptor size metrics. This feature will cause exporter to run as root as it needs access to /proc/X/fd”
+
Choices:
+
+false ← (default)
true
+
+
systemd_exporter_enable_ip_accounting
+
boolean
+
Enables service ip accounting metrics. This feature only works with systemd 235 and above”
+
Choices:
+
+false ← (default)
true
+
+
systemd_exporter_enable_restart_count
+
boolean
+
Enables service restart count metrics. This feature only works with systemd 235 and above”
+
Choices:
+
+false ← (default)
true
+
+
systemd_exporter_local_cache_path
+
string
+
Local path to stash the archive and its extraction
+
Default: "/tmp/systemd_exporter-{{ ansible_system | lower }}-{{ _systemd_exporter_go_ansible_arch }}/{{ systemd_exporter_version }}"
+
+
systemd_exporter_log_level
+
string
+
Only log messages with the given severity or above.
+
+
systemd_exporter_system_group
+
string
+
Advanced
+
System group for systemd exporter
+
Default: "systemd-exporter"
+
+
systemd_exporter_system_user
+
string
+
Advanced
+
Systemd exporter user
+
Default: "systemd-exporter"
+
+
systemd_exporter_tls_server_config
+
dictionary
+
Configuration for TLS authentication.
+
Keys and values are the same as in Prometheus docs .
+
+
systemd_exporter_unit_exclude
+
string
+
+
systemd_exporter_unit_include
+
string
+
+
systemd_exporter_version
+
string
+
SystemD exporter package version. Also accepts latest as parameter.
+
Default: "0.6.0"
+
+
systemd_exporter_web_listen_address
+
string
+
Address on which systemd exporter will listen”
+
Default: "0.0.0.0:9558"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
+