-
Notifications
You must be signed in to change notification settings - Fork 491
Spring boot package [Audit events - data stream] #2977
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
sunny-elastic
merged 10 commits into
elastic:main
from
sunny-elastic:package_spring_boot_audit_events
Apr 14, 2022
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
1c92a0a
Spring boot package [Audit events - data stream]
sunny-elastic 5991162
Merge branch 'elastic:main' into package_spring_boot_audit_events
sunny-elastic 68f8bf1
Merge branch 'elastic:main' into package_spring_boot_audit_events
yug-rajani 18ea5e7
Update as per review comments
sunny-elastic f01d922
update README.md
sunny-elastic 24b9bf6
Merge branch 'elastic:main' into package_spring_boot_audit_events
sunny-elastic faa8a8a
update CODEOWNERS and manifest
sunny-elastic 1fbfd99
updated code according to review comments
sunny-elastic 8657727
updated README.md
sunny-elastic a0c75e6
update git ecs version
sunny-elastic File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
dependencies: | ||
ecs: | ||
reference: [email protected] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Spring Boot integration | ||
|
||
The Spring Boot integration is used to fetch observability data from [Spring Boot Actuator web endpoints](https://docs.spring.io/spring-boot/docs/2.6.3/actuator-api/htmlsingle/) and ingest it into Elasticsearch. | ||
|
||
## Compatibility | ||
|
||
This integration has been tested against Spring Boot v2.3.12. | ||
|
||
## Requirements | ||
|
||
In order to ingest data from Spring Boot: | ||
- You must know the host for Spring Boot application, add that host while configuring the integration package. | ||
- Add default path for jolokia. | ||
- Spring-boot-actuator module provides all Spring Boot’s production-ready features. So add below dependency in `pom.xml` file. | ||
``` | ||
<dependency> | ||
<groupId>org.springframework.boot</groupId> | ||
<artifactId>spring-boot-starter-actuator</artifactId> | ||
</dependency> | ||
``` | ||
- For access of jolokia add below dependency in `pom.xml` of Spring Boot Application. | ||
``` | ||
<dependency> | ||
<groupId>org.jolokia</groupId> | ||
<artifactId>jolokia-core</artifactId> | ||
</dependency> | ||
``` | ||
|
||
## Logs | ||
|
||
### Audit Events logs | ||
|
||
This is the `audit_events` data stream. | ||
|
||
- This data stream exposes audit events information for the current application. | ||
|
||
{{event "audit_events"}} | ||
|
||
{{fields "audit_events"}} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
FROM maven:3.8.4-openjdk-8 | ||
RUN mkdir -p /build | ||
RUN chmod -R 777 /build | ||
WORKDIR /build | ||
COPY ./spring_boot/ /build/spring_boot/ | ||
WORKDIR /build/spring_boot | ||
RUN mvn package | ||
HEALTHCHECK --interval=1s --retries=90 CMD curl -f http://actuator:actuator@springboot:8090/actuator/info | ||
ENTRYPOINT ["java","-jar","/build/spring_boot/target/actuator-0.0.1-Release.jar"] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
version: '2.3' | ||
services: | ||
spring_boot: | ||
build: . | ||
hostname: springboot | ||
ports: | ||
- 8090 |
225 changes: 225 additions & 0 deletions
225
packages/spring_boot/_dev/deploy/docker/spring_boot/mvnw
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,225 @@ | ||
#!/bin/sh | ||
# ---------------------------------------------------------------------------- | ||
# Licensed to the Apache Software Foundation (ASF) under one | ||
# or more contributor license agreements. See the NOTICE file | ||
# distributed with this work for additional information | ||
# regarding copyright ownership. The ASF licenses this file | ||
# to you 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. | ||
# ---------------------------------------------------------------------------- | ||
|
||
# ---------------------------------------------------------------------------- | ||
# Maven2 Start Up Batch script | ||
# | ||
# Required ENV vars: | ||
# ------------------ | ||
# JAVA_HOME - location of a JDK home dir | ||
# | ||
# Optional ENV vars | ||
# ----------------- | ||
# M2_HOME - location of maven2's installed home dir | ||
# MAVEN_OPTS - parameters passed to the Java VM when running Maven | ||
# e.g. to debug Maven itself, use | ||
# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 | ||
# MAVEN_SKIP_RC - flag to disable loading of mavenrc files | ||
# ---------------------------------------------------------------------------- | ||
|
||
if [ -z "$MAVEN_SKIP_RC" ] ; then | ||
|
||
if [ -f /etc/mavenrc ] ; then | ||
. /etc/mavenrc | ||
fi | ||
|
||
if [ -f "$HOME/.mavenrc" ] ; then | ||
. "$HOME/.mavenrc" | ||
fi | ||
|
||
fi | ||
|
||
# OS specific support. $var _must_ be set to either true or false. | ||
cygwin=false; | ||
darwin=false; | ||
mingw=false | ||
case "`uname`" in | ||
CYGWIN*) cygwin=true ;; | ||
MINGW*) mingw=true;; | ||
Darwin*) darwin=true | ||
# Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home | ||
# See https://developer.apple.com/library/mac/qa/qa1170/_index.html | ||
if [ -z "$JAVA_HOME" ]; then | ||
if [ -x "/usr/libexec/java_home" ]; then | ||
export JAVA_HOME="`/usr/libexec/java_home`" | ||
else | ||
export JAVA_HOME="/Library/Java/Home" | ||
fi | ||
fi | ||
;; | ||
esac | ||
|
||
if [ -z "$JAVA_HOME" ] ; then | ||
if [ -r /etc/gentoo-release ] ; then | ||
JAVA_HOME=`java-config --jre-home` | ||
fi | ||
fi | ||
|
||
if [ -z "$M2_HOME" ] ; then | ||
## resolve links - $0 may be a link to maven's home | ||
PRG="$0" | ||
|
||
# need this for relative symlinks | ||
while [ -h "$PRG" ] ; do | ||
ls=`ls -ld "$PRG"` | ||
link=`expr "$ls" : '.*-> \(.*\)$'` | ||
if expr "$link" : '/.*' > /dev/null; then | ||
PRG="$link" | ||
else | ||
PRG="`dirname "$PRG"`/$link" | ||
fi | ||
done | ||
|
||
saveddir=`pwd` | ||
|
||
M2_HOME=`dirname "$PRG"`/.. | ||
|
||
# make it fully qualified | ||
M2_HOME=`cd "$M2_HOME" && pwd` | ||
|
||
cd "$saveddir" | ||
# echo Using m2 at $M2_HOME | ||
fi | ||
|
||
# For Cygwin, ensure paths are in UNIX format before anything is touched | ||
if $cygwin ; then | ||
[ -n "$M2_HOME" ] && | ||
M2_HOME=`cygpath --unix "$M2_HOME"` | ||
[ -n "$JAVA_HOME" ] && | ||
JAVA_HOME=`cygpath --unix "$JAVA_HOME"` | ||
[ -n "$CLASSPATH" ] && | ||
CLASSPATH=`cygpath --path --unix "$CLASSPATH"` | ||
fi | ||
|
||
# For Migwn, ensure paths are in UNIX format before anything is touched | ||
if $mingw ; then | ||
[ -n "$M2_HOME" ] && | ||
M2_HOME="`(cd "$M2_HOME"; pwd)`" | ||
[ -n "$JAVA_HOME" ] && | ||
JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" | ||
# TODO classpath? | ||
fi | ||
|
||
if [ -z "$JAVA_HOME" ]; then | ||
javaExecutable="`which javac`" | ||
if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then | ||
# readlink(1) is not available as standard on Solaris 10. | ||
readLink=`which readlink` | ||
if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then | ||
if $darwin ; then | ||
javaHome="`dirname \"$javaExecutable\"`" | ||
javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" | ||
else | ||
javaExecutable="`readlink -f \"$javaExecutable\"`" | ||
fi | ||
javaHome="`dirname \"$javaExecutable\"`" | ||
javaHome=`expr "$javaHome" : '\(.*\)/bin'` | ||
JAVA_HOME="$javaHome" | ||
export JAVA_HOME | ||
fi | ||
fi | ||
fi | ||
|
||
if [ -z "$JAVACMD" ] ; then | ||
if [ -n "$JAVA_HOME" ] ; then | ||
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then | ||
# IBM's JDK on AIX uses strange locations for the executables | ||
JAVACMD="$JAVA_HOME/jre/sh/java" | ||
else | ||
JAVACMD="$JAVA_HOME/bin/java" | ||
fi | ||
else | ||
JAVACMD="`which java`" | ||
fi | ||
fi | ||
|
||
if [ ! -x "$JAVACMD" ] ; then | ||
echo "Error: JAVA_HOME is not defined correctly." >&2 | ||
echo " We cannot execute $JAVACMD" >&2 | ||
exit 1 | ||
fi | ||
|
||
if [ -z "$JAVA_HOME" ] ; then | ||
echo "Warning: JAVA_HOME environment variable is not set." | ||
fi | ||
|
||
CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher | ||
|
||
# traverses directory structure from process work directory to filesystem root | ||
# first directory with .mvn subdirectory is considered project base directory | ||
find_maven_basedir() { | ||
|
||
if [ -z "$1" ] | ||
then | ||
echo "Path not specified to find_maven_basedir" | ||
return 1 | ||
fi | ||
|
||
basedir="$1" | ||
wdir="$1" | ||
while [ "$wdir" != '/' ] ; do | ||
if [ -d "$wdir"/.mvn ] ; then | ||
basedir=$wdir | ||
break | ||
fi | ||
# workaround for JBEAP-8937 (on Solaris 10/Sparc) | ||
if [ -d "${wdir}" ]; then | ||
wdir=`cd "$wdir/.."; pwd` | ||
fi | ||
# end of workaround | ||
done | ||
echo "${basedir}" | ||
} | ||
|
||
# concatenates all lines of a file | ||
concat_lines() { | ||
if [ -f "$1" ]; then | ||
echo "$(tr -s '\n' ' ' < "$1")" | ||
fi | ||
} | ||
|
||
BASE_DIR=`find_maven_basedir "$(pwd)"` | ||
if [ -z "$BASE_DIR" ]; then | ||
exit 1; | ||
fi | ||
|
||
export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} | ||
echo $MAVEN_PROJECTBASEDIR | ||
MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" | ||
|
||
# For Cygwin, switch paths to Windows format before running java | ||
if $cygwin; then | ||
[ -n "$M2_HOME" ] && | ||
M2_HOME=`cygpath --path --windows "$M2_HOME"` | ||
[ -n "$JAVA_HOME" ] && | ||
JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` | ||
[ -n "$CLASSPATH" ] && | ||
CLASSPATH=`cygpath --path --windows "$CLASSPATH"` | ||
[ -n "$MAVEN_PROJECTBASEDIR" ] && | ||
MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` | ||
fi | ||
|
||
WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain | ||
|
||
exec "$JAVACMD" \ | ||
$MAVEN_OPTS \ | ||
-classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ | ||
"-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ | ||
${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.