Skip to content
This repository was archived by the owner on Dec 23, 2023. It is now read-only.

Commit 7eb2499

Browse files
authored
spring servlet example. (#1939)
* spring servlet example. * add gradle wrapper jar to fix build error. * rename function and added configurable port number. - also changed opencensus version to fix the maven build error.
1 parent a012a62 commit 7eb2499

File tree

17 files changed

+707
-0
lines changed

17 files changed

+707
-0
lines changed

buildscripts/import-control.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -330,5 +330,6 @@ General guidelines on imports:
330330
<allow pkg="org.apache.log4j"/>
331331
<allow pkg="org.eclipse.jetty"/>
332332
<allow pkg="javax.servlet"/>
333+
<allow pkg="org.springframework"/>
333334
</subpackage>
334335
</import-control>

buildscripts/travis_script

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,11 @@ case "$TASK" in
5454
;;
5555
"BUILD_EXAMPLES_GRADLE")
5656
pushd examples && ./gradlew clean assemble --stacktrace && ./gradlew check && ./gradlew verGJF && popd
57+
pushd examples/spring/servlet && ./gradlew clean assemble --stacktrace && ./gradlew check && ./gradlew verGJF && popd
5758
;;
5859
"BUILD_EXAMPLES_MAVEN")
5960
pushd examples && mvn clean package appassembler:assemble -e && popd
61+
pushd examples/spring/servlet && mvn clean package appassembler:assemble -e && popd
6062
;;
6163
*)
6264
echo "Unknown task $TASK"

