- 
+ 
diff --git a/_modules/pubtools/_impl/pluggy.html b/_modules/pubtools/_impl/pluggy.html
index 04768bd..62add54 100644
--- a/_modules/pubtools/_impl/pluggy.html
+++ b/_modules/pubtools/_impl/pluggy.html
@@ -6,7 +6,8 @@
pubtools._impl.pluggy — pubtools documentation
-
+
+
@@ -166,7 +167,7 @@
-
+
diff --git a/_modules/pubtools/_impl/pluggy.html b/_modules/pubtools/_impl/pluggy.html
index 04768bd..62add54 100644
--- a/_modules/pubtools/_impl/pluggy.html
+++ b/_modules/pubtools/_impl/pluggy.html
@@ -6,7 +6,8 @@
Source code for pubtools._impl.pluggy
+
-
+ 
diff --git a/_modules/pubtools/_impl/tracing.html b/_modules/pubtools/_impl/tracing.html
index 780bb1e..e8ee97a 100644
--- a/_modules/pubtools/_impl/tracing.html
+++ b/_modules/pubtools/_impl/tracing.html
@@ -6,7 +6,8 @@
pubtools._impl.tracing — pubtools documentation
-
+
+
@@ -200,7 +201,7 @@
-
+
diff --git a/_modules/pubtools/_impl/tracing.html b/_modules/pubtools/_impl/tracing.html
index 780bb1e..e8ee97a 100644
--- a/_modules/pubtools/_impl/tracing.html
+++ b/_modules/pubtools/_impl/tracing.html
@@ -6,7 +6,8 @@
Source code for pubtools._impl.tracing
+
-
-
+
diff --git a/_static/alabaster.css b/_static/alabaster.css
index 74db16c..067f2fd 100644
--- a/_static/alabaster.css
+++ b/_static/alabaster.css
@@ -1,5 +1,3 @@
-@import url("basic.css");
-
/* -- page layout ----------------------------------------------------------- */
body {
@@ -160,8 +158,8 @@ div.sphinxsidebar input {
font-size: 1em;
}
-div.sphinxsidebar #searchbox input[type="text"] {
- width: 160px;
+div.sphinxsidebar #searchbox {
+ margin: 1em 0;
}
div.sphinxsidebar .search > div {
@@ -263,10 +261,6 @@ div.admonition p.last {
margin-bottom: 0;
}
-div.highlight {
- background-color: #fff;
-}
-
dt:target, .highlight {
background: #FAF3E8;
}
@@ -454,7 +448,7 @@ ul, ol {
}
pre {
- background: #EEE;
+ background: unset;
padding: 7px 30px;
margin: 15px 0px;
line-height: 1.3em;
@@ -485,15 +479,15 @@ a.reference {
border-bottom: 1px dotted #004B6B;
}
+a.reference:hover {
+ border-bottom: 1px solid #6D4100;
+}
+
/* Don't put an underline on images */
a.image-reference, a.image-reference:hover {
border-bottom: none;
}
-a.reference:hover {
- border-bottom: 1px solid #6D4100;
-}
-
a.footnote-reference {
text-decoration: none;
font-size: 0.7em;
@@ -509,68 +503,7 @@ a:hover tt, a:hover code {
background: #EEE;
}
-
-@media screen and (max-width: 870px) {
-
- div.sphinxsidebar {
- display: none;
- }
-
- div.document {
- width: 100%;
-
- }
-
- div.documentwrapper {
- margin-left: 0;
- margin-top: 0;
- margin-right: 0;
- margin-bottom: 0;
- }
-
- div.bodywrapper {
- margin-top: 0;
- margin-right: 0;
- margin-bottom: 0;
- margin-left: 0;
- }
-
- ul {
- margin-left: 0;
- }
-
- li > ul {
- /* Matches the 30px from the "ul, ol" selector above */
- margin-left: 30px;
- }
-
- .document {
- width: auto;
- }
-
- .footer {
- width: auto;
- }
-
- .bodywrapper {
- margin: 0;
- }
-
- .footer {
- width: auto;
- }
-
- .github {
- display: none;
- }
-
-
-
-}
-
-
-
-@media screen and (max-width: 875px) {
+@media screen and (max-width: 1100px) {
body {
margin: 0;
@@ -580,12 +513,16 @@ a:hover tt, a:hover code {
div.documentwrapper {
float: none;
background: #fff;
+ margin-left: 0;
+ margin-top: 0;
+ margin-right: 0;
+ margin-bottom: 0;
}
div.sphinxsidebar {
display: block;
float: none;
- width: 102.5%;
+ width: unset;
margin: 50px -30px -20px -30px;
padding: 10px 20px;
background: #333;
@@ -620,8 +557,14 @@ a:hover tt, a:hover code {
div.body {
min-height: 0;
+ min-width: auto; /* fixes width on small screens, breaks .hll */
padding: 0;
}
+
+ .hll {
+ /* "fixes" the breakage */
+ width: max-content;
+ }
.rtd_doc_footer {
display: none;
@@ -635,13 +578,18 @@ a:hover tt, a:hover code {
width: auto;
}
- .footer {
- width: auto;
- }
-
.github {
display: none;
}
+
+ ul {
+ margin-left: 0;
+ }
+
+ li > ul {
+ /* Matches the 30px from the "ul, ol" selector above */
+ margin-left: 30px;
+ }
}
@@ -705,4 +653,11 @@ nav#breadcrumbs li+li:before {
div.related {
display: none;
}
+}
+
+img.github {
+ position: absolute;
+ top: 0;
+ border: 0;
+ right: 0;
}
\ No newline at end of file
diff --git a/_static/github-banner.svg b/_static/github-banner.svg
new file mode 100644
index 0000000..c47d9dc
--- /dev/null
+++ b/_static/github-banner.svg
@@ -0,0 +1,5 @@
+
diff --git a/_static/searchtools.js b/_static/searchtools.js
index 92da3f8..b08d58c 100644
--- a/_static/searchtools.js
+++ b/_static/searchtools.js
@@ -178,7 +178,7 @@ const Search = {
htmlToText: (htmlString, anchor) => {
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
- for (const removalQuery of [".headerlinks", "script", "style"]) {
+ for (const removalQuery of [".headerlink", "script", "style"]) {
htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
}
if (anchor) {
@@ -328,13 +328,14 @@ const Search = {
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) {
- let score = Math.round(100 * queryLower.length / title.length)
+ 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,
+ score + boost,
filenames[file],
]);
}
diff --git a/devguide.html b/devguide.html
index 0ff65d2..0fa6018 100644
--- a/devguide.html
+++ b/devguide.html
@@ -7,7 +7,8 @@
Developer Guide — pubtools documentation
-
+
+
@@ -477,7 +478,7 @@
+
diff --git a/_static/alabaster.css b/_static/alabaster.css
index 74db16c..067f2fd 100644
--- a/_static/alabaster.css
+++ b/_static/alabaster.css
@@ -1,5 +1,3 @@
-@import url("basic.css");
-
/* -- page layout ----------------------------------------------------------- */
body {
@@ -160,8 +158,8 @@ div.sphinxsidebar input {
font-size: 1em;
}
-div.sphinxsidebar #searchbox input[type="text"] {
- width: 160px;
+div.sphinxsidebar #searchbox {
+ margin: 1em 0;
}
div.sphinxsidebar .search > div {
@@ -263,10 +261,6 @@ div.admonition p.last {
margin-bottom: 0;
}
-div.highlight {
- background-color: #fff;
-}
-
dt:target, .highlight {
background: #FAF3E8;
}
@@ -454,7 +448,7 @@ ul, ol {
}
pre {
- background: #EEE;
+ background: unset;
padding: 7px 30px;
margin: 15px 0px;
line-height: 1.3em;
@@ -485,15 +479,15 @@ a.reference {
border-bottom: 1px dotted #004B6B;
}
+a.reference:hover {
+ border-bottom: 1px solid #6D4100;
+}
+
/* Don't put an underline on images */
a.image-reference, a.image-reference:hover {
border-bottom: none;
}
-a.reference:hover {
- border-bottom: 1px solid #6D4100;
-}
-
a.footnote-reference {
text-decoration: none;
font-size: 0.7em;
@@ -509,68 +503,7 @@ a:hover tt, a:hover code {
background: #EEE;
}
-
-@media screen and (max-width: 870px) {
-
- div.sphinxsidebar {
- display: none;
- }
-
- div.document {
- width: 100%;
-
- }
-
- div.documentwrapper {
- margin-left: 0;
- margin-top: 0;
- margin-right: 0;
- margin-bottom: 0;
- }
-
- div.bodywrapper {
- margin-top: 0;
- margin-right: 0;
- margin-bottom: 0;
- margin-left: 0;
- }
-
- ul {
- margin-left: 0;
- }
-
- li > ul {
- /* Matches the 30px from the "ul, ol" selector above */
- margin-left: 30px;
- }
-
- .document {
- width: auto;
- }
-
- .footer {
- width: auto;
- }
-
- .bodywrapper {
- margin: 0;
- }
-
- .footer {
- width: auto;
- }
-
- .github {
- display: none;
- }
-
-
-
-}
-
-
-
-@media screen and (max-width: 875px) {
+@media screen and (max-width: 1100px) {
body {
margin: 0;
@@ -580,12 +513,16 @@ a:hover tt, a:hover code {
div.documentwrapper {
float: none;
background: #fff;
+ margin-left: 0;
+ margin-top: 0;
+ margin-right: 0;
+ margin-bottom: 0;
}
div.sphinxsidebar {
display: block;
float: none;
- width: 102.5%;
+ width: unset;
margin: 50px -30px -20px -30px;
padding: 10px 20px;
background: #333;
@@ -620,8 +557,14 @@ a:hover tt, a:hover code {
div.body {
min-height: 0;
+ min-width: auto; /* fixes width on small screens, breaks .hll */
padding: 0;
}
+
+ .hll {
+ /* "fixes" the breakage */
+ width: max-content;
+ }
.rtd_doc_footer {
display: none;
@@ -635,13 +578,18 @@ a:hover tt, a:hover code {
width: auto;
}
- .footer {
- width: auto;
- }
-
.github {
display: none;
}
+
+ ul {
+ margin-left: 0;
+ }
+
+ li > ul {
+ /* Matches the 30px from the "ul, ol" selector above */
+ margin-left: 30px;
+ }
}
@@ -705,4 +653,11 @@ nav#breadcrumbs li+li:before {
div.related {
display: none;
}
+}
+
+img.github {
+ position: absolute;
+ top: 0;
+ border: 0;
+ right: 0;
}
\ No newline at end of file
diff --git a/_static/github-banner.svg b/_static/github-banner.svg
new file mode 100644
index 0000000..c47d9dc
--- /dev/null
+++ b/_static/github-banner.svg
@@ -0,0 +1,5 @@
+
diff --git a/_static/searchtools.js b/_static/searchtools.js
index 92da3f8..b08d58c 100644
--- a/_static/searchtools.js
+++ b/_static/searchtools.js
@@ -178,7 +178,7 @@ const Search = {
htmlToText: (htmlString, anchor) => {
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
- for (const removalQuery of [".headerlinks", "script", "style"]) {
+ for (const removalQuery of [".headerlink", "script", "style"]) {
htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
}
if (anchor) {
@@ -328,13 +328,14 @@ const Search = {
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) {
- let score = Math.round(100 * queryLower.length / title.length)
+ 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,
+ score + boost,
filenames[file],
]);
}
diff --git a/devguide.html b/devguide.html
index 0ff65d2..0fa6018 100644
--- a/devguide.html
+++ b/devguide.html
@@ -7,7 +7,8 @@
Structured logging v
+
+ 
diff --git a/genindex.html b/genindex.html
index e2e1fb7..7ede0bb 100644
--- a/genindex.html
+++ b/genindex.html
@@ -6,7 +6,8 @@
Index — pubtools documentation
-
+
+
@@ -241,7 +242,7 @@
-
pubtools
@@ -552,8 +553,8 @@Quick search
©2021, Red Hat. | - Powered by Sphinx 7.3.7 - & Alabaster 0.7.16 + Powered by Sphinx 8.0.2 + & Alabaster 1.0.0 | Quick search -
+
diff --git a/genindex.html b/genindex.html
index e2e1fb7..7ede0bb 100644
--- a/genindex.html
+++ b/genindex.html
@@ -6,7 +6,8 @@
T
+
-
+
diff --git a/hooks.html b/hooks.html
index 62c0afe..cdae1bc 100644
--- a/hooks.html
+++ b/hooks.html
@@ -7,7 +7,8 @@
Hooks — pubtools documentation
-
+
+
@@ -526,7 +527,7 @@
-
+
diff --git a/hooks.html b/hooks.html
index 62c0afe..cdae1bc 100644
--- a/hooks.html
+++ b/hooks.html
@@ -7,7 +7,8 @@
Hook reference
+
+
diff --git a/index.html b/index.html
index 476cfe1..ffbfe82 100644
--- a/index.html
+++ b/index.html
@@ -7,7 +7,8 @@
pubtools — pubtools documentation
-
+
+
@@ -82,7 +83,7 @@ Introduction
+
pubtools
@@ -600,8 +601,8 @@Quick search
©2021, Red Hat. | - Powered by Sphinx 7.3.7 - & Alabaster 0.7.16 + Powered by Sphinx 8.0.2 + & Alabaster 1.0.0 | Quick search -
+
diff --git a/index.html b/index.html
index 476cfe1..ffbfe82 100644
--- a/index.html
+++ b/index.html
@@ -7,7 +7,8 @@
Introduction
+
pubtools
@@ -150,8 +151,8 @@ Quick search
©2021, Red Hat.
|
- Powered by Sphinx 7.3.7
- & Alabaster 0.7.16
+ Powered by Sphinx 8.0.2
+ & Alabaster 1.0.0
|
Quick search
-
+
diff --git a/projects.html b/projects.html
index b4bc3bf..db10f55 100644
--- a/projects.html
+++ b/projects.html
@@ -7,7 +7,8 @@
Project Overview — pubtools documentation
-
+
+
@@ -88,7 +89,7 @@ Helper libraries<
-
+
pubtools
@@ -161,8 +162,8 @@ Quick search
©2021, Red Hat.
|
- Powered by Sphinx 7.3.7
- & Alabaster 0.7.16
+ Powered by Sphinx 8.0.2
+ & Alabaster 1.0.0
|
Quick search
-
+
diff --git a/search.html b/search.html
index 94b51ea..f011ab6 100644
--- a/search.html
+++ b/search.html
@@ -6,7 +6,8 @@
Search — pubtools documentation
-
+
+
@@ -68,7 +69,7 @@ Search
-
+
-
+
diff --git a/searchindex.js b/searchindex.js
index 546ef67..4cd65cd 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"--debug: enable debug logging": [[0, "debug-enable-debug-logging"]], "--skip, --step: execute subset of task": [[0, "skip-step-execute-subset-of-task"]], "--source: obtain content via pushsource": [[0, "source-obtain-content-via-pushsource"]], "1. Define hookspecs": [[1, "define-hookspecs"]], "2. Invoke hooks": [[1, "invoke-hooks"]], "API reference": [[1, "api-reference"], [4, "api-reference"]], "Argument conventions": [[0, "argument-conventions"]], "Arguments with multiple values": [[0, "arguments-with-multiple-values"]], "Avoid changing logger configuration": [[0, "avoid-changing-logger-configuration"]], "Contents": [[1, "contents"], [4, "contents"]], "Developer Guide": [[0, "developer-guide"]], "Guide: hook implementers": [[1, "guide-hook-implementers"]], "Guide: hook providers": [[1, "guide-hook-providers"]], "Guide: managing context": [[1, "guide-managing-context"]], "Helper libraries": [[3, "helper-libraries"]], "Hook reference": [[1, "hook-reference"]], "Hooks": [[1, "hooks"]], "Inputs": [[0, "inputs"]], "Instrument tracing for functions": [[4, "instrument-tracing-for-functions"]], "Introduction": [[2, "introduction"]], "Logging": [[0, "logging"]], "Name loggers after your project": [[0, "name-loggers-after-your-project"]], "Naming": [[0, "naming"]], "OTEL Exporter": [[4, "otel-exporter"]], "Outputs": [[0, "outputs"]], "Overview": [[1, "overview"], [4, "overview"]], "Project Overview": [[3, "project-overview"]], "Project setup": [[0, "project-setup"]], "Set environment variables": [[4, "set-environment-variables"]], "Standalone vs Hosted": [[0, "standalone-vs-hosted"]], "Structured logging via extra": [[0, "structured-logging-via-extra"]], "Target platforms": [[0, "target-platforms"]], "Task interface": [[0, "task-interface"]], "Task libraries": [[3, "task-libraries"]], "Tracing": [[4, "tracing"]], "Understanding tasks": [[0, "understanding-tasks"]], "Usage": [[4, "usage"]], "Use appropriate log levels": [[0, "use-appropriate-log-levels"]], "Use loggers as primary output mechanism": [[0, "use-loggers-as-primary-output-mechanism"]], "pubtools": [[2, "pubtools"]]}, "docnames": ["devguide", "hooks", "index", "projects", "tracing"], "envversion": {"sphinx": 61, "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, "sphinx.ext.viewcode": 1}, "filenames": ["devguide.rst", "hooks.rst", "index.rst", "projects.rst", "tracing.rst"], "indexentries": {"built-in function": [[1, "get_cert_key_paths", false], [1, "otel_exporter", false], [1, "pulp_item_push_finished", false], [1, "pulp_repository_pre_publish", false], [1, "pulp_repository_published", false], [1, "quay_images_tagged", false], [1, "quay_images_untagged", false], [1, "quay_repositories_cleared", false], [1, "quay_repositories_removed", false], [1, "task_pulp_flush", false], [1, "task_start", false], [1, "task_stop", false]], "force_flush() (in module pubtools._impl.tracing.tracingwrapper)": [[4, "pubtools._impl.tracing.TracingWrapper.force_flush", false]], "get_cert_key_paths()": [[1, "get_cert_key_paths", false]], "get_trace_wrapper() (in module pubtools.tracing)": [[4, "pubtools.tracing.get_trace_wrapper", false]], "hookimpl (pubtools.pluggy attribute)": [[1, "pubtools.pluggy.hookimpl", false]], "hookspec (pubtools.pluggy attribute)": [[1, "pubtools.pluggy.hookspec", false]], "instrument_func() (in module pubtools._impl.tracing.tracingwrapper)": [[4, "pubtools._impl.tracing.TracingWrapper.instrument_func", false]], "otel_exporter()": [[1, "otel_exporter", false]], "pm (pubtools.pluggy attribute)": [[1, "pubtools.pluggy.pm", false]], "pulp_item_push_finished()": [[1, "pulp_item_push_finished", false]], "pulp_repository_pre_publish()": [[1, "pulp_repository_pre_publish", false]], "pulp_repository_published()": [[1, "pulp_repository_published", false]], "quay_images_tagged()": [[1, "quay_images_tagged", false]], "quay_images_untagged()": [[1, "quay_images_untagged", false]], "quay_repositories_cleared()": [[1, "quay_repositories_cleared", false]], "quay_repositories_removed()": [[1, "quay_repositories_removed", false]], "task_context() (in module pubtools.pluggy)": [[1, "pubtools.pluggy.task_context", false]], "task_pulp_flush()": [[1, "task_pulp_flush", false]], "task_start()": [[1, "task_start", false]], "task_stop()": [[1, "task_stop", false]]}, "objects": {"": [[1, 0, 1, "", "get_cert_key_paths"], [1, 0, 1, "", "otel_exporter"], [1, 0, 1, "", "pulp_item_push_finished"], [1, 0, 1, "", "pulp_repository_pre_publish"], [1, 0, 1, "", "pulp_repository_published"], [1, 0, 1, "", "quay_images_tagged"], [1, 0, 1, "", "quay_images_untagged"], [1, 0, 1, "", "quay_repositories_cleared"], [1, 0, 1, "", "quay_repositories_removed"], [1, 0, 1, "", "task_pulp_flush"], [1, 0, 1, "", "task_start"], [1, 0, 1, "", "task_stop"]], "pubtools._impl.tracing.TracingWrapper": [[4, 0, 1, "", "force_flush"], [4, 0, 1, "", "instrument_func"]], "pubtools.pluggy": [[1, 1, 1, "", "hookimpl"], [1, 1, 1, "", "hookspec"], [1, 1, 1, "", "pm"], [1, 0, 1, "", "task_context"]], "pubtools.tracing": [[4, 0, 1, "", "get_trace_wrapper"]]}, "objnames": {"0": ["py", "function", "Python function"], "1": ["py", "attribute", "Python attribute"]}, "objtypes": {"0": "py:function", "1": "py:attribute"}, "terms": {"": [0, 1, 4], "0": 1, "00": 4, "01": 4, "1": 4, "2": [3, 4], "3": [0, 4], "355989206d66228f21ff34634b77ae1a": 4, "9": 0, "97efa33ebed5d06c": 4, "A": [0, 1, 3, 4], "As": [0, 4], "At": 1, "Be": 1, "By": [0, 1], "For": [0, 1, 4], "If": [0, 1], "In": [0, 1, 3, 4], "It": [0, 1, 4], "No": 0, "Of": 0, "The": [0, 1, 4], "There": [0, 1], "These": [0, 3], "To": 2, "__init__": 1, "__name__": 1, "_impl": [1, 4], "_pulp": 0, "abl": [0, 4], "about": 2, "abov": [1, 3], "accept": 0, "access": 3, "accord": 1, "across": [0, 1, 4], "action": 0, "ad": [0, 4], "add": [0, 1, 4], "add_hookspec": 1, "addit": [0, 1], "adjust": [0, 1], "advanc": 1, "advic": 0, "advisori": 3, "after": 1, "again": 1, "aim": 0, "all": [0, 1], "allow": [0, 1], "almost": 0, "along": 4, "alreadi": 0, "also": [1, 3], "although": 0, "alwai": 0, "amount": [0, 1], "an": [0, 1, 4], "analyz": 4, "ani": [0, 1], "ansibl": 0, "answer": [0, 1], "antipattern": 1, "anyon": 1, "anyth": [0, 1], "api": [2, 3], "appear": 4, "applic": 4, "approach": [0, 1], "appropri": 1, "ar": [0, 1, 2, 3, 4], "arbitrari": 0, "arg": 1, "argmax": 0, "argpars": 0, "args_to_attr": 4, "argument": 2, "argv": 0, "aris": 0, "around": 1, "arrang": 0, "artifact": 3, "as_complet": 4, "ask": 0, "assign": 4, "associ": [0, 1, 3], "attach": 1, "attribut": [0, 4], "audienc": 0, "audit": 0, "authent": 1, "avail": [0, 1, 4], "avoid": 1, "await": 0, "awar": 1, "b": 0, "backend": [0, 4], "backward": 0, "bad": 0, "bar": 1, "base": [0, 1], "basic": [0, 1, 4], "basicconfig": 0, "batch": 4, "becaus": [0, 2], "becom": 0, "been": 1, "befor": 1, "behavior": [0, 1], "being": 4, "belong": 1, "below": 0, "best": [0, 1], "better": 1, "between": [0, 1], "block": 1, "boil": 1, "bool": 1, "boolean": 4, "both": 0, "bound": [0, 1], "break": 0, "brief": [0, 2], "brittl": 0, "bug": 0, "build": 3, "bundl": 3, "c": 0, "cach": 1, "call": [0, 1, 4], "callback": 1, "caller": [0, 1, 4], "can": [0, 1, 2, 4], "canon": 1, "care": 1, "carri": 4, "carrier": 4, "case": [0, 1, 4], "caus": [0, 1], "cdn": 1, "cento": 0, "cert": 1, "certain": 0, "certainli": 0, "certif": 1, "chang": 1, "charact": 0, "child": 4, "choos": 4, "circumst": 1, "clash": 1, "class": 1, "clean": 0, "clear": 1, "client": 3, "close": 3, "code": [0, 1, 3], "collect": [0, 3], "collector": 4, "combin": 0, "command": 0, "common": [0, 3], "commonli": [0, 2], "compar": 0, "compat": 0, "complet": [0, 1], "complic": 0, "compris": 2, "concern": 0, "configur": 1, "confus": 0, "connect": 0, "conserv": 3, "consid": [0, 1], "consist": 0, "console_script": 0, "consolespanexport": [1, 4], "consum": 0, "consumpt": 1, "contain": [0, 1, 3], "content": [2, 3], "context": [0, 4], "contextvar": 4, "control": 0, "convent": [1, 2], "correctli": 0, "correspond": 1, "could": 1, "count": 1, "cours": [0, 1], "crash": 1, "creat": [0, 1, 4], "critic": 0, "cross": 4, "cup": 1, "current": [0, 1, 3], "d": 1, "data": [0, 4], "databas": 3, "date": 1, "debug": 4, "declar": 1, "decor": [1, 4], "def": [1, 4], "default": [0, 1, 4], "defin": 0, "depend": [0, 1, 4], "deploi": 0, "deriv": 1, "describ": [0, 2], "design": [0, 3], "desir": 1, "dest_ref": 1, "destin": 1, "develop": [2, 4], "dict": [0, 4], "dictionari": 4, "differ": [0, 1, 4], "digest": 1, "direct": 1, "directli": 0, "directori": 3, "disabl": [1, 4], "discard": 3, "discourag": 0, "discret": 0, "dispatch": 1, "do": [0, 1], "do_task": 1, "doc": 1, "document": [0, 1, 2, 3], "doesn": 0, "don": [0, 1], "done": 1, "down": 1, "downstream": 4, "due": [0, 1], "dure": [0, 1, 3], "e": [0, 1, 3, 4], "each": [0, 1, 3], "earli": 0, "earlier": 0, "effect": [0, 1], "either": 3, "elsewher": 0, "emerg": 0, "emit": 1, "emitt": 1, "empti": [0, 1], "en": 1, "enabl": [1, 3, 4], "encount": 0, "end": [0, 1], "enforc": 1, "enough": 0, "ensur": [0, 1], "enter": 1, "entri": [0, 1], "entry_point": [0, 1], "environ": [0, 3], "errata": 3, "error": 0, "establish": 1, "etc": 1, "even": 0, "event": [0, 1], "everi": 1, "exactli": 1, "exampl": [0, 1, 4], "except": [0, 1], "exclud": 1, "execut": [1, 3], "executor": 4, "exhaust": 0, "exist": 0, "exit": 1, "expect": [0, 1, 4], "explain": [0, 1], "explan": 2, "export": 1, "extend": 1, "extra": 1, "extract": 4, "facad": 3, "fail": [0, 1], "fallback": 1, "fals": 4, "famili": [0, 1, 2, 3], "familiar": 0, "fatal": 0, "featur": [0, 1], "fedora": 0, "few": [0, 1], "field": [0, 1], "file": [0, 3], "fill_wat": 1, "find": [0, 4], "first": 1, "firstli": 2, "flat": 1, "flavor": 0, "flush": [1, 4], "focu": 0, "follow": [0, 1, 2, 4], "foo": [0, 1, 4], "foo_span": 4, "force_flush": 4, "forget": 1, "form": 0, "format": [0, 1], "forward": 0, "friendli": 0, "from": [0, 1, 3, 4], "fulli": 1, "function": [0, 1, 3], "futur": 0, "future_r": 4, "g": [0, 3, 4], "gener": [0, 3], "get": 1, "get_cert_key_path": 1, "get_trace_wrapp": 4, "give": 0, "given": 1, "global": [1, 4], "glue": 3, "gone": 0, "group": 1, "guid": 2, "guidelin": 0, "ha": [0, 1], "hand": 1, "happen": [0, 1], "hat": 0, "have": [0, 1, 4], "health": 0, "help": [0, 3], "helper": 2, "here": [0, 1], "hidden": 0, "hierarchi": 0, "high": 3, "hold": 4, "hood": 4, "hook": [0, 2, 4], "hookimpl": [0, 1], "host": [1, 2, 3], "how": [0, 2], "howev": 0, "http": 1, "huge": 1, "human": 0, "i": [0, 1, 2, 3, 4], "id": 1, "identifi": 0, "ignor": 0, "iib": 3, "imag": [1, 3, 4], "immedi": 1, "implement": [0, 2, 4], "impli": 0, "import": [1, 4], "improv": 0, "inappropri": 1, "includ": [0, 3], "incompat": 0, "indic": [0, 1], "info": 0, "inform": [0, 1], "initi": [1, 4], "input": 4, "insert": 0, "instal": [0, 1], "instanc": [1, 4], "instrument": 1, "instrument_func": 4, "integr": 0, "intend": [0, 1], "interest": [0, 1], "interf": 0, "interfer": 0, "introduc": 0, "invok": [0, 3], "io": 3, "issu": 0, "item": [0, 1, 3], "its": 1, "jaeger": 4, "json": 0, "just": [0, 1], "keep": [0, 1], "kei": [0, 1], "kettl": 1, "kettle_off": 1, "kettle_on": 1, "kettlecount": 1, "kettlespikehandl": 1, "key1": 0, "key2": 0, "kind": 0, "known": [0, 1, 2], "koji": 3, "larg": 0, "last": [0, 1], "later": [0, 3], "launch": 0, "learn": 2, "least": 0, "left": 1, "legaci": 3, "level": [1, 3], "librari": [0, 1, 2, 4], "lifecycl": 1, "lifo": 1, "like": [0, 1], "limit": 0, "line": 0, "list": [0, 1, 2, 3], "load": 0, "local": [0, 3], "locat": 1, "log": 2, "long": 0, "longer": [0, 1], "lose": 0, "lost_ref": 1, "made": 0, "mai": [0, 1, 3], "main_thread": 4, "main_thread_span": 4, "mainli": 1, "maintain": 1, "major": 0, "make": [0, 1], "make_tea": 1, "mani": 4, "manipul": 3, "manual": [0, 4], "match": [0, 1], "max_work": 4, "maximum": 1, "me": 0, "mean": 0, "mechan": 1, "mention": 0, "messag": 0, "metadata": [0, 3], "method": [0, 1], "metric": 0, "might": 0, "mind": 0, "mode": 0, "modul": [0, 1, 4], "monitor": 0, "more": [0, 1, 2, 4], "most": [0, 2], "multipl": [1, 4], "must": [0, 1], "mutat": 1, "myself": 1, "naiv": 1, "name": [1, 4], "namespac": [0, 1, 4], "necessari": [0, 1], "need": [0, 1, 4], "never": 0, "new": 0, "next": 1, "noisi": 0, "non": [0, 1], "none": [1, 4], "normal": [0, 1], "notabl": [0, 3], "note": [0, 1], "noth": 1, "notifi": 1, "now": 1, "number": 0, "o": [0, 4], "object": [0, 1], "off": 1, "ok": 1, "old": 1, "omit": 4, "onc": [0, 1], "one": [0, 1], "onli": [0, 1], "onto": [0, 1], "opentelemetri": [1, 4], "oper": [0, 1, 3], "opinion": 3, "option": [0, 1, 4], "order": [0, 1, 4], "org": 1, "orient": 0, "otel": 1, "otel_export": [1, 4], "otel_service_nam": 4, "otel_trac": 4, "other": 0, "otherwis": [1, 3, 4], "otlpspanexport": 4, "outsid": 3, "overview": 2, "overwrit": 0, "own": 1, "p1": 4, "page": 3, "pair": 0, "paradigm": [0, 3], "param1": 4, "param2": 4, "paramet": [1, 4], "part": [0, 4], "particularli": 0, "pass": [0, 1, 4], "path": [0, 1], "pattern": 1, "pem": 1, "per": 1, "perform": 0, "perhap": 0, "permit": 1, "plain": 1, "pleas": 0, "pluggi": 1, "plugin": 1, "pluginmanag": 1, "pm": 1, "point": [0, 1], "popul": 0, "portion": 0, "possibl": [0, 1], "potenti": [0, 1], "power": [0, 1], "powerbank": 1, "practic": 0, "predict": 0, "prefer": 0, "prefix": 0, "prepar": 1, "previou": 1, "primarili": [0, 3], "principl": 0, "prior": 0, "problem": 0, "proce": 1, "process": [0, 1, 3], "processor": 4, "produc": 0, "product": [0, 4], "programmat": 0, "project": [1, 2, 4], "project_nam": 0, "propag": [1, 4], "provid": [0, 3, 4], "pub": [0, 2], "publish": [0, 1, 2, 3], "publishopt": 1, "pubtool": [0, 1, 3, 4], "pulp": [0, 1, 3], "pulp_item_push_finish": 1, "pulp_repository_pre_publish": 1, "pulp_repository_publish": 1, "pulp_unit": 1, "pulplib": [0, 1, 3], "pure": 1, "purpos": [0, 1], "push": [0, 1, 3], "push_item": 1, "pushcollector": [0, 3], "pushitem": 1, "pushsourc": 3, "put": 0, "py": [0, 1], "python": [0, 2, 4], "pyxi": 3, "quai": [1, 3], "quay_images_tag": 1, "quay_images_untag": 1, "quay_repositories_clear": 1, "quay_repositories_remov": 1, "queue": 0, "rais": 1, "rang": 4, "re": [0, 1], "reach": 0, "reachabl": 1, "read": [0, 2, 3], "realist": 1, "reason": 1, "receiv": 1, "recent": 1, "recommend": 0, "record": 0, "recover": 0, "red": 0, "redirect": 0, "refer": [0, 2], "referenc": 1, "refrain": 0, "regist": 1, "relat": [0, 3], "relev": 0, "reli": 0, "remot": 0, "remov": [0, 1], "replac": 1, "repositori": 1, "repository_id": 1, "requir": 4, "reserv": 1, "resolv": 1, "resort": 0, "resourc": [0, 4], "respons": 0, "result": 1, "retri": 0, "return": [0, 1, 4], "rhel": 0, "right": [0, 1], "root": 0, "rpm": 3, "rule": 0, "run": [0, 1], "running_count": 0, "same": [1, 4], "save": [0, 3], "scenario": [0, 1, 4], "scope": [0, 2], "sdk": 1, "secondli": 2, "secret": 0, "section": [0, 1], "see": [0, 1, 2], "self": [1, 4], "semant": 0, "sensibl": 0, "server_url": 1, "servic": [0, 1, 2, 3, 4], "set": [0, 1, 3], "setup": [1, 2], "setuptool": 0, "sever": 0, "shall": [0, 1], "short": 2, "should": [0, 1, 4], "show": 1, "side": [0, 1], "signatur": [1, 3], "signific": 0, "similar": 4, "simpl": [0, 3], "simpler": 0, "simpli": 0, "simultan": 0, "sinc": 0, "small": [0, 1], "snapshot": 0, "so": [0, 1, 4], "solut": 4, "some": [0, 1, 3], "somehow": 0, "someth": [0, 1], "sometim": 0, "somewhat": 3, "sourc": [1, 3, 4], "source_ref": 1, "span": 4, "span_nam": 4, "spanexport": 1, "specif": 0, "specifi": [0, 1, 4], "spike": 1, "ssl": 1, "stage": 1, "standalon": [1, 3], "standard": [0, 1], "start": [0, 1], "start_boil": 1, "state": 1, "statement": 1, "stderr": 0, "stdout": 0, "step": 1, "still": 0, "str": [1, 4], "strategi": 1, "strictli": 0, "string": [0, 1], "strongli": 0, "style": 0, "sub_thread": 4, "sub_thread_span": 4, "submit": 4, "subscrib": 1, "subset": 1, "subsystem": 0, "succeed": 0, "success": 1, "successfulli": 1, "suggest": 0, "suitabl": 4, "summar": 0, "support": [0, 3], "sy": [0, 1], "system": [0, 1, 3, 4], "t": [0, 1], "tabl": 0, "tag": [0, 1], "take": 1, "task": [1, 2, 4], "task_context": 1, "task_nam": 0, "task_pulp_flush": 1, "task_start": 1, "task_stop": 1, "tear": 1, "telemetri": 4, "tend": 0, "test": 0, "than": 0, "them": [0, 1], "themselv": [0, 1], "therefor": 0, "thi": [0, 1, 3, 4], "thing": 0, "those": 0, "though": 0, "thread": [1, 4], "threadpoolexecutor": 4, "through": 1, "thumb": 0, "ticket": 0, "time": [0, 1], "timestamp": 0, "too": 0, "tool": [0, 2, 3], "top": [0, 1], "trace": [1, 2], "tracepar": 4, "tracingwrapp": 4, "trail": 0, "trigger": 1, "true": [1, 4], "turn": 1, "tv_pickup": 1, "tw": 4, "two": [0, 1, 2], "type": [0, 1], "typic": [0, 1], "ultim": 0, "under": [0, 1, 4], "understand": 2, "uniformli": 1, "uniqu": 4, "unit": 1, "unknown": 0, "unreason": 0, "unregist": 1, "unsur": 1, "untag": 1, "untag_ref": 1, "up": [0, 1], "updat": [0, 1], "upload": 1, "upstream": 4, "upward": 1, "url": [0, 1], "us": [1, 3, 4], "usag": [0, 1], "user": 0, "usual": 0, "v": 3, "val1": 0, "val2": 0, "val3": 0, "valid": 0, "valu": [1, 4], "valuabl": 0, "value1": 0, "value2": 0, "variabl": 0, "varieti": 3, "variou": 0, "verbos": 0, "veri": [0, 3], "version": 0, "via": [1, 3], "visual": 4, "wa": 1, "wai": [0, 2], "wait": 0, "wait_boil": 1, "waiting_count": 0, "want": [0, 1], "warn": 0, "we": [0, 1, 3], "well": 3, "were": 1, "what": 0, "when": [0, 1, 3], "whenev": 0, "where": [0, 1], "whether": 1, "which": [0, 1, 2, 4], "while": [0, 4], "wiki": 1, "wikipedia": 1, "wish": 0, "within": [0, 1, 2, 3, 4], "without": [0, 1], "won": 1, "work": [0, 1], "workaround": 0, "workflow": 2, "would": 0, "wrapper": 4, "write": 0, "wrong": 0, "x": [0, 3], "you": [0, 1, 3, 4], "your": 1, "yourself": 0, "zero": [0, 1]}, "titles": ["Developer Guide", "Hooks", "pubtools", "Project Overview", "Tracing"], "titleterms": {"1": 1, "2": 1, "after": 0, "api": [1, 4], "appropri": 0, "argument": 0, "avoid": 0, "chang": 0, "configur": 0, "content": [0, 1, 4], "context": 1, "convent": 0, "debug": 0, "defin": 1, "develop": 0, "enabl": 0, "environ": 4, "execut": 0, "export": 4, "extra": 0, "function": 4, "guid": [0, 1], "helper": 3, "hook": 1, "hookspec": 1, "host": 0, "implement": 1, "input": 0, "instrument": 4, "interfac": 0, "introduct": 2, "invok": 1, "level": 0, "librari": 3, "log": 0, "logger": 0, "manag": 1, "mechan": 0, "multipl": 0, "name": 0, "obtain": 0, "otel": 4, "output": 0, "overview": [1, 3, 4], "platform": 0, "primari": 0, "project": [0, 3], "provid": 1, "pubtool": 2, "pushsourc": 0, "refer": [1, 4], "set": 4, "setup": 0, "skip": 0, "sourc": 0, "standalon": 0, "step": 0, "structur": 0, "subset": 0, "target": 0, "task": [0, 3], "trace": 4, "understand": 0, "us": 0, "usag": 4, "v": 0, "valu": 0, "variabl": 4, "via": 0, "your": 0}})
\ No newline at end of file
+Search.setIndex({"alltitles": {"--debug: enable debug logging": [[0, "debug-enable-debug-logging"]], "--skip, --step: execute subset of task": [[0, "skip-step-execute-subset-of-task"]], "--source: obtain content via pushsource": [[0, "source-obtain-content-via-pushsource"]], "1. Define hookspecs": [[1, "define-hookspecs"]], "2. Invoke hooks": [[1, "invoke-hooks"]], "API reference": [[1, "api-reference"], [4, "api-reference"]], "Argument conventions": [[0, "argument-conventions"]], "Arguments with multiple values": [[0, "arguments-with-multiple-values"]], "Avoid changing logger configuration": [[0, "avoid-changing-logger-configuration"]], "Contents": [[1, "contents"], [4, "contents"]], "Developer Guide": [[0, null]], "Guide: hook implementers": [[1, "guide-hook-implementers"]], "Guide: hook providers": [[1, "guide-hook-providers"]], "Guide: managing context": [[1, "guide-managing-context"]], "Helper libraries": [[3, "helper-libraries"]], "Hook reference": [[1, "hook-reference"]], "Hooks": [[1, null]], "Inputs": [[0, "inputs"]], "Instrument tracing for functions": [[4, "instrument-tracing-for-functions"]], "Introduction": [[2, "introduction"]], "Logging": [[0, "logging"]], "Name loggers after your project": [[0, "name-loggers-after-your-project"]], "Naming": [[0, "naming"]], "OTEL Exporter": [[4, "otel-exporter"]], "Outputs": [[0, "outputs"]], "Overview": [[1, "overview"], [4, "overview"]], "Project Overview": [[3, null]], "Project setup": [[0, "project-setup"]], "Set environment variables": [[4, "set-environment-variables"]], "Standalone vs Hosted": [[0, "standalone-vs-hosted"]], "Structured logging via extra": [[0, "structured-logging-via-extra"]], "Target platforms": [[0, "target-platforms"]], "Task interface": [[0, "task-interface"]], "Task libraries": [[3, "task-libraries"]], "Tracing": [[4, null]], "Understanding tasks": [[0, "understanding-tasks"]], "Usage": [[4, "usage"]], "Use appropriate log levels": [[0, "use-appropriate-log-levels"]], "Use loggers as primary output mechanism": [[0, "use-loggers-as-primary-output-mechanism"]], "pubtools": [[2, null]]}, "docnames": ["devguide", "hooks", "index", "projects", "tracing"], "envversion": {"sphinx": 63, "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, "sphinx.ext.viewcode": 1}, "filenames": ["devguide.rst", "hooks.rst", "index.rst", "projects.rst", "tracing.rst"], "indexentries": {"built-in function": [[1, "get_cert_key_paths", false], [1, "otel_exporter", false], [1, "pulp_item_push_finished", false], [1, "pulp_repository_pre_publish", false], [1, "pulp_repository_published", false], [1, "quay_images_tagged", false], [1, "quay_images_untagged", false], [1, "quay_repositories_cleared", false], [1, "quay_repositories_removed", false], [1, "task_pulp_flush", false], [1, "task_start", false], [1, "task_stop", false]], "force_flush() (in module pubtools._impl.tracing.tracingwrapper)": [[4, "pubtools._impl.tracing.TracingWrapper.force_flush", false]], "get_cert_key_paths()": [[1, "get_cert_key_paths", false]], "get_trace_wrapper() (in module pubtools.tracing)": [[4, "pubtools.tracing.get_trace_wrapper", false]], "hookimpl (pubtools.pluggy attribute)": [[1, "pubtools.pluggy.hookimpl", false]], "hookspec (pubtools.pluggy attribute)": [[1, "pubtools.pluggy.hookspec", false]], "instrument_func() (in module pubtools._impl.tracing.tracingwrapper)": [[4, "pubtools._impl.tracing.TracingWrapper.instrument_func", false]], "otel_exporter()": [[1, "otel_exporter", false]], "pm (pubtools.pluggy attribute)": [[1, "pubtools.pluggy.pm", false]], "pulp_item_push_finished()": [[1, "pulp_item_push_finished", false]], "pulp_repository_pre_publish()": [[1, "pulp_repository_pre_publish", false]], "pulp_repository_published()": [[1, "pulp_repository_published", false]], "quay_images_tagged()": [[1, "quay_images_tagged", false]], "quay_images_untagged()": [[1, "quay_images_untagged", false]], "quay_repositories_cleared()": [[1, "quay_repositories_cleared", false]], "quay_repositories_removed()": [[1, "quay_repositories_removed", false]], "task_context() (in module pubtools.pluggy)": [[1, "pubtools.pluggy.task_context", false]], "task_pulp_flush()": [[1, "task_pulp_flush", false]], "task_start()": [[1, "task_start", false]], "task_stop()": [[1, "task_stop", false]]}, "objects": {"": [[1, 0, 1, "", "get_cert_key_paths"], [1, 0, 1, "", "otel_exporter"], [1, 0, 1, "", "pulp_item_push_finished"], [1, 0, 1, "", "pulp_repository_pre_publish"], [1, 0, 1, "", "pulp_repository_published"], [1, 0, 1, "", "quay_images_tagged"], [1, 0, 1, "", "quay_images_untagged"], [1, 0, 1, "", "quay_repositories_cleared"], [1, 0, 1, "", "quay_repositories_removed"], [1, 0, 1, "", "task_pulp_flush"], [1, 0, 1, "", "task_start"], [1, 0, 1, "", "task_stop"]], "pubtools._impl.tracing.TracingWrapper": [[4, 0, 1, "", "force_flush"], [4, 0, 1, "", "instrument_func"]], "pubtools.pluggy": [[1, 1, 1, "", "hookimpl"], [1, 1, 1, "", "hookspec"], [1, 1, 1, "", "pm"], [1, 0, 1, "", "task_context"]], "pubtools.tracing": [[4, 0, 1, "", "get_trace_wrapper"]]}, "objnames": {"0": ["py", "function", "Python function"], "1": ["py", "attribute", "Python attribute"]}, "objtypes": {"0": "py:function", "1": "py:attribute"}, "terms": {"": [0, 1, 4], "0": 1, "00": 4, "01": 4, "1": 4, "2": [3, 4], "3": [0, 4], "355989206d66228f21ff34634b77ae1a": 4, "9": 0, "97efa33ebed5d06c": 4, "A": [0, 1, 3, 4], "As": [0, 4], "At": 1, "Be": 1, "By": [0, 1], "For": [0, 1, 4], "If": [0, 1], "In": [0, 1, 3, 4], "It": [0, 1, 4], "No": 0, "Of": 0, "The": [0, 1, 4], "There": [0, 1], "These": [0, 3], "To": 2, "__init__": 1, "__name__": 1, "_impl": [1, 4], "_pulp": 0, "abl": [0, 4], "about": 2, "abov": [1, 3], "accept": 0, "access": 3, "accord": 1, "across": [0, 1, 4], "action": 0, "ad": [0, 4], "add": [0, 1, 4], "add_hookspec": 1, "addit": [0, 1], "adjust": [0, 1], "advanc": 1, "advic": 0, "advisori": 3, "after": 1, "again": 1, "aim": 0, "all": [0, 1], "allow": [0, 1], "almost": 0, "along": 4, "alreadi": 0, "also": [1, 3], "although": 0, "alwai": 0, "amount": [0, 1], "an": [0, 1, 4], "analyz": 4, "ani": [0, 1], "ansibl": 0, "answer": [0, 1], "antipattern": 1, "anyon": 1, "anyth": [0, 1], "api": [2, 3], "appear": 4, "applic": 4, "approach": [0, 1], "appropri": 1, "ar": [0, 1, 2, 3, 4], "arbitrari": 0, "arg": 1, "argmax": 0, "argpars": 0, "args_to_attr": 4, "argument": 2, "argv": 0, "aris": 0, "around": 1, "arrang": 0, "artifact": 3, "as_complet": 4, "ask": 0, "assign": 4, "associ": [0, 1, 3], "attach": 1, "attribut": [0, 4], "audienc": 0, "audit": 0, "authent": 1, "avail": [0, 1, 4], "avoid": 1, "await": 0, "awar": 1, "b": 0, "backend": [0, 4], "backward": 0, "bad": 0, "bar": 1, "base": [0, 1], "basic": [0, 1, 4], "basicconfig": 0, "batch": 4, "becaus": [0, 2], "becom": 0, "been": 1, "befor": 1, "behavior": [0, 1], "being": 4, "belong": 1, "below": 0, "best": [0, 1], "better": 1, "between": [0, 1], "block": 1, "boil": 1, "bool": 1, "boolean": 4, "both": 0, "bound": [0, 1], "break": 0, "brief": [0, 2], "brittl": 0, "bug": 0, "build": 3, "bundl": 3, "c": 0, "cach": 1, "call": [0, 1, 4], "callback": 1, "caller": [0, 1, 4], "can": [0, 1, 2, 4], "canon": 1, "care": 1, "carri": 4, "carrier": 4, "case": [0, 1, 4], "caus": [0, 1], "cdn": 1, "cento": 0, "cert": 1, "certain": 0, "certainli": 0, "certif": 1, "chang": 1, "charact": 0, "child": 4, "choos": 4, "circumst": 1, "clash": 1, "class": 1, "clean": 0, "clear": 1, "client": 3, "close": 3, "code": [0, 1, 3], "collect": [0, 3], "collector": 4, "combin": 0, "command": 0, "common": [0, 3], "commonli": [0, 2], "compar": 0, "compat": 0, "complet": [0, 1], "complic": 0, "compris": 2, "concern": 0, "configur": 1, "confus": 0, "connect": 0, "conserv": 3, "consid": [0, 1], "consist": 0, "console_script": 0, "consolespanexport": [1, 4], "consum": 0, "consumpt": 1, "contain": [0, 1, 3], "content": [2, 3], "context": [0, 4], "contextvar": 4, "control": 0, "convent": [1, 2], "correctli": 0, "correspond": 1, "could": 1, "count": 1, "cours": [0, 1], "crash": 1, "creat": [0, 1, 4], "critic": 0, "cross": 4, "cup": 1, "current": [0, 1, 3], "d": 1, "data": [0, 4], "databas": 3, "date": 1, "debug": 4, "declar": 1, "decor": [1, 4], "def": [1, 4], "default": [0, 1, 4], "defin": 0, "depend": [0, 1, 4], "deploi": 0, "deriv": 1, "describ": [0, 2], "design": [0, 3], "desir": 1, "dest_ref": 1, "destin": 1, "develop": [2, 4], "dict": [0, 4], "dictionari": 4, "differ": [0, 1, 4], "digest": 1, "direct": 1, "directli": 0, "directori": 3, "disabl": [1, 4], "discard": 3, "discourag": 0, "discret": 0, "dispatch": 1, "do": [0, 1], "do_task": 1, "doc": 1, "document": [0, 1, 2, 3], "doesn": 0, "don": [0, 1], "done": 1, "down": 1, "downstream": 4, "due": [0, 1], "dure": [0, 1, 3], "e": [0, 1, 3, 4], "each": [0, 1, 3], "earli": 0, "earlier": 0, "effect": [0, 1], "either": 3, "elsewher": 0, "emerg": 0, "emit": 1, "emitt": 1, "empti": [0, 1], "en": 1, "enabl": [1, 3, 4], "encount": 0, "end": [0, 1], "enforc": 1, "enough": 0, "ensur": [0, 1], "enter": 1, "entri": [0, 1], "entry_point": [0, 1], "environ": [0, 3], "errata": 3, "error": 0, "establish": 1, "etc": 1, "even": 0, "event": [0, 1], "everi": 1, "exactli": 1, "exampl": [0, 1, 4], "except": [0, 1], "exclud": 1, "execut": [1, 3], "executor": 4, "exhaust": 0, "exist": 0, "exit": 1, "expect": [0, 1, 4], "explain": [0, 1], "explan": 2, "export": 1, "extend": 1, "extra": 1, "extract": 4, "facad": 3, "fail": [0, 1], "fallback": 1, "fals": 4, "famili": [0, 1, 2, 3], "familiar": 0, "fatal": 0, "featur": [0, 1], "fedora": 0, "few": [0, 1], "field": [0, 1], "file": [0, 3], "fill_wat": 1, "find": [0, 4], "first": 1, "firstli": 2, "flat": 1, "flavor": 0, "flush": [1, 4], "focu": 0, "follow": [0, 1, 2, 4], "foo": [0, 1, 4], "foo_span": 4, "force_flush": 4, "forget": 1, "form": 0, "format": [0, 1], "forward": 0, "friendli": 0, "from": [0, 1, 3, 4], "fulli": 1, "function": [0, 1, 3], "futur": 0, "future_r": 4, "g": [0, 3, 4], "gener": [0, 3], "get": 1, "get_cert_key_path": 1, "get_trace_wrapp": 4, "give": 0, "given": 1, "global": [1, 4], "glue": 3, "gone": 0, "group": 1, "guid": 2, "guidelin": 0, "ha": [0, 1], "hand": 1, "happen": [0, 1], "hat": 0, "have": [0, 1, 4], "health": 0, "help": [0, 3], "helper": 2, "here": [0, 1], "hidden": 0, "hierarchi": 0, "high": 3, "hold": 4, "hood": 4, "hook": [0, 2, 4], "hookimpl": [0, 1], "host": [1, 2, 3], "how": [0, 2], "howev": 0, "http": 1, "huge": 1, "human": 0, "i": [0, 1, 2, 3, 4], "id": 1, "identifi": 0, "ignor": 0, "iib": 3, "imag": [1, 3, 4], "immedi": 1, "implement": [0, 2, 4], "impli": 0, "import": [1, 4], "improv": 0, "inappropri": 1, "includ": [0, 3], "incompat": 0, "indic": [0, 1], "info": 0, "inform": [0, 1], "initi": [1, 4], "input": 4, "insert": 0, "instal": [0, 1], "instanc": [1, 4], "instrument": 1, "instrument_func": 4, "integr": 0, "intend": [0, 1], "interest": [0, 1], "interf": 0, "interfer": 0, "introduc": 0, "invok": [0, 3], "io": 3, "issu": 0, "item": [0, 1, 3], "its": 1, "jaeger": 4, "json": 0, "just": [0, 1], "keep": [0, 1], "kei": [0, 1], "kettl": 1, "kettle_off": 1, "kettle_on": 1, "kettlecount": 1, "kettlespikehandl": 1, "key1": 0, "key2": 0, "kind": 0, "known": [0, 1, 2], "koji": 3, "larg": 0, "last": [0, 1], "later": [0, 3], "launch": 0, "learn": 2, "least": 0, "left": 1, "legaci": 3, "level": [1, 3], "librari": [0, 1, 2, 4], "lifecycl": 1, "lifo": 1, "like": [0, 1], "limit": 0, "line": 0, "list": [0, 1, 2, 3], "load": 0, "local": [0, 3], "locat": 1, "log": 2, "long": 0, "longer": [0, 1], "lose": 0, "lost_ref": 1, "made": 0, "mai": [0, 1, 3], "main_thread": 4, "main_thread_span": 4, "mainli": 1, "maintain": 1, "major": 0, "make": [0, 1], "make_tea": 1, "mani": 4, "manipul": 3, "manual": [0, 4], "match": [0, 1], "max_work": 4, "maximum": 1, "me": 0, "mean": 0, "mechan": 1, "mention": 0, "messag": 0, "metadata": [0, 3], "method": [0, 1], "metric": 0, "might": 0, "mind": 0, "mode": 0, "modul": [0, 1, 4], "monitor": 0, "more": [0, 1, 2, 4], "most": [0, 2], "multipl": [1, 4], "must": [0, 1], "mutat": 1, "myself": 1, "naiv": 1, "name": [1, 4], "namespac": [0, 1, 4], "necessari": [0, 1], "need": [0, 1, 4], "never": 0, "new": 0, "next": 1, "noisi": 0, "non": [0, 1], "none": [1, 4], "normal": [0, 1], "notabl": [0, 3], "note": [0, 1], "noth": 1, "notifi": 1, "now": 1, "number": 0, "o": [0, 4], "object": [0, 1], "off": 1, "ok": 1, "old": 1, "omit": 4, "onc": [0, 1], "one": [0, 1], "onli": [0, 1], "onto": [0, 1], "opentelemetri": [1, 4], "oper": [0, 1, 3], "opinion": 3, "option": [0, 1, 4], "order": [0, 1, 4], "org": 1, "orient": 0, "otel": 1, "otel_export": [1, 4], "otel_service_nam": 4, "otel_trac": 4, "other": 0, "otherwis": [1, 3, 4], "otlpspanexport": 4, "outsid": 3, "overview": 2, "overwrit": 0, "own": 1, "p1": 4, "page": 3, "pair": 0, "paradigm": [0, 3], "param1": 4, "param2": 4, "paramet": [1, 4], "part": [0, 4], "particularli": 0, "pass": [0, 1, 4], "path": [0, 1], "pattern": 1, "pem": 1, "per": 1, "perform": 0, "perhap": 0, "permit": 1, "plain": 1, "pleas": 0, "pluggi": 1, "plugin": 1, "pluginmanag": 1, "pm": 1, "point": [0, 1], "popul": 0, "portion": 0, "possibl": [0, 1], "potenti": [0, 1], "power": [0, 1], "powerbank": 1, "practic": 0, "predict": 0, "prefer": 0, "prefix": 0, "prepar": 1, "previou": 1, "primarili": [0, 3], "principl": 0, "prior": 0, "problem": 0, "proce": 1, "process": [0, 1, 3], "processor": 4, "produc": 0, "product": [0, 4], "programmat": 0, "project": [1, 2, 4], "project_nam": 0, "propag": [1, 4], "provid": [0, 3, 4], "pub": [0, 2], "publish": [0, 1, 2, 3], "publishopt": 1, "pubtool": [0, 1, 3, 4], "pulp": [0, 1, 3], "pulp_item_push_finish": 1, "pulp_repository_pre_publish": 1, "pulp_repository_publish": 1, "pulp_unit": 1, "pulplib": [0, 1, 3], "pure": 1, "purpos": [0, 1], "push": [0, 1, 3], "push_item": 1, "pushcollector": [0, 3], "pushitem": 1, "pushsourc": 3, "put": 0, "py": [0, 1], "python": [0, 2, 4], "pyxi": 3, "quai": [1, 3], "quay_images_tag": 1, "quay_images_untag": 1, "quay_repositories_clear": 1, "quay_repositories_remov": 1, "queue": 0, "rais": 1, "rang": 4, "re": [0, 1], "reach": 0, "reachabl": 1, "read": [0, 2, 3], "realist": 1, "reason": 1, "receiv": 1, "recent": 1, "recommend": 0, "record": 0, "recover": 0, "red": 0, "redirect": 0, "refer": [0, 2], "referenc": 1, "refrain": 0, "regist": 1, "relat": [0, 3], "relev": 0, "reli": 0, "remot": 0, "remov": [0, 1], "replac": 1, "repositori": 1, "repository_id": 1, "requir": 4, "reserv": 1, "resolv": 1, "resort": 0, "resourc": [0, 4], "respons": 0, "result": 1, "retri": 0, "return": [0, 1, 4], "rhel": 0, "right": [0, 1], "root": 0, "rpm": 3, "rule": 0, "run": [0, 1], "running_count": 0, "same": [1, 4], "save": [0, 3], "scenario": [0, 1, 4], "scope": [0, 2], "sdk": 1, "secondli": 2, "secret": 0, "section": [0, 1], "see": [0, 1, 2], "self": [1, 4], "semant": 0, "sensibl": 0, "server_url": 1, "servic": [0, 1, 2, 3, 4], "set": [0, 1, 3], "setup": [1, 2], "setuptool": 0, "sever": 0, "shall": [0, 1], "short": 2, "should": [0, 1, 4], "show": 1, "side": [0, 1], "signatur": [1, 3], "signific": 0, "similar": 4, "simpl": [0, 3], "simpler": 0, "simpli": 0, "simultan": 0, "sinc": 0, "small": [0, 1], "snapshot": 0, "so": [0, 1, 4], "solut": 4, "some": [0, 1, 3], "somehow": 0, "someth": [0, 1], "sometim": 0, "somewhat": 3, "sourc": [1, 3, 4], "source_ref": 1, "span": 4, "span_nam": 4, "spanexport": 1, "specif": 0, "specifi": [0, 1, 4], "spike": 1, "ssl": 1, "stage": 1, "standalon": [1, 3], "standard": [0, 1], "start": [0, 1], "start_boil": 1, "state": 1, "statement": 1, "stderr": 0, "stdout": 0, "step": 1, "still": 0, "str": [1, 4], "strategi": 1, "strictli": 0, "string": [0, 1], "strongli": 0, "style": 0, "sub_thread": 4, "sub_thread_span": 4, "submit": 4, "subscrib": 1, "subset": 1, "subsystem": 0, "succeed": 0, "success": 1, "successfulli": 1, "suggest": 0, "suitabl": 4, "summar": 0, "support": [0, 3], "sy": [0, 1], "system": [0, 1, 3, 4], "t": [0, 1], "tabl": 0, "tag": [0, 1], "take": 1, "task": [1, 2, 4], "task_context": 1, "task_nam": 0, "task_pulp_flush": 1, "task_start": 1, "task_stop": 1, "tear": 1, "telemetri": 4, "tend": 0, "test": 0, "than": 0, "them": [0, 1], "themselv": [0, 1], "therefor": 0, "thi": [0, 1, 3, 4], "thing": 0, "those": 0, "though": 0, "thread": [1, 4], "threadpoolexecutor": 4, "through": 1, "thumb": 0, "ticket": 0, "time": [0, 1], "timestamp": 0, "too": 0, "tool": [0, 2, 3], "top": [0, 1], "trace": [1, 2], "tracepar": 4, "tracingwrapp": 4, "trail": 0, "trigger": 1, "true": [1, 4], "turn": 1, "tv_pickup": 1, "tw": 4, "two": [0, 1, 2], "type": [0, 1], "typic": [0, 1], "ultim": 0, "under": [0, 1, 4], "understand": 2, "uniformli": 1, "uniqu": 4, "unit": 1, "unknown": 0, "unreason": 0, "unregist": 1, "unsur": 1, "untag": 1, "untag_ref": 1, "up": [0, 1], "updat": [0, 1], "upload": 1, "upstream": 4, "upward": 1, "url": [0, 1], "us": [1, 3, 4], "usag": [0, 1], "user": 0, "usual": 0, "v": 3, "val1": 0, "val2": 0, "val3": 0, "valid": 0, "valu": [1, 4], "valuabl": 0, "value1": 0, "value2": 0, "variabl": 0, "varieti": 3, "variou": 0, "verbos": 0, "veri": [0, 3], "version": 0, "via": [1, 3], "visual": 4, "wa": 1, "wai": [0, 2], "wait": 0, "wait_boil": 1, "waiting_count": 0, "want": [0, 1], "warn": 0, "we": [0, 1, 3], "well": 3, "were": 1, "what": 0, "when": [0, 1, 3], "whenev": 0, "where": [0, 1], "whether": 1, "which": [0, 1, 2, 4], "while": [0, 4], "wiki": 1, "wikipedia": 1, "wish": 0, "within": [0, 1, 2, 3, 4], "without": [0, 1], "won": 1, "work": [0, 1], "workaround": 0, "workflow": 2, "would": 0, "wrapper": 4, "write": 0, "wrong": 0, "x": [0, 3], "you": [0, 1, 3, 4], "your": 1, "yourself": 0, "zero": [0, 1]}, "titles": ["Developer Guide", "Hooks", "pubtools", "Project Overview", "Tracing"], "titleterms": {"1": 1, "2": 1, "after": 0, "api": [1, 4], "appropri": 0, "argument": 0, "avoid": 0, "chang": 0, "configur": 0, "content": [0, 1, 4], "context": 1, "convent": 0, "debug": 0, "defin": 1, "develop": 0, "enabl": 0, "environ": 4, "execut": 0, "export": 4, "extra": 0, "function": 4, "guid": [0, 1], "helper": 3, "hook": 1, "hookspec": 1, "host": 0, "implement": 1, "input": 0, "instrument": 4, "interfac": 0, "introduct": 2, "invok": 1, "level": 0, "librari": 3, "log": 0, "logger": 0, "manag": 1, "mechan": 0, "multipl": 0, "name": 0, "obtain": 0, "otel": 4, "output": 0, "overview": [1, 3, 4], "platform": 0, "primari": 0, "project": [0, 3], "provid": 1, "pubtool": 2, "pushsourc": 0, "refer": [1, 4], "set": 4, "setup": 0, "skip": 0, "sourc": 0, "standalon": 0, "step": 0, "structur": 0, "subset": 0, "target": 0, "task": [0, 3], "trace": 4, "understand": 0, "us": 0, "usag": 4, "v": 0, "valu": 0, "variabl": 4, "via": 0, "your": 0}})
\ No newline at end of file
diff --git a/tracing.html b/tracing.html
index e5102b5..fce5d65 100644
--- a/tracing.html
+++ b/tracing.html
@@ -7,7 +7,8 @@
Tracing — pubtools documentation
-
+
+
@@ -198,7 +199,7 @@ API reference
-
+
pubtools
@@ -270,8 +271,8 @@ Quick search
©2021, Red Hat.
|
- Powered by Sphinx 7.3.7
- & Alabaster 0.7.16
+ Powered by Sphinx 8.0.2
+ & Alabaster 1.0.0
|
Quick search
-
+
pubtools
@@ -150,8 +151,8 @@Quick search
©2021, Red Hat. | - Powered by Sphinx 7.3.7 - & Alabaster 0.7.16 + Powered by Sphinx 8.0.2 + & Alabaster 1.0.0 | Quick search -
+
diff --git a/projects.html b/projects.html
index b4bc3bf..db10f55 100644
--- a/projects.html
+++ b/projects.html
@@ -7,7 +7,8 @@
Helper libraries<
pubtools
@@ -161,8 +162,8 @@Quick search
©2021, Red Hat. | - Powered by Sphinx 7.3.7 - & Alabaster 0.7.16 + Powered by Sphinx 8.0.2 + & Alabaster 1.0.0 | Quick search -
+
diff --git a/search.html b/search.html
index 94b51ea..f011ab6 100644
--- a/search.html
+++ b/search.html
@@ -6,7 +6,8 @@
Search
+
-
+
diff --git a/searchindex.js b/searchindex.js
index 546ef67..4cd65cd 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"--debug: enable debug logging": [[0, "debug-enable-debug-logging"]], "--skip, --step: execute subset of task": [[0, "skip-step-execute-subset-of-task"]], "--source: obtain content via pushsource": [[0, "source-obtain-content-via-pushsource"]], "1. Define hookspecs": [[1, "define-hookspecs"]], "2. Invoke hooks": [[1, "invoke-hooks"]], "API reference": [[1, "api-reference"], [4, "api-reference"]], "Argument conventions": [[0, "argument-conventions"]], "Arguments with multiple values": [[0, "arguments-with-multiple-values"]], "Avoid changing logger configuration": [[0, "avoid-changing-logger-configuration"]], "Contents": [[1, "contents"], [4, "contents"]], "Developer Guide": [[0, "developer-guide"]], "Guide: hook implementers": [[1, "guide-hook-implementers"]], "Guide: hook providers": [[1, "guide-hook-providers"]], "Guide: managing context": [[1, "guide-managing-context"]], "Helper libraries": [[3, "helper-libraries"]], "Hook reference": [[1, "hook-reference"]], "Hooks": [[1, "hooks"]], "Inputs": [[0, "inputs"]], "Instrument tracing for functions": [[4, "instrument-tracing-for-functions"]], "Introduction": [[2, "introduction"]], "Logging": [[0, "logging"]], "Name loggers after your project": [[0, "name-loggers-after-your-project"]], "Naming": [[0, "naming"]], "OTEL Exporter": [[4, "otel-exporter"]], "Outputs": [[0, "outputs"]], "Overview": [[1, "overview"], [4, "overview"]], "Project Overview": [[3, "project-overview"]], "Project setup": [[0, "project-setup"]], "Set environment variables": [[4, "set-environment-variables"]], "Standalone vs Hosted": [[0, "standalone-vs-hosted"]], "Structured logging via extra": [[0, "structured-logging-via-extra"]], "Target platforms": [[0, "target-platforms"]], "Task interface": [[0, "task-interface"]], "Task libraries": [[3, "task-libraries"]], "Tracing": [[4, "tracing"]], "Understanding tasks": [[0, "understanding-tasks"]], "Usage": [[4, "usage"]], "Use appropriate log levels": [[0, "use-appropriate-log-levels"]], "Use loggers as primary output mechanism": [[0, "use-loggers-as-primary-output-mechanism"]], "pubtools": [[2, "pubtools"]]}, "docnames": ["devguide", "hooks", "index", "projects", "tracing"], "envversion": {"sphinx": 61, "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, "sphinx.ext.viewcode": 1}, "filenames": ["devguide.rst", "hooks.rst", "index.rst", "projects.rst", "tracing.rst"], "indexentries": {"built-in function": [[1, "get_cert_key_paths", false], [1, "otel_exporter", false], [1, "pulp_item_push_finished", false], [1, "pulp_repository_pre_publish", false], [1, "pulp_repository_published", false], [1, "quay_images_tagged", false], [1, "quay_images_untagged", false], [1, "quay_repositories_cleared", false], [1, "quay_repositories_removed", false], [1, "task_pulp_flush", false], [1, "task_start", false], [1, "task_stop", false]], "force_flush() (in module pubtools._impl.tracing.tracingwrapper)": [[4, "pubtools._impl.tracing.TracingWrapper.force_flush", false]], "get_cert_key_paths()": [[1, "get_cert_key_paths", false]], "get_trace_wrapper() (in module pubtools.tracing)": [[4, "pubtools.tracing.get_trace_wrapper", false]], "hookimpl (pubtools.pluggy attribute)": [[1, "pubtools.pluggy.hookimpl", false]], "hookspec (pubtools.pluggy attribute)": [[1, "pubtools.pluggy.hookspec", false]], "instrument_func() (in module pubtools._impl.tracing.tracingwrapper)": [[4, "pubtools._impl.tracing.TracingWrapper.instrument_func", false]], "otel_exporter()": [[1, "otel_exporter", false]], "pm (pubtools.pluggy attribute)": [[1, "pubtools.pluggy.pm", false]], "pulp_item_push_finished()": [[1, "pulp_item_push_finished", false]], "pulp_repository_pre_publish()": [[1, "pulp_repository_pre_publish", false]], "pulp_repository_published()": [[1, "pulp_repository_published", false]], "quay_images_tagged()": [[1, "quay_images_tagged", false]], "quay_images_untagged()": [[1, "quay_images_untagged", false]], "quay_repositories_cleared()": [[1, "quay_repositories_cleared", false]], "quay_repositories_removed()": [[1, "quay_repositories_removed", false]], "task_context() (in module pubtools.pluggy)": [[1, "pubtools.pluggy.task_context", false]], "task_pulp_flush()": [[1, "task_pulp_flush", false]], "task_start()": [[1, "task_start", false]], "task_stop()": [[1, "task_stop", false]]}, "objects": {"": [[1, 0, 1, "", "get_cert_key_paths"], [1, 0, 1, "", "otel_exporter"], [1, 0, 1, "", "pulp_item_push_finished"], [1, 0, 1, "", "pulp_repository_pre_publish"], [1, 0, 1, "", "pulp_repository_published"], [1, 0, 1, "", "quay_images_tagged"], [1, 0, 1, "", "quay_images_untagged"], [1, 0, 1, "", "quay_repositories_cleared"], [1, 0, 1, "", "quay_repositories_removed"], [1, 0, 1, "", "task_pulp_flush"], [1, 0, 1, "", "task_start"], [1, 0, 1, "", "task_stop"]], "pubtools._impl.tracing.TracingWrapper": [[4, 0, 1, "", "force_flush"], [4, 0, 1, "", "instrument_func"]], "pubtools.pluggy": [[1, 1, 1, "", "hookimpl"], [1, 1, 1, "", "hookspec"], [1, 1, 1, "", "pm"], [1, 0, 1, "", "task_context"]], "pubtools.tracing": [[4, 0, 1, "", "get_trace_wrapper"]]}, "objnames": {"0": ["py", "function", "Python function"], "1": ["py", "attribute", "Python attribute"]}, "objtypes": {"0": "py:function", "1": "py:attribute"}, "terms": {"": [0, 1, 4], "0": 1, "00": 4, "01": 4, "1": 4, "2": [3, 4], "3": [0, 4], "355989206d66228f21ff34634b77ae1a": 4, "9": 0, "97efa33ebed5d06c": 4, "A": [0, 1, 3, 4], "As": [0, 4], "At": 1, "Be": 1, "By": [0, 1], "For": [0, 1, 4], "If": [0, 1], "In": [0, 1, 3, 4], "It": [0, 1, 4], "No": 0, "Of": 0, "The": [0, 1, 4], "There": [0, 1], "These": [0, 3], "To": 2, "__init__": 1, "__name__": 1, "_impl": [1, 4], "_pulp": 0, "abl": [0, 4], "about": 2, "abov": [1, 3], "accept": 0, "access": 3, "accord": 1, "across": [0, 1, 4], "action": 0, "ad": [0, 4], "add": [0, 1, 4], "add_hookspec": 1, "addit": [0, 1], "adjust": [0, 1], "advanc": 1, "advic": 0, "advisori": 3, "after": 1, "again": 1, "aim": 0, "all": [0, 1], "allow": [0, 1], "almost": 0, "along": 4, "alreadi": 0, "also": [1, 3], "although": 0, "alwai": 0, "amount": [0, 1], "an": [0, 1, 4], "analyz": 4, "ani": [0, 1], "ansibl": 0, "answer": [0, 1], "antipattern": 1, "anyon": 1, "anyth": [0, 1], "api": [2, 3], "appear": 4, "applic": 4, "approach": [0, 1], "appropri": 1, "ar": [0, 1, 2, 3, 4], "arbitrari": 0, "arg": 1, "argmax": 0, "argpars": 0, "args_to_attr": 4, "argument": 2, "argv": 0, "aris": 0, "around": 1, "arrang": 0, "artifact": 3, "as_complet": 4, "ask": 0, "assign": 4, "associ": [0, 1, 3], "attach": 1, "attribut": [0, 4], "audienc": 0, "audit": 0, "authent": 1, "avail": [0, 1, 4], "avoid": 1, "await": 0, "awar": 1, "b": 0, "backend": [0, 4], "backward": 0, "bad": 0, "bar": 1, "base": [0, 1], "basic": [0, 1, 4], "basicconfig": 0, "batch": 4, "becaus": [0, 2], "becom": 0, "been": 1, "befor": 1, "behavior": [0, 1], "being": 4, "belong": 1, "below": 0, "best": [0, 1], "better": 1, "between": [0, 1], "block": 1, "boil": 1, "bool": 1, "boolean": 4, "both": 0, "bound": [0, 1], "break": 0, "brief": [0, 2], "brittl": 0, "bug": 0, "build": 3, "bundl": 3, "c": 0, "cach": 1, "call": [0, 1, 4], "callback": 1, "caller": [0, 1, 4], "can": [0, 1, 2, 4], "canon": 1, "care": 1, "carri": 4, "carrier": 4, "case": [0, 1, 4], "caus": [0, 1], "cdn": 1, "cento": 0, "cert": 1, "certain": 0, "certainli": 0, "certif": 1, "chang": 1, "charact": 0, "child": 4, "choos": 4, "circumst": 1, "clash": 1, "class": 1, "clean": 0, "clear": 1, "client": 3, "close": 3, "code": [0, 1, 3], "collect": [0, 3], "collector": 4, "combin": 0, "command": 0, "common": [0, 3], "commonli": [0, 2], "compar": 0, "compat": 0, "complet": [0, 1], "complic": 0, "compris": 2, "concern": 0, "configur": 1, "confus": 0, "connect": 0, "conserv": 3, "consid": [0, 1], "consist": 0, "console_script": 0, "consolespanexport": [1, 4], "consum": 0, "consumpt": 1, "contain": [0, 1, 3], "content": [2, 3], "context": [0, 4], "contextvar": 4, "control": 0, "convent": [1, 2], "correctli": 0, "correspond": 1, "could": 1, "count": 1, "cours": [0, 1], "crash": 1, "creat": [0, 1, 4], "critic": 0, "cross": 4, "cup": 1, "current": [0, 1, 3], "d": 1, "data": [0, 4], "databas": 3, "date": 1, "debug": 4, "declar": 1, "decor": [1, 4], "def": [1, 4], "default": [0, 1, 4], "defin": 0, "depend": [0, 1, 4], "deploi": 0, "deriv": 1, "describ": [0, 2], "design": [0, 3], "desir": 1, "dest_ref": 1, "destin": 1, "develop": [2, 4], "dict": [0, 4], "dictionari": 4, "differ": [0, 1, 4], "digest": 1, "direct": 1, "directli": 0, "directori": 3, "disabl": [1, 4], "discard": 3, "discourag": 0, "discret": 0, "dispatch": 1, "do": [0, 1], "do_task": 1, "doc": 1, "document": [0, 1, 2, 3], "doesn": 0, "don": [0, 1], "done": 1, "down": 1, "downstream": 4, "due": [0, 1], "dure": [0, 1, 3], "e": [0, 1, 3, 4], "each": [0, 1, 3], "earli": 0, "earlier": 0, "effect": [0, 1], "either": 3, "elsewher": 0, "emerg": 0, "emit": 1, "emitt": 1, "empti": [0, 1], "en": 1, "enabl": [1, 3, 4], "encount": 0, "end": [0, 1], "enforc": 1, "enough": 0, "ensur": [0, 1], "enter": 1, "entri": [0, 1], "entry_point": [0, 1], "environ": [0, 3], "errata": 3, "error": 0, "establish": 1, "etc": 1, "even": 0, "event": [0, 1], "everi": 1, "exactli": 1, "exampl": [0, 1, 4], "except": [0, 1], "exclud": 1, "execut": [1, 3], "executor": 4, "exhaust": 0, "exist": 0, "exit": 1, "expect": [0, 1, 4], "explain": [0, 1], "explan": 2, "export": 1, "extend": 1, "extra": 1, "extract": 4, "facad": 3, "fail": [0, 1], "fallback": 1, "fals": 4, "famili": [0, 1, 2, 3], "familiar": 0, "fatal": 0, "featur": [0, 1], "fedora": 0, "few": [0, 1], "field": [0, 1], "file": [0, 3], "fill_wat": 1, "find": [0, 4], "first": 1, "firstli": 2, "flat": 1, "flavor": 0, "flush": [1, 4], "focu": 0, "follow": [0, 1, 2, 4], "foo": [0, 1, 4], "foo_span": 4, "force_flush": 4, "forget": 1, "form": 0, "format": [0, 1], "forward": 0, "friendli": 0, "from": [0, 1, 3, 4], "fulli": 1, "function": [0, 1, 3], "futur": 0, "future_r": 4, "g": [0, 3, 4], "gener": [0, 3], "get": 1, "get_cert_key_path": 1, "get_trace_wrapp": 4, "give": 0, "given": 1, "global": [1, 4], "glue": 3, "gone": 0, "group": 1, "guid": 2, "guidelin": 0, "ha": [0, 1], "hand": 1, "happen": [0, 1], "hat": 0, "have": [0, 1, 4], "health": 0, "help": [0, 3], "helper": 2, "here": [0, 1], "hidden": 0, "hierarchi": 0, "high": 3, "hold": 4, "hood": 4, "hook": [0, 2, 4], "hookimpl": [0, 1], "host": [1, 2, 3], "how": [0, 2], "howev": 0, "http": 1, "huge": 1, "human": 0, "i": [0, 1, 2, 3, 4], "id": 1, "identifi": 0, "ignor": 0, "iib": 3, "imag": [1, 3, 4], "immedi": 1, "implement": [0, 2, 4], "impli": 0, "import": [1, 4], "improv": 0, "inappropri": 1, "includ": [0, 3], "incompat": 0, "indic": [0, 1], "info": 0, "inform": [0, 1], "initi": [1, 4], "input": 4, "insert": 0, "instal": [0, 1], "instanc": [1, 4], "instrument": 1, "instrument_func": 4, "integr": 0, "intend": [0, 1], "interest": [0, 1], "interf": 0, "interfer": 0, "introduc": 0, "invok": [0, 3], "io": 3, "issu": 0, "item": [0, 1, 3], "its": 1, "jaeger": 4, "json": 0, "just": [0, 1], "keep": [0, 1], "kei": [0, 1], "kettl": 1, "kettle_off": 1, "kettle_on": 1, "kettlecount": 1, "kettlespikehandl": 1, "key1": 0, "key2": 0, "kind": 0, "known": [0, 1, 2], "koji": 3, "larg": 0, "last": [0, 1], "later": [0, 3], "launch": 0, "learn": 2, "least": 0, "left": 1, "legaci": 3, "level": [1, 3], "librari": [0, 1, 2, 4], "lifecycl": 1, "lifo": 1, "like": [0, 1], "limit": 0, "line": 0, "list": [0, 1, 2, 3], "load": 0, "local": [0, 3], "locat": 1, "log": 2, "long": 0, "longer": [0, 1], "lose": 0, "lost_ref": 1, "made": 0, "mai": [0, 1, 3], "main_thread": 4, "main_thread_span": 4, "mainli": 1, "maintain": 1, "major": 0, "make": [0, 1], "make_tea": 1, "mani": 4, "manipul": 3, "manual": [0, 4], "match": [0, 1], "max_work": 4, "maximum": 1, "me": 0, "mean": 0, "mechan": 1, "mention": 0, "messag": 0, "metadata": [0, 3], "method": [0, 1], "metric": 0, "might": 0, "mind": 0, "mode": 0, "modul": [0, 1, 4], "monitor": 0, "more": [0, 1, 2, 4], "most": [0, 2], "multipl": [1, 4], "must": [0, 1], "mutat": 1, "myself": 1, "naiv": 1, "name": [1, 4], "namespac": [0, 1, 4], "necessari": [0, 1], "need": [0, 1, 4], "never": 0, "new": 0, "next": 1, "noisi": 0, "non": [0, 1], "none": [1, 4], "normal": [0, 1], "notabl": [0, 3], "note": [0, 1], "noth": 1, "notifi": 1, "now": 1, "number": 0, "o": [0, 4], "object": [0, 1], "off": 1, "ok": 1, "old": 1, "omit": 4, "onc": [0, 1], "one": [0, 1], "onli": [0, 1], "onto": [0, 1], "opentelemetri": [1, 4], "oper": [0, 1, 3], "opinion": 3, "option": [0, 1, 4], "order": [0, 1, 4], "org": 1, "orient": 0, "otel": 1, "otel_export": [1, 4], "otel_service_nam": 4, "otel_trac": 4, "other": 0, "otherwis": [1, 3, 4], "otlpspanexport": 4, "outsid": 3, "overview": 2, "overwrit": 0, "own": 1, "p1": 4, "page": 3, "pair": 0, "paradigm": [0, 3], "param1": 4, "param2": 4, "paramet": [1, 4], "part": [0, 4], "particularli": 0, "pass": [0, 1, 4], "path": [0, 1], "pattern": 1, "pem": 1, "per": 1, "perform": 0, "perhap": 0, "permit": 1, "plain": 1, "pleas": 0, "pluggi": 1, "plugin": 1, "pluginmanag": 1, "pm": 1, "point": [0, 1], "popul": 0, "portion": 0, "possibl": [0, 1], "potenti": [0, 1], "power": [0, 1], "powerbank": 1, "practic": 0, "predict": 0, "prefer": 0, "prefix": 0, "prepar": 1, "previou": 1, "primarili": [0, 3], "principl": 0, "prior": 0, "problem": 0, "proce": 1, "process": [0, 1, 3], "processor": 4, "produc": 0, "product": [0, 4], "programmat": 0, "project": [1, 2, 4], "project_nam": 0, "propag": [1, 4], "provid": [0, 3, 4], "pub": [0, 2], "publish": [0, 1, 2, 3], "publishopt": 1, "pubtool": [0, 1, 3, 4], "pulp": [0, 1, 3], "pulp_item_push_finish": 1, "pulp_repository_pre_publish": 1, "pulp_repository_publish": 1, "pulp_unit": 1, "pulplib": [0, 1, 3], "pure": 1, "purpos": [0, 1], "push": [0, 1, 3], "push_item": 1, "pushcollector": [0, 3], "pushitem": 1, "pushsourc": 3, "put": 0, "py": [0, 1], "python": [0, 2, 4], "pyxi": 3, "quai": [1, 3], "quay_images_tag": 1, "quay_images_untag": 1, "quay_repositories_clear": 1, "quay_repositories_remov": 1, "queue": 0, "rais": 1, "rang": 4, "re": [0, 1], "reach": 0, "reachabl": 1, "read": [0, 2, 3], "realist": 1, "reason": 1, "receiv": 1, "recent": 1, "recommend": 0, "record": 0, "recover": 0, "red": 0, "redirect": 0, "refer": [0, 2], "referenc": 1, "refrain": 0, "regist": 1, "relat": [0, 3], "relev": 0, "reli": 0, "remot": 0, "remov": [0, 1], "replac": 1, "repositori": 1, "repository_id": 1, "requir": 4, "reserv": 1, "resolv": 1, "resort": 0, "resourc": [0, 4], "respons": 0, "result": 1, "retri": 0, "return": [0, 1, 4], "rhel": 0, "right": [0, 1], "root": 0, "rpm": 3, "rule": 0, "run": [0, 1], "running_count": 0, "same": [1, 4], "save": [0, 3], "scenario": [0, 1, 4], "scope": [0, 2], "sdk": 1, "secondli": 2, "secret": 0, "section": [0, 1], "see": [0, 1, 2], "self": [1, 4], "semant": 0, "sensibl": 0, "server_url": 1, "servic": [0, 1, 2, 3, 4], "set": [0, 1, 3], "setup": [1, 2], "setuptool": 0, "sever": 0, "shall": [0, 1], "short": 2, "should": [0, 1, 4], "show": 1, "side": [0, 1], "signatur": [1, 3], "signific": 0, "similar": 4, "simpl": [0, 3], "simpler": 0, "simpli": 0, "simultan": 0, "sinc": 0, "small": [0, 1], "snapshot": 0, "so": [0, 1, 4], "solut": 4, "some": [0, 1, 3], "somehow": 0, "someth": [0, 1], "sometim": 0, "somewhat": 3, "sourc": [1, 3, 4], "source_ref": 1, "span": 4, "span_nam": 4, "spanexport": 1, "specif": 0, "specifi": [0, 1, 4], "spike": 1, "ssl": 1, "stage": 1, "standalon": [1, 3], "standard": [0, 1], "start": [0, 1], "start_boil": 1, "state": 1, "statement": 1, "stderr": 0, "stdout": 0, "step": 1, "still": 0, "str": [1, 4], "strategi": 1, "strictli": 0, "string": [0, 1], "strongli": 0, "style": 0, "sub_thread": 4, "sub_thread_span": 4, "submit": 4, "subscrib": 1, "subset": 1, "subsystem": 0, "succeed": 0, "success": 1, "successfulli": 1, "suggest": 0, "suitabl": 4, "summar": 0, "support": [0, 3], "sy": [0, 1], "system": [0, 1, 3, 4], "t": [0, 1], "tabl": 0, "tag": [0, 1], "take": 1, "task": [1, 2, 4], "task_context": 1, "task_nam": 0, "task_pulp_flush": 1, "task_start": 1, "task_stop": 1, "tear": 1, "telemetri": 4, "tend": 0, "test": 0, "than": 0, "them": [0, 1], "themselv": [0, 1], "therefor": 0, "thi": [0, 1, 3, 4], "thing": 0, "those": 0, "though": 0, "thread": [1, 4], "threadpoolexecutor": 4, "through": 1, "thumb": 0, "ticket": 0, "time": [0, 1], "timestamp": 0, "too": 0, "tool": [0, 2, 3], "top": [0, 1], "trace": [1, 2], "tracepar": 4, "tracingwrapp": 4, "trail": 0, "trigger": 1, "true": [1, 4], "turn": 1, "tv_pickup": 1, "tw": 4, "two": [0, 1, 2], "type": [0, 1], "typic": [0, 1], "ultim": 0, "under": [0, 1, 4], "understand": 2, "uniformli": 1, "uniqu": 4, "unit": 1, "unknown": 0, "unreason": 0, "unregist": 1, "unsur": 1, "untag": 1, "untag_ref": 1, "up": [0, 1], "updat": [0, 1], "upload": 1, "upstream": 4, "upward": 1, "url": [0, 1], "us": [1, 3, 4], "usag": [0, 1], "user": 0, "usual": 0, "v": 3, "val1": 0, "val2": 0, "val3": 0, "valid": 0, "valu": [1, 4], "valuabl": 0, "value1": 0, "value2": 0, "variabl": 0, "varieti": 3, "variou": 0, "verbos": 0, "veri": [0, 3], "version": 0, "via": [1, 3], "visual": 4, "wa": 1, "wai": [0, 2], "wait": 0, "wait_boil": 1, "waiting_count": 0, "want": [0, 1], "warn": 0, "we": [0, 1, 3], "well": 3, "were": 1, "what": 0, "when": [0, 1, 3], "whenev": 0, "where": [0, 1], "whether": 1, "which": [0, 1, 2, 4], "while": [0, 4], "wiki": 1, "wikipedia": 1, "wish": 0, "within": [0, 1, 2, 3, 4], "without": [0, 1], "won": 1, "work": [0, 1], "workaround": 0, "workflow": 2, "would": 0, "wrapper": 4, "write": 0, "wrong": 0, "x": [0, 3], "you": [0, 1, 3, 4], "your": 1, "yourself": 0, "zero": [0, 1]}, "titles": ["Developer Guide", "Hooks", "pubtools", "Project Overview", "Tracing"], "titleterms": {"1": 1, "2": 1, "after": 0, "api": [1, 4], "appropri": 0, "argument": 0, "avoid": 0, "chang": 0, "configur": 0, "content": [0, 1, 4], "context": 1, "convent": 0, "debug": 0, "defin": 1, "develop": 0, "enabl": 0, "environ": 4, "execut": 0, "export": 4, "extra": 0, "function": 4, "guid": [0, 1], "helper": 3, "hook": 1, "hookspec": 1, "host": 0, "implement": 1, "input": 0, "instrument": 4, "interfac": 0, "introduct": 2, "invok": 1, "level": 0, "librari": 3, "log": 0, "logger": 0, "manag": 1, "mechan": 0, "multipl": 0, "name": 0, "obtain": 0, "otel": 4, "output": 0, "overview": [1, 3, 4], "platform": 0, "primari": 0, "project": [0, 3], "provid": 1, "pubtool": 2, "pushsourc": 0, "refer": [1, 4], "set": 4, "setup": 0, "skip": 0, "sourc": 0, "standalon": 0, "step": 0, "structur": 0, "subset": 0, "target": 0, "task": [0, 3], "trace": 4, "understand": 0, "us": 0, "usag": 4, "v": 0, "valu": 0, "variabl": 4, "via": 0, "your": 0}})
\ No newline at end of file
+Search.setIndex({"alltitles": {"--debug: enable debug logging": [[0, "debug-enable-debug-logging"]], "--skip, --step: execute subset of task": [[0, "skip-step-execute-subset-of-task"]], "--source: obtain content via pushsource": [[0, "source-obtain-content-via-pushsource"]], "1. Define hookspecs": [[1, "define-hookspecs"]], "2. Invoke hooks": [[1, "invoke-hooks"]], "API reference": [[1, "api-reference"], [4, "api-reference"]], "Argument conventions": [[0, "argument-conventions"]], "Arguments with multiple values": [[0, "arguments-with-multiple-values"]], "Avoid changing logger configuration": [[0, "avoid-changing-logger-configuration"]], "Contents": [[1, "contents"], [4, "contents"]], "Developer Guide": [[0, null]], "Guide: hook implementers": [[1, "guide-hook-implementers"]], "Guide: hook providers": [[1, "guide-hook-providers"]], "Guide: managing context": [[1, "guide-managing-context"]], "Helper libraries": [[3, "helper-libraries"]], "Hook reference": [[1, "hook-reference"]], "Hooks": [[1, null]], "Inputs": [[0, "inputs"]], "Instrument tracing for functions": [[4, "instrument-tracing-for-functions"]], "Introduction": [[2, "introduction"]], "Logging": [[0, "logging"]], "Name loggers after your project": [[0, "name-loggers-after-your-project"]], "Naming": [[0, "naming"]], "OTEL Exporter": [[4, "otel-exporter"]], "Outputs": [[0, "outputs"]], "Overview": [[1, "overview"], [4, "overview"]], "Project Overview": [[3, null]], "Project setup": [[0, "project-setup"]], "Set environment variables": [[4, "set-environment-variables"]], "Standalone vs Hosted": [[0, "standalone-vs-hosted"]], "Structured logging via extra": [[0, "structured-logging-via-extra"]], "Target platforms": [[0, "target-platforms"]], "Task interface": [[0, "task-interface"]], "Task libraries": [[3, "task-libraries"]], "Tracing": [[4, null]], "Understanding tasks": [[0, "understanding-tasks"]], "Usage": [[4, "usage"]], "Use appropriate log levels": [[0, "use-appropriate-log-levels"]], "Use loggers as primary output mechanism": [[0, "use-loggers-as-primary-output-mechanism"]], "pubtools": [[2, null]]}, "docnames": ["devguide", "hooks", "index", "projects", "tracing"], "envversion": {"sphinx": 63, "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, "sphinx.ext.viewcode": 1}, "filenames": ["devguide.rst", "hooks.rst", "index.rst", "projects.rst", "tracing.rst"], "indexentries": {"built-in function": [[1, "get_cert_key_paths", false], [1, "otel_exporter", false], [1, "pulp_item_push_finished", false], [1, "pulp_repository_pre_publish", false], [1, "pulp_repository_published", false], [1, "quay_images_tagged", false], [1, "quay_images_untagged", false], [1, "quay_repositories_cleared", false], [1, "quay_repositories_removed", false], [1, "task_pulp_flush", false], [1, "task_start", false], [1, "task_stop", false]], "force_flush() (in module pubtools._impl.tracing.tracingwrapper)": [[4, "pubtools._impl.tracing.TracingWrapper.force_flush", false]], "get_cert_key_paths()": [[1, "get_cert_key_paths", false]], "get_trace_wrapper() (in module pubtools.tracing)": [[4, "pubtools.tracing.get_trace_wrapper", false]], "hookimpl (pubtools.pluggy attribute)": [[1, "pubtools.pluggy.hookimpl", false]], "hookspec (pubtools.pluggy attribute)": [[1, "pubtools.pluggy.hookspec", false]], "instrument_func() (in module pubtools._impl.tracing.tracingwrapper)": [[4, "pubtools._impl.tracing.TracingWrapper.instrument_func", false]], "otel_exporter()": [[1, "otel_exporter", false]], "pm (pubtools.pluggy attribute)": [[1, "pubtools.pluggy.pm", false]], "pulp_item_push_finished()": [[1, "pulp_item_push_finished", false]], "pulp_repository_pre_publish()": [[1, "pulp_repository_pre_publish", false]], "pulp_repository_published()": [[1, "pulp_repository_published", false]], "quay_images_tagged()": [[1, "quay_images_tagged", false]], "quay_images_untagged()": [[1, "quay_images_untagged", false]], "quay_repositories_cleared()": [[1, "quay_repositories_cleared", false]], "quay_repositories_removed()": [[1, "quay_repositories_removed", false]], "task_context() (in module pubtools.pluggy)": [[1, "pubtools.pluggy.task_context", false]], "task_pulp_flush()": [[1, "task_pulp_flush", false]], "task_start()": [[1, "task_start", false]], "task_stop()": [[1, "task_stop", false]]}, "objects": {"": [[1, 0, 1, "", "get_cert_key_paths"], [1, 0, 1, "", "otel_exporter"], [1, 0, 1, "", "pulp_item_push_finished"], [1, 0, 1, "", "pulp_repository_pre_publish"], [1, 0, 1, "", "pulp_repository_published"], [1, 0, 1, "", "quay_images_tagged"], [1, 0, 1, "", "quay_images_untagged"], [1, 0, 1, "", "quay_repositories_cleared"], [1, 0, 1, "", "quay_repositories_removed"], [1, 0, 1, "", "task_pulp_flush"], [1, 0, 1, "", "task_start"], [1, 0, 1, "", "task_stop"]], "pubtools._impl.tracing.TracingWrapper": [[4, 0, 1, "", "force_flush"], [4, 0, 1, "", "instrument_func"]], "pubtools.pluggy": [[1, 1, 1, "", "hookimpl"], [1, 1, 1, "", "hookspec"], [1, 1, 1, "", "pm"], [1, 0, 1, "", "task_context"]], "pubtools.tracing": [[4, 0, 1, "", "get_trace_wrapper"]]}, "objnames": {"0": ["py", "function", "Python function"], "1": ["py", "attribute", "Python attribute"]}, "objtypes": {"0": "py:function", "1": "py:attribute"}, "terms": {"": [0, 1, 4], "0": 1, "00": 4, "01": 4, "1": 4, "2": [3, 4], "3": [0, 4], "355989206d66228f21ff34634b77ae1a": 4, "9": 0, "97efa33ebed5d06c": 4, "A": [0, 1, 3, 4], "As": [0, 4], "At": 1, "Be": 1, "By": [0, 1], "For": [0, 1, 4], "If": [0, 1], "In": [0, 1, 3, 4], "It": [0, 1, 4], "No": 0, "Of": 0, "The": [0, 1, 4], "There": [0, 1], "These": [0, 3], "To": 2, "__init__": 1, "__name__": 1, "_impl": [1, 4], "_pulp": 0, "abl": [0, 4], "about": 2, "abov": [1, 3], "accept": 0, "access": 3, "accord": 1, "across": [0, 1, 4], "action": 0, "ad": [0, 4], "add": [0, 1, 4], "add_hookspec": 1, "addit": [0, 1], "adjust": [0, 1], "advanc": 1, "advic": 0, "advisori": 3, "after": 1, "again": 1, "aim": 0, "all": [0, 1], "allow": [0, 1], "almost": 0, "along": 4, "alreadi": 0, "also": [1, 3], "although": 0, "alwai": 0, "amount": [0, 1], "an": [0, 1, 4], "analyz": 4, "ani": [0, 1], "ansibl": 0, "answer": [0, 1], "antipattern": 1, "anyon": 1, "anyth": [0, 1], "api": [2, 3], "appear": 4, "applic": 4, "approach": [0, 1], "appropri": 1, "ar": [0, 1, 2, 3, 4], "arbitrari": 0, "arg": 1, "argmax": 0, "argpars": 0, "args_to_attr": 4, "argument": 2, "argv": 0, "aris": 0, "around": 1, "arrang": 0, "artifact": 3, "as_complet": 4, "ask": 0, "assign": 4, "associ": [0, 1, 3], "attach": 1, "attribut": [0, 4], "audienc": 0, "audit": 0, "authent": 1, "avail": [0, 1, 4], "avoid": 1, "await": 0, "awar": 1, "b": 0, "backend": [0, 4], "backward": 0, "bad": 0, "bar": 1, "base": [0, 1], "basic": [0, 1, 4], "basicconfig": 0, "batch": 4, "becaus": [0, 2], "becom": 0, "been": 1, "befor": 1, "behavior": [0, 1], "being": 4, "belong": 1, "below": 0, "best": [0, 1], "better": 1, "between": [0, 1], "block": 1, "boil": 1, "bool": 1, "boolean": 4, "both": 0, "bound": [0, 1], "break": 0, "brief": [0, 2], "brittl": 0, "bug": 0, "build": 3, "bundl": 3, "c": 0, "cach": 1, "call": [0, 1, 4], "callback": 1, "caller": [0, 1, 4], "can": [0, 1, 2, 4], "canon": 1, "care": 1, "carri": 4, "carrier": 4, "case": [0, 1, 4], "caus": [0, 1], "cdn": 1, "cento": 0, "cert": 1, "certain": 0, "certainli": 0, "certif": 1, "chang": 1, "charact": 0, "child": 4, "choos": 4, "circumst": 1, "clash": 1, "class": 1, "clean": 0, "clear": 1, "client": 3, "close": 3, "code": [0, 1, 3], "collect": [0, 3], "collector": 4, "combin": 0, "command": 0, "common": [0, 3], "commonli": [0, 2], "compar": 0, "compat": 0, "complet": [0, 1], "complic": 0, "compris": 2, "concern": 0, "configur": 1, "confus": 0, "connect": 0, "conserv": 3, "consid": [0, 1], "consist": 0, "console_script": 0, "consolespanexport": [1, 4], "consum": 0, "consumpt": 1, "contain": [0, 1, 3], "content": [2, 3], "context": [0, 4], "contextvar": 4, "control": 0, "convent": [1, 2], "correctli": 0, "correspond": 1, "could": 1, "count": 1, "cours": [0, 1], "crash": 1, "creat": [0, 1, 4], "critic": 0, "cross": 4, "cup": 1, "current": [0, 1, 3], "d": 1, "data": [0, 4], "databas": 3, "date": 1, "debug": 4, "declar": 1, "decor": [1, 4], "def": [1, 4], "default": [0, 1, 4], "defin": 0, "depend": [0, 1, 4], "deploi": 0, "deriv": 1, "describ": [0, 2], "design": [0, 3], "desir": 1, "dest_ref": 1, "destin": 1, "develop": [2, 4], "dict": [0, 4], "dictionari": 4, "differ": [0, 1, 4], "digest": 1, "direct": 1, "directli": 0, "directori": 3, "disabl": [1, 4], "discard": 3, "discourag": 0, "discret": 0, "dispatch": 1, "do": [0, 1], "do_task": 1, "doc": 1, "document": [0, 1, 2, 3], "doesn": 0, "don": [0, 1], "done": 1, "down": 1, "downstream": 4, "due": [0, 1], "dure": [0, 1, 3], "e": [0, 1, 3, 4], "each": [0, 1, 3], "earli": 0, "earlier": 0, "effect": [0, 1], "either": 3, "elsewher": 0, "emerg": 0, "emit": 1, "emitt": 1, "empti": [0, 1], "en": 1, "enabl": [1, 3, 4], "encount": 0, "end": [0, 1], "enforc": 1, "enough": 0, "ensur": [0, 1], "enter": 1, "entri": [0, 1], "entry_point": [0, 1], "environ": [0, 3], "errata": 3, "error": 0, "establish": 1, "etc": 1, "even": 0, "event": [0, 1], "everi": 1, "exactli": 1, "exampl": [0, 1, 4], "except": [0, 1], "exclud": 1, "execut": [1, 3], "executor": 4, "exhaust": 0, "exist": 0, "exit": 1, "expect": [0, 1, 4], "explain": [0, 1], "explan": 2, "export": 1, "extend": 1, "extra": 1, "extract": 4, "facad": 3, "fail": [0, 1], "fallback": 1, "fals": 4, "famili": [0, 1, 2, 3], "familiar": 0, "fatal": 0, "featur": [0, 1], "fedora": 0, "few": [0, 1], "field": [0, 1], "file": [0, 3], "fill_wat": 1, "find": [0, 4], "first": 1, "firstli": 2, "flat": 1, "flavor": 0, "flush": [1, 4], "focu": 0, "follow": [0, 1, 2, 4], "foo": [0, 1, 4], "foo_span": 4, "force_flush": 4, "forget": 1, "form": 0, "format": [0, 1], "forward": 0, "friendli": 0, "from": [0, 1, 3, 4], "fulli": 1, "function": [0, 1, 3], "futur": 0, "future_r": 4, "g": [0, 3, 4], "gener": [0, 3], "get": 1, "get_cert_key_path": 1, "get_trace_wrapp": 4, "give": 0, "given": 1, "global": [1, 4], "glue": 3, "gone": 0, "group": 1, "guid": 2, "guidelin": 0, "ha": [0, 1], "hand": 1, "happen": [0, 1], "hat": 0, "have": [0, 1, 4], "health": 0, "help": [0, 3], "helper": 2, "here": [0, 1], "hidden": 0, "hierarchi": 0, "high": 3, "hold": 4, "hood": 4, "hook": [0, 2, 4], "hookimpl": [0, 1], "host": [1, 2, 3], "how": [0, 2], "howev": 0, "http": 1, "huge": 1, "human": 0, "i": [0, 1, 2, 3, 4], "id": 1, "identifi": 0, "ignor": 0, "iib": 3, "imag": [1, 3, 4], "immedi": 1, "implement": [0, 2, 4], "impli": 0, "import": [1, 4], "improv": 0, "inappropri": 1, "includ": [0, 3], "incompat": 0, "indic": [0, 1], "info": 0, "inform": [0, 1], "initi": [1, 4], "input": 4, "insert": 0, "instal": [0, 1], "instanc": [1, 4], "instrument": 1, "instrument_func": 4, "integr": 0, "intend": [0, 1], "interest": [0, 1], "interf": 0, "interfer": 0, "introduc": 0, "invok": [0, 3], "io": 3, "issu": 0, "item": [0, 1, 3], "its": 1, "jaeger": 4, "json": 0, "just": [0, 1], "keep": [0, 1], "kei": [0, 1], "kettl": 1, "kettle_off": 1, "kettle_on": 1, "kettlecount": 1, "kettlespikehandl": 1, "key1": 0, "key2": 0, "kind": 0, "known": [0, 1, 2], "koji": 3, "larg": 0, "last": [0, 1], "later": [0, 3], "launch": 0, "learn": 2, "least": 0, "left": 1, "legaci": 3, "level": [1, 3], "librari": [0, 1, 2, 4], "lifecycl": 1, "lifo": 1, "like": [0, 1], "limit": 0, "line": 0, "list": [0, 1, 2, 3], "load": 0, "local": [0, 3], "locat": 1, "log": 2, "long": 0, "longer": [0, 1], "lose": 0, "lost_ref": 1, "made": 0, "mai": [0, 1, 3], "main_thread": 4, "main_thread_span": 4, "mainli": 1, "maintain": 1, "major": 0, "make": [0, 1], "make_tea": 1, "mani": 4, "manipul": 3, "manual": [0, 4], "match": [0, 1], "max_work": 4, "maximum": 1, "me": 0, "mean": 0, "mechan": 1, "mention": 0, "messag": 0, "metadata": [0, 3], "method": [0, 1], "metric": 0, "might": 0, "mind": 0, "mode": 0, "modul": [0, 1, 4], "monitor": 0, "more": [0, 1, 2, 4], "most": [0, 2], "multipl": [1, 4], "must": [0, 1], "mutat": 1, "myself": 1, "naiv": 1, "name": [1, 4], "namespac": [0, 1, 4], "necessari": [0, 1], "need": [0, 1, 4], "never": 0, "new": 0, "next": 1, "noisi": 0, "non": [0, 1], "none": [1, 4], "normal": [0, 1], "notabl": [0, 3], "note": [0, 1], "noth": 1, "notifi": 1, "now": 1, "number": 0, "o": [0, 4], "object": [0, 1], "off": 1, "ok": 1, "old": 1, "omit": 4, "onc": [0, 1], "one": [0, 1], "onli": [0, 1], "onto": [0, 1], "opentelemetri": [1, 4], "oper": [0, 1, 3], "opinion": 3, "option": [0, 1, 4], "order": [0, 1, 4], "org": 1, "orient": 0, "otel": 1, "otel_export": [1, 4], "otel_service_nam": 4, "otel_trac": 4, "other": 0, "otherwis": [1, 3, 4], "otlpspanexport": 4, "outsid": 3, "overview": 2, "overwrit": 0, "own": 1, "p1": 4, "page": 3, "pair": 0, "paradigm": [0, 3], "param1": 4, "param2": 4, "paramet": [1, 4], "part": [0, 4], "particularli": 0, "pass": [0, 1, 4], "path": [0, 1], "pattern": 1, "pem": 1, "per": 1, "perform": 0, "perhap": 0, "permit": 1, "plain": 1, "pleas": 0, "pluggi": 1, "plugin": 1, "pluginmanag": 1, "pm": 1, "point": [0, 1], "popul": 0, "portion": 0, "possibl": [0, 1], "potenti": [0, 1], "power": [0, 1], "powerbank": 1, "practic": 0, "predict": 0, "prefer": 0, "prefix": 0, "prepar": 1, "previou": 1, "primarili": [0, 3], "principl": 0, "prior": 0, "problem": 0, "proce": 1, "process": [0, 1, 3], "processor": 4, "produc": 0, "product": [0, 4], "programmat": 0, "project": [1, 2, 4], "project_nam": 0, "propag": [1, 4], "provid": [0, 3, 4], "pub": [0, 2], "publish": [0, 1, 2, 3], "publishopt": 1, "pubtool": [0, 1, 3, 4], "pulp": [0, 1, 3], "pulp_item_push_finish": 1, "pulp_repository_pre_publish": 1, "pulp_repository_publish": 1, "pulp_unit": 1, "pulplib": [0, 1, 3], "pure": 1, "purpos": [0, 1], "push": [0, 1, 3], "push_item": 1, "pushcollector": [0, 3], "pushitem": 1, "pushsourc": 3, "put": 0, "py": [0, 1], "python": [0, 2, 4], "pyxi": 3, "quai": [1, 3], "quay_images_tag": 1, "quay_images_untag": 1, "quay_repositories_clear": 1, "quay_repositories_remov": 1, "queue": 0, "rais": 1, "rang": 4, "re": [0, 1], "reach": 0, "reachabl": 1, "read": [0, 2, 3], "realist": 1, "reason": 1, "receiv": 1, "recent": 1, "recommend": 0, "record": 0, "recover": 0, "red": 0, "redirect": 0, "refer": [0, 2], "referenc": 1, "refrain": 0, "regist": 1, "relat": [0, 3], "relev": 0, "reli": 0, "remot": 0, "remov": [0, 1], "replac": 1, "repositori": 1, "repository_id": 1, "requir": 4, "reserv": 1, "resolv": 1, "resort": 0, "resourc": [0, 4], "respons": 0, "result": 1, "retri": 0, "return": [0, 1, 4], "rhel": 0, "right": [0, 1], "root": 0, "rpm": 3, "rule": 0, "run": [0, 1], "running_count": 0, "same": [1, 4], "save": [0, 3], "scenario": [0, 1, 4], "scope": [0, 2], "sdk": 1, "secondli": 2, "secret": 0, "section": [0, 1], "see": [0, 1, 2], "self": [1, 4], "semant": 0, "sensibl": 0, "server_url": 1, "servic": [0, 1, 2, 3, 4], "set": [0, 1, 3], "setup": [1, 2], "setuptool": 0, "sever": 0, "shall": [0, 1], "short": 2, "should": [0, 1, 4], "show": 1, "side": [0, 1], "signatur": [1, 3], "signific": 0, "similar": 4, "simpl": [0, 3], "simpler": 0, "simpli": 0, "simultan": 0, "sinc": 0, "small": [0, 1], "snapshot": 0, "so": [0, 1, 4], "solut": 4, "some": [0, 1, 3], "somehow": 0, "someth": [0, 1], "sometim": 0, "somewhat": 3, "sourc": [1, 3, 4], "source_ref": 1, "span": 4, "span_nam": 4, "spanexport": 1, "specif": 0, "specifi": [0, 1, 4], "spike": 1, "ssl": 1, "stage": 1, "standalon": [1, 3], "standard": [0, 1], "start": [0, 1], "start_boil": 1, "state": 1, "statement": 1, "stderr": 0, "stdout": 0, "step": 1, "still": 0, "str": [1, 4], "strategi": 1, "strictli": 0, "string": [0, 1], "strongli": 0, "style": 0, "sub_thread": 4, "sub_thread_span": 4, "submit": 4, "subscrib": 1, "subset": 1, "subsystem": 0, "succeed": 0, "success": 1, "successfulli": 1, "suggest": 0, "suitabl": 4, "summar": 0, "support": [0, 3], "sy": [0, 1], "system": [0, 1, 3, 4], "t": [0, 1], "tabl": 0, "tag": [0, 1], "take": 1, "task": [1, 2, 4], "task_context": 1, "task_nam": 0, "task_pulp_flush": 1, "task_start": 1, "task_stop": 1, "tear": 1, "telemetri": 4, "tend": 0, "test": 0, "than": 0, "them": [0, 1], "themselv": [0, 1], "therefor": 0, "thi": [0, 1, 3, 4], "thing": 0, "those": 0, "though": 0, "thread": [1, 4], "threadpoolexecutor": 4, "through": 1, "thumb": 0, "ticket": 0, "time": [0, 1], "timestamp": 0, "too": 0, "tool": [0, 2, 3], "top": [0, 1], "trace": [1, 2], "tracepar": 4, "tracingwrapp": 4, "trail": 0, "trigger": 1, "true": [1, 4], "turn": 1, "tv_pickup": 1, "tw": 4, "two": [0, 1, 2], "type": [0, 1], "typic": [0, 1], "ultim": 0, "under": [0, 1, 4], "understand": 2, "uniformli": 1, "uniqu": 4, "unit": 1, "unknown": 0, "unreason": 0, "unregist": 1, "unsur": 1, "untag": 1, "untag_ref": 1, "up": [0, 1], "updat": [0, 1], "upload": 1, "upstream": 4, "upward": 1, "url": [0, 1], "us": [1, 3, 4], "usag": [0, 1], "user": 0, "usual": 0, "v": 3, "val1": 0, "val2": 0, "val3": 0, "valid": 0, "valu": [1, 4], "valuabl": 0, "value1": 0, "value2": 0, "variabl": 0, "varieti": 3, "variou": 0, "verbos": 0, "veri": [0, 3], "version": 0, "via": [1, 3], "visual": 4, "wa": 1, "wai": [0, 2], "wait": 0, "wait_boil": 1, "waiting_count": 0, "want": [0, 1], "warn": 0, "we": [0, 1, 3], "well": 3, "were": 1, "what": 0, "when": [0, 1, 3], "whenev": 0, "where": [0, 1], "whether": 1, "which": [0, 1, 2, 4], "while": [0, 4], "wiki": 1, "wikipedia": 1, "wish": 0, "within": [0, 1, 2, 3, 4], "without": [0, 1], "won": 1, "work": [0, 1], "workaround": 0, "workflow": 2, "would": 0, "wrapper": 4, "write": 0, "wrong": 0, "x": [0, 3], "you": [0, 1, 3, 4], "your": 1, "yourself": 0, "zero": [0, 1]}, "titles": ["Developer Guide", "Hooks", "pubtools", "Project Overview", "Tracing"], "titleterms": {"1": 1, "2": 1, "after": 0, "api": [1, 4], "appropri": 0, "argument": 0, "avoid": 0, "chang": 0, "configur": 0, "content": [0, 1, 4], "context": 1, "convent": 0, "debug": 0, "defin": 1, "develop": 0, "enabl": 0, "environ": 4, "execut": 0, "export": 4, "extra": 0, "function": 4, "guid": [0, 1], "helper": 3, "hook": 1, "hookspec": 1, "host": 0, "implement": 1, "input": 0, "instrument": 4, "interfac": 0, "introduct": 2, "invok": 1, "level": 0, "librari": 3, "log": 0, "logger": 0, "manag": 1, "mechan": 0, "multipl": 0, "name": 0, "obtain": 0, "otel": 4, "output": 0, "overview": [1, 3, 4], "platform": 0, "primari": 0, "project": [0, 3], "provid": 1, "pubtool": 2, "pushsourc": 0, "refer": [1, 4], "set": 4, "setup": 0, "skip": 0, "sourc": 0, "standalon": 0, "step": 0, "structur": 0, "subset": 0, "target": 0, "task": [0, 3], "trace": 4, "understand": 0, "us": 0, "usag": 4, "v": 0, "valu": 0, "variabl": 4, "via": 0, "your": 0}})
\ No newline at end of file
diff --git a/tracing.html b/tracing.html
index e5102b5..fce5d65 100644
--- a/tracing.html
+++ b/tracing.html
@@ -7,7 +7,8 @@
Tracing — pubtools documentation
-
+
+
@@ -198,7 +199,7 @@
-
+
diff --git a/searchindex.js b/searchindex.js
index 546ef67..4cd65cd 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"--debug: enable debug logging": [[0, "debug-enable-debug-logging"]], "--skip, --step: execute subset of task": [[0, "skip-step-execute-subset-of-task"]], "--source: obtain content via pushsource": [[0, "source-obtain-content-via-pushsource"]], "1. Define hookspecs": [[1, "define-hookspecs"]], "2. Invoke hooks": [[1, "invoke-hooks"]], "API reference": [[1, "api-reference"], [4, "api-reference"]], "Argument conventions": [[0, "argument-conventions"]], "Arguments with multiple values": [[0, "arguments-with-multiple-values"]], "Avoid changing logger configuration": [[0, "avoid-changing-logger-configuration"]], "Contents": [[1, "contents"], [4, "contents"]], "Developer Guide": [[0, "developer-guide"]], "Guide: hook implementers": [[1, "guide-hook-implementers"]], "Guide: hook providers": [[1, "guide-hook-providers"]], "Guide: managing context": [[1, "guide-managing-context"]], "Helper libraries": [[3, "helper-libraries"]], "Hook reference": [[1, "hook-reference"]], "Hooks": [[1, "hooks"]], "Inputs": [[0, "inputs"]], "Instrument tracing for functions": [[4, "instrument-tracing-for-functions"]], "Introduction": [[2, "introduction"]], "Logging": [[0, "logging"]], "Name loggers after your project": [[0, "name-loggers-after-your-project"]], "Naming": [[0, "naming"]], "OTEL Exporter": [[4, "otel-exporter"]], "Outputs": [[0, "outputs"]], "Overview": [[1, "overview"], [4, "overview"]], "Project Overview": [[3, "project-overview"]], "Project setup": [[0, "project-setup"]], "Set environment variables": [[4, "set-environment-variables"]], "Standalone vs Hosted": [[0, "standalone-vs-hosted"]], "Structured logging via extra": [[0, "structured-logging-via-extra"]], "Target platforms": [[0, "target-platforms"]], "Task interface": [[0, "task-interface"]], "Task libraries": [[3, "task-libraries"]], "Tracing": [[4, "tracing"]], "Understanding tasks": [[0, "understanding-tasks"]], "Usage": [[4, "usage"]], "Use appropriate log levels": [[0, "use-appropriate-log-levels"]], "Use loggers as primary output mechanism": [[0, "use-loggers-as-primary-output-mechanism"]], "pubtools": [[2, "pubtools"]]}, "docnames": ["devguide", "hooks", "index", "projects", "tracing"], "envversion": {"sphinx": 61, "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, "sphinx.ext.viewcode": 1}, "filenames": ["devguide.rst", "hooks.rst", "index.rst", "projects.rst", "tracing.rst"], "indexentries": {"built-in function": [[1, "get_cert_key_paths", false], [1, "otel_exporter", false], [1, "pulp_item_push_finished", false], [1, "pulp_repository_pre_publish", false], [1, "pulp_repository_published", false], [1, "quay_images_tagged", false], [1, "quay_images_untagged", false], [1, "quay_repositories_cleared", false], [1, "quay_repositories_removed", false], [1, "task_pulp_flush", false], [1, "task_start", false], [1, "task_stop", false]], "force_flush() (in module pubtools._impl.tracing.tracingwrapper)": [[4, "pubtools._impl.tracing.TracingWrapper.force_flush", false]], "get_cert_key_paths()": [[1, "get_cert_key_paths", false]], "get_trace_wrapper() (in module pubtools.tracing)": [[4, "pubtools.tracing.get_trace_wrapper", false]], "hookimpl (pubtools.pluggy attribute)": [[1, "pubtools.pluggy.hookimpl", false]], "hookspec (pubtools.pluggy attribute)": [[1, "pubtools.pluggy.hookspec", false]], "instrument_func() (in module pubtools._impl.tracing.tracingwrapper)": [[4, "pubtools._impl.tracing.TracingWrapper.instrument_func", false]], "otel_exporter()": [[1, "otel_exporter", false]], "pm (pubtools.pluggy attribute)": [[1, "pubtools.pluggy.pm", false]], "pulp_item_push_finished()": [[1, "pulp_item_push_finished", false]], "pulp_repository_pre_publish()": [[1, "pulp_repository_pre_publish", false]], "pulp_repository_published()": [[1, "pulp_repository_published", false]], "quay_images_tagged()": [[1, "quay_images_tagged", false]], "quay_images_untagged()": [[1, "quay_images_untagged", false]], "quay_repositories_cleared()": [[1, "quay_repositories_cleared", false]], "quay_repositories_removed()": [[1, "quay_repositories_removed", false]], "task_context() (in module pubtools.pluggy)": [[1, "pubtools.pluggy.task_context", false]], "task_pulp_flush()": [[1, "task_pulp_flush", false]], "task_start()": [[1, "task_start", false]], "task_stop()": [[1, "task_stop", false]]}, "objects": {"": [[1, 0, 1, "", "get_cert_key_paths"], [1, 0, 1, "", "otel_exporter"], [1, 0, 1, "", "pulp_item_push_finished"], [1, 0, 1, "", "pulp_repository_pre_publish"], [1, 0, 1, "", "pulp_repository_published"], [1, 0, 1, "", "quay_images_tagged"], [1, 0, 1, "", "quay_images_untagged"], [1, 0, 1, "", "quay_repositories_cleared"], [1, 0, 1, "", "quay_repositories_removed"], [1, 0, 1, "", "task_pulp_flush"], [1, 0, 1, "", "task_start"], [1, 0, 1, "", "task_stop"]], "pubtools._impl.tracing.TracingWrapper": [[4, 0, 1, "", "force_flush"], [4, 0, 1, "", "instrument_func"]], "pubtools.pluggy": [[1, 1, 1, "", "hookimpl"], [1, 1, 1, "", "hookspec"], [1, 1, 1, "", "pm"], [1, 0, 1, "", "task_context"]], "pubtools.tracing": [[4, 0, 1, "", "get_trace_wrapper"]]}, "objnames": {"0": ["py", "function", "Python function"], "1": ["py", "attribute", "Python attribute"]}, "objtypes": {"0": "py:function", "1": "py:attribute"}, "terms": {"": [0, 1, 4], "0": 1, "00": 4, "01": 4, "1": 4, "2": [3, 4], "3": [0, 4], "355989206d66228f21ff34634b77ae1a": 4, "9": 0, "97efa33ebed5d06c": 4, "A": [0, 1, 3, 4], "As": [0, 4], "At": 1, "Be": 1, "By": [0, 1], "For": [0, 1, 4], "If": [0, 1], "In": [0, 1, 3, 4], "It": [0, 1, 4], "No": 0, "Of": 0, "The": [0, 1, 4], "There": [0, 1], "These": [0, 3], "To": 2, "__init__": 1, "__name__": 1, "_impl": [1, 4], "_pulp": 0, "abl": [0, 4], "about": 2, "abov": [1, 3], "accept": 0, "access": 3, "accord": 1, "across": [0, 1, 4], "action": 0, "ad": [0, 4], "add": [0, 1, 4], "add_hookspec": 1, "addit": [0, 1], "adjust": [0, 1], "advanc": 1, "advic": 0, "advisori": 3, "after": 1, "again": 1, "aim": 0, "all": [0, 1], "allow": [0, 1], "almost": 0, "along": 4, "alreadi": 0, "also": [1, 3], "although": 0, "alwai": 0, "amount": [0, 1], "an": [0, 1, 4], "analyz": 4, "ani": [0, 1], "ansibl": 0, "answer": [0, 1], "antipattern": 1, "anyon": 1, "anyth": [0, 1], "api": [2, 3], "appear": 4, "applic": 4, "approach": [0, 1], "appropri": 1, "ar": [0, 1, 2, 3, 4], "arbitrari": 0, "arg": 1, "argmax": 0, "argpars": 0, "args_to_attr": 4, "argument": 2, "argv": 0, "aris": 0, "around": 1, "arrang": 0, "artifact": 3, "as_complet": 4, "ask": 0, "assign": 4, "associ": [0, 1, 3], "attach": 1, "attribut": [0, 4], "audienc": 0, "audit": 0, "authent": 1, "avail": [0, 1, 4], "avoid": 1, "await": 0, "awar": 1, "b": 0, "backend": [0, 4], "backward": 0, "bad": 0, "bar": 1, "base": [0, 1], "basic": [0, 1, 4], "basicconfig": 0, "batch": 4, "becaus": [0, 2], "becom": 0, "been": 1, "befor": 1, "behavior": [0, 1], "being": 4, "belong": 1, "below": 0, "best": [0, 1], "better": 1, "between": [0, 1], "block": 1, "boil": 1, "bool": 1, "boolean": 4, "both": 0, "bound": [0, 1], "break": 0, "brief": [0, 2], "brittl": 0, "bug": 0, "build": 3, "bundl": 3, "c": 0, "cach": 1, "call": [0, 1, 4], "callback": 1, "caller": [0, 1, 4], "can": [0, 1, 2, 4], "canon": 1, "care": 1, "carri": 4, "carrier": 4, "case": [0, 1, 4], "caus": [0, 1], "cdn": 1, "cento": 0, "cert": 1, "certain": 0, "certainli": 0, "certif": 1, "chang": 1, "charact": 0, "child": 4, "choos": 4, "circumst": 1, "clash": 1, "class": 1, "clean": 0, "clear": 1, "client": 3, "close": 3, "code": [0, 1, 3], "collect": [0, 3], "collector": 4, "combin": 0, "command": 0, "common": [0, 3], "commonli": [0, 2], "compar": 0, "compat": 0, "complet": [0, 1], "complic": 0, "compris": 2, "concern": 0, "configur": 1, "confus": 0, "connect": 0, "conserv": 3, "consid": [0, 1], "consist": 0, "console_script": 0, "consolespanexport": [1, 4], "consum": 0, "consumpt": 1, "contain": [0, 1, 3], "content": [2, 3], "context": [0, 4], "contextvar": 4, "control": 0, "convent": [1, 2], "correctli": 0, "correspond": 1, "could": 1, "count": 1, "cours": [0, 1], "crash": 1, "creat": [0, 1, 4], "critic": 0, "cross": 4, "cup": 1, "current": [0, 1, 3], "d": 1, "data": [0, 4], "databas": 3, "date": 1, "debug": 4, "declar": 1, "decor": [1, 4], "def": [1, 4], "default": [0, 1, 4], "defin": 0, "depend": [0, 1, 4], "deploi": 0, "deriv": 1, "describ": [0, 2], "design": [0, 3], "desir": 1, "dest_ref": 1, "destin": 1, "develop": [2, 4], "dict": [0, 4], "dictionari": 4, "differ": [0, 1, 4], "digest": 1, "direct": 1, "directli": 0, "directori": 3, "disabl": [1, 4], "discard": 3, "discourag": 0, "discret": 0, "dispatch": 1, "do": [0, 1], "do_task": 1, "doc": 1, "document": [0, 1, 2, 3], "doesn": 0, "don": [0, 1], "done": 1, "down": 1, "downstream": 4, "due": [0, 1], "dure": [0, 1, 3], "e": [0, 1, 3, 4], "each": [0, 1, 3], "earli": 0, "earlier": 0, "effect": [0, 1], "either": 3, "elsewher": 0, "emerg": 0, "emit": 1, "emitt": 1, "empti": [0, 1], "en": 1, "enabl": [1, 3, 4], "encount": 0, "end": [0, 1], "enforc": 1, "enough": 0, "ensur": [0, 1], "enter": 1, "entri": [0, 1], "entry_point": [0, 1], "environ": [0, 3], "errata": 3, "error": 0, "establish": 1, "etc": 1, "even": 0, "event": [0, 1], "everi": 1, "exactli": 1, "exampl": [0, 1, 4], "except": [0, 1], "exclud": 1, "execut": [1, 3], "executor": 4, "exhaust": 0, "exist": 0, "exit": 1, "expect": [0, 1, 4], "explain": [0, 1], "explan": 2, "export": 1, "extend": 1, "extra": 1, "extract": 4, "facad": 3, "fail": [0, 1], "fallback": 1, "fals": 4, "famili": [0, 1, 2, 3], "familiar": 0, "fatal": 0, "featur": [0, 1], "fedora": 0, "few": [0, 1], "field": [0, 1], "file": [0, 3], "fill_wat": 1, "find": [0, 4], "first": 1, "firstli": 2, "flat": 1, "flavor": 0, "flush": [1, 4], "focu": 0, "follow": [0, 1, 2, 4], "foo": [0, 1, 4], "foo_span": 4, "force_flush": 4, "forget": 1, "form": 0, "format": [0, 1], "forward": 0, "friendli": 0, "from": [0, 1, 3, 4], "fulli": 1, "function": [0, 1, 3], "futur": 0, "future_r": 4, "g": [0, 3, 4], "gener": [0, 3], "get": 1, "get_cert_key_path": 1, "get_trace_wrapp": 4, "give": 0, "given": 1, "global": [1, 4], "glue": 3, "gone": 0, "group": 1, "guid": 2, "guidelin": 0, "ha": [0, 1], "hand": 1, "happen": [0, 1], "hat": 0, "have": [0, 1, 4], "health": 0, "help": [0, 3], "helper": 2, "here": [0, 1], "hidden": 0, "hierarchi": 0, "high": 3, "hold": 4, "hood": 4, "hook": [0, 2, 4], "hookimpl": [0, 1], "host": [1, 2, 3], "how": [0, 2], "howev": 0, "http": 1, "huge": 1, "human": 0, "i": [0, 1, 2, 3, 4], "id": 1, "identifi": 0, "ignor": 0, "iib": 3, "imag": [1, 3, 4], "immedi": 1, "implement": [0, 2, 4], "impli": 0, "import": [1, 4], "improv": 0, "inappropri": 1, "includ": [0, 3], "incompat": 0, "indic": [0, 1], "info": 0, "inform": [0, 1], "initi": [1, 4], "input": 4, "insert": 0, "instal": [0, 1], "instanc": [1, 4], "instrument": 1, "instrument_func": 4, "integr": 0, "intend": [0, 1], "interest": [0, 1], "interf": 0, "interfer": 0, "introduc": 0, "invok": [0, 3], "io": 3, "issu": 0, "item": [0, 1, 3], "its": 1, "jaeger": 4, "json": 0, "just": [0, 1], "keep": [0, 1], "kei": [0, 1], "kettl": 1, "kettle_off": 1, "kettle_on": 1, "kettlecount": 1, "kettlespikehandl": 1, "key1": 0, "key2": 0, "kind": 0, "known": [0, 1, 2], "koji": 3, "larg": 0, "last": [0, 1], "later": [0, 3], "launch": 0, "learn": 2, "least": 0, "left": 1, "legaci": 3, "level": [1, 3], "librari": [0, 1, 2, 4], "lifecycl": 1, "lifo": 1, "like": [0, 1], "limit": 0, "line": 0, "list": [0, 1, 2, 3], "load": 0, "local": [0, 3], "locat": 1, "log": 2, "long": 0, "longer": [0, 1], "lose": 0, "lost_ref": 1, "made": 0, "mai": [0, 1, 3], "main_thread": 4, "main_thread_span": 4, "mainli": 1, "maintain": 1, "major": 0, "make": [0, 1], "make_tea": 1, "mani": 4, "manipul": 3, "manual": [0, 4], "match": [0, 1], "max_work": 4, "maximum": 1, "me": 0, "mean": 0, "mechan": 1, "mention": 0, "messag": 0, "metadata": [0, 3], "method": [0, 1], "metric": 0, "might": 0, "mind": 0, "mode": 0, "modul": [0, 1, 4], "monitor": 0, "more": [0, 1, 2, 4], "most": [0, 2], "multipl": [1, 4], "must": [0, 1], "mutat": 1, "myself": 1, "naiv": 1, "name": [1, 4], "namespac": [0, 1, 4], "necessari": [0, 1], "need": [0, 1, 4], "never": 0, "new": 0, "next": 1, "noisi": 0, "non": [0, 1], "none": [1, 4], "normal": [0, 1], "notabl": [0, 3], "note": [0, 1], "noth": 1, "notifi": 1, "now": 1, "number": 0, "o": [0, 4], "object": [0, 1], "off": 1, "ok": 1, "old": 1, "omit": 4, "onc": [0, 1], "one": [0, 1], "onli": [0, 1], "onto": [0, 1], "opentelemetri": [1, 4], "oper": [0, 1, 3], "opinion": 3, "option": [0, 1, 4], "order": [0, 1, 4], "org": 1, "orient": 0, "otel": 1, "otel_export": [1, 4], "otel_service_nam": 4, "otel_trac": 4, "other": 0, "otherwis": [1, 3, 4], "otlpspanexport": 4, "outsid": 3, "overview": 2, "overwrit": 0, "own": 1, "p1": 4, "page": 3, "pair": 0, "paradigm": [0, 3], "param1": 4, "param2": 4, "paramet": [1, 4], "part": [0, 4], "particularli": 0, "pass": [0, 1, 4], "path": [0, 1], "pattern": 1, "pem": 1, "per": 1, "perform": 0, "perhap": 0, "permit": 1, "plain": 1, "pleas": 0, "pluggi": 1, "plugin": 1, "pluginmanag": 1, "pm": 1, "point": [0, 1], "popul": 0, "portion": 0, "possibl": [0, 1], "potenti": [0, 1], "power": [0, 1], "powerbank": 1, "practic": 0, "predict": 0, "prefer": 0, "prefix": 0, "prepar": 1, "previou": 1, "primarili": [0, 3], "principl": 0, "prior": 0, "problem": 0, "proce": 1, "process": [0, 1, 3], "processor": 4, "produc": 0, "product": [0, 4], "programmat": 0, "project": [1, 2, 4], "project_nam": 0, "propag": [1, 4], "provid": [0, 3, 4], "pub": [0, 2], "publish": [0, 1, 2, 3], "publishopt": 1, "pubtool": [0, 1, 3, 4], "pulp": [0, 1, 3], "pulp_item_push_finish": 1, "pulp_repository_pre_publish": 1, "pulp_repository_publish": 1, "pulp_unit": 1, "pulplib": [0, 1, 3], "pure": 1, "purpos": [0, 1], "push": [0, 1, 3], "push_item": 1, "pushcollector": [0, 3], "pushitem": 1, "pushsourc": 3, "put": 0, "py": [0, 1], "python": [0, 2, 4], "pyxi": 3, "quai": [1, 3], "quay_images_tag": 1, "quay_images_untag": 1, "quay_repositories_clear": 1, "quay_repositories_remov": 1, "queue": 0, "rais": 1, "rang": 4, "re": [0, 1], "reach": 0, "reachabl": 1, "read": [0, 2, 3], "realist": 1, "reason": 1, "receiv": 1, "recent": 1, "recommend": 0, "record": 0, "recover": 0, "red": 0, "redirect": 0, "refer": [0, 2], "referenc": 1, "refrain": 0, "regist": 1, "relat": [0, 3], "relev": 0, "reli": 0, "remot": 0, "remov": [0, 1], "replac": 1, "repositori": 1, "repository_id": 1, "requir": 4, "reserv": 1, "resolv": 1, "resort": 0, "resourc": [0, 4], "respons": 0, "result": 1, "retri": 0, "return": [0, 1, 4], "rhel": 0, "right": [0, 1], "root": 0, "rpm": 3, "rule": 0, "run": [0, 1], "running_count": 0, "same": [1, 4], "save": [0, 3], "scenario": [0, 1, 4], "scope": [0, 2], "sdk": 1, "secondli": 2, "secret": 0, "section": [0, 1], "see": [0, 1, 2], "self": [1, 4], "semant": 0, "sensibl": 0, "server_url": 1, "servic": [0, 1, 2, 3, 4], "set": [0, 1, 3], "setup": [1, 2], "setuptool": 0, "sever": 0, "shall": [0, 1], "short": 2, "should": [0, 1, 4], "show": 1, "side": [0, 1], "signatur": [1, 3], "signific": 0, "similar": 4, "simpl": [0, 3], "simpler": 0, "simpli": 0, "simultan": 0, "sinc": 0, "small": [0, 1], "snapshot": 0, "so": [0, 1, 4], "solut": 4, "some": [0, 1, 3], "somehow": 0, "someth": [0, 1], "sometim": 0, "somewhat": 3, "sourc": [1, 3, 4], "source_ref": 1, "span": 4, "span_nam": 4, "spanexport": 1, "specif": 0, "specifi": [0, 1, 4], "spike": 1, "ssl": 1, "stage": 1, "standalon": [1, 3], "standard": [0, 1], "start": [0, 1], "start_boil": 1, "state": 1, "statement": 1, "stderr": 0, "stdout": 0, "step": 1, "still": 0, "str": [1, 4], "strategi": 1, "strictli": 0, "string": [0, 1], "strongli": 0, "style": 0, "sub_thread": 4, "sub_thread_span": 4, "submit": 4, "subscrib": 1, "subset": 1, "subsystem": 0, "succeed": 0, "success": 1, "successfulli": 1, "suggest": 0, "suitabl": 4, "summar": 0, "support": [0, 3], "sy": [0, 1], "system": [0, 1, 3, 4], "t": [0, 1], "tabl": 0, "tag": [0, 1], "take": 1, "task": [1, 2, 4], "task_context": 1, "task_nam": 0, "task_pulp_flush": 1, "task_start": 1, "task_stop": 1, "tear": 1, "telemetri": 4, "tend": 0, "test": 0, "than": 0, "them": [0, 1], "themselv": [0, 1], "therefor": 0, "thi": [0, 1, 3, 4], "thing": 0, "those": 0, "though": 0, "thread": [1, 4], "threadpoolexecutor": 4, "through": 1, "thumb": 0, "ticket": 0, "time": [0, 1], "timestamp": 0, "too": 0, "tool": [0, 2, 3], "top": [0, 1], "trace": [1, 2], "tracepar": 4, "tracingwrapp": 4, "trail": 0, "trigger": 1, "true": [1, 4], "turn": 1, "tv_pickup": 1, "tw": 4, "two": [0, 1, 2], "type": [0, 1], "typic": [0, 1], "ultim": 0, "under": [0, 1, 4], "understand": 2, "uniformli": 1, "uniqu": 4, "unit": 1, "unknown": 0, "unreason": 0, "unregist": 1, "unsur": 1, "untag": 1, "untag_ref": 1, "up": [0, 1], "updat": [0, 1], "upload": 1, "upstream": 4, "upward": 1, "url": [0, 1], "us": [1, 3, 4], "usag": [0, 1], "user": 0, "usual": 0, "v": 3, "val1": 0, "val2": 0, "val3": 0, "valid": 0, "valu": [1, 4], "valuabl": 0, "value1": 0, "value2": 0, "variabl": 0, "varieti": 3, "variou": 0, "verbos": 0, "veri": [0, 3], "version": 0, "via": [1, 3], "visual": 4, "wa": 1, "wai": [0, 2], "wait": 0, "wait_boil": 1, "waiting_count": 0, "want": [0, 1], "warn": 0, "we": [0, 1, 3], "well": 3, "were": 1, "what": 0, "when": [0, 1, 3], "whenev": 0, "where": [0, 1], "whether": 1, "which": [0, 1, 2, 4], "while": [0, 4], "wiki": 1, "wikipedia": 1, "wish": 0, "within": [0, 1, 2, 3, 4], "without": [0, 1], "won": 1, "work": [0, 1], "workaround": 0, "workflow": 2, "would": 0, "wrapper": 4, "write": 0, "wrong": 0, "x": [0, 3], "you": [0, 1, 3, 4], "your": 1, "yourself": 0, "zero": [0, 1]}, "titles": ["Developer Guide", "Hooks", "pubtools", "Project Overview", "Tracing"], "titleterms": {"1": 1, "2": 1, "after": 0, "api": [1, 4], "appropri": 0, "argument": 0, "avoid": 0, "chang": 0, "configur": 0, "content": [0, 1, 4], "context": 1, "convent": 0, "debug": 0, "defin": 1, "develop": 0, "enabl": 0, "environ": 4, "execut": 0, "export": 4, "extra": 0, "function": 4, "guid": [0, 1], "helper": 3, "hook": 1, "hookspec": 1, "host": 0, "implement": 1, "input": 0, "instrument": 4, "interfac": 0, "introduct": 2, "invok": 1, "level": 0, "librari": 3, "log": 0, "logger": 0, "manag": 1, "mechan": 0, "multipl": 0, "name": 0, "obtain": 0, "otel": 4, "output": 0, "overview": [1, 3, 4], "platform": 0, "primari": 0, "project": [0, 3], "provid": 1, "pubtool": 2, "pushsourc": 0, "refer": [1, 4], "set": 4, "setup": 0, "skip": 0, "sourc": 0, "standalon": 0, "step": 0, "structur": 0, "subset": 0, "target": 0, "task": [0, 3], "trace": 4, "understand": 0, "us": 0, "usag": 4, "v": 0, "valu": 0, "variabl": 4, "via": 0, "your": 0}})
\ No newline at end of file
+Search.setIndex({"alltitles": {"--debug: enable debug logging": [[0, "debug-enable-debug-logging"]], "--skip, --step: execute subset of task": [[0, "skip-step-execute-subset-of-task"]], "--source: obtain content via pushsource": [[0, "source-obtain-content-via-pushsource"]], "1. Define hookspecs": [[1, "define-hookspecs"]], "2. Invoke hooks": [[1, "invoke-hooks"]], "API reference": [[1, "api-reference"], [4, "api-reference"]], "Argument conventions": [[0, "argument-conventions"]], "Arguments with multiple values": [[0, "arguments-with-multiple-values"]], "Avoid changing logger configuration": [[0, "avoid-changing-logger-configuration"]], "Contents": [[1, "contents"], [4, "contents"]], "Developer Guide": [[0, null]], "Guide: hook implementers": [[1, "guide-hook-implementers"]], "Guide: hook providers": [[1, "guide-hook-providers"]], "Guide: managing context": [[1, "guide-managing-context"]], "Helper libraries": [[3, "helper-libraries"]], "Hook reference": [[1, "hook-reference"]], "Hooks": [[1, null]], "Inputs": [[0, "inputs"]], "Instrument tracing for functions": [[4, "instrument-tracing-for-functions"]], "Introduction": [[2, "introduction"]], "Logging": [[0, "logging"]], "Name loggers after your project": [[0, "name-loggers-after-your-project"]], "Naming": [[0, "naming"]], "OTEL Exporter": [[4, "otel-exporter"]], "Outputs": [[0, "outputs"]], "Overview": [[1, "overview"], [4, "overview"]], "Project Overview": [[3, null]], "Project setup": [[0, "project-setup"]], "Set environment variables": [[4, "set-environment-variables"]], "Standalone vs Hosted": [[0, "standalone-vs-hosted"]], "Structured logging via extra": [[0, "structured-logging-via-extra"]], "Target platforms": [[0, "target-platforms"]], "Task interface": [[0, "task-interface"]], "Task libraries": [[3, "task-libraries"]], "Tracing": [[4, null]], "Understanding tasks": [[0, "understanding-tasks"]], "Usage": [[4, "usage"]], "Use appropriate log levels": [[0, "use-appropriate-log-levels"]], "Use loggers as primary output mechanism": [[0, "use-loggers-as-primary-output-mechanism"]], "pubtools": [[2, null]]}, "docnames": ["devguide", "hooks", "index", "projects", "tracing"], "envversion": {"sphinx": 63, "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, "sphinx.ext.viewcode": 1}, "filenames": ["devguide.rst", "hooks.rst", "index.rst", "projects.rst", "tracing.rst"], "indexentries": {"built-in function": [[1, "get_cert_key_paths", false], [1, "otel_exporter", false], [1, "pulp_item_push_finished", false], [1, "pulp_repository_pre_publish", false], [1, "pulp_repository_published", false], [1, "quay_images_tagged", false], [1, "quay_images_untagged", false], [1, "quay_repositories_cleared", false], [1, "quay_repositories_removed", false], [1, "task_pulp_flush", false], [1, "task_start", false], [1, "task_stop", false]], "force_flush() (in module pubtools._impl.tracing.tracingwrapper)": [[4, "pubtools._impl.tracing.TracingWrapper.force_flush", false]], "get_cert_key_paths()": [[1, "get_cert_key_paths", false]], "get_trace_wrapper() (in module pubtools.tracing)": [[4, "pubtools.tracing.get_trace_wrapper", false]], "hookimpl (pubtools.pluggy attribute)": [[1, "pubtools.pluggy.hookimpl", false]], "hookspec (pubtools.pluggy attribute)": [[1, "pubtools.pluggy.hookspec", false]], "instrument_func() (in module pubtools._impl.tracing.tracingwrapper)": [[4, "pubtools._impl.tracing.TracingWrapper.instrument_func", false]], "otel_exporter()": [[1, "otel_exporter", false]], "pm (pubtools.pluggy attribute)": [[1, "pubtools.pluggy.pm", false]], "pulp_item_push_finished()": [[1, "pulp_item_push_finished", false]], "pulp_repository_pre_publish()": [[1, "pulp_repository_pre_publish", false]], "pulp_repository_published()": [[1, "pulp_repository_published", false]], "quay_images_tagged()": [[1, "quay_images_tagged", false]], "quay_images_untagged()": [[1, "quay_images_untagged", false]], "quay_repositories_cleared()": [[1, "quay_repositories_cleared", false]], "quay_repositories_removed()": [[1, "quay_repositories_removed", false]], "task_context() (in module pubtools.pluggy)": [[1, "pubtools.pluggy.task_context", false]], "task_pulp_flush()": [[1, "task_pulp_flush", false]], "task_start()": [[1, "task_start", false]], "task_stop()": [[1, "task_stop", false]]}, "objects": {"": [[1, 0, 1, "", "get_cert_key_paths"], [1, 0, 1, "", "otel_exporter"], [1, 0, 1, "", "pulp_item_push_finished"], [1, 0, 1, "", "pulp_repository_pre_publish"], [1, 0, 1, "", "pulp_repository_published"], [1, 0, 1, "", "quay_images_tagged"], [1, 0, 1, "", "quay_images_untagged"], [1, 0, 1, "", "quay_repositories_cleared"], [1, 0, 1, "", "quay_repositories_removed"], [1, 0, 1, "", "task_pulp_flush"], [1, 0, 1, "", "task_start"], [1, 0, 1, "", "task_stop"]], "pubtools._impl.tracing.TracingWrapper": [[4, 0, 1, "", "force_flush"], [4, 0, 1, "", "instrument_func"]], "pubtools.pluggy": [[1, 1, 1, "", "hookimpl"], [1, 1, 1, "", "hookspec"], [1, 1, 1, "", "pm"], [1, 0, 1, "", "task_context"]], "pubtools.tracing": [[4, 0, 1, "", "get_trace_wrapper"]]}, "objnames": {"0": ["py", "function", "Python function"], "1": ["py", "attribute", "Python attribute"]}, "objtypes": {"0": "py:function", "1": "py:attribute"}, "terms": {"": [0, 1, 4], "0": 1, "00": 4, "01": 4, "1": 4, "2": [3, 4], "3": [0, 4], "355989206d66228f21ff34634b77ae1a": 4, "9": 0, "97efa33ebed5d06c": 4, "A": [0, 1, 3, 4], "As": [0, 4], "At": 1, "Be": 1, "By": [0, 1], "For": [0, 1, 4], "If": [0, 1], "In": [0, 1, 3, 4], "It": [0, 1, 4], "No": 0, "Of": 0, "The": [0, 1, 4], "There": [0, 1], "These": [0, 3], "To": 2, "__init__": 1, "__name__": 1, "_impl": [1, 4], "_pulp": 0, "abl": [0, 4], "about": 2, "abov": [1, 3], "accept": 0, "access": 3, "accord": 1, "across": [0, 1, 4], "action": 0, "ad": [0, 4], "add": [0, 1, 4], "add_hookspec": 1, "addit": [0, 1], "adjust": [0, 1], "advanc": 1, "advic": 0, "advisori": 3, "after": 1, "again": 1, "aim": 0, "all": [0, 1], "allow": [0, 1], "almost": 0, "along": 4, "alreadi": 0, "also": [1, 3], "although": 0, "alwai": 0, "amount": [0, 1], "an": [0, 1, 4], "analyz": 4, "ani": [0, 1], "ansibl": 0, "answer": [0, 1], "antipattern": 1, "anyon": 1, "anyth": [0, 1], "api": [2, 3], "appear": 4, "applic": 4, "approach": [0, 1], "appropri": 1, "ar": [0, 1, 2, 3, 4], "arbitrari": 0, "arg": 1, "argmax": 0, "argpars": 0, "args_to_attr": 4, "argument": 2, "argv": 0, "aris": 0, "around": 1, "arrang": 0, "artifact": 3, "as_complet": 4, "ask": 0, "assign": 4, "associ": [0, 1, 3], "attach": 1, "attribut": [0, 4], "audienc": 0, "audit": 0, "authent": 1, "avail": [0, 1, 4], "avoid": 1, "await": 0, "awar": 1, "b": 0, "backend": [0, 4], "backward": 0, "bad": 0, "bar": 1, "base": [0, 1], "basic": [0, 1, 4], "basicconfig": 0, "batch": 4, "becaus": [0, 2], "becom": 0, "been": 1, "befor": 1, "behavior": [0, 1], "being": 4, "belong": 1, "below": 0, "best": [0, 1], "better": 1, "between": [0, 1], "block": 1, "boil": 1, "bool": 1, "boolean": 4, "both": 0, "bound": [0, 1], "break": 0, "brief": [0, 2], "brittl": 0, "bug": 0, "build": 3, "bundl": 3, "c": 0, "cach": 1, "call": [0, 1, 4], "callback": 1, "caller": [0, 1, 4], "can": [0, 1, 2, 4], "canon": 1, "care": 1, "carri": 4, "carrier": 4, "case": [0, 1, 4], "caus": [0, 1], "cdn": 1, "cento": 0, "cert": 1, "certain": 0, "certainli": 0, "certif": 1, "chang": 1, "charact": 0, "child": 4, "choos": 4, "circumst": 1, "clash": 1, "class": 1, "clean": 0, "clear": 1, "client": 3, "close": 3, "code": [0, 1, 3], "collect": [0, 3], "collector": 4, "combin": 0, "command": 0, "common": [0, 3], "commonli": [0, 2], "compar": 0, "compat": 0, "complet": [0, 1], "complic": 0, "compris": 2, "concern": 0, "configur": 1, "confus": 0, "connect": 0, "conserv": 3, "consid": [0, 1], "consist": 0, "console_script": 0, "consolespanexport": [1, 4], "consum": 0, "consumpt": 1, "contain": [0, 1, 3], "content": [2, 3], "context": [0, 4], "contextvar": 4, "control": 0, "convent": [1, 2], "correctli": 0, "correspond": 1, "could": 1, "count": 1, "cours": [0, 1], "crash": 1, "creat": [0, 1, 4], "critic": 0, "cross": 4, "cup": 1, "current": [0, 1, 3], "d": 1, "data": [0, 4], "databas": 3, "date": 1, "debug": 4, "declar": 1, "decor": [1, 4], "def": [1, 4], "default": [0, 1, 4], "defin": 0, "depend": [0, 1, 4], "deploi": 0, "deriv": 1, "describ": [0, 2], "design": [0, 3], "desir": 1, "dest_ref": 1, "destin": 1, "develop": [2, 4], "dict": [0, 4], "dictionari": 4, "differ": [0, 1, 4], "digest": 1, "direct": 1, "directli": 0, "directori": 3, "disabl": [1, 4], "discard": 3, "discourag": 0, "discret": 0, "dispatch": 1, "do": [0, 1], "do_task": 1, "doc": 1, "document": [0, 1, 2, 3], "doesn": 0, "don": [0, 1], "done": 1, "down": 1, "downstream": 4, "due": [0, 1], "dure": [0, 1, 3], "e": [0, 1, 3, 4], "each": [0, 1, 3], "earli": 0, "earlier": 0, "effect": [0, 1], "either": 3, "elsewher": 0, "emerg": 0, "emit": 1, "emitt": 1, "empti": [0, 1], "en": 1, "enabl": [1, 3, 4], "encount": 0, "end": [0, 1], "enforc": 1, "enough": 0, "ensur": [0, 1], "enter": 1, "entri": [0, 1], "entry_point": [0, 1], "environ": [0, 3], "errata": 3, "error": 0, "establish": 1, "etc": 1, "even": 0, "event": [0, 1], "everi": 1, "exactli": 1, "exampl": [0, 1, 4], "except": [0, 1], "exclud": 1, "execut": [1, 3], "executor": 4, "exhaust": 0, "exist": 0, "exit": 1, "expect": [0, 1, 4], "explain": [0, 1], "explan": 2, "export": 1, "extend": 1, "extra": 1, "extract": 4, "facad": 3, "fail": [0, 1], "fallback": 1, "fals": 4, "famili": [0, 1, 2, 3], "familiar": 0, "fatal": 0, "featur": [0, 1], "fedora": 0, "few": [0, 1], "field": [0, 1], "file": [0, 3], "fill_wat": 1, "find": [0, 4], "first": 1, "firstli": 2, "flat": 1, "flavor": 0, "flush": [1, 4], "focu": 0, "follow": [0, 1, 2, 4], "foo": [0, 1, 4], "foo_span": 4, "force_flush": 4, "forget": 1, "form": 0, "format": [0, 1], "forward": 0, "friendli": 0, "from": [0, 1, 3, 4], "fulli": 1, "function": [0, 1, 3], "futur": 0, "future_r": 4, "g": [0, 3, 4], "gener": [0, 3], "get": 1, "get_cert_key_path": 1, "get_trace_wrapp": 4, "give": 0, "given": 1, "global": [1, 4], "glue": 3, "gone": 0, "group": 1, "guid": 2, "guidelin": 0, "ha": [0, 1], "hand": 1, "happen": [0, 1], "hat": 0, "have": [0, 1, 4], "health": 0, "help": [0, 3], "helper": 2, "here": [0, 1], "hidden": 0, "hierarchi": 0, "high": 3, "hold": 4, "hood": 4, "hook": [0, 2, 4], "hookimpl": [0, 1], "host": [1, 2, 3], "how": [0, 2], "howev": 0, "http": 1, "huge": 1, "human": 0, "i": [0, 1, 2, 3, 4], "id": 1, "identifi": 0, "ignor": 0, "iib": 3, "imag": [1, 3, 4], "immedi": 1, "implement": [0, 2, 4], "impli": 0, "import": [1, 4], "improv": 0, "inappropri": 1, "includ": [0, 3], "incompat": 0, "indic": [0, 1], "info": 0, "inform": [0, 1], "initi": [1, 4], "input": 4, "insert": 0, "instal": [0, 1], "instanc": [1, 4], "instrument": 1, "instrument_func": 4, "integr": 0, "intend": [0, 1], "interest": [0, 1], "interf": 0, "interfer": 0, "introduc": 0, "invok": [0, 3], "io": 3, "issu": 0, "item": [0, 1, 3], "its": 1, "jaeger": 4, "json": 0, "just": [0, 1], "keep": [0, 1], "kei": [0, 1], "kettl": 1, "kettle_off": 1, "kettle_on": 1, "kettlecount": 1, "kettlespikehandl": 1, "key1": 0, "key2": 0, "kind": 0, "known": [0, 1, 2], "koji": 3, "larg": 0, "last": [0, 1], "later": [0, 3], "launch": 0, "learn": 2, "least": 0, "left": 1, "legaci": 3, "level": [1, 3], "librari": [0, 1, 2, 4], "lifecycl": 1, "lifo": 1, "like": [0, 1], "limit": 0, "line": 0, "list": [0, 1, 2, 3], "load": 0, "local": [0, 3], "locat": 1, "log": 2, "long": 0, "longer": [0, 1], "lose": 0, "lost_ref": 1, "made": 0, "mai": [0, 1, 3], "main_thread": 4, "main_thread_span": 4, "mainli": 1, "maintain": 1, "major": 0, "make": [0, 1], "make_tea": 1, "mani": 4, "manipul": 3, "manual": [0, 4], "match": [0, 1], "max_work": 4, "maximum": 1, "me": 0, "mean": 0, "mechan": 1, "mention": 0, "messag": 0, "metadata": [0, 3], "method": [0, 1], "metric": 0, "might": 0, "mind": 0, "mode": 0, "modul": [0, 1, 4], "monitor": 0, "more": [0, 1, 2, 4], "most": [0, 2], "multipl": [1, 4], "must": [0, 1], "mutat": 1, "myself": 1, "naiv": 1, "name": [1, 4], "namespac": [0, 1, 4], "necessari": [0, 1], "need": [0, 1, 4], "never": 0, "new": 0, "next": 1, "noisi": 0, "non": [0, 1], "none": [1, 4], "normal": [0, 1], "notabl": [0, 3], "note": [0, 1], "noth": 1, "notifi": 1, "now": 1, "number": 0, "o": [0, 4], "object": [0, 1], "off": 1, "ok": 1, "old": 1, "omit": 4, "onc": [0, 1], "one": [0, 1], "onli": [0, 1], "onto": [0, 1], "opentelemetri": [1, 4], "oper": [0, 1, 3], "opinion": 3, "option": [0, 1, 4], "order": [0, 1, 4], "org": 1, "orient": 0, "otel": 1, "otel_export": [1, 4], "otel_service_nam": 4, "otel_trac": 4, "other": 0, "otherwis": [1, 3, 4], "otlpspanexport": 4, "outsid": 3, "overview": 2, "overwrit": 0, "own": 1, "p1": 4, "page": 3, "pair": 0, "paradigm": [0, 3], "param1": 4, "param2": 4, "paramet": [1, 4], "part": [0, 4], "particularli": 0, "pass": [0, 1, 4], "path": [0, 1], "pattern": 1, "pem": 1, "per": 1, "perform": 0, "perhap": 0, "permit": 1, "plain": 1, "pleas": 0, "pluggi": 1, "plugin": 1, "pluginmanag": 1, "pm": 1, "point": [0, 1], "popul": 0, "portion": 0, "possibl": [0, 1], "potenti": [0, 1], "power": [0, 1], "powerbank": 1, "practic": 0, "predict": 0, "prefer": 0, "prefix": 0, "prepar": 1, "previou": 1, "primarili": [0, 3], "principl": 0, "prior": 0, "problem": 0, "proce": 1, "process": [0, 1, 3], "processor": 4, "produc": 0, "product": [0, 4], "programmat": 0, "project": [1, 2, 4], "project_nam": 0, "propag": [1, 4], "provid": [0, 3, 4], "pub": [0, 2], "publish": [0, 1, 2, 3], "publishopt": 1, "pubtool": [0, 1, 3, 4], "pulp": [0, 1, 3], "pulp_item_push_finish": 1, "pulp_repository_pre_publish": 1, "pulp_repository_publish": 1, "pulp_unit": 1, "pulplib": [0, 1, 3], "pure": 1, "purpos": [0, 1], "push": [0, 1, 3], "push_item": 1, "pushcollector": [0, 3], "pushitem": 1, "pushsourc": 3, "put": 0, "py": [0, 1], "python": [0, 2, 4], "pyxi": 3, "quai": [1, 3], "quay_images_tag": 1, "quay_images_untag": 1, "quay_repositories_clear": 1, "quay_repositories_remov": 1, "queue": 0, "rais": 1, "rang": 4, "re": [0, 1], "reach": 0, "reachabl": 1, "read": [0, 2, 3], "realist": 1, "reason": 1, "receiv": 1, "recent": 1, "recommend": 0, "record": 0, "recover": 0, "red": 0, "redirect": 0, "refer": [0, 2], "referenc": 1, "refrain": 0, "regist": 1, "relat": [0, 3], "relev": 0, "reli": 0, "remot": 0, "remov": [0, 1], "replac": 1, "repositori": 1, "repository_id": 1, "requir": 4, "reserv": 1, "resolv": 1, "resort": 0, "resourc": [0, 4], "respons": 0, "result": 1, "retri": 0, "return": [0, 1, 4], "rhel": 0, "right": [0, 1], "root": 0, "rpm": 3, "rule": 0, "run": [0, 1], "running_count": 0, "same": [1, 4], "save": [0, 3], "scenario": [0, 1, 4], "scope": [0, 2], "sdk": 1, "secondli": 2, "secret": 0, "section": [0, 1], "see": [0, 1, 2], "self": [1, 4], "semant": 0, "sensibl": 0, "server_url": 1, "servic": [0, 1, 2, 3, 4], "set": [0, 1, 3], "setup": [1, 2], "setuptool": 0, "sever": 0, "shall": [0, 1], "short": 2, "should": [0, 1, 4], "show": 1, "side": [0, 1], "signatur": [1, 3], "signific": 0, "similar": 4, "simpl": [0, 3], "simpler": 0, "simpli": 0, "simultan": 0, "sinc": 0, "small": [0, 1], "snapshot": 0, "so": [0, 1, 4], "solut": 4, "some": [0, 1, 3], "somehow": 0, "someth": [0, 1], "sometim": 0, "somewhat": 3, "sourc": [1, 3, 4], "source_ref": 1, "span": 4, "span_nam": 4, "spanexport": 1, "specif": 0, "specifi": [0, 1, 4], "spike": 1, "ssl": 1, "stage": 1, "standalon": [1, 3], "standard": [0, 1], "start": [0, 1], "start_boil": 1, "state": 1, "statement": 1, "stderr": 0, "stdout": 0, "step": 1, "still": 0, "str": [1, 4], "strategi": 1, "strictli": 0, "string": [0, 1], "strongli": 0, "style": 0, "sub_thread": 4, "sub_thread_span": 4, "submit": 4, "subscrib": 1, "subset": 1, "subsystem": 0, "succeed": 0, "success": 1, "successfulli": 1, "suggest": 0, "suitabl": 4, "summar": 0, "support": [0, 3], "sy": [0, 1], "system": [0, 1, 3, 4], "t": [0, 1], "tabl": 0, "tag": [0, 1], "take": 1, "task": [1, 2, 4], "task_context": 1, "task_nam": 0, "task_pulp_flush": 1, "task_start": 1, "task_stop": 1, "tear": 1, "telemetri": 4, "tend": 0, "test": 0, "than": 0, "them": [0, 1], "themselv": [0, 1], "therefor": 0, "thi": [0, 1, 3, 4], "thing": 0, "those": 0, "though": 0, "thread": [1, 4], "threadpoolexecutor": 4, "through": 1, "thumb": 0, "ticket": 0, "time": [0, 1], "timestamp": 0, "too": 0, "tool": [0, 2, 3], "top": [0, 1], "trace": [1, 2], "tracepar": 4, "tracingwrapp": 4, "trail": 0, "trigger": 1, "true": [1, 4], "turn": 1, "tv_pickup": 1, "tw": 4, "two": [0, 1, 2], "type": [0, 1], "typic": [0, 1], "ultim": 0, "under": [0, 1, 4], "understand": 2, "uniformli": 1, "uniqu": 4, "unit": 1, "unknown": 0, "unreason": 0, "unregist": 1, "unsur": 1, "untag": 1, "untag_ref": 1, "up": [0, 1], "updat": [0, 1], "upload": 1, "upstream": 4, "upward": 1, "url": [0, 1], "us": [1, 3, 4], "usag": [0, 1], "user": 0, "usual": 0, "v": 3, "val1": 0, "val2": 0, "val3": 0, "valid": 0, "valu": [1, 4], "valuabl": 0, "value1": 0, "value2": 0, "variabl": 0, "varieti": 3, "variou": 0, "verbos": 0, "veri": [0, 3], "version": 0, "via": [1, 3], "visual": 4, "wa": 1, "wai": [0, 2], "wait": 0, "wait_boil": 1, "waiting_count": 0, "want": [0, 1], "warn": 0, "we": [0, 1, 3], "well": 3, "were": 1, "what": 0, "when": [0, 1, 3], "whenev": 0, "where": [0, 1], "whether": 1, "which": [0, 1, 2, 4], "while": [0, 4], "wiki": 1, "wikipedia": 1, "wish": 0, "within": [0, 1, 2, 3, 4], "without": [0, 1], "won": 1, "work": [0, 1], "workaround": 0, "workflow": 2, "would": 0, "wrapper": 4, "write": 0, "wrong": 0, "x": [0, 3], "you": [0, 1, 3, 4], "your": 1, "yourself": 0, "zero": [0, 1]}, "titles": ["Developer Guide", "Hooks", "pubtools", "Project Overview", "Tracing"], "titleterms": {"1": 1, "2": 1, "after": 0, "api": [1, 4], "appropri": 0, "argument": 0, "avoid": 0, "chang": 0, "configur": 0, "content": [0, 1, 4], "context": 1, "convent": 0, "debug": 0, "defin": 1, "develop": 0, "enabl": 0, "environ": 4, "execut": 0, "export": 4, "extra": 0, "function": 4, "guid": [0, 1], "helper": 3, "hook": 1, "hookspec": 1, "host": 0, "implement": 1, "input": 0, "instrument": 4, "interfac": 0, "introduct": 2, "invok": 1, "level": 0, "librari": 3, "log": 0, "logger": 0, "manag": 1, "mechan": 0, "multipl": 0, "name": 0, "obtain": 0, "otel": 4, "output": 0, "overview": [1, 3, 4], "platform": 0, "primari": 0, "project": [0, 3], "provid": 1, "pubtool": 2, "pushsourc": 0, "refer": [1, 4], "set": 4, "setup": 0, "skip": 0, "sourc": 0, "standalon": 0, "step": 0, "structur": 0, "subset": 0, "target": 0, "task": [0, 3], "trace": 4, "understand": 0, "us": 0, "usag": 4, "v": 0, "valu": 0, "variabl": 4, "via": 0, "your": 0}})
\ No newline at end of file
diff --git a/tracing.html b/tracing.html
index e5102b5..fce5d65 100644
--- a/tracing.html
+++ b/tracing.html
@@ -7,7 +7,8 @@
API reference
+
+
pubtools
@@ -270,8 +271,8 @@Quick search
©2021, Red Hat. | - Powered by Sphinx 7.3.7 - & Alabaster 0.7.16 + Powered by Sphinx 8.0.2 + & Alabaster 1.0.0 | Quick search -
+