866 lines
43 KiB
HTML
866 lines
43 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>Timer Class Reference</title>
|
|
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
|
|
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
|
|
<meta charset="utf-8">
|
|
<script src="../js/jquery.min.js" defer></script>
|
|
<script src="../js/jazzy.js" defer></script>
|
|
|
|
<script src="../js/lunr.min.js" defer></script>
|
|
<script src="../js/typeahead.jquery.js" defer></script>
|
|
<script src="../js/jazzy.search.js" defer></script>
|
|
</head>
|
|
<body>
|
|
|
|
<a name="//apple_ref/swift/Class/Timer" class="dashAnchor"></a>
|
|
|
|
<a title="Timer Class Reference"></a>
|
|
|
|
<header class="header">
|
|
<p class="header-col header-col--primary">
|
|
<a class="header-link" href="../index.html">
|
|
CoreMetrics Docs
|
|
</a>
|
|
(81% documented)
|
|
</p>
|
|
|
|
<p class="header-col--secondary">
|
|
<form role="search" action="../search.json">
|
|
<input type="text" placeholder="Search documentation" data-typeahead>
|
|
</form>
|
|
</p>
|
|
|
|
<p class="header-col header-col--secondary">
|
|
<a class="header-link" href="https://github.com/apple/swift-metrics">
|
|
<img class="header-icon" src="../img/gh.png"/>
|
|
View on GitHub
|
|
</a>
|
|
</p>
|
|
|
|
</header>
|
|
|
|
<p class="breadcrumbs">
|
|
<a class="breadcrumb" href="../index.html">CoreMetrics Reference</a>
|
|
<img class="carat" src="../img/carat.png" />
|
|
Timer Class Reference
|
|
</p>
|
|
|
|
<div class="content-wrapper">
|
|
<nav class="navigation">
|
|
<ul class="nav-groups">
|
|
<li class="nav-group-name">
|
|
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a class="nav-group-task-link" href="../Classes/Counter.html">Counter</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a class="nav-group-task-link" href="../Classes/Gauge.html">Gauge</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a class="nav-group-task-link" href="../Classes/MultiplexMetricsHandler.html">MultiplexMetricsHandler</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a class="nav-group-task-link" href="../Classes/NOOPMetricsHandler.html">NOOPMetricsHandler</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a class="nav-group-task-link" href="../Classes/Recorder.html">Recorder</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a class="nav-group-task-link" href="../Classes/Timer.html">Timer</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-group-name">
|
|
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a class="nav-group-task-link" href="../Enums/MetricsSystem.html">MetricsSystem</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a class="nav-group-task-link" href="../Enums/TimeUnit.html">TimeUnit</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-group-name">
|
|
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a class="nav-group-task-link" href="../Protocols/CounterHandler.html">CounterHandler</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a class="nav-group-task-link" href="../Protocols/MetricsFactory.html">MetricsFactory</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a class="nav-group-task-link" href="../Protocols/RecorderHandler.html">RecorderHandler</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a class="nav-group-task-link" href="../Protocols/TimerHandler.html">TimerHandler</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<article class="main-content">
|
|
|
|
<section class="section">
|
|
<div class="section-content">
|
|
<h1>Timer</h1>
|
|
<div class="declaration">
|
|
<div class="language">
|
|
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Timer</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<p>A timer collects observations within a time window (usually things like request durations) and provides aggregated information about the data sample,
|
|
for example, min, max and various quantiles. It is similar to a <code><a href="../Classes/Recorder.html">Recorder</a></code> but specialized for values that represent durations.</p>
|
|
|
|
<p>This is the user-facing Timer API.</p>
|
|
|
|
<p>Its behavior depends on the <code><a href="../Protocols/TimerHandler.html">TimerHandler</a></code> implementation.</p>
|
|
|
|
</div>
|
|
</section>
|
|
|
|
<section class="section">
|
|
<div class="section-content">
|
|
<div class="task-group">
|
|
<ul class="item-container">
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:11CoreMetrics5TimerC5labelSSvp"></a>
|
|
<a name="//apple_ref/swift/Property/label" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:11CoreMetrics5TimerC5labelSSvp">label</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Undocumented</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">label</span><span class="p">:</span> <span class="kt">String</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="slightly-smaller">
|
|
<a href="https://github.com/apple/swift-metrics/tree/1.2.0/Sources/CoreMetrics/Metrics.swift#L">Show on GitHub</a>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:11CoreMetrics5TimerC10dimensionsSaySS_SStGvp"></a>
|
|
<a name="//apple_ref/swift/Property/dimensions" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:11CoreMetrics5TimerC10dimensionsSaySS_SStGvp">dimensions</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Undocumented</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">dimensions</span><span class="p">:</span> <span class="p">[(</span><span class="kt">String</span><span class="p">,</span> <span class="kt">String</span><span class="p">)]</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="slightly-smaller">
|
|
<a href="https://github.com/apple/swift-metrics/tree/1.2.0/Sources/CoreMetrics/Metrics.swift#L">Show on GitHub</a>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:11CoreMetrics5TimerC5label10dimensions7handlerACSS_SaySS_SStGAA0C7Handler_ptcfc"></a>
|
|
<a name="//apple_ref/swift/Method/init(label:dimensions:handler:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:11CoreMetrics5TimerC5label10dimensions7handlerACSS_SaySS_SStGAA0C7Handler_ptcfc">init(label:dimensions:handler:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Alternative way to create a new <code>Timer</code>, while providing an explicit <code><a href="../Protocols/TimerHandler.html">TimerHandler</a></code>.</p>
|
|
<div class="aside aside-warning">
|
|
<p class="aside-title">Warning</p>
|
|
<p>This initializer provides an escape hatch for situations where one must use a custom factory instead of the global one.
|
|
We do not expect this API to be used in normal circumstances, so if you find yourself using it make sure it’s for a good reason.</p>
|
|
|
|
</div>
|
|
<div class="aside aside-see-also">
|
|
<p class="aside-title">See also</p>
|
|
<p>Use <code><a href="../Classes/Timer.html#/s:11CoreMetrics5TimerC5label10dimensionsACSS_SaySS_SStGtcfc">init(label:dimensions:)</a></code> to create <code><a href="../Classes/Recorder.html">Recorder</a></code> instances using the configured metrics backend.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">label</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">dimensions</span><span class="p">:</span> <span class="p">[(</span><span class="kt">String</span><span class="p">,</span> <span class="kt">String</span><span class="p">)],</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/TimerHandler.html">TimerHandler</a></span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>label</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The label for the <code>Timer</code>.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>dimensions</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The dimensions for the <code>Timer</code>.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>handler</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The custom backend.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="slightly-smaller">
|
|
<a href="https://github.com/apple/swift-metrics/tree/1.2.0/Sources/CoreMetrics/Metrics.swift#L233-L237">Show on GitHub</a>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:11CoreMetrics5TimerC17recordNanosecondsyys5Int64VF"></a>
|
|
<a name="//apple_ref/swift/Method/recordNanoseconds(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:11CoreMetrics5TimerC17recordNanosecondsyys5Int64VF">recordNanoseconds(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Record a duration in nanoseconds.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">@inlinable</span>
|
|
<span class="kd">public</span> <span class="kd">func</span> <span class="nf">recordNanoseconds</span><span class="p">(</span><span class="n">_</span> <span class="nv">duration</span><span class="p">:</span> <span class="kt">Int64</span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>value</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>Duration to record.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="slightly-smaller">
|
|
<a href="https://github.com/apple/swift-metrics/tree/1.2.0/Sources/CoreMetrics/Metrics.swift#L244-L246">Show on GitHub</a>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:11CoreMetrics5TimerC17recordNanosecondsyyxSzRzlF"></a>
|
|
<a name="//apple_ref/swift/Method/recordNanoseconds(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:11CoreMetrics5TimerC17recordNanosecondsyyxSzRzlF">recordNanoseconds(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Record a duration in nanoseconds.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">@inlinable</span>
|
|
<span class="kd">public</span> <span class="kd">func</span> <span class="n">recordNanoseconds</span><span class="o"><</span><span class="kt">DataType</span><span class="o">></span><span class="p">(</span><span class="n">_</span> <span class="nv">duration</span><span class="p">:</span> <span class="kt">DataType</span><span class="p">)</span> <span class="k">where</span> <span class="kt">DataType</span> <span class="p">:</span> <span class="kt">BinaryInteger</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>value</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>Duration to record.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="slightly-smaller">
|
|
<a href="https://github.com/apple/swift-metrics/tree/1.2.0/Sources/CoreMetrics/Metrics.swift#L253-L255">Show on GitHub</a>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:11CoreMetrics5TimerC18recordMicrosecondsyyxSzRzlF"></a>
|
|
<a name="//apple_ref/swift/Method/recordMicroseconds(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:11CoreMetrics5TimerC18recordMicrosecondsyyxSzRzlF">recordMicroseconds(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Record a duration in microseconds.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">@inlinable</span>
|
|
<span class="kd">public</span> <span class="kd">func</span> <span class="n">recordMicroseconds</span><span class="o"><</span><span class="kt">DataType</span><span class="o">></span><span class="p">(</span><span class="n">_</span> <span class="nv">duration</span><span class="p">:</span> <span class="kt">DataType</span><span class="p">)</span> <span class="k">where</span> <span class="kt">DataType</span> <span class="p">:</span> <span class="kt">BinaryInteger</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>value</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>Duration to record.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="slightly-smaller">
|
|
<a href="https://github.com/apple/swift-metrics/tree/1.2.0/Sources/CoreMetrics/Metrics.swift#L262-L271">Show on GitHub</a>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:11CoreMetrics5TimerC18recordMicrosecondsyyxSBRzlF"></a>
|
|
<a name="//apple_ref/swift/Method/recordMicroseconds(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:11CoreMetrics5TimerC18recordMicrosecondsyyxSBRzlF">recordMicroseconds(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Record a duration in microseconds.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">@inlinable</span>
|
|
<span class="kd">public</span> <span class="kd">func</span> <span class="n">recordMicroseconds</span><span class="o"><</span><span class="kt">DataType</span><span class="o">></span><span class="p">(</span><span class="n">_</span> <span class="nv">duration</span><span class="p">:</span> <span class="kt">DataType</span><span class="p">)</span> <span class="k">where</span> <span class="kt">DataType</span> <span class="p">:</span> <span class="kt">BinaryFloatingPoint</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>value</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>Duration to record.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="slightly-smaller">
|
|
<a href="https://github.com/apple/swift-metrics/tree/1.2.0/Sources/CoreMetrics/Metrics.swift#L278-L280">Show on GitHub</a>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:11CoreMetrics5TimerC18recordMillisecondsyyxSzRzlF"></a>
|
|
<a name="//apple_ref/swift/Method/recordMilliseconds(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:11CoreMetrics5TimerC18recordMillisecondsyyxSzRzlF">recordMilliseconds(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Record a duration in milliseconds.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">@inlinable</span>
|
|
<span class="kd">public</span> <span class="kd">func</span> <span class="n">recordMilliseconds</span><span class="o"><</span><span class="kt">DataType</span><span class="o">></span><span class="p">(</span><span class="n">_</span> <span class="nv">duration</span><span class="p">:</span> <span class="kt">DataType</span><span class="p">)</span> <span class="k">where</span> <span class="kt">DataType</span> <span class="p">:</span> <span class="kt">BinaryInteger</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>value</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>Duration to record.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="slightly-smaller">
|
|
<a href="https://github.com/apple/swift-metrics/tree/1.2.0/Sources/CoreMetrics/Metrics.swift#L287-L296">Show on GitHub</a>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:11CoreMetrics5TimerC18recordMillisecondsyyxSBRzlF"></a>
|
|
<a name="//apple_ref/swift/Method/recordMilliseconds(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:11CoreMetrics5TimerC18recordMillisecondsyyxSBRzlF">recordMilliseconds(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Record a duration in milliseconds.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">@inlinable</span>
|
|
<span class="kd">public</span> <span class="kd">func</span> <span class="n">recordMilliseconds</span><span class="o"><</span><span class="kt">DataType</span><span class="o">></span><span class="p">(</span><span class="n">_</span> <span class="nv">duration</span><span class="p">:</span> <span class="kt">DataType</span><span class="p">)</span> <span class="k">where</span> <span class="kt">DataType</span> <span class="p">:</span> <span class="kt">BinaryFloatingPoint</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>value</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>Duration to record.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="slightly-smaller">
|
|
<a href="https://github.com/apple/swift-metrics/tree/1.2.0/Sources/CoreMetrics/Metrics.swift#L303-L305">Show on GitHub</a>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:11CoreMetrics5TimerC13recordSecondsyyxSzRzlF"></a>
|
|
<a name="//apple_ref/swift/Method/recordSeconds(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:11CoreMetrics5TimerC13recordSecondsyyxSzRzlF">recordSeconds(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Record a duration in seconds.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">@inlinable</span>
|
|
<span class="kd">public</span> <span class="kd">func</span> <span class="n">recordSeconds</span><span class="o"><</span><span class="kt">DataType</span><span class="o">></span><span class="p">(</span><span class="n">_</span> <span class="nv">duration</span><span class="p">:</span> <span class="kt">DataType</span><span class="p">)</span> <span class="k">where</span> <span class="kt">DataType</span> <span class="p">:</span> <span class="kt">BinaryInteger</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>value</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>Duration to record.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="slightly-smaller">
|
|
<a href="https://github.com/apple/swift-metrics/tree/1.2.0/Sources/CoreMetrics/Metrics.swift#L312-L321">Show on GitHub</a>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:11CoreMetrics5TimerC13recordSecondsyyxSBRzlF"></a>
|
|
<a name="//apple_ref/swift/Method/recordSeconds(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:11CoreMetrics5TimerC13recordSecondsyyxSBRzlF">recordSeconds(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Record a duration in seconds.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">@inlinable</span>
|
|
<span class="kd">public</span> <span class="kd">func</span> <span class="n">recordSeconds</span><span class="o"><</span><span class="kt">DataType</span><span class="o">></span><span class="p">(</span><span class="n">_</span> <span class="nv">duration</span><span class="p">:</span> <span class="kt">DataType</span><span class="p">)</span> <span class="k">where</span> <span class="kt">DataType</span> <span class="p">:</span> <span class="kt">BinaryFloatingPoint</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>value</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>Duration to record.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="slightly-smaller">
|
|
<a href="https://github.com/apple/swift-metrics/tree/1.2.0/Sources/CoreMetrics/Metrics.swift#L328-L330">Show on GitHub</a>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="task-group">
|
|
<div class="task-name-container">
|
|
<a name="/User%20API"></a>
|
|
<a name="//apple_ref/swift/Section/User API" class="dashAnchor"></a>
|
|
<a href="#/User%20API">
|
|
<h3 class="section-name">User API</h3>
|
|
</a>
|
|
</div>
|
|
<ul class="item-container">
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:11CoreMetrics5TimerC5label10dimensionsACSS_SaySS_SStGtcfc"></a>
|
|
<a name="//apple_ref/swift/Method/init(label:dimensions:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:11CoreMetrics5TimerC5label10dimensionsACSS_SaySS_SStGtcfc">init(label:dimensions:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Create a new <code>Timer</code>.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">label</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">dimensions</span><span class="p">:</span> <span class="p">[(</span><span class="kt">String</span><span class="p">,</span> <span class="kt">String</span><span class="p">)]</span> <span class="o">=</span> <span class="p">[])</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>label</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The label for the <code>Timer</code>.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>dimensions</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The dimensions for the <code>Timer</code>.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="slightly-smaller">
|
|
<a href="https://github.com/apple/swift-metrics/tree/1.2.0/Sources/CoreMetrics/Metrics.swift#L185-L188">Show on GitHub</a>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:11CoreMetrics5TimerC5label10dimensions20preferredDisplayUnitACSS_SaySS_SStGAA04TimeH0Otcfc"></a>
|
|
<a name="//apple_ref/swift/Method/init(label:dimensions:preferredDisplayUnit:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:11CoreMetrics5TimerC5label10dimensions20preferredDisplayUnitACSS_SaySS_SStGAA04TimeH0Otcfc">init(label:dimensions:preferredDisplayUnit:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Create a new <code>Timer</code>.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">label</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">dimensions</span><span class="p">:</span> <span class="p">[(</span><span class="kt">String</span><span class="p">,</span> <span class="kt">String</span><span class="p">)]</span> <span class="o">=</span> <span class="p">[],</span> <span class="n">preferredDisplayUnit</span> <span class="nv">displayUnit</span><span class="p">:</span> <span class="kt"><a href="../Enums/TimeUnit.html">TimeUnit</a></span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>label</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The label for the <code>Timer</code>.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>dimensions</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The dimensions for the <code>Timer</code>.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>displayUnit</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A hint to the backend responsible for presenting the data of the preferred display unit. This is not guaranteed to be supported by all backends.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="slightly-smaller">
|
|
<a href="https://github.com/apple/swift-metrics/tree/1.2.0/Sources/CoreMetrics/Metrics.swift#L196-L200">Show on GitHub</a>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:11CoreMetrics5TimerC7destroyyyF"></a>
|
|
<a name="//apple_ref/swift/Method/destroy()" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:11CoreMetrics5TimerC7destroyyyF">destroy()</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Signal the underlying metrics library that this timer will never be updated again.
|
|
In response the library MAY decide to eagerly release any resources held by this <code>Timer</code>.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">@inlinable</span>
|
|
<span class="kd">func</span> <span class="nf">destroy</span><span class="p">()</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="slightly-smaller">
|
|
<a href="https://github.com/apple/swift-metrics/tree/1.2.0/Sources/CoreMetrics/Metrics.swift#L205-L207">Show on GitHub</a>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
|
|
</article>
|
|
</div>
|
|
<section class="footer">
|
|
<p>© 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-09-30)</p>
|
|
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.10.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
|
</section>
|
|
</body>
|
|
</div>
|
|
</html>
|