blob: 8d69e84a885b0a9f078eea6193f2516e8f8874fe (
plain) (
blame)
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
|
/*
* =========================================================================================
* Copyright © 2013-2015 the kamon project <http://kamon.io/>
*
* 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.
* =========================================================================================
*/
package kamon.annotation;
import java.lang.annotation.*;
/**
* A marker annotation to start a new Segment.
* <p>
* <p>
* Given a method like this:
* <pre><code>
* {@literal @}Segment("coolSegmentName", tags="${'my-cool-tag':'my-cool-value'}")
* public String coolName(String name) {
* return "Hello " + name;
* }
* </code></pre>
* <p>
* <p>
* A new Segment will be created only if in the moment of the method execution exist a TraceContext.
*/
@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Segment {
/**
* @return The Segment's name.
* <p>
* Also, the Segment name can be resolved with an EL expression that evaluates to a String:
* <p>
* <pre>
* {@code
* class Segment {
* private long id;
*
* public long getId() { return id; }
*
* {@literal @}Segment (name = "${'segmentID:' += this.id}")
* void segment() {} // create a Segment with name => segmentID:[id]
* }
* }
* </pre>
*/
String name();
/**
* @return The Segment's category.
*/
String category();
/**
* @return The Segment's library.
*/
String library();
/**
* Tags are a way of adding dimensions to metrics,
* these are constructed using EL syntax e.g. "${'algorithm':'1','env':'production'}"
*
* @return the tags associated to the segment
*/
String tags() default "";
}
|