examples/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,13 @@
1212
mvn package appassembler:assemble
1313
```
1414

15+
To build Spring Servlet example
16+
```bash
17+
cd spring/servlet
18+
mvn package appassembler:assemble
19+
```
20+
21+
1522
## To run "TagContextExample" use
1623

1724
### Gradle
@@ -162,3 +169,32 @@ Stats are available from Prometheus server running at
162169

163170
You also need to install and start OpenCensus-Agent in order to receive the traces and metrics.
164171
For more information on setting up Agent, see [tutorial](https://opencensus.io/agent/).
172+
173+
## To run Spring HTTP Server and Client
174+
175+
`SpringServletApplication` is a web service application using Spring framework. The application
176+
is instrumented with opencensus simply by incuding opencensus-contrib-spring-starter package.
177+
The instrumentation enables tracing on incoming and outgoing http requests. On receiving GET
178+
request, the server originates multiple GET requests to itself using AsyncRestTemplate on different
179+
endpoint.
180+
181+
Send a http GET request using curl to see the traces on console.
182+
```
183+
curl http://localhost:8080
184+
```
185+
186+
Stats are available from Prometheus server running at
187+
- http://localhost:9090/metrics - for server and client stats
188+
189+
### Gradle
190+
```bash
191+
cd spring/servlet
192+
./gradlew bootRun
193+
```
194+
195+
### Maven
196+
```bash
197+
cd spring/servlet
198+
./target/appassembler/bin/SpringServletApplication
199+
```
200+

examples/spring/servlet/.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.mvn/**
2+
mvn**
3+
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
opencensus.spring.enabled = true
2+
opencensus.spring.trace.publicEndpoint = false
Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
description = 'OpenCensus Examples Spring Servlet'
2+
3+
buildscript {
4+
repositories {
5+
mavenCentral()
6+
mavenLocal()
7+
maven {
8+
url "https://plugins.gradle.org/m2/"
9+
}
10+
}
11+
dependencies {
12+
classpath 'org.springframework.boot:spring-boot-gradle-plugin:2.0.5.RELEASE'
13+
classpath 'com.github.ben-manes:gradle-versions-plugin:0.20.0'
14+
classpath "gradle.plugin.com.github.sherter.google-java-format:google-java-format-gradle-plugin:0.8"
15+
}
16+
}
17+
18+
apply plugin: "checkstyle"
19+
apply plugin: 'com.github.sherter.google-java-format'
20+
apply plugin: 'idea'
21+
apply plugin: 'java'
22+
23+
// Display the version report using: ./gradlew dependencyUpdates
24+
// Also see https://github.com/ben-manes/gradle-versions-plugin.
25+
apply plugin: 'com.github.ben-manes.versions'
26+
27+
repositories {
28+
mavenCentral()
29+
mavenLocal()
30+
}
31+
32+
group = "io.opencensus"
33+
version = "0.24.0-SNAPSHOT" // CURRENT_OPENCENSUS_VERSION
34+
35+
def opencensusVersion = "0.23.0" // LATEST_OPENCENSUS_RELEASE_VERSION
36+
def prometheusVersion = "0.6.0"
37+
def httpasyncclientVersion = "4.1.4"
38+
39+
40+
tasks.withType(JavaCompile) {
41+
sourceCompatibility = '1.8'
42+
targetCompatibility = '1.8'
43+
}
44+
45+
googleJavaFormat {
46+
toolVersion '1.7'
47+
source = 'src/main'
48+
include '**/*.java'
49+
}
50+
51+
verifyGoogleJavaFormat {
52+
source = 'src/main'
53+
include '**/*.java'
54+
}
55+
56+
// Inform IDEs like IntelliJ IDEA, Eclipse or NetBeans about the generated code.
57+
sourceSets {
58+
main {
59+
java {
60+
srcDir 'src'
61+
}
62+
}
63+
}
64+
65+
checkstyle {
66+
configFile = file("$rootDir/../../../buildscripts/checkstyle.xml")
67+
toolVersion = "8.12"
68+
ignoreFailures = false
69+
configProperties["rootDir"] = "$rootDir/../../.."
70+
}
71+
72+
// Disable checkstyle if no java8.
73+
checkstyleMain.source = 'src/main'
74+
checkstyleTest.source = 'src/main'
75+
buildscript {
76+
dependencies {
77+
classpath 'org.springframework.boot:spring-boot-gradle-plugin:2.0.5.RELEASE'
78+
}
79+
}
80+
81+
apply plugin: 'java'
82+
apply plugin: 'org.springframework.boot'
83+
apply plugin: 'io.spring.dependency-management'
84+
85+
bootJar {
86+
mainClassName = 'com.baeldung.Application'
87+
baseName = 'opencensus-examples-spring-servlet'
88+
version = "0.24.0-SNAPSHOT" // CURRENT_OPENCENSUS_VERSION
89+
}
90+
91+
sourceCompatibility = 1.8
92+
targetCompatibility = 1.8
93+
94+
dependencyManagement {
95+
imports {
96+
mavenBom "io.opencensus:opencensus-contrib-spring-starter:${opencensusVersion}"
97+
}
98+
}
99+
100+
dependencies {
101+
compile("io.opencensus:opencensus-contrib-spring-starter:${opencensusVersion}")
102+
103+
compile("io.opencensus:opencensus-exporter-stats-prometheus:${opencensusVersion}",
104+
"io.opencensus:opencensus-exporter-trace-logging:${opencensusVersion}",
105+
"io.prometheus:simpleclient_httpserver:${prometheusVersion}",
106+
"org.apache.httpcomponents:httpasyncclient:${httpasyncclientVersion}")
107+
}
53.1 KB
Binary file not shown.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
distributionBase=GRADLE_USER_HOME
2+
distributionPath=wrapper/dists
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-4.9-bin.zip
4+
zipStoreBase=GRADLE_USER_HOME
5+
zipStorePath=wrapper/dists

examples/spring/servlet/gradlew

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
#!/usr/bin/env sh
2+
3+
##############################################################################
4+
##
5+
## Gradle start up script for UN*X
6+
##
7+
##############################################################################
8+
9+
# Attempt to set APP_HOME
10+
# Resolve links: $0 may be a link
11+
PRG="$0"
12+
# Need this for relative symlinks.
13+
while [ -h "$PRG" ] ; do
14+
ls=`ls -ld "$PRG"`
15+
link=`expr "$ls" : '.*-> \(.*\)$'`
16+
if expr "$link" : '/.*' > /dev/null; then
17+
PRG="$link"
18+
else
19+
PRG=`dirname "$PRG"`"/$link"
20+
fi
21+
done
22+
SAVED="`pwd`"
23+
cd "`dirname \"$PRG\"`/" >/dev/null
24+
APP_HOME="`pwd -P`"
25+
cd "$SAVED" >/dev/null
26+
27+
APP_NAME="Gradle"
28+
APP_BASE_NAME=`basename "$0"`
29+
30+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31+
DEFAULT_JVM_OPTS=""
32+
33+
# Use the maximum available, or set MAX_FD != -1 to use that value.
34+
MAX_FD="maximum"
35+
36+
warn () {
37+
echo "$*"
38+
}
39+
40+
die () {
41+
echo
42+
echo "$*"
43+
echo
44+
exit 1
45+
}
46+
47+
# OS specific support (must be 'true' or 'false').
48+
cygwin=false
49+
msys=false
50+
darwin=false
51+
nonstop=false
52+
case "`uname`" in
53+
CYGWIN* )
54+
cygwin=true
55+
;;
56+
Darwin* )
57+
darwin=true
58+
;;
59+
MINGW* )
60+
msys=true
61+
;;
62+
NONSTOP* )
63+
nonstop=true
64+
;;
65+
esac
66+
67+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68+
69+
# Determine the Java command to use to start the JVM.
70+
if [ -n "$JAVA_HOME" ] ; then
71+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72+
# IBM's JDK on AIX uses strange locations for the executables
73+
JAVACMD="$JAVA_HOME/jre/sh/java"
74+
else
75+
JAVACMD="$JAVA_HOME/bin/java"
76+
fi
77+
if [ ! -x "$JAVACMD" ] ; then
78+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79+
80+
Please set the JAVA_HOME variable in your environment to match the
81+
location of your Java installation."
82+
fi
83+
else
84+
JAVACMD="java"
85+
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86+
87+
Please set the JAVA_HOME variable in your environment to match the
88+
location of your Java installation."
89+
fi
90+
91+
# Increase the maximum file descriptors if we can.
92+
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93+
MAX_FD_LIMIT=`ulimit -H -n`
94+
if [ $? -eq 0 ] ; then
95+
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96+
MAX_FD="$MAX_FD_LIMIT"
97+
fi
98+
ulimit -n $MAX_FD
99+
if [ $? -ne 0 ] ; then
100+
warn "Could not set maximum file descriptor limit: $MAX_FD"
101+
fi
102+
else
103+
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104+
fi
105+
fi
106+
107+
# For Darwin, add options to specify how the application appears in the dock
108+
if $darwin; then
109+
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110+
fi
111+
112+
# For Cygwin, switch paths to Windows format before running java
113+
if $cygwin ; then
114+
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115+
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116+
JAVACMD=`cygpath --unix "$JAVACMD"`
117+
118+
# We build the pattern for arguments to be converted via cygpath
119+
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120+
SEP=""
121+
for dir in $ROOTDIRSRAW ; do
122+
ROOTDIRS="$ROOTDIRS$SEP$dir"
123+
SEP="|"
124+
done
125+
OURCYGPATTERN="(^($ROOTDIRS))"
126+
# Add a user-defined pattern to the cygpath arguments
127+
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128+
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129+
fi
130+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
131+
i=0
132+
for arg in "$@" ; do
133+
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134+
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135+
136+
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137+
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138+
else
139+
eval `echo args$i`="\"$arg\""
140+
fi
141+
i=$((i+1))
142+
done
143+
case $i in
144+
(0) set -- ;;
145+
(1) set -- "$args0" ;;
146+
(2) set -- "$args0" "$args1" ;;
147+
(3) set -- "$args0" "$args1" "$args2" ;;
148+
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149+
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150+
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151+
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152+
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153+
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154+
esac
155+
fi
156+
157+
# Escape application args
158+
save () {
159+
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160+
echo " "
161+
}
162+
APP_ARGS=$(save "$@")
163+
164+
# Collect all arguments for the java command, following the shell quoting and substitution rules
165+
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166+
167+
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168+
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169+
cd "$(dirname "$0")"
170+
fi
171+
172+
exec "$JAVACMD" "$@"

0 commit comments

Comments
 (0)