Skip to content

Commit 12007ee

Browse files
committed
acuate: demo with health
1 parent 013ef04 commit 12007ee

23 files changed

+851
-0
lines changed

springboot-actuator-demo/.gitignore

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
HELP.md
2+
.gradle
3+
build/
4+
!gradle/wrapper/gradle-wrapper.jar
5+
!**/src/main/**/build/
6+
!**/src/test/**/build/
7+
8+
### STS ###
9+
.apt_generated
10+
.classpath
11+
.factorypath
12+
.project
13+
.settings
14+
.springBeans
15+
.sts4-cache
16+
17+
### IntelliJ IDEA ###
18+
.idea
19+
*.iws
20+
*.iml
21+
*.ipr
22+
out/
23+
!**/src/main/**/out/
24+
!**/src/test/**/out/
25+
26+
### NetBeans ###
27+
/nbproject/private/
28+
/nbbuild/
29+
/dist/
30+
/nbdist/
31+
/.nb-gradle/
32+
33+
### VS Code ###
34+
.vscode/

springboot-actuator-demo/README.md

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Spring boot with actuator
2+
3+
- [Health](#Health)
4+
5+
---
6+
7+
# Health
8+
9+
3 components are [`db`, `redis`, `custom indicator`]
10+
11+
> Getting started
12+
13+
```bash
14+
// start mysql and redis
15+
$ docker-compose -f tools/compose/mysql-compose.yaml up
16+
$ docker-compose -f tools/compose/redis-compose.yaml up
17+
18+
19+
// start application
20+
$ ./gradlew boot:Run
21+
22+
// request health
23+
$ curl -XGET http://localhost:3000/manage/health | jq .
24+
{
25+
"status": "UP",
26+
"components": {
27+
"custom": {
28+
"status": "UP",
29+
"details": {
30+
"type": "custom indicator"
31+
}
32+
},
33+
"db": {
34+
"status": "UP",
35+
"details": {
36+
"database": "MySQL",
37+
"validationQuery": "isValid()"
38+
}
39+
},
40+
"redis": {
41+
"status": "UP",
42+
"details": {
43+
"version": "5.0.9"
44+
}
45+
}
46+
}
47+
}
48+
```
49+
50+
51+
52+
> application.yaml
53+
54+
```yaml
55+
management:
56+
health:
57+
diskspace:
58+
enabled: false
59+
datasource:
60+
enabled: true
61+
redis:
62+
enabled: true
63+
ping:
64+
enabled: false
65+
endpoint:
66+
health:
67+
show-details: always
68+
endpoints:
69+
web:
70+
# default value is "/actuator"
71+
base-path: /manage
72+
```
73+
74+
75+
76+
77+
78+
79+
---
80+
81+
# References
82+
83+
- [Actuator api docs](https://docs.spring.io/spring-boot/docs/current/actuator-api/html/)
84+
- [Actuator reference docs](https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html)
85+
86+
---
87+
88+
## TODO
89+
90+
- final status is "UP" if running database only. i.e redis health indicator is just observer
91+

springboot-actuator-demo/build.gradle

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
plugins {
2+
id 'org.springframework.boot' version '2.3.3.RELEASE'
3+
id 'io.spring.dependency-management' version '1.0.10.RELEASE'
4+
id 'java'
5+
}
6+
7+
group = 'com.github.zacscoding'
8+
version = '0.0.1-SNAPSHOT'
9+
sourceCompatibility = '1.8'
10+
11+
configurations {
12+
compileOnly {
13+
extendsFrom annotationProcessor
14+
}
15+
}
16+
17+
repositories {
18+
mavenCentral()
19+
}
20+
21+
dependencies {
22+
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
23+
implementation 'org.springframework.boot:spring-boot-starter-data-redis'
24+
implementation 'org.springframework.boot:spring-boot-starter-web'
25+
implementation 'org.springframework.boot:spring-boot-starter-actuator'
26+
compileOnly 'org.projectlombok:lombok'
27+
developmentOnly 'org.springframework.boot:spring-boot-devtools'
28+
runtimeOnly 'mysql:mysql-connector-java'
29+
compile 'com.google.guava:guava:29.0-jre'
30+
annotationProcessor 'org.projectlombok:lombok'
31+
testImplementation('org.springframework.boot:spring-boot-starter-test') {
32+
exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
33+
}
34+
}
35+
36+
test {
37+
useJUnitPlatform()
38+
}
Binary file not shown.
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-6.4.1-bin.zip
4+
zipStoreBase=GRADLE_USER_HOME
5+
zipStorePath=wrapper/dists

springboot-actuator-demo/gradlew

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

0 commit comments

Comments
 (0)