Skip to content

Regenerate site #1119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: gh-pages
Choose a base branch
from
Open

Regenerate site #1119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6b456d
add gitignore
mwz Jan 17, 2025
23f3441
Regenerate site
mwz Jan 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
*.class
*.log

# these are moved into the doc project by the build
modules/docs/src/main/tut/changelog.md
modules/docs/src/main/tut/license.md

# sbt specific
dist/*
target/
lib_managed/
src_managed/
project/boot/
project/plugins/project/
project/hydra.sbt

# Scala-IDE specific
.scala_dependencies
.cache
.classpath
.project
.worksheet/
bin/
.settings/

# OS X
.DS_Store

# Ctags
.tags

# ENSIME
.ensime
.ensime_cache/

# IntelliJ
.idea/

# Mill
out/

# Bloop/Metals
.bloop/
.metals/
metals.sbt
.bsp/

# VS-Code
.vscode/
63 changes: 56 additions & 7 deletions backends/datadog.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta name="description" content='docs'/>
<link rel="canonical" href="https://github.com/tpolecat/natchezbackends/datadog.html"/>
<link rel="canonical" href="https://github.com/typelevel/natchezbackends/datadog.html"/>
<link href="https://fonts.googleapis.com/css?family=Roboto:100normal,100italic,300normal,300italic,400normal,400italic,500normal,500italic,700normal,700italic,900normal,900italicc" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../lib/jquery/jquery.min.js"></script>
<script type="text/javascript" src="../js/page.js"></script>
Expand All @@ -32,7 +32,7 @@
<span class="home-icon">⌂</span>Natchez
</a>
<div class="version-number">
0.1.5
0.3.7
</div>
</div>
<div class="nav-toc">
Expand All @@ -58,6 +58,7 @@
<li><a href="../backends/noop.html" class="page">No-Op</a></li>
<li><a href="../backends/odin.html" class="page">Odin</a></li>
<li><a href="../backends/opencensus.html" class="page">OpenCensus</a></li>
<li><a href="../backends/opentelemetry.html" class="page">OpenTelemetry</a></li>
</ul></li>
<li><a href="../examples/index.html" class="page">Examples</a>
<ul>
Expand Down Expand Up @@ -95,7 +96,7 @@
<span class="home-icon">⌂</span>Natchez
</a>
<div class="version-number">
0.1.5
0.3.7
</div>
</div>
<div class="nav-toc">
Expand All @@ -121,6 +122,7 @@
<li><a href="../backends/noop.html" class="page">No-Op</a></li>
<li><a href="../backends/odin.html" class="page">Odin</a></li>
<li><a href="../backends/opencensus.html" class="page">OpenCensus</a></li>
<li><a href="../backends/opentelemetry.html" class="page">OpenTelemetry</a></li>
</ul></li>
<li><a href="../examples/index.html" class="page">Examples</a>
<ul>
Expand Down Expand Up @@ -153,19 +155,66 @@
<div class="page-content row">
<div class="small-12 large-9 column" id="docs">
<h1><a href="#datadog" name="datadog" class="anchor"><span class="anchor-link"></span></a>Datadog</h1>
<p>To get access to an <code>EntryPoint</code> instance for DataDog, add the following dependency.</p>
<p>It transitively pulls in <code>&quot;com.datadoghq&quot; % &quot;dd-trace-ot&quot;</code> and <code>&quot;com.datadoghq&quot; % &quot;dd-trace-api&quot;</code>.</p><dl class="dependency"><dt>sbt</dt><dd><pre class="prettyprint"><code class="language-scala">libraryDependencies += "org.tpolecat" %% "natchez-datadog" % "0.3.7"</code></pre></dd><dt>Maven</dt><dd><pre class="prettyprint"><code class="language-xml">&lt;dependencies&gt
&lt;dependency&gt;
&lt;groupId&gt;org.tpolecat&lt;/groupId&gt;
&lt;artifactId&gt;natchez-datadog_2.13&lt;/artifactId&gt;
&lt;version&gt;0.3.7&lt;/version&gt;
&lt;/dependency&gt
&lt;/dependencies&gt;</code></pre></dd><dt>Gradle</dt><dd><pre class="prettyprint"><code class="language-gradle">dependencies {
implementation "org.tpolecat:natchez-datadog_2.13:0.3.7"
}</code></pre></dd></dl>
<h2><a href="#constructing-an-entrypoint" name="constructing-an-entrypoint" class="anchor"><span class="anchor-link"></span></a>Constructing an EntryPoint</h2>
<p>You can use <code>DDTracer.entryPoint</code> to build a DataDog tracer, register it globally, and get it as a <code>Resource[F, EntryPoint[F]]</code>. The method takes a function in which you can customize the underlying <code>DDTracerBuilder</code> instance to specify the service name, sampling rules, etc.</p>
<p>At the end, the function should return a <code>datadog.opentracing.DDTracer</code>, for example by calling <code>build()</code>.</p>
<p>The builder is mutable, so customizing it is considered an effect - hence the wrapping in <code>Sync[F].delay</code>:</p>
<pre class="prettyprint"><code class="language-scala">import cats.effect.{Sync, Resource}
import natchez.datadog.DDTracer
import natchez.EntryPoint

def entryPoint[F[_]: Sync]: Resource[F, EntryPoint[F]] =
DDTracer.entryPoint[F] {
builder =&gt; Sync[F].delay {
builder
.serviceName(&quot;my-app&quot;)
.build()
}
}
</code></pre>
<p>An alternative approach is to use the already registered global tracer (for example, if you&rsquo;ve already set it up and registered through some other means, like adding the Java Agent):</p>
<pre class="prettyprint"><code class="language-scala">import java.net.URI

// Will return `None` if there&#39;s no tracer registered already
def entryPointUseGlobal[F[_]: Sync]: F[Option[EntryPoint[F]]] =
DDTracer.globalTracerEntryPoint[F](Some(new URI(s&quot;https://app.datadoghq.com&quot;)))
</code></pre>
<script type="text/javascript" src="../js/link_fix.js"></script>

<div class="source-github">
The source code for this page can be found <a id="source-link" href="https://github.com/tpolecat/natchez/tree/v0.1.5/modules/docs/target/mdoc/backends/datadog.md">here</a>.
The source code for this page can be found <a id="source-link" href="https://github.com/typelevel/natchez/tree/master/modules/docs/target/mdoc/backends/datadog.md">here</a>.
</div>

<script type="text/javascript">jQuery(function(){sourceUrlFix('https://github.com/tpolecat/natchez/tree/v0.1.5/modules/docs/target/mdoc/backends/datadog.md')});</script>
<script type="text/javascript">jQuery(function(){sourceUrlFix('https://github.com/typelevel/natchez/tree/master/modules/docs/target/mdoc/backends/datadog.md')});</script>

<div class="nav-next">
<p><strong>Next:</strong> <a href="../backends/honeycomb.html">Honeycomb</a></p>
</div>
</div>
<div class="large-3 show-for-large column" data-sticky-container>
<nav class="sidebar sticky" data-sticky data-anchor="docs" data-sticky-on="large">
<div class="page-nav">
<div class="nav-title">On this page:</div>
<div class="nav-toc">
<ul>
<li><a href="../backends/datadog.html#datadog" class="header">Datadog</a>
<ul>
<li><a href="../backends/datadog.html#constructing-an-entrypoint" class="header">Constructing an EntryPoint</a></li>
</ul></li>
</ul>
</div>
</div>
</nav>
</div>
</div>

Expand Down Expand Up @@ -203,7 +252,7 @@ <h1><a href="#datadog" name="datadog" class="anchor"><span class="anchor-link"><

<!--
<div class="copyright">
<span class="text">&copy; 2021</span>
<span class="text">&copy; 2025</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand All @@ -228,7 +277,7 @@ <h1><a href="#datadog" name="datadog" class="anchor"><span class="anchor-link"><
<script type="text/javascript" src="../lib/prettify/prettify.js"></script>
<script type="text/javascript" src="../lib/prettify/lang-scala.js"></script>
<script type="text/javascript">jQuery(function(){window.prettyPrint && prettyPrint()});</script>
<script type="text/javascript">jQuery(function(jq){initOldVersionWarnings(jq, '0.1.5', 'https://github.com/tpolecat/natchez')});</script>
<script type="text/javascript">jQuery(function(jq){initOldVersionWarnings(jq, '0.3.7', 'https://github.com/typelevel/natchez')});</script>


</html>
24 changes: 13 additions & 11 deletions backends/honeycomb.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta name="description" content='docs'/>
<link rel="canonical" href="https://github.com/tpolecat/natchezbackends/honeycomb.html"/>
<link rel="canonical" href="https://github.com/typelevel/natchezbackends/honeycomb.html"/>
<link href="https://fonts.googleapis.com/css?family=Roboto:100normal,100italic,300normal,300italic,400normal,400italic,500normal,500italic,700normal,700italic,900normal,900italicc" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../lib/jquery/jquery.min.js"></script>
<script type="text/javascript" src="../js/page.js"></script>
Expand All @@ -32,7 +32,7 @@
<span class="home-icon">⌂</span>Natchez
</a>
<div class="version-number">
0.1.5
0.3.7
</div>
</div>
<div class="nav-toc">
Expand All @@ -58,6 +58,7 @@
<li><a href="../backends/noop.html" class="page">No-Op</a></li>
<li><a href="../backends/odin.html" class="page">Odin</a></li>
<li><a href="../backends/opencensus.html" class="page">OpenCensus</a></li>
<li><a href="../backends/opentelemetry.html" class="page">OpenTelemetry</a></li>
</ul></li>
<li><a href="../examples/index.html" class="page">Examples</a>
<ul>
Expand Down Expand Up @@ -95,7 +96,7 @@
<span class="home-icon">⌂</span>Natchez
</a>
<div class="version-number">
0.1.5
0.3.7
</div>
</div>
<div class="nav-toc">
Expand All @@ -121,6 +122,7 @@
<li><a href="../backends/noop.html" class="page">No-Op</a></li>
<li><a href="../backends/odin.html" class="page">Odin</a></li>
<li><a href="../backends/opencensus.html" class="page">OpenCensus</a></li>
<li><a href="../backends/opentelemetry.html" class="page">OpenTelemetry</a></li>
</ul></li>
<li><a href="../examples/index.html" class="page">Examples</a>
<ul>
Expand Down Expand Up @@ -153,14 +155,14 @@
<div class="page-content row">
<div class="small-12 large-9 column" id="docs">
<h1><a href="#honeycomb" name="honeycomb" class="anchor"><span class="anchor-link"></span></a>Honeycomb</h1>
<p>To use the <a href="https://honeycomb.io">Honeycomb</a> back end, add the following dependency:</p><dl class="dependency"><dt>sbt</dt><dd><pre class="prettyprint"><code class="language-scala">libraryDependencies += "org.tpolecat" %% "natchez-honeycomb" % "0.1.5"</code></pre></dd><dt>Maven</dt><dd><pre class="prettyprint"><code class="language-xml">&lt;dependencies&gt
<p>To use the <a href="https://honeycomb.io">Honeycomb</a> back end, add the following dependency:</p><dl class="dependency"><dt>sbt</dt><dd><pre class="prettyprint"><code class="language-scala">libraryDependencies += "org.tpolecat" %% "natchez-honeycomb" % "0.3.7"</code></pre></dd><dt>Maven</dt><dd><pre class="prettyprint"><code class="language-xml">&lt;dependencies&gt
&lt;dependency&gt;
&lt;groupId&gt;org.tpolecat&lt;/groupId&gt;
&lt;artifactId&gt;natchez-honeycomb_2.13&lt;/artifactId&gt;
&lt;version&gt;0.1.5&lt;/version&gt;
&lt;version&gt;0.3.7&lt;/version&gt;
&lt;/dependency&gt
&lt;/dependencies&gt;</code></pre></dd><dt>Gradle</dt><dd><pre class="prettyprint"><code class="language-gradle">dependencies {
implementation "org.tpolecat:natchez-honeycomb_2.13:0.1.5"
implementation "org.tpolecat:natchez-honeycomb_2.13:0.3.7"
}</code></pre></dd></dl>
<h2><a href="#example-trace" name="example-trace" class="anchor"><span class="anchor-link"></span></a>Example Trace</h2>
<p><img src="honeycomb.png" /></p>
Expand Down Expand Up @@ -192,7 +194,7 @@ <h2><a href="#honeycomb-fields" name="honeycomb-fields" class="anchor"><span cla
</thead>
<tbody>
<tr>
<td><code>service_name</code> </td>
<td><code>service.name</code> </td>
<td>String </td>
<td>User-supplied service name. </td>
</tr>
Expand Down Expand Up @@ -241,10 +243,10 @@ <h2><a href="#honeycomb-fields" name="honeycomb-fields" class="anchor"><span cla
<script type="text/javascript" src="../js/link_fix.js"></script>

<div class="source-github">
The source code for this page can be found <a id="source-link" href="https://github.com/tpolecat/natchez/tree/v0.1.5/modules/docs/target/mdoc/backends/honeycomb.md">here</a>.
The source code for this page can be found <a id="source-link" href="https://github.com/typelevel/natchez/tree/master/modules/docs/target/mdoc/backends/honeycomb.md">here</a>.
</div>

<script type="text/javascript">jQuery(function(){sourceUrlFix('https://github.com/tpolecat/natchez/tree/v0.1.5/modules/docs/target/mdoc/backends/honeycomb.md')});</script>
<script type="text/javascript">jQuery(function(){sourceUrlFix('https://github.com/typelevel/natchez/tree/master/modules/docs/target/mdoc/backends/honeycomb.md')});</script>

<div class="nav-next">
<p><strong>Next:</strong> <a href="../backends/jaeger.html">Jaeger</a></p>
Expand Down Expand Up @@ -303,7 +305,7 @@ <h2><a href="#honeycomb-fields" name="honeycomb-fields" class="anchor"><span cla

<!--
<div class="copyright">
<span class="text">&copy; 2021</span>
<span class="text">&copy; 2025</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand All @@ -328,7 +330,7 @@ <h2><a href="#honeycomb-fields" name="honeycomb-fields" class="anchor"><span cla
<script type="text/javascript" src="../lib/prettify/prettify.js"></script>
<script type="text/javascript" src="../lib/prettify/lang-scala.js"></script>
<script type="text/javascript">jQuery(function(){window.prettyPrint && prettyPrint()});</script>
<script type="text/javascript">jQuery(function(jq){initOldVersionWarnings(jq, '0.1.5', 'https://github.com/tpolecat/natchez')});</script>
<script type="text/javascript">jQuery(function(jq){initOldVersionWarnings(jq, '0.3.7', 'https://github.com/typelevel/natchez')});</script>


</html>
25 changes: 17 additions & 8 deletions backends/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta name="description" content='docs'/>
<link rel="canonical" href="https://github.com/tpolecat/natchezbackends/index.html"/>
<link rel="canonical" href="https://github.com/typelevel/natchezbackends/index.html"/>
<link href="https://fonts.googleapis.com/css?family=Roboto:100normal,100italic,300normal,300italic,400normal,400italic,500normal,500italic,700normal,700italic,900normal,900italicc" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../lib/jquery/jquery.min.js"></script>
<script type="text/javascript" src="../js/page.js"></script>
Expand All @@ -32,7 +32,7 @@
<span class="home-icon">⌂</span>Natchez
</a>
<div class="version-number">
0.1.5
0.3.7
</div>
</div>
<div class="nav-toc">
Expand All @@ -58,6 +58,7 @@
<li><a href="../backends/noop.html" class="page">No-Op</a></li>
<li><a href="../backends/odin.html" class="page">Odin</a></li>
<li><a href="../backends/opencensus.html" class="page">OpenCensus</a></li>
<li><a href="../backends/opentelemetry.html" class="page">OpenTelemetry</a></li>
</ul></li>
<li><a href="../examples/index.html" class="page">Examples</a>
<ul>
Expand Down Expand Up @@ -95,7 +96,7 @@
<span class="home-icon">⌂</span>Natchez
</a>
<div class="version-number">
0.1.5
0.3.7
</div>
</div>
<div class="nav-toc">
Expand All @@ -121,6 +122,7 @@
<li><a href="../backends/noop.html" class="page">No-Op</a></li>
<li><a href="../backends/odin.html" class="page">Odin</a></li>
<li><a href="../backends/opencensus.html" class="page">OpenCensus</a></li>
<li><a href="../backends/opentelemetry.html" class="page">OpenTelemetry</a></li>
</ul></li>
<li><a href="../examples/index.html" class="page">Examples</a>
<ul>
Expand Down Expand Up @@ -155,7 +157,10 @@ <h1><a href="#back-ends" name="back-ends" class="anchor"><span class="anchor-lin
<p>Natchez supports the following tracing back ends. If you&rsquo;re not sure which one you&rsquo;d like to use, you might start with <a href="jaeger.html">Jaeger</a>, which is easy to set up with Docker.</p>
<div class="toc ">
<ul>
<li><a href="../backends/datadog.html" class="page">Datadog</a></li>
<li><a href="../backends/datadog.html" class="page">Datadog</a>
<ul>
<li><a href="../backends/datadog.html#constructing-an-entrypoint" class="header">Constructing an EntryPoint</a></li>
</ul></li>
<li><a href="../backends/honeycomb.html" class="page">Honeycomb</a>
<ul>
<li><a href="../backends/honeycomb.html#example-trace" class="header">Example Trace</a></li>
Expand All @@ -175,15 +180,19 @@ <h1><a href="#back-ends" name="back-ends" class="anchor"><span class="anchor-lin
<li><a href="../backends/noop.html" class="page">No-Op</a></li>
<li><a href="../backends/odin.html" class="page">Odin</a></li>
<li><a href="../backends/opencensus.html" class="page">OpenCensus</a></li>
<li><a href="../backends/opentelemetry.html" class="page">OpenTelemetry</a>
<ul>
<li><a href="../backends/opentelemetry.html#configuring-an-opentelemetry-entrypoint" class="header">Configuring an OpenTelemetry entrypoint</a></li>
</ul></li>
</ul>
</div>
<script type="text/javascript" src="../js/link_fix.js"></script>

<div class="source-github">
The source code for this page can be found <a id="source-link" href="https://github.com/tpolecat/natchez/tree/v0.1.5/modules/docs/target/mdoc/backends/index.md">here</a>.
The source code for this page can be found <a id="source-link" href="https://github.com/typelevel/natchez/tree/master/modules/docs/target/mdoc/backends/index.md">here</a>.
</div>

<script type="text/javascript">jQuery(function(){sourceUrlFix('https://github.com/tpolecat/natchez/tree/v0.1.5/modules/docs/target/mdoc/backends/index.md')});</script>
<script type="text/javascript">jQuery(function(){sourceUrlFix('https://github.com/typelevel/natchez/tree/master/modules/docs/target/mdoc/backends/index.md')});</script>

<div class="nav-next">
<p><strong>Next:</strong> <a href="../backends/datadog.html">Datadog</a></p>
Expand Down Expand Up @@ -227,7 +236,7 @@ <h1><a href="#back-ends" name="back-ends" class="anchor"><span class="anchor-lin

<!--
<div class="copyright">
<span class="text">&copy; 2021</span>
<span class="text">&copy; 2025</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand All @@ -252,7 +261,7 @@ <h1><a href="#back-ends" name="back-ends" class="anchor"><span class="anchor-lin
<script type="text/javascript" src="../lib/prettify/prettify.js"></script>
<script type="text/javascript" src="../lib/prettify/lang-scala.js"></script>
<script type="text/javascript">jQuery(function(){window.prettyPrint && prettyPrint()});</script>
<script type="text/javascript">jQuery(function(jq){initOldVersionWarnings(jq, '0.1.5', 'https://github.com/tpolecat/natchez')});</script>
<script type="text/javascript">jQuery(function(jq){initOldVersionWarnings(jq, '0.3.7', 'https://github.com/typelevel/natchez')});</script>


</html>
Loading