swift-metrics/docs/current/CoreMetrics/index.html

159 lines
6.6 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<title>CoreMetrics 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 title="CoreMetrics Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
CoreMetrics 2.2.0 Docs
</a>
(83% documented)
</p>
<div class="header-col--secondary">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</div>
<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" alt="GitHub"/>
View on GitHub
</a>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="dash-feed://https%3A%2F%2Fapple.github.io%2Fswift-metrics%2Fdocs%2F2.2.0%2FCoreMetrics%2Fdocsets%2FCoreMetrics.xml">
<img class="header-icon" src="img/dash.png" alt="Dash"/>
Install in Dash
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="index.html">CoreMetrics Reference</a>
<img class="carat" src="img/carat.png" alt=""/>
CoreMetrics 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/FloatingPointCounter.html">FloatingPointCounter</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>
</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/FloatingPointCounterHandler.html">FloatingPointCounterHandler</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>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/TimeUnit.html">TimeUnit</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1 id='swiftmetrics-docs' class='heading'>SwiftMetrics Docs</h1>
<p>SwiftMetrics is a Swift metrics API package.</p>
<p>To get started with SwiftMetrics, <a href="../CoreMetrics/index.html"><code>import Metrics</code></a>. The most important types are:</p>
<ul>
<li><a href="https://apple.github.io/swift-metrics/docs/current/CoreMetrics/Classes/Counter.html"><code><a href="Classes/Counter.html">Counter</a></code></a></li>
<li><a href="https://apple.github.io/swift-metrics/docs/current/CoreMetrics/Classes/Timer.html"><code><a href="Classes/Timer.html">Timer</a></code></a></li>
<li><a href="https://apple.github.io/swift-metrics/docs/current/CoreMetrics/Classes/Recorder.html"><code><a href="Classes/Recorder.html">Recorder</a></code></a></li>
<li><a href="https://apple.github.io/swift-metrics/docs/current/CoreMetrics/Classes/Gauge.html"><code><a href="Classes/Gauge.html">Gauge</a></code></a></li>
</ul>
<p>SwiftMetrics contains multiple modules:</p>
<ul>
<li><a href="../CoreMetrics/index.html">CoreMetrics</a></li>
<li><a href="../Metrics/index.html">Metrics</a></li>
</ul>
</div>
</section>
</article>
</div>
<section class="footer">
<p>&copy; 2021 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external noopener">SwiftMetrics team</a>. All rights reserved. (Last updated: 2021-12-17)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</body>
</html>