0.7.0 snapshot API docs

pedestal · Feb 23, 2024 · b3cc02b · b3cc02b
1 parent 898d540
commit b3cc02b
Show file tree

Hide file tree

Showing 53 changed files with 307 additions and 233 deletions.
diff --git a/api/0.7/index.html b/api/0.7/index.html
diff --git a/api/0.7/io.pedestal.environment.html b/api/0.7/io.pedestal.environment.html
diff --git a/api/0.7/io.pedestal.http.aws.lambda.html b/api/0.7/io.pedestal.http.aws.lambda.html
diff --git a/api/0.7/io.pedestal.http.aws.lambda.utils.html b/api/0.7/io.pedestal.http.aws.lambda.utils.html
diff --git a/api/0.7/io.pedestal.http.body-params.html b/api/0.7/io.pedestal.http.body-params.html
diff --git a/api/0.7/io.pedestal.http.container.html b/api/0.7/io.pedestal.http.container.html
diff --git a/api/0.7/io.pedestal.http.content-negotiation.html b/api/0.7/io.pedestal.http.content-negotiation.html
diff --git a/api/0.7/io.pedestal.http.cors.html b/api/0.7/io.pedestal.http.cors.html
diff --git a/api/0.7/io.pedestal.http.csrf.html b/api/0.7/io.pedestal.http.csrf.html
diff --git a/api/0.7/io.pedestal.http.html b/api/0.7/io.pedestal.http.html
diff --git a/api/0.7/io.pedestal.http.impl.servlet-interceptor.html b/api/0.7/io.pedestal.http.impl.servlet-interceptor.html
diff --git a/api/0.7/io.pedestal.http.jetty.container.html b/api/0.7/io.pedestal.http.jetty.container.html
diff --git a/api/0.7/io.pedestal.http.jetty.html b/api/0.7/io.pedestal.http.jetty.html
diff --git a/api/0.7/io.pedestal.http.jetty.util.html b/api/0.7/io.pedestal.http.jetty.util.html
diff --git a/api/0.7/io.pedestal.http.params.html b/api/0.7/io.pedestal.http.params.html
diff --git a/api/0.7/io.pedestal.http.request.html b/api/0.7/io.pedestal.http.request.html
diff --git a/api/0.7/io.pedestal.http.request.lazy.html b/api/0.7/io.pedestal.http.request.lazy.html
diff --git a/api/0.7/io.pedestal.http.request.map.html b/api/0.7/io.pedestal.http.request.map.html
diff --git a/api/0.7/io.pedestal.http.request.servlet-support.html b/api/0.7/io.pedestal.http.request.servlet-support.html
diff --git a/api/0.7/io.pedestal.http.request.zerocopy.html b/api/0.7/io.pedestal.http.request.zerocopy.html
diff --git a/api/0.7/io.pedestal.http.ring-middlewares.html b/api/0.7/io.pedestal.http.ring-middlewares.html
diff --git a/api/0.7/io.pedestal.http.route.definition.html b/api/0.7/io.pedestal.http.route.definition.html
diff --git a/api/0.7/io.pedestal.http.route.definition.table.html b/api/0.7/io.pedestal.http.route.definition.table.html
diff --git a/api/0.7/io.pedestal.http.route.definition.terse.html b/api/0.7/io.pedestal.http.route.definition.terse.html
diff --git a/api/0.7/io.pedestal.http.route.definition.verbose.html b/api/0.7/io.pedestal.http.route.definition.verbose.html
diff --git a/api/0.7/io.pedestal.http.route.html b/api/0.7/io.pedestal.http.route.html
diff --git a/api/0.7/io.pedestal.http.route.linear-search.html b/api/0.7/io.pedestal.http.route.linear-search.html
diff --git a/api/0.7/io.pedestal.http.route.map-tree.html b/api/0.7/io.pedestal.http.route.map-tree.html
diff --git a/api/0.7/io.pedestal.http.route.path.html b/api/0.7/io.pedestal.http.route.path.html
diff --git a/api/0.7/io.pedestal.http.route.prefix-tree.html b/api/0.7/io.pedestal.http.route.prefix-tree.html
diff --git a/api/0.7/io.pedestal.http.route.router.html b/api/0.7/io.pedestal.http.route.router.html
diff --git a/api/0.7/io.pedestal.http.secure-headers.html b/api/0.7/io.pedestal.http.secure-headers.html
diff --git a/api/0.7/io.pedestal.http.servlet.html b/api/0.7/io.pedestal.http.servlet.html
diff --git a/api/0.7/io.pedestal.http.sse.html b/api/0.7/io.pedestal.http.sse.html
diff --git a/api/0.7/io.pedestal.http.tracing.html b/api/0.7/io.pedestal.http.tracing.html
@@ -0,0 +1,6 @@
+<!DOCTYPE html PUBLIC ""
+    "">
+<html><head><meta charset="UTF-8" /><title>io.pedestal.http.tracing documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">io.pedestal libraries</span> <span class="project-version">0.7.0-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>io</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>pedestal</span></div></div></li><li class="depth-3 branch"><a href="io.pedestal.environment.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>environment</span></div></a></li><li class="depth-3"><a href="io.pedestal.http.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>http</span></div></a></li><li class="depth-4"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>aws</span></div></div></li><li class="depth-5"><a href="io.pedestal.http.aws.lambda.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>lambda</span></div></a></li><li class="depth-6"><a href="io.pedestal.http.aws.lambda.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li><li class="depth-4 branch"><a href="io.pedestal.http.body-params.html"><div class="inner"><span class="tree" style="top: -83px;"><span class="top" style="height: 92px;"></span><span class="bottom"></span></span><span>body-params</span></div></a></li><li class="depth-4 branch"><a href="io.pedestal.http.container.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>container</span></div></a></li><li class="depth-4 branch"><a href="io.pedestal.http.content-negotiation.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>content-negotiation</span></div></a></li><li class="depth-4 branch"><a href="io.pedestal.http.cors.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>cors</span></div></a></li><li class="depth-4 branch"><a href="io.pedestal.http.csrf.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>csrf</span></div></a></li><li class="depth-4"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>impl</span></div></div></li><li class="depth-5"><a href="io.pedestal.http.impl.servlet-interceptor.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>servlet-interceptor</span></div></a></li><li class="depth-4"><a href="io.pedestal.http.jetty.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>jetty</span></div></a></li><li class="depth-5 branch"><a href="io.pedestal.http.jetty.container.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>container</span></div></a></li><li class="depth-5"><a href="io.pedestal.http.jetty.util.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>util</span></div></a></li><li class="depth-4 branch"><a href="io.pedestal.http.params.html"><div class="inner"><span class="tree" style="top: -83px;"><span class="top" style="height: 92px;"></span><span class="bottom"></span></span><span>params</span></div></a></li><li class="depth-4"><a href="io.pedestal.http.request.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>request</span></div></a></li><li class="depth-5 branch"><a href="io.pedestal.http.request.lazy.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>lazy</span></div></a></li><li class="depth-5 branch"><a href="io.pedestal.http.request.map.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>map</span></div></a></li><li class="depth-5 branch"><a href="io.pedestal.http.request.servlet-support.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>servlet-support</span></div></a></li><li class="depth-5"><a href="io.pedestal.http.request.zerocopy.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>zerocopy</span></div></a></li><li class="depth-4 branch"><a href="io.pedestal.http.ring-middlewares.html"><div class="inner"><span class="tree" style="top: -145px;"><span class="top" style="height: 154px;"></span><span class="bottom"></span></span><span>ring-middlewares</span></div></a></li><li class="depth-4"><a href="io.pedestal.http.route.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>route</span></div></a></li><li class="depth-5"><a href="io.pedestal.http.route.definition.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>definition</span></div></a></li><li class="depth-6 branch"><a href="io.pedestal.http.route.definition.table.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>table</span></div></a></li><li class="depth-6 branch"><a href="io.pedestal.http.route.definition.terse.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>terse</span></div></a></li><li class="depth-6"><a href="io.pedestal.http.route.definition.verbose.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>verbose</span></div></a></li><li class="depth-5 branch"><a href="io.pedestal.http.route.linear-search.html"><div class="inner"><span class="tree" style="top: -114px;"><span class="top" style="height: 123px;"></span><span class="bottom"></span></span><span>linear-search</span></div></a></li><li class="depth-5 branch"><a href="io.pedestal.http.route.map-tree.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>map-tree</span></div></a></li><li class="depth-5 branch"><a href="io.pedestal.http.route.path.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>path</span></div></a></li><li class="depth-5 branch"><a href="io.pedestal.http.route.prefix-tree.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>prefix-tree</span></div></a></li><li class="depth-5"><a href="io.pedestal.http.route.router.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>router</span></div></a></li><li class="depth-4 branch"><a href="io.pedestal.http.secure-headers.html"><div class="inner"><span class="tree" style="top: -300px;"><span class="top" style="height: 309px;"></span><span class="bottom"></span></span><span>secure-headers</span></div></a></li><li class="depth-4 branch"><a href="io.pedestal.http.servlet.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>servlet</span></div></a></li><li class="depth-4 branch"><a href="io.pedestal.http.sse.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>sse</span></div></a></li><li class="depth-4 current"><a href="io.pedestal.http.tracing.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tracing</span></div></a></li><li class="depth-3"><a href="io.pedestal.interceptor.html"><div class="inner"><span class="tree" style="top: -1075px;"><span class="top" style="height: 1084px;"></span><span class="bottom"></span></span><span>interceptor</span></div></a></li><li class="depth-4 branch"><a href="io.pedestal.interceptor.chain.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>chain</span></div></a></li><li class="depth-4 branch"><a href="io.pedestal.interceptor.error.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>error</span></div></a></li><li class="depth-4 branch"><a href="io.pedestal.interceptor.helpers.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>helpers</span></div></a></li><li class="depth-4"><a href="io.pedestal.interceptor.trace.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>trace</span></div></a></li><li class="depth-3"><a href="io.pedestal.log.html"><div class="inner"><span class="tree" style="top: -145px;"><span class="top" style="height: 154px;"></span><span class="bottom"></span></span><span>log</span></div></a></li><li class="depth-4"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>aws</span></div></div></li><li class="depth-5"><a href="io.pedestal.log.aws.xray.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>xray</span></div></a></li><li class="depth-3"><a href="io.pedestal.metrics.html"><div class="inner"><span class="tree" style="top: -83px;"><span class="top" style="height: 92px;"></span><span class="bottom"></span></span><span>metrics</span></div></a></li><li class="depth-4 branch"><a href="io.pedestal.metrics.codahale.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>codahale</span></div></a></li><li class="depth-4 branch"><a href="io.pedestal.metrics.otel.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>otel</span></div></a></li><li class="depth-4"><a href="io.pedestal.metrics.spi.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>spi</span></div></a></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree" style="top: -114px;"><span class="top" style="height: 123px;"></span><span class="bottom"></span></span><span>service-tools</span></div></div></li><li class="depth-4 branch"><a href="io.pedestal.service-tools.dev.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>dev</span></div></a></li><li class="depth-4"><a href="io.pedestal.service-tools.war.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>war</span></div></a></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree" style="top: -83px;"><span class="top" style="height: 92px;"></span><span class="bottom"></span></span><span>telemetry</span></div></div></li><li class="depth-4"><a href="io.pedestal.telemetry.otel-global-init.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>otel-global-init</span></div></a></li><li class="depth-3 branch"><a href="io.pedestal.test.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>test</span></div></a></li><li class="depth-3"><a href="io.pedestal.tracing.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tracing</span></div></a></li><li class="depth-4"><a href="io.pedestal.tracing.spi.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>spi</span></div></a></li><li class="depth-3"><a href="io.pedestal.websocket.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>websocket</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="io.pedestal.http.tracing.html#var-request-tracing-interceptor"><div class="inner"><span>request-tracing-interceptor</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">io.pedestal.http.tracing</h1><h4 class="added">added in 0.7.0</h4><div class="doc"><div class="markdown"><p>HTTP request tracing based on Open Telemetry.</p>
+</div></div><div class="public anchor" id="var-request-tracing-interceptor"><h3>request-tracing-interceptor</h3><div class="usage"><code>(request-tracing-interceptor)</code></div><div class="doc"><div class="markdown"><p>A tracing interceptor traces the execution of the request.  When the request is successfully routed, the trace will identify the HTTP route and route name.</p>
+<p>This interceptor should come first (or at least, early) in the incoming pipeline to ensure that all execution time is accounted for.  This is less important when the OpenTelemetry Java agent is in use, at that captures the overall request processing time, from start to finish, more accurately.</p>
+</div></div><div class="src-link"><a href="https://github.com/pedestal/pedestal/blob/0.7.0-SNAPSHOT/service/src/io/pedestal/http/tracing.clj#L100">view source</a></div></div></div></body></html>