/
package-info.java
94 lines (93 loc) · 2.99 KB
/
package-info.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
/*
**********************************************************************
* Copyright (c) 2017, 2019 Contributors to the Eclipse Foundation
*
* See the NOTICES file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* You may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
**********************************************************************/
/**
* <p>
* This package contains the annotations used for MicroProfile Metrics.
*
* <h2>Metric Annotation</h2>
* <p>
* The {@link org.eclipse.microprofile.metrics.annotation.Metric Metric}
* annotation is used to provide metadata for the metric being injected. If a
* metric with the same name exists in the
* {@link org.eclipse.microprofile.metrics.MetricRegistry MetricRegistry}, the
* metric is returned. Otherwise, a new metric is registered into the
* MetricRegistry along with the metadata provided by the {@literal @}Metric
* annotation.
* <p>
* For example,
*
* <pre>
* <code>
* {@literal @}Inject
* {@literal @}Metric(name="histogram", description="The description")
* public Histogram histogram;
* </code>
* </pre>
*
* <h2>Interceptor Bindings</h2>
* <p>
* MicroProfile Metrics provides interceptor bindings which can be used to
* instrument an application: {@literal @}Counted, {@literal @}Gauge,
* {@literal @}Metered, {@literal @}Timed, {@literal @}SimplyTimed and {@literal @}ConcurrentGauge.
* <p>
* An example using {@literal @}Counted,
*
* <pre>
* <code>
* {@literal @}Counted (name="visitorCount",
* description="The number of visitors to the application")
* public void visit () {
* ...
* }
* </code>
* </pre>
* <p>
* An example using {@literal @}Gauge,
*
* <pre>
* <code>
* {@literal @}Gauge(name = "queueSize")
* public int getQueueSize() {
* return queue.size;
* }
* </code>
* </pre>
*
*
* <h2>CDI Qualifier</h2>
* <p>
* The {@link org.eclipse.microprofile.metrics.annotation.RegistryType
* RegistryType} is used to identify which <code>MetricRegistry</code> (Application, Base, or
* Vendor) should be injected. By default, no <code>RegistryType</code> will
* inject the application <code>MetricRegistry</code>.
*
* <pre>
* <code>
* {@literal @}Inject
* {@literal @}RegistryType(type=MetricRegistry.Type.BASE)
* MetricRegistry baseRegistry;
* </code>
* </pre>
*
*/
@org.osgi.annotation.versioning.Version("2.3")
package org.eclipse.microprofile.metrics.annotation;