blob: 8c74029736dccf79b91aff1515bd02e8f81acf21 (
plain)
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
# spring
[![Build Status][travis-image]][travis-url]
[![Windows Build Status][appveyor-image]][appveyor-url]
[![Maven Central][maven-image]][maven-url]
Provides annotation support for projects that use Spring.
## Quickstart
### Add the dependencies to your project.
Replace `SPRING_VERSION` with the version of spring you're using.
For Maven add to your `pom.xml`:
```xml
<dependencies>
<!-- census -->
<dependency>
<groupId>io.opencensus</groupId>
<artifactId>opencensus-api</artifactId>
<version>0.16.1</version>
</dependency>
<dependency>
<groupId>io.opencensus</groupId>
<artifactId>opencensus-contrib-spring</artifactId>
<version>0.16.1</version>
</dependency>
<dependency>
<groupId>io.opencensus</groupId>
<artifactId>opencensus-impl</artifactId>
<version>0.16.1</version>
<scope>runtime</scope>
</dependency>
<!-- spring aspects -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aspects</artifactId>
<version>SPRING_VERSION</version>
<scope>runtime</scope>
</dependency>
</dependencies>
```
For Gradle add to your dependencies:
```gradle
compile 'io.opencensus:opencensus-api:0.16.1'
compile 'io.opencensus:opencensus-contrib-spring:0.16.1'
runtime 'io.opencensus:opencensus-impl:0.16.1'
runtime 'org.springframework:spring-aspects:SPRING_VERSION'
```
### Features
#### Traced Annotation
The `opencensus-contrib-spring` package provides support for a `@Traced` annotation
that can be applied to methods. When applied, the method will be wrapped in a
Span, [https://github.com/census-instrumentation/opencensus-specs/blob/master/trace/Span.md](https://github.com/census-instrumentation/opencensus-specs/blob/master/trace/Span.md)
If the method throws an exception, the `Span` will be marked with a status of `Status.UNKNOWN`
and the stack trace will be added to the span as an annotation.
To enable the `@Traced` annotation, include the `CensusSpringAspect` bean.
```xml
<!-- traces explicit calls to Traced -->
<bean id="censusAspect" class="io.opencensus.contrib.spring.aop.CensusSpringAspect">
<constructor-arg ref="tracer"/>
</bean>
```
#### Database Support
The `opencensus-contrib-spring` package also includes support for tracing database
calls. When database support is included, all calls to `java.sql.PreparedStatement.execute*`
will be wrapped in a Span in the same way that `@Traced` wraps methods.
To enable database support, include the `CensusSpringSqlAspect` bean.
```xml
<!-- traces all SQL calls -->
<bean id="censusSQLAspect" class="io.opencensus.contrib.spring.aop.CensusSpringSqlAspect">
<constructor-arg ref="tracer"/>
</bean>
```
#### Complete Spring XML configuration
The following contains a complete spring xml file to configure `opencensus-contrib-spring`
with support for both `@Traced` and database connection tracing.
**Note:** This example does not include the configuration of any exporters. That will
need to be done separately.
**TBD:*** Include examples of spring with exporters.
```xml
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:aop="http://www.springframework.org/schema/aop"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.2.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">
<aop:aspectj-autoproxy/>
<!-- traces explicit calls to Traced -->
<bean id="censusAspect" class="io.opencensus.contrib.spring.aop.CensusSpringAspect">
<constructor-arg ref="tracer"/>
</bean>
<!-- traces all SQL calls -->
<bean id="censusSQLAspect" class="io.opencensus.contrib.spring.aop.CensusSpringSqlAspect">
<constructor-arg ref="tracer"/>
</bean>
<!-- global tracer -->
<bean id="tracer" class="io.opencensus.trace.Tracing" factory-method="getTracer"/>
</beans>
```
### Traced Usage
Once configured, you can use the `@Traced` annotation to indicate that a method should
be wrapped with a `Span`. By default, `@Traced` will use the name of the method as the
span name. However, `@Traced` supports an optional name attribute to allow a custom
span name to be specified.
```java
@Traced()
void example1() {
// do work
}
// a custom span name can also be provided to Traced
@Traced(name = "custom-span-name")
void example2() {
// do moar work
}
```
#### Notes
`opencensus-contrib-spring` support only enables annotations. You will still need to configure opencensus and register exporters / views.
[travis-image]: https://travis-ci.org/census-instrumentation/opencensus-java.svg?branch=master
[travis-url]: https://travis-ci.org/census-instrumentation/opencensus-java
[appveyor-image]: https://ci.appveyor.com/api/projects/status/hxthmpkxar4jq4be/branch/master?svg=true
[appveyor-url]: https://ci.appveyor.com/project/opencensusjavateam/opencensus-java/branch/master
[maven-image]: https://maven-badges.herokuapp.com/maven-central/io.opencensus/opencensus-contrib-spring/badge.svg
[maven-url]: https://maven-badges.herokuapp.com/maven-central/io.opencensus/opencensus-contrib-spring
#### Java Versions
Java 6 or above is required for using this artifact.
#### About the `aop` package
`opencensus-contrib-spring` makes heavy use of Aspect Oriented Programming [AOP](https://en.wikipedia.org/wiki/Aspect-oriented_programming) to
add behavior to annotations. Fortunately, Spring supports this natively so we can leverage the capabilities they've already built in.
|
