You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1204 lines
41 KiB

8 years ago
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1">
  6. <meta name="theme-color" content="#375EAB">
  7. <title>io_prometheus_client - The Go Programming Language</title>
  8. <link type="text/css" rel="stylesheet" href="../../../../../lib/godoc/style.css">
  9. <link rel="stylesheet" href="../../../../../lib/godoc/jquery.treeview.css">
  10. <script type="text/javascript">window.initFuncs = [];</script>
  11. </head>
  12. <body>
  13. <div id='lowframe' style="position: fixed; bottom: 0; left: 0; height: 0; width: 100%; border-top: thin solid grey; background-color: white; overflow: auto;">
  14. ...
  15. </div><!-- #lowframe -->
  16. <div id="topbar" class="wide"><div class="container">
  17. <div class="top-heading" id="heading-wide"><a href="http://localhost:6060/">The Go Programming Language</a></div>
  18. <div class="top-heading" id="heading-narrow"><a href="http://localhost:6060/">Go</a></div>
  19. <a href="index.html#" id="menu-button"><span id="menu-button-arrow">&#9661;</span></a>
  20. <form method="GET" action="http://localhost:6060/search">
  21. <div id="menu">
  22. <a href="http://localhost:6060/doc/">Documents</a>
  23. <a href="http://localhost:6060/pkg/">Packages</a>
  24. <a href="http://localhost:6060/project/">The Project</a>
  25. <a href="http://localhost:6060/help/">Help</a>
  26. <a href="http://localhost:6060/blog/">Blog</a>
  27. <input type="text" id="search" name="q" class="inactive" value="Search" placeholder="Search">
  28. </div>
  29. </form>
  30. </div></div>
  31. <div id="page" class="wide">
  32. <div class="container">
  33. <h1>Package io_prometheus_client</h1>
  34. <div id="nav"></div>
  35. <!--
  36. Copyright 2009 The Go Authors. All rights reserved.
  37. Use of this source code is governed by a BSD-style
  38. license that can be found in the LICENSE file.
  39. -->
  40. <!--
  41. Note: Static (i.e., not template-generated) href and id
  42. attributes start with "pkg-" to make it impossible for
  43. them to conflict with generated attributes (some of which
  44. correspond to Go identifiers).
  45. -->
  46. <script type='text/javascript'>
  47. document.ANALYSIS_DATA = null;
  48. document.CALLGRAPH = null;
  49. </script>
  50. <div id="short-nav">
  51. <dl>
  52. <dd><code>import "github.com/prometheus/client_model/go"</code></dd>
  53. </dl>
  54. <dl>
  55. <dd><a href="index.html#pkg-overview" class="overviewLink">Overview</a></dd>
  56. <dd><a href="index.html#pkg-index" class="indexLink">Index</a></dd>
  57. </dl>
  58. </div>
  59. <!-- The package's Name is printed as title by the top-level template -->
  60. <div id="pkg-overview" class="toggleVisible">
  61. <div class="collapsed">
  62. <h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2>
  63. </div>
  64. <div class="expanded">
  65. <h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2>
  66. <p>
  67. Package io_prometheus_client is a generated protocol buffer package.
  68. </p>
  69. <p>
  70. It is generated from these files:
  71. </p>
  72. <pre>metrics.proto
  73. </pre>
  74. <p>
  75. It has these top-level messages:
  76. </p>
  77. <pre>LabelPair
  78. Gauge
  79. Counter
  80. Quantile
  81. Summary
  82. Untyped
  83. Histogram
  84. Bucket
  85. Metric
  86. MetricFamily
  87. </pre>
  88. </div>
  89. </div>
  90. <div id="pkg-index" class="toggleVisible">
  91. <div class="collapsed">
  92. <h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
  93. </div>
  94. <div class="expanded">
  95. <h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>
  96. <!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
  97. <div id="manual-nav">
  98. <dl>
  99. <dd><a href="index.html#pkg-variables">Variables</a></dd>
  100. <dd><a href="index.html#Bucket">type Bucket</a></dd>
  101. <dd>&nbsp; &nbsp; <a href="index.html#Bucket.GetCumulativeCount">func (m *Bucket) GetCumulativeCount() uint64</a></dd>
  102. <dd>&nbsp; &nbsp; <a href="index.html#Bucket.GetUpperBound">func (m *Bucket) GetUpperBound() float64</a></dd>
  103. <dd>&nbsp; &nbsp; <a href="index.html#Bucket.ProtoMessage">func (*Bucket) ProtoMessage()</a></dd>
  104. <dd>&nbsp; &nbsp; <a href="index.html#Bucket.Reset">func (m *Bucket) Reset()</a></dd>
  105. <dd>&nbsp; &nbsp; <a href="index.html#Bucket.String">func (m *Bucket) String() string</a></dd>
  106. <dd><a href="index.html#Counter">type Counter</a></dd>
  107. <dd>&nbsp; &nbsp; <a href="index.html#Counter.GetValue">func (m *Counter) GetValue() float64</a></dd>
  108. <dd>&nbsp; &nbsp; <a href="index.html#Counter.ProtoMessage">func (*Counter) ProtoMessage()</a></dd>
  109. <dd>&nbsp; &nbsp; <a href="index.html#Counter.Reset">func (m *Counter) Reset()</a></dd>
  110. <dd>&nbsp; &nbsp; <a href="index.html#Counter.String">func (m *Counter) String() string</a></dd>
  111. <dd><a href="index.html#Gauge">type Gauge</a></dd>
  112. <dd>&nbsp; &nbsp; <a href="index.html#Gauge.GetValue">func (m *Gauge) GetValue() float64</a></dd>
  113. <dd>&nbsp; &nbsp; <a href="index.html#Gauge.ProtoMessage">func (*Gauge) ProtoMessage()</a></dd>
  114. <dd>&nbsp; &nbsp; <a href="index.html#Gauge.Reset">func (m *Gauge) Reset()</a></dd>
  115. <dd>&nbsp; &nbsp; <a href="index.html#Gauge.String">func (m *Gauge) String() string</a></dd>
  116. <dd><a href="index.html#Histogram">type Histogram</a></dd>
  117. <dd>&nbsp; &nbsp; <a href="index.html#Histogram.GetBucket">func (m *Histogram) GetBucket() []*Bucket</a></dd>
  118. <dd>&nbsp; &nbsp; <a href="index.html#Histogram.GetSampleCount">func (m *Histogram) GetSampleCount() uint64</a></dd>
  119. <dd>&nbsp; &nbsp; <a href="index.html#Histogram.GetSampleSum">func (m *Histogram) GetSampleSum() float64</a></dd>
  120. <dd>&nbsp; &nbsp; <a href="index.html#Histogram.ProtoMessage">func (*Histogram) ProtoMessage()</a></dd>
  121. <dd>&nbsp; &nbsp; <a href="index.html#Histogram.Reset">func (m *Histogram) Reset()</a></dd>
  122. <dd>&nbsp; &nbsp; <a href="index.html#Histogram.String">func (m *Histogram) String() string</a></dd>
  123. <dd><a href="index.html#LabelPair">type LabelPair</a></dd>
  124. <dd>&nbsp; &nbsp; <a href="index.html#LabelPair.GetName">func (m *LabelPair) GetName() string</a></dd>
  125. <dd>&nbsp; &nbsp; <a href="index.html#LabelPair.GetValue">func (m *LabelPair) GetValue() string</a></dd>
  126. <dd>&nbsp; &nbsp; <a href="index.html#LabelPair.ProtoMessage">func (*LabelPair) ProtoMessage()</a></dd>
  127. <dd>&nbsp; &nbsp; <a href="index.html#LabelPair.Reset">func (m *LabelPair) Reset()</a></dd>
  128. <dd>&nbsp; &nbsp; <a href="index.html#LabelPair.String">func (m *LabelPair) String() string</a></dd>
  129. <dd><a href="index.html#Metric">type Metric</a></dd>
  130. <dd>&nbsp; &nbsp; <a href="index.html#Metric.GetCounter">func (m *Metric) GetCounter() *Counter</a></dd>
  131. <dd>&nbsp; &nbsp; <a href="index.html#Metric.GetGauge">func (m *Metric) GetGauge() *Gauge</a></dd>
  132. <dd>&nbsp; &nbsp; <a href="index.html#Metric.GetHistogram">func (m *Metric) GetHistogram() *Histogram</a></dd>
  133. <dd>&nbsp; &nbsp; <a href="index.html#Metric.GetLabel">func (m *Metric) GetLabel() []*LabelPair</a></dd>
  134. <dd>&nbsp; &nbsp; <a href="index.html#Metric.GetSummary">func (m *Metric) GetSummary() *Summary</a></dd>
  135. <dd>&nbsp; &nbsp; <a href="index.html#Metric.GetTimestampMs">func (m *Metric) GetTimestampMs() int64</a></dd>
  136. <dd>&nbsp; &nbsp; <a href="index.html#Metric.GetUntyped">func (m *Metric) GetUntyped() *Untyped</a></dd>
  137. <dd>&nbsp; &nbsp; <a href="index.html#Metric.ProtoMessage">func (*Metric) ProtoMessage()</a></dd>
  138. <dd>&nbsp; &nbsp; <a href="index.html#Metric.Reset">func (m *Metric) Reset()</a></dd>
  139. <dd>&nbsp; &nbsp; <a href="index.html#Metric.String">func (m *Metric) String() string</a></dd>
  140. <dd><a href="index.html#MetricFamily">type MetricFamily</a></dd>
  141. <dd>&nbsp; &nbsp; <a href="index.html#MetricFamily.GetHelp">func (m *MetricFamily) GetHelp() string</a></dd>
  142. <dd>&nbsp; &nbsp; <a href="index.html#MetricFamily.GetMetric">func (m *MetricFamily) GetMetric() []*Metric</a></dd>
  143. <dd>&nbsp; &nbsp; <a href="index.html#MetricFamily.GetName">func (m *MetricFamily) GetName() string</a></dd>
  144. <dd>&nbsp; &nbsp; <a href="index.html#MetricFamily.GetType">func (m *MetricFamily) GetType() MetricType</a></dd>
  145. <dd>&nbsp; &nbsp; <a href="index.html#MetricFamily.ProtoMessage">func (*MetricFamily) ProtoMessage()</a></dd>
  146. <dd>&nbsp; &nbsp; <a href="index.html#MetricFamily.Reset">func (m *MetricFamily) Reset()</a></dd>
  147. <dd>&nbsp; &nbsp; <a href="index.html#MetricFamily.String">func (m *MetricFamily) String() string</a></dd>
  148. <dd><a href="index.html#MetricType">type MetricType</a></dd>
  149. <dd>&nbsp; &nbsp; <a href="index.html#MetricType.Enum">func (x MetricType) Enum() *MetricType</a></dd>
  150. <dd>&nbsp; &nbsp; <a href="index.html#MetricType.String">func (x MetricType) String() string</a></dd>
  151. <dd>&nbsp; &nbsp; <a href="index.html#MetricType.UnmarshalJSON">func (x *MetricType) UnmarshalJSON(data []byte) error</a></dd>
  152. <dd><a href="index.html#Quantile">type Quantile</a></dd>
  153. <dd>&nbsp; &nbsp; <a href="index.html#Quantile.GetQuantile">func (m *Quantile) GetQuantile() float64</a></dd>
  154. <dd>&nbsp; &nbsp; <a href="index.html#Quantile.GetValue">func (m *Quantile) GetValue() float64</a></dd>
  155. <dd>&nbsp; &nbsp; <a href="index.html#Quantile.ProtoMessage">func (*Quantile) ProtoMessage()</a></dd>
  156. <dd>&nbsp; &nbsp; <a href="index.html#Quantile.Reset">func (m *Quantile) Reset()</a></dd>
  157. <dd>&nbsp; &nbsp; <a href="index.html#Quantile.String">func (m *Quantile) String() string</a></dd>
  158. <dd><a href="index.html#Summary">type Summary</a></dd>
  159. <dd>&nbsp; &nbsp; <a href="index.html#Summary.GetQuantile">func (m *Summary) GetQuantile() []*Quantile</a></dd>
  160. <dd>&nbsp; &nbsp; <a href="index.html#Summary.GetSampleCount">func (m *Summary) GetSampleCount() uint64</a></dd>
  161. <dd>&nbsp; &nbsp; <a href="index.html#Summary.GetSampleSum">func (m *Summary) GetSampleSum() float64</a></dd>
  162. <dd>&nbsp; &nbsp; <a href="index.html#Summary.ProtoMessage">func (*Summary) ProtoMessage()</a></dd>
  163. <dd>&nbsp; &nbsp; <a href="index.html#Summary.Reset">func (m *Summary) Reset()</a></dd>
  164. <dd>&nbsp; &nbsp; <a href="index.html#Summary.String">func (m *Summary) String() string</a></dd>
  165. <dd><a href="index.html#Untyped">type Untyped</a></dd>
  166. <dd>&nbsp; &nbsp; <a href="index.html#Untyped.GetValue">func (m *Untyped) GetValue() float64</a></dd>
  167. <dd>&nbsp; &nbsp; <a href="index.html#Untyped.ProtoMessage">func (*Untyped) ProtoMessage()</a></dd>
  168. <dd>&nbsp; &nbsp; <a href="index.html#Untyped.Reset">func (m *Untyped) Reset()</a></dd>
  169. <dd>&nbsp; &nbsp; <a href="index.html#Untyped.String">func (m *Untyped) String() string</a></dd>
  170. </dl>
  171. </div><!-- #manual-nav -->
  172. <h4>Package files</h4>
  173. <p>
  174. <span style="font-size:90%">
  175. <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go">metrics.pb.go</a>
  176. </span>
  177. </p>
  178. </div><!-- .expanded -->
  179. </div><!-- #pkg-index -->
  180. <div id="pkg-callgraph" class="toggle" style="display: none">
  181. <div class="collapsed">
  182. <h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
  183. </div> <!-- .expanded -->
  184. <div class="expanded">
  185. <h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
  186. <p>
  187. In the call graph viewer below, each node
  188. is a function belonging to this package
  189. and its children are the functions it
  190. calls&mdash;perhaps dynamically.
  191. </p>
  192. <p>
  193. The root nodes are the entry points of the
  194. package: functions that may be called from
  195. outside the package.
  196. There may be non-exported or anonymous
  197. functions among them if they are called
  198. dynamically from another package.
  199. </p>
  200. <p>
  201. Click a node to visit that function's source code.
  202. From there you can visit its callers by
  203. clicking its declaring <code>func</code>
  204. token.
  205. </p>
  206. <p>
  207. Functions may be omitted if they were
  208. determined to be unreachable in the
  209. particular programs or tests that were
  210. analyzed.
  211. </p>
  212. <!-- Zero means show all package entry points. -->
  213. <ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
  214. </div>
  215. </div> <!-- #pkg-callgraph -->
  216. <h2 id="pkg-variables">Variables</h2>
  217. <pre>var <span id="MetricType_name">MetricType_name</span> = map[<a href="../../../../builtin/index.html#int32">int32</a>]<a href="../../../../builtin/index.html#string">string</a>{
  218. 0: &#34;COUNTER&#34;,
  219. 1: &#34;GAUGE&#34;,
  220. 2: &#34;SUMMARY&#34;,
  221. 3: &#34;UNTYPED&#34;,
  222. 4: &#34;HISTOGRAM&#34;,
  223. }</pre>
  224. <pre>var <span id="MetricType_value">MetricType_value</span> = map[<a href="../../../../builtin/index.html#string">string</a>]<a href="../../../../builtin/index.html#int32">int32</a>{
  225. &#34;COUNTER&#34;: 0,
  226. &#34;GAUGE&#34;: 1,
  227. &#34;SUMMARY&#34;: 2,
  228. &#34;UNTYPED&#34;: 3,
  229. &#34;HISTOGRAM&#34;: 4,
  230. }</pre>
  231. <h2 id="Bucket">type <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=5622:5891#L224">Bucket</a></h2>
  232. <pre>type Bucket struct {
  233. CumulativeCount *<a href="../../../../builtin/index.html#uint64">uint64</a> `protobuf:&#34;varint,1,opt,name=cumulative_count&#34; json:&#34;cumulative_count,omitempty&#34;`
  234. UpperBound *<a href="../../../../builtin/index.html#float64">float64</a> `protobuf:&#34;fixed64,2,opt,name=upper_bound&#34; json:&#34;upper_bound,omitempty&#34;`
  235. XXX_unrecognized []<a href="../../../../builtin/index.html#byte">byte</a> `json:&#34;-&#34;`
  236. }</pre>
  237. <h3 id="Bucket.GetCumulativeCount">func (*Bucket) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=6052:6096#L234">GetCumulativeCount</a></h3>
  238. <pre>func (m *<a href="index.html#Bucket">Bucket</a>) GetCumulativeCount() <a href="../../../../builtin/index.html#uint64">uint64</a></pre>
  239. <h3 id="Bucket.GetUpperBound">func (*Bucket) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=6186:6226#L241">GetUpperBound</a></h3>
  240. <pre>func (m *<a href="index.html#Bucket">Bucket</a>) GetUpperBound() <a href="../../../../builtin/index.html#float64">float64</a></pre>
  241. <h3 id="Bucket.ProtoMessage">func (*Bucket) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=6015:6044#L232">ProtoMessage</a></h3>
  242. <pre>func (*<a href="index.html#Bucket">Bucket</a>) ProtoMessage()</pre>
  243. <h3 id="Bucket.Reset">func (*Bucket) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=5893:5917#L230">Reset</a></h3>
  244. <pre>func (m *<a href="index.html#Bucket">Bucket</a>) Reset()</pre>
  245. <h3 id="Bucket.String">func (*Bucket) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=5944:5976#L231">String</a></h3>
  246. <pre>func (m *<a href="index.html#Bucket">Bucket</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
  247. <h2 id="Counter">type <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=2410:2559#L104">Counter</a></h2>
  248. <pre>type Counter struct {
  249. Value *<a href="../../../../builtin/index.html#float64">float64</a> `protobuf:&#34;fixed64,1,opt,name=value&#34; json:&#34;value,omitempty&#34;`
  250. XXX_unrecognized []<a href="../../../../builtin/index.html#byte">byte</a> `json:&#34;-&#34;`
  251. }</pre>
  252. <h3 id="Counter.GetValue">func (*Counter) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=2724:2760#L113">GetValue</a></h3>
  253. <pre>func (m *<a href="index.html#Counter">Counter</a>) GetValue() <a href="../../../../builtin/index.html#float64">float64</a></pre>
  254. <h3 id="Counter.ProtoMessage">func (*Counter) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=2686:2716#L111">ProtoMessage</a></h3>
  255. <pre>func (*<a href="index.html#Counter">Counter</a>) ProtoMessage()</pre>
  256. <h3 id="Counter.Reset">func (*Counter) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=2561:2586#L109">Reset</a></h3>
  257. <pre>func (m *<a href="index.html#Counter">Counter</a>) Reset()</pre>
  258. <h3 id="Counter.String">func (*Counter) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=2614:2647#L110">String</a></h3>
  259. <pre>func (m *<a href="index.html#Counter">Counter</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
  260. <h2 id="Gauge">type <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=2002:2149#L88">Gauge</a></h2>
  261. <pre>type Gauge struct {
  262. Value *<a href="../../../../builtin/index.html#float64">float64</a> `protobuf:&#34;fixed64,1,opt,name=value&#34; json:&#34;value,omitempty&#34;`
  263. XXX_unrecognized []<a href="../../../../builtin/index.html#byte">byte</a> `json:&#34;-&#34;`
  264. }</pre>
  265. <h3 id="Gauge.GetValue">func (*Gauge) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=2306:2340#L97">GetValue</a></h3>
  266. <pre>func (m *<a href="index.html#Gauge">Gauge</a>) GetValue() <a href="../../../../builtin/index.html#float64">float64</a></pre>
  267. <h3 id="Gauge.ProtoMessage">func (*Gauge) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=2270:2298#L95">ProtoMessage</a></h3>
  268. <pre>func (*<a href="index.html#Gauge">Gauge</a>) ProtoMessage()</pre>
  269. <h3 id="Gauge.Reset">func (*Gauge) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=2151:2174#L93">Reset</a></h3>
  270. <pre>func (m *<a href="index.html#Gauge">Gauge</a>) Reset()</pre>
  271. <h3 id="Gauge.String">func (*Gauge) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=2200:2231#L94">String</a></h3>
  272. <pre>func (m *<a href="index.html#Gauge">Gauge</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
  273. <h2 id="Histogram">type <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=4755:5109#L192">Histogram</a></h2>
  274. <pre>type Histogram struct {
  275. SampleCount *<a href="../../../../builtin/index.html#uint64">uint64</a> `protobuf:&#34;varint,1,opt,name=sample_count&#34; json:&#34;sample_count,omitempty&#34;`
  276. SampleSum *<a href="../../../../builtin/index.html#float64">float64</a> `protobuf:&#34;fixed64,2,opt,name=sample_sum&#34; json:&#34;sample_sum,omitempty&#34;`
  277. Bucket []*<a href="index.html#Bucket">Bucket</a> `protobuf:&#34;bytes,3,rep,name=bucket&#34; json:&#34;bucket,omitempty&#34;`
  278. XXX_unrecognized []<a href="../../../../builtin/index.html#byte">byte</a> `json:&#34;-&#34;`
  279. }</pre>
  280. <h3 id="Histogram.GetBucket">func (*Histogram) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=5527:5568#L217">GetBucket</a></h3>
  281. <pre>func (m *<a href="index.html#Histogram">Histogram</a>) GetBucket() []*<a href="index.html#Bucket">Bucket</a></pre>
  282. <h3 id="Histogram.GetSampleCount">func (*Histogram) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=5282:5325#L203">GetSampleCount</a></h3>
  283. <pre>func (m *<a href="index.html#Histogram">Histogram</a>) GetSampleCount() <a href="../../../../builtin/index.html#uint64">uint64</a></pre>
  284. <h3 id="Histogram.GetSampleSum">func (*Histogram) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=5407:5449#L210">GetSampleSum</a></h3>
  285. <pre>func (m *<a href="index.html#Histogram">Histogram</a>) GetSampleSum() <a href="../../../../builtin/index.html#float64">float64</a></pre>
  286. <h3 id="Histogram.ProtoMessage">func (*Histogram) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=5242:5274#L201">ProtoMessage</a></h3>
  287. <pre>func (*<a href="index.html#Histogram">Histogram</a>) ProtoMessage()</pre>
  288. <h3 id="Histogram.Reset">func (*Histogram) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=5111:5138#L199">Reset</a></h3>
  289. <pre>func (m *<a href="index.html#Histogram">Histogram</a>) Reset()</pre>
  290. <h3 id="Histogram.String">func (*Histogram) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=5168:5203#L200">String</a></h3>
  291. <pre>func (m *<a href="index.html#Histogram">Histogram</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
  292. <h2 id="LabelPair">type <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=1386:1616#L64">LabelPair</a></h2>
  293. <pre>type LabelPair struct {
  294. Name *<a href="../../../../builtin/index.html#string">string</a> `protobuf:&#34;bytes,1,opt,name=name&#34; json:&#34;name,omitempty&#34;`
  295. Value *<a href="../../../../builtin/index.html#string">string</a> `protobuf:&#34;bytes,2,opt,name=value&#34; json:&#34;value,omitempty&#34;`
  296. XXX_unrecognized []<a href="../../../../builtin/index.html#byte">byte</a> `json:&#34;-&#34;`
  297. }</pre>
  298. <h3 id="LabelPair.GetName">func (*LabelPair) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=1789:1825#L74">GetName</a></h3>
  299. <pre>func (m *<a href="index.html#LabelPair">LabelPair</a>) GetName() <a href="../../../../builtin/index.html#string">string</a></pre>
  300. <h3 id="LabelPair.GetValue">func (*LabelPair) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=1894:1931#L81">GetValue</a></h3>
  301. <pre>func (m *<a href="index.html#LabelPair">LabelPair</a>) GetValue() <a href="../../../../builtin/index.html#string">string</a></pre>
  302. <h3 id="LabelPair.ProtoMessage">func (*LabelPair) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=1749:1781#L72">ProtoMessage</a></h3>
  303. <pre>func (*<a href="index.html#LabelPair">LabelPair</a>) ProtoMessage()</pre>
  304. <h3 id="LabelPair.Reset">func (*LabelPair) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=1618:1645#L70">Reset</a></h3>
  305. <pre>func (m *<a href="index.html#LabelPair">LabelPair</a>) Reset()</pre>
  306. <h3 id="LabelPair.String">func (*LabelPair) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=1675:1710#L71">String</a></h3>
  307. <pre>func (m *<a href="index.html#LabelPair">LabelPair</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
  308. <h2 id="Metric">type <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=6306:7035#L248">Metric</a></h2>
  309. <pre>type Metric struct {
  310. Label []*<a href="index.html#LabelPair">LabelPair</a> `protobuf:&#34;bytes,1,rep,name=label&#34; json:&#34;label,omitempty&#34;`
  311. Gauge *<a href="index.html#Gauge">Gauge</a> `protobuf:&#34;bytes,2,opt,name=gauge&#34; json:&#34;gauge,omitempty&#34;`
  312. Counter *<a href="index.html#Counter">Counter</a> `protobuf:&#34;bytes,3,opt,name=counter&#34; json:&#34;counter,omitempty&#34;`
  313. Summary *<a href="index.html#Summary">Summary</a> `protobuf:&#34;bytes,4,opt,name=summary&#34; json:&#34;summary,omitempty&#34;`
  314. Untyped *<a href="index.html#Untyped">Untyped</a> `protobuf:&#34;bytes,5,opt,name=untyped&#34; json:&#34;untyped,omitempty&#34;`
  315. Histogram *<a href="index.html#Histogram">Histogram</a> `protobuf:&#34;bytes,7,opt,name=histogram&#34; json:&#34;histogram,omitempty&#34;`
  316. TimestampMs *<a href="../../../../builtin/index.html#int64">int64</a> `protobuf:&#34;varint,6,opt,name=timestamp_ms&#34; json:&#34;timestamp_ms,omitempty&#34;`
  317. XXX_unrecognized []<a href="../../../../builtin/index.html#byte">byte</a> `json:&#34;-&#34;`
  318. }</pre>
  319. <h3 id="Metric.GetCounter">func (*Metric) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=7376:7414#L277">GetCounter</a></h3>
  320. <pre>func (m *<a href="index.html#Metric">Metric</a>) GetCounter() *<a href="index.html#Counter">Counter</a></pre>
  321. <h3 id="Metric.GetGauge">func (*Metric) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=7289:7323#L270">GetGauge</a></h3>
  322. <pre>func (m *<a href="index.html#Metric">Metric</a>) GetGauge() *<a href="index.html#Gauge">Gauge</a></pre>
  323. <h3 id="Metric.GetHistogram">func (*Metric) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=7655:7697#L298">GetHistogram</a></h3>
  324. <pre>func (m *<a href="index.html#Metric">Metric</a>) GetHistogram() *<a href="index.html#Histogram">Histogram</a></pre>
  325. <h3 id="Metric.GetLabel">func (*Metric) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=7196:7236#L263">GetLabel</a></h3>
  326. <pre>func (m *<a href="index.html#Metric">Metric</a>) GetLabel() []*<a href="index.html#LabelPair">LabelPair</a></pre>
  327. <h3 id="Metric.GetSummary">func (*Metric) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=7469:7507#L284">GetSummary</a></h3>
  328. <pre>func (m *<a href="index.html#Metric">Metric</a>) GetSummary() *<a href="index.html#Summary">Summary</a></pre>
  329. <h3 id="Metric.GetTimestampMs">func (*Metric) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=7754:7793#L305">GetTimestampMs</a></h3>
  330. <pre>func (m *<a href="index.html#Metric">Metric</a>) GetTimestampMs() <a href="../../../../builtin/index.html#int64">int64</a></pre>
  331. <h3 id="Metric.GetUntyped">func (*Metric) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=7562:7600#L291">GetUntyped</a></h3>
  332. <pre>func (m *<a href="index.html#Metric">Metric</a>) GetUntyped() *<a href="index.html#Untyped">Untyped</a></pre>
  333. <h3 id="Metric.ProtoMessage">func (*Metric) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=7159:7188#L261">ProtoMessage</a></h3>
  334. <pre>func (*<a href="index.html#Metric">Metric</a>) ProtoMessage()</pre>
  335. <h3 id="Metric.Reset">func (*Metric) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=7037:7061#L259">Reset</a></h3>
  336. <pre>func (m *<a href="index.html#Metric">Metric</a>) Reset()</pre>
  337. <h3 id="Metric.String">func (*Metric) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=7088:7120#L260">String</a></h3>
  338. <pre>func (m *<a href="index.html#Metric">Metric</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
  339. <h2 id="MetricFamily">type <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=7875:8334#L312">MetricFamily</a></h2>
  340. <pre>type MetricFamily struct {
  341. Name *<a href="../../../../builtin/index.html#string">string</a> `protobuf:&#34;bytes,1,opt,name=name&#34; json:&#34;name,omitempty&#34;`
  342. Help *<a href="../../../../builtin/index.html#string">string</a> `protobuf:&#34;bytes,2,opt,name=help&#34; json:&#34;help,omitempty&#34;`
  343. Type *<a href="index.html#MetricType">MetricType</a> `protobuf:&#34;varint,3,opt,name=type,enum=io.prometheus.client.MetricType&#34; json:&#34;type,omitempty&#34;`
  344. Metric []*<a href="index.html#Metric">Metric</a> `protobuf:&#34;bytes,4,rep,name=metric&#34; json:&#34;metric,omitempty&#34;`
  345. XXX_unrecognized []<a href="../../../../builtin/index.html#byte">byte</a> `json:&#34;-&#34;`
  346. }</pre>
  347. <h3 id="MetricFamily.GetHelp">func (*MetricFamily) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=8627:8666#L331">GetHelp</a></h3>
  348. <pre>func (m *<a href="index.html#MetricFamily">MetricFamily</a>) GetHelp() <a href="../../../../builtin/index.html#string">string</a></pre>
  349. <h3 id="MetricFamily.GetMetric">func (*MetricFamily) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=8863:8907#L345">GetMetric</a></h3>
  350. <pre>func (m *<a href="index.html#MetricFamily">MetricFamily</a>) GetMetric() []*<a href="index.html#Metric">Metric</a></pre>
  351. <h3 id="MetricFamily.GetName">func (*MetricFamily) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=8519:8558#L324">GetName</a></h3>
  352. <pre>func (m *<a href="index.html#MetricFamily">MetricFamily</a>) GetName() <a href="../../../../builtin/index.html#string">string</a></pre>
  353. <h3 id="MetricFamily.GetType">func (*MetricFamily) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=8735:8778#L338">GetType</a></h3>
  354. <pre>func (m *<a href="index.html#MetricFamily">MetricFamily</a>) GetType() <a href="index.html#MetricType">MetricType</a></pre>
  355. <h3 id="MetricFamily.ProtoMessage">func (*MetricFamily) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=8476:8511#L322">ProtoMessage</a></h3>
  356. <pre>func (*<a href="index.html#MetricFamily">MetricFamily</a>) ProtoMessage()</pre>
  357. <h3 id="MetricFamily.Reset">func (*MetricFamily) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=8336:8366#L320">Reset</a></h3>
  358. <pre>func (m *<a href="index.html#MetricFamily">MetricFamily</a>) Reset()</pre>
  359. <h3 id="MetricFamily.String">func (*MetricFamily) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=8399:8437#L321">String</a></h3>
  360. <pre>func (m *<a href="index.html#MetricFamily">MetricFamily</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
  361. <h2 id="MetricType">type <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=543:564#L22">MetricType</a></h2>
  362. <pre>type MetricType <a href="../../../../builtin/index.html#int32">int32</a></pre>
  363. <pre>const (
  364. <span id="MetricType_COUNTER">MetricType_COUNTER</span> <a href="index.html#MetricType">MetricType</a> = 0
  365. <span id="MetricType_GAUGE">MetricType_GAUGE</span> <a href="index.html#MetricType">MetricType</a> = 1
  366. <span id="MetricType_SUMMARY">MetricType_SUMMARY</span> <a href="index.html#MetricType">MetricType</a> = 2
  367. <span id="MetricType_UNTYPED">MetricType_UNTYPED</span> <a href="index.html#MetricType">MetricType</a> = 3
  368. <span id="MetricType_HISTOGRAM">MetricType_HISTOGRAM</span> <a href="index.html#MetricType">MetricType</a> = 4
  369. )</pre>
  370. <h3 id="MetricType.Enum">func (MetricType) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=1008:1046#L47">Enum</a></h3>
  371. <pre>func (x <a href="index.html#MetricType">MetricType</a>) Enum() *<a href="index.html#MetricType">MetricType</a></pre>
  372. <h3 id="MetricType.String">func (MetricType) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=1091:1126#L52">String</a></h3>
  373. <pre>func (x <a href="index.html#MetricType">MetricType</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
  374. <h3 id="MetricType.UnmarshalJSON">func (*MetricType) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=1181:1234#L55">UnmarshalJSON</a></h3>
  375. <pre>func (x *<a href="index.html#MetricType">MetricType</a>) UnmarshalJSON(data []<a href="../../../../builtin/index.html#byte">byte</a>) <a href="../../../../builtin/index.html#error">error</a></pre>
  376. <h2 id="Quantile">type <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=2830:3074#L120">Quantile</a></h2>
  377. <pre>type Quantile struct {
  378. Quantile *<a href="../../../../builtin/index.html#float64">float64</a> `protobuf:&#34;fixed64,1,opt,name=quantile&#34; json:&#34;quantile,omitempty&#34;`
  379. Value *<a href="../../../../builtin/index.html#float64">float64</a> `protobuf:&#34;fixed64,2,opt,name=value&#34; json:&#34;value,omitempty&#34;`
  380. XXX_unrecognized []<a href="../../../../builtin/index.html#byte">byte</a> `json:&#34;-&#34;`
  381. }</pre>
  382. <h3 id="Quantile.GetQuantile">func (*Quantile) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=3243:3283#L130">GetQuantile</a></h3>
  383. <pre>func (m *<a href="index.html#Quantile">Quantile</a>) GetQuantile() <a href="../../../../builtin/index.html#float64">float64</a></pre>
  384. <h3 id="Quantile.GetValue">func (*Quantile) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=3359:3396#L137">GetValue</a></h3>
  385. <pre>func (m *<a href="index.html#Quantile">Quantile</a>) GetValue() <a href="../../../../builtin/index.html#float64">float64</a></pre>
  386. <h3 id="Quantile.ProtoMessage">func (*Quantile) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=3204:3235#L128">ProtoMessage</a></h3>
  387. <pre>func (*<a href="index.html#Quantile">Quantile</a>) ProtoMessage()</pre>
  388. <h3 id="Quantile.Reset">func (*Quantile) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=3076:3102#L126">Reset</a></h3>
  389. <pre>func (m *<a href="index.html#Quantile">Quantile</a>) Reset()</pre>
  390. <h3 id="Quantile.String">func (*Quantile) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=3131:3165#L127">String</a></h3>
  391. <pre>func (m *<a href="index.html#Quantile">Quantile</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
  392. <h2 id="Summary">type <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=3466:3830#L144">Summary</a></h2>
  393. <pre>type Summary struct {
  394. SampleCount *<a href="../../../../builtin/index.html#uint64">uint64</a> `protobuf:&#34;varint,1,opt,name=sample_count&#34; json:&#34;sample_count,omitempty&#34;`
  395. SampleSum *<a href="../../../../builtin/index.html#float64">float64</a> `protobuf:&#34;fixed64,2,opt,name=sample_sum&#34; json:&#34;sample_sum,omitempty&#34;`
  396. Quantile []*<a href="index.html#Quantile">Quantile</a> `protobuf:&#34;bytes,3,rep,name=quantile&#34; json:&#34;quantile,omitempty&#34;`
  397. XXX_unrecognized []<a href="../../../../builtin/index.html#byte">byte</a> `json:&#34;-&#34;`
  398. }</pre>
  399. <h3 id="Summary.GetQuantile">func (*Summary) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=4236:4279#L169">GetQuantile</a></h3>
  400. <pre>func (m *<a href="index.html#Summary">Summary</a>) GetQuantile() []*<a href="index.html#Quantile">Quantile</a></pre>
  401. <h3 id="Summary.GetSampleCount">func (*Summary) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=3995:4036#L155">GetSampleCount</a></h3>
  402. <pre>func (m *<a href="index.html#Summary">Summary</a>) GetSampleCount() <a href="../../../../builtin/index.html#uint64">uint64</a></pre>
  403. <h3 id="Summary.GetSampleSum">func (*Summary) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=4118:4158#L162">GetSampleSum</a></h3>
  404. <pre>func (m *<a href="index.html#Summary">Summary</a>) GetSampleSum() <a href="../../../../builtin/index.html#float64">float64</a></pre>
  405. <h3 id="Summary.ProtoMessage">func (*Summary) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=3957:3987#L153">ProtoMessage</a></h3>
  406. <pre>func (*<a href="index.html#Summary">Summary</a>) ProtoMessage()</pre>
  407. <h3 id="Summary.Reset">func (*Summary) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=3832:3857#L151">Reset</a></h3>
  408. <pre>func (m *<a href="index.html#Summary">Summary</a>) Reset()</pre>
  409. <h3 id="Summary.String">func (*Summary) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=3885:3918#L152">String</a></h3>
  410. <pre>func (m *<a href="index.html#Summary">Summary</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
  411. <h2 id="Untyped">type <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=4335:4484#L176">Untyped</a></h2>
  412. <pre>type Untyped struct {
  413. Value *<a href="../../../../builtin/index.html#float64">float64</a> `protobuf:&#34;fixed64,1,opt,name=value&#34; json:&#34;value,omitempty&#34;`
  414. XXX_unrecognized []<a href="../../../../builtin/index.html#byte">byte</a> `json:&#34;-&#34;`
  415. }</pre>
  416. <h3 id="Untyped.GetValue">func (*Untyped) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=4649:4685#L185">GetValue</a></h3>
  417. <pre>func (m *<a href="index.html#Untyped">Untyped</a>) GetValue() <a href="../../../../builtin/index.html#float64">float64</a></pre>
  418. <h3 id="Untyped.ProtoMessage">func (*Untyped) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=4611:4641#L183">ProtoMessage</a></h3>
  419. <pre>func (*<a href="index.html#Untyped">Untyped</a>) ProtoMessage()</pre>
  420. <h3 id="Untyped.Reset">func (*Untyped) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=4486:4511#L181">Reset</a></h3>
  421. <pre>func (m *<a href="index.html#Untyped">Untyped</a>) Reset()</pre>
  422. <h3 id="Untyped.String">func (*Untyped) <a href="http://localhost:6060/src/github.com/prometheus/client_model/go/metrics.pb.go?s=4539:4572#L182">String</a></h3>
  423. <pre>func (m *<a href="index.html#Untyped">Untyped</a>) String() <a href="../../../../builtin/index.html#string">string</a></pre>
  424. <div id="footer">
  425. Build version go1.6.<br>
  426. Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
  427. the content of this page is licensed under the
  428. Creative Commons Attribution 3.0 License,
  429. and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
  430. <a href="http://localhost:6060/doc/tos.html">Terms of Service</a> |
  431. <a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
  432. </div>
  433. </div><!-- .container -->
  434. </div><!-- #page -->
  435. <!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
  436. <script type="text/javascript" src="../../../../../lib/godoc/jquery.js"></script>
  437. <script type="text/javascript" src="../../../../../lib/godoc/jquery.treeview.js"></script>
  438. <script type="text/javascript" src="../../../../../lib/godoc/jquery.treeview.edit.js"></script>
  439. <script type="text/javascript" src="../../../../../lib/godoc/godocs.js"></script>
  440. </body>
  441. </html>