|
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara">
<title>Nine Nines: cowboy_tracer_h(3)</title>
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'>
<link href="/css/99s.css?r=7" rel="stylesheet">
<link rel="shortcut icon" href="/img/ico/favicon.ico">
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png">
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png">
<link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png">
</head>
<body class="">
<header id="page-head">
<div id="topbar" class="container">
<div class="row">
<div class="span2">
<h1 id="logo"><a href="/" title="99s">99s</a></h1>
</div>
<div class="span10">
<div id="side-header">
<nav>
<ul>
<li><a title="Hear my thoughts" href="/articles">Articles</a></li>
<li><a title="Watch my talks" href="/talks">Talks</a></li>
<li class="active"><a title="Read the docs" href="/docs">Documentation</a></li>
<li><a title="Request my services" href="/services">Consulting & Training</a></li>
</ul>
</nav>
<ul id="social">
<li>
<a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a>
</li>
<li>
<a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a>
</li>
</ul>
</div>
</div>
</div>
</div>
</header>
<div id="contents" class="two_col">
<div class="container">
<div class="row">
<div id="docs" class="span9 maincol">
<h1 class="lined-header"><span>cowboy_tracer_h(3)</span></h1>
<h2 id="_name">Name</h2>
<p>cowboy_tracer_h - Tracer stream handler</p>
<h2 id="_description">Description</h2>
<p>The module <code>cowboy_tracer_h</code> can be used to conditionally trace streams based on information found in the request. Trace messages are given to the configured callback.</p>
<h2 id="_options">Options</h2>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#000000">opts</font></b>() <font color="#990000">::</font> #{
<font color="#0000FF">tracer_callback</font> <font color="#990000">=></font> <font color="#009900">Callback</font>,
<font color="#0000FF">tracer_flags</font> <font color="#990000">=></font> [<b><font color="#000080">atom</font></b>()],
<font color="#0000FF">tracer_match_specs</font> <font color="#990000">=></font> [<font color="#009900">MatchSpec</font>]
}
<font color="#009900">Callback</font> <font color="#990000">::</font> <b><font color="#0000FF">fun</font></b>((<font color="#FF6600">init</font> | <font color="#FF6600">terminate</font> | <b><font color="#000000">tuple</font></b>(), <font color="#009900">State</font>) <font color="#990000">-></font> <font color="#009900">State</font>)
<font color="#009900">MatchSpec</font> <font color="#990000">::</font> <font color="#009900">MatchPredicate</font>
| {<font color="#FF6600">method</font>, <b><font color="#000080">binary</font></b>()}
| {<font color="#FF6600">host</font>, <b><font color="#000080">binary</font></b>()}
| {<font color="#FF6600">path</font>, <b><font color="#000080">binary</font></b>()}
| {<font color="#FF6600">path_start</font>, <b><font color="#000080">binary</font></b>()}
| {<font color="#FF6600">header</font>, <b><font color="#000080">binary</font></b>()}
| {<font color="#FF6600">header</font>, <b><font color="#000080">binary</font></b>(), <b><font color="#000080">binary</font></b>()}
| {<font color="#FF6600">peer_ip</font>, <b><font color="#000000">inet:ip_address</font></b>()}
<font color="#009900">MatchPredicate</font> <font color="#990000">::</font> <b><font color="#0000FF">fun</font></b>((<b><font color="#000000">cowboy_stream:streamid</font></b>(),
<b><font color="#000000">cowboy_req:req</font></b>(),
<b><font color="#000000">cowboy:opts</font></b>()) <font color="#990000">-></font> <b><font color="#000000">boolean</font></b>())
}</tt></pre>
</div></div>
<p>Configuration for the tracer stream handler.</p>
<p>This module will not set trace patterns. Those must be set by the user directly, either from the callback's <code>init</code> or, preferably, in advance.</p>
<dl><dt>tracer_callback</dt>
<dd><p>The function that will be called for each trace events. It will also be called before any trace event with an argument <code>init</code>, and when the stream is terminated with an argument <code>terminate</code>.</p>
<p>This option is required for tracing to be enabled. The tracer stream handler does nothing otherwise.</p>
</dd>
<dt>tracer_flags</dt>
<dd><p>Trace flags to enable. See the documentation of <code>erlang:trace/3</code> for details. Note that all trace flags are allowed except for the <code>tracer</code> flag.</p>
</dd>
<dt>tracer_match_specs</dt>
<dd><p>A list of match conditions that must all be fulfilled for the stream to be traced. Cowboy will compare these with the information found in the request and only enable tracing if all matches succeed.</p>
<p>This option is required for tracing to be enabled. The tracer stream handler does nothing otherwise.</p>
</dd>
</dl>
<h2 id="_events">Events</h2>
<p>The tracer stream handler does not produce any event.</p>
<h2 id="_changelog">Changelog</h2>
<ul><li><strong>2.7</strong>: Module introduced.
</li>
</ul>
<h2 id="_see_also">See also</h2>
<p><a href="..">cowboy(7)</a>, <a href="../cowboy_stream">cowboy_stream(3)</a>, <a href="../cowboy_compress_h">cowboy_compress_h(3)</a>, <a href="../cowboy_metrics_h">cowboy_metrics_h(3)</a>, <a href="../cowboy_stream_h">cowboy_stream_h(3)</a></p>
</div>
<div class="span3 sidecol">
<h3>
Cowboy
2.10
Function Reference
</h3>
<ul>
<li><a href="/docs/en/cowboy/2.10/guide">User Guide</a></li>
<li><a href="/docs/en/cowboy/2.10/manual">Function Reference</a></li>
</ul>
<h4 id="docs-nav">Navigation</h4>
<h4>Version select</h4>
<ul>
<li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li>
<li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li>
<li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li>
<li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li>
<li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li>
<li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li>
<li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li>
</ul>
<h3 id="_like_my_work__donate">Like my work? Donate!</h3>
<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p>
<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline">
<input type="hidden" name="cmd" value="_donations">
<input type="hidden" name="business" value="[email protected]">
<input type="hidden" name="lc" value="FR">
<input type="hidden" name="item_name" value="Loic Hoguin">
<input type="hidden" name="item_number" value="99s">
<input type="hidden" name="currency_code" value="EUR">
<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted">
<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1">
</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="span6">
<p id="scroll-top"><a href="#">↑ Scroll to top</a></p>
<nav>
<ul>
<li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li>
</ul>
</nav>
</div>
<div class="span6 credits">
<p><img src="/img/footer_logo.png"></p>
<p>Copyright © Loïc Hoguin 2012-2018</p>
</div>
</div>
</div>
</footer>
<script src="/js/custom.js"></script>
</body>
</html>
|
