swift-metrics/docs/1.2.0/CoreMetrics/Classes/NOOPMetricsHandler.html

489 lines
26 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<title>NOOPMetricsHandler 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/NOOPMetricsHandler" class="dashAnchor"></a>
<a title="NOOPMetricsHandler 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" />
NOOPMetricsHandler 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>NOOPMetricsHandler</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">NOOPMetricsHandler</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/MetricsFactory.html">MetricsFactory</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/CounterHandler.html">CounterHandler</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/RecorderHandler.html">RecorderHandler</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/TimerHandler.html">TimerHandler</a></span></code></pre>
</div>
</div>
<p>Ships with the metrics module, used for initial bootstrapping.</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:11CoreMetrics18NOOPMetricsHandlerC8instanceACvpZ"></a>
<a name="//apple_ref/swift/Variable/instance" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics18NOOPMetricsHandlerC8instanceACvpZ">instance</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="kd">static</span> <span class="k">let</span> <span class="nv">instance</span><span class="p">:</span> <span class="kt">NOOPMetricsHandler</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:11CoreMetrics0B7FactoryP11makeCounter5label10dimensionsAA0E7Handler_pSS_SaySS_SStGtF"></a>
<a name="//apple_ref/swift/Method/makeCounter(label:dimensions:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP11makeCounter5label10dimensionsAA0E7Handler_pSS_SaySS_SStGtF">makeCounter(label:dimensions:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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="kd">func</span> <span class="nf">makeCounter</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">-&gt;</span> <span class="kt"><a href="../Protocols/CounterHandler.html">CounterHandler</a></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#L603-L605">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP12makeRecorder5label10dimensions9aggregateAA0E7Handler_pSS_SaySS_SStGSbtF"></a>
<a name="//apple_ref/swift/Method/makeRecorder(label:dimensions:aggregate:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP12makeRecorder5label10dimensions9aggregateAA0E7Handler_pSS_SaySS_SStGSbtF">makeRecorder(label:dimensions:aggregate:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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="kd">func</span> <span class="nf">makeRecorder</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">aggregate</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Protocols/RecorderHandler.html">RecorderHandler</a></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#L607-L609">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP9makeTimer5label10dimensionsAA0E7Handler_pSS_SaySS_SStGtF"></a>
<a name="//apple_ref/swift/Method/makeTimer(label:dimensions:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP9makeTimer5label10dimensionsAA0E7Handler_pSS_SaySS_SStGtF">makeTimer(label:dimensions:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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="kd">func</span> <span class="nf">makeTimer</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">-&gt;</span> <span class="kt"><a href="../Protocols/TimerHandler.html">TimerHandler</a></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#L611-L613">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP14destroyCounteryyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyCounter(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP14destroyCounteryyAA0E7Handler_pF">destroyCounter(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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="kd">func</span> <span class="nf">destroyCounter</span><span class="p">(</span><span class="nv">_</span><span class="p">:</span> <span class="kt"><a href="../Protocols/CounterHandler.html">CounterHandler</a></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#L422">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP15destroyRecorderyyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyRecorder(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP15destroyRecorderyyAA0E7Handler_pF">destroyRecorder(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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="kd">func</span> <span class="nf">destroyRecorder</span><span class="p">(</span><span class="nv">_</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RecorderHandler.html">RecorderHandler</a></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#L429">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP12destroyTimeryyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyTimer(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP12destroyTimeryyAA0E7Handler_pF">destroyTimer(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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="kd">func</span> <span class="nf">destroyTimer</span><span class="p">(</span><span class="nv">_</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 class="slightly-smaller">
<a href="https://github.com/apple/swift-metrics/tree/1.2.0/Sources/CoreMetrics/Metrics.swift#L436">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics14CounterHandlerP9increment2byys5Int64V_tF"></a>
<a name="//apple_ref/swift/Method/increment(by:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics14CounterHandlerP9increment2byys5Int64V_tF">increment(by:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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="kd">func</span> <span class="nf">increment</span><span class="p">(</span><span class="nv">by</span><span class="p">:</span> <span class="kt">Int64</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#L455">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics14CounterHandlerP5resetyyF"></a>
<a name="//apple_ref/swift/Method/reset()" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics14CounterHandlerP5resetyyF">reset()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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="kd">func</span> <span class="nf">reset</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#L458">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics15RecorderHandlerP6recordyys5Int64VF"></a>
<a name="//apple_ref/swift/Method/record(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics15RecorderHandlerP6recordyys5Int64VF">record(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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="kd">func</span> <span class="nf">record</span><span class="p">(</span><span class="nv">_</span><span class="p">:</span> <span class="kt">Int64</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#L477">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics15RecorderHandlerP6recordyySdF"></a>
<a name="//apple_ref/swift/Method/record(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics15RecorderHandlerP6recordyySdF">record(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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="kd">func</span> <span class="nf">record</span><span class="p">(</span><span class="nv">_</span><span class="p">:</span> <span class="kt">Double</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#L482">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics12TimerHandlerP17recordNanosecondsyys5Int64VF"></a>
<a name="//apple_ref/swift/Method/recordNanoseconds(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics12TimerHandlerP17recordNanosecondsyys5Int64VF">recordNanoseconds(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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="kd">func</span> <span class="nf">recordNanoseconds</span><span class="p">(</span><span class="nv">_</span><span class="p">:</span> <span class="kt">Int64</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#L501">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>&copy; 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>