diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..063e4a8 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,3 @@ +[*.{kt,kts}] +ij_kotlin_allow_trailing_comma = false +ij_kotlin_allow_trailing_comma_on_call_site = false diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml new file mode 100644 index 0000000..a7092fa --- /dev/null +++ b/.github/workflows/publish.yaml @@ -0,0 +1,41 @@ +name: Publish +on: + push: + tags: + - '*' + +jobs: + verify: + uses: ./.github/workflows/verify.yaml + publish: + runs-on: ubuntu-latest + needs: [ verify ] + steps: + - uses: actions/checkout@v4 + - name: setup java + uses: graalvm/setup-graalvm@v1 + with: + java-version: "21" + architecture: x64 + distribution: graalvm + cache: 'gradle' + - name: Validate version + run: | + VERSION=${GITHUB_REF#refs/tags/} + if grep -Eq "version\s+=\s+\"${VERSION}\"" ./build.gradle.kts + then + echo "Publishing version '${VERSION}'" + ./gradlew publish + else + echo "Detected tag version '${VERSION}' and version from build.gradle.kts does not match." + exit 1 + fi + - name: Publish + run: ./gradlew publishToCentralPortal + env: + SIGNING_PASSPHRASE: ${{ secrets.SIGNING_PASSPHRASE }} + SIGNING_SECRETKEY: ${{ secrets.SIGNING_SECRETKEY }} + SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }} + SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }} + LIBRARY_GROUP: ${{ vars.LIBRARY_GROUP }} + SIGNING_KEYID: ${{ vars.SIGNING_KEYID }} \ No newline at end of file diff --git a/.github/workflows/verify.yaml b/.github/workflows/verify.yaml new file mode 100644 index 0000000..aea1b54 --- /dev/null +++ b/.github/workflows/verify.yaml @@ -0,0 +1,36 @@ +name: Verify +on: + pull_request: + workflow_call: + push: + branches: ['**'] + # Don't run on tags, publish will call this workflow + tags-ignore: ['**'] + +jobs: + lint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: setup java + uses: graalvm/setup-graalvm@v1 + with: + java-version: "21" + architecture: x64 + distribution: graalvm + cache: 'gradle' + - name: Lint + run: ./gradlew lintKotlin + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: setup java + uses: graalvm/setup-graalvm@v1 + with: + java-version: "21" + architecture: x64 + distribution: graalvm + cache: 'gradle' + - name: Test + run: ./gradlew test \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..edab8d3 --- /dev/null +++ b/.gitignore @@ -0,0 +1,35 @@ +.gradle +/build/ +/modules/**/build/ +!gradle/wrapper/gradle-wrapper.jar + +### Eclipse ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr + +*/lib +out/ +build + +*/report +__pycache__/ +trace.db/ +kubernetes-configuration/istio-release-0.8 +*/logs +*.log +.DS_Store +secret + +build-gradle.properties + +docker-compose.yml diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..5dbd271 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) 2024 Valensas + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..19d904d --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# Valensas Observability + +A simple library to manage observability needs for Spring Boot. + +## Usage + +### Installation + +Include in your `build.gradle.kts`: + +```kotlin + +dependencies { + implementation("com.valensas:observability:$observabilityVersion") +} + +// Needed for dependency version metrics only +plugins { + id("com.valensas.observability-artifacts") version "$observabilityVersion" +} + +tasks.withType { + dependsOn(tasks.getByName("observabilityArtifacts")) +} +``` + +### WebClient metrics + +This feature allows to expose [Micrometer](http://micrometer.io) metrics for [Spring's WebClient](https://docs.spring.io/spring-framework/reference/web/webflux-webclient.html). + +```kotlin +val webClient = WebClient.builder().observationConvention(IntegrationRequestObservationConvention("metric.name")) +``` + +### Feign Micrometer Capability auto configuration + +This feature is automatically enabled when [Feign](https://github.com/OpenFeign/feign) and [Micrometer](http://micrometer.io) +are configured. It enables Micrometer metrics for Feign requests. + +### B3 Header propagation + +Allows for customization of [B3 header propagation](https://github.com/openzipkin/b3-propagation). This configuration +is enabled when `management.tracing.propagation.type=B3` and the header format can be configured using +`management.tracing.propagation.format=SINGLE/MULTI/SINGLE_NO_PARENT`. The default value is `SINGLE`. + +### Version metrics + +This feature allows to expose you application's dependencies' versions to Micrometer. This feature +is enabled when Micrometer is configured and `valensas.observability.version-metrics.enabled=true` (default is true). +The metric name can be configured using the `valensas.observability.version-metric.name` property (default is `valensas_application`). + +For this feature to work properly, you will need the use the `com.valensas.observability-artifacts` plugin as described +in the installation section. diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..338a449 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,114 @@ +import org.jetbrains.kotlin.gradle.tasks.KotlinCompile + +repositories { + mavenCentral() +} + +plugins { + `java-gradle-plugin` + id("com.github.ben-manes.versions") version "0.51.0" + id("org.springframework.boot") version "3.3.1" apply false + id("io.spring.dependency-management") version "1.1.6" + id("org.jmailen.kotlinter") version "4.4.0" + id("maven-publish") + id("java-library") + kotlin("jvm") version "1.9.21" + id("net.thebugmc.gradle.sonatype-central-portal-publisher") version "1.2.3" +} + +group = "com.valensas" +version = "3.0.0" +java.sourceCompatibility = JavaVersion.VERSION_17 + +dependencyManagement { + imports { + mavenBom(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES) + } +} + +gradlePlugin { + val observabilityArtifactsPlugin by plugins.creating { + id = "com.valensas.observability-artifacts" + implementationClass = "com.valensas.observability.plugin.ObservabilityArtifactsPlugin" + } +} + +dependencies { + implementation("org.graalvm.polyglot:polyglot:24.0.1") + compileOnly("io.micrometer:micrometer-tracing-bridge-brave") + compileOnly("org.springframework.boot:spring-boot-starter-actuator") + compileOnly("io.github.openfeign:feign-micrometer:13.3") + compileOnly("org.springframework.boot:spring-boot-starter") + compileOnly("org.springframework.boot:spring-boot-starter-webflux") + + testImplementation("org.jetbrains.kotlin:kotlin-test-junit5") + testRuntimeOnly("org.junit.platform:junit-platform-launcher") +} + +tasks.withType { + kotlinOptions { + freeCompilerArgs = listOf("-Xjsr305=strict") + jvmTarget = "17" + } +} + +tasks.withType { + useJUnitPlatform() +} + +publishing { + publications { + create("plugin") { + groupId = "com.valensas.observability-artifacts" + artifactId = "com.valensas.observability-artifacts" + from(components["java"]) + } + create("artifact") { + groupId = "com.valensas" + artifactId = "observability" + from(components["java"]) + } + } +} + +tasks.getByName("jar") { + archiveClassifier = "" +} + + +signing { + val keyId = System.getenv("SIGNING_KEYID") + val secretKey = System.getenv("SIGNING_SECRETKEY") + val passphrase = System.getenv("SIGNING_PASSPHRASE") + + useInMemoryPgpKeys(keyId, secretKey, passphrase) +} + +centralPortal { + username = System.getenv("SONATYPE_USERNAME") + password = System.getenv("SONATYPE_PASSWORD") + + pom { + name = "Observability" + description = "A simple library to manage observability needs for Spring Boot." + url = "https://valensas.com/" + scm { + url = "https://github.com/Valensas/observability" + } + + licenses { + license { + name.set("MIT License") + url.set("https://mit-license.org") + } + } + + developers { + developer { + id.set("0") + name.set("Valensas") + email.set("info@valensas.com") + } + } + } +} \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..d64cd49 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..09523c0 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..1aa94a4 --- /dev/null +++ b/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# 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 +# +# https://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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +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 + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..6689b85 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..a5cc016 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1 @@ +rootProject.name = "observability" diff --git a/src/main/kotlin/com/valensas/observability/client/IntegrationRequestObservationConvention.kt b/src/main/kotlin/com/valensas/observability/client/IntegrationRequestObservationConvention.kt new file mode 100644 index 0000000..2cea80f --- /dev/null +++ b/src/main/kotlin/com/valensas/observability/client/IntegrationRequestObservationConvention.kt @@ -0,0 +1,21 @@ +package com.valensas.observability.client + +import io.micrometer.common.KeyValue +import io.micrometer.common.KeyValues +import org.springframework.web.reactive.function.client.ClientRequestObservationContext +import org.springframework.web.reactive.function.client.DefaultClientRequestObservationConvention + +class IntegrationRequestObservationConvention( + name: String = "integration.request" +) : DefaultClientRequestObservationConvention(name) { + override fun getLowCardinalityKeyValues(context: ClientRequestObservationContext): KeyValues = + super.getLowCardinalityKeyValues(context).and( + KeyValue.of( + "clientName", + context.carrier!! + .build() + .url() + .host + ) + ) +} diff --git a/src/main/kotlin/com/valensas/observability/config/FeignMicrometerAutoConfiguration.kt b/src/main/kotlin/com/valensas/observability/config/FeignMicrometerAutoConfiguration.kt new file mode 100644 index 0000000..e3c3767 --- /dev/null +++ b/src/main/kotlin/com/valensas/observability/config/FeignMicrometerAutoConfiguration.kt @@ -0,0 +1,17 @@ +package com.valensas.observability.config + +import feign.Capability +import feign.micrometer.MicrometerCapability +import io.micrometer.core.instrument.MeterRegistry +import org.springframework.boot.autoconfigure.condition.ConditionalOnBean +import org.springframework.boot.autoconfigure.condition.ConditionalOnClass +import org.springframework.context.annotation.Bean +import org.springframework.context.annotation.Configuration + +@Configuration +@ConditionalOnBean(MeterRegistry::class) +@ConditionalOnClass(MicrometerCapability::class) +open class FeignMicrometerAutoConfiguration { + @Bean + open fun micrometerCapability(meterRegistry: MeterRegistry): Capability = MicrometerCapability(meterRegistry) +} diff --git a/src/main/kotlin/com/valensas/observability/config/TracingAutoConfiguration.kt b/src/main/kotlin/com/valensas/observability/config/TracingAutoConfiguration.kt new file mode 100644 index 0000000..d2738fb --- /dev/null +++ b/src/main/kotlin/com/valensas/observability/config/TracingAutoConfiguration.kt @@ -0,0 +1,29 @@ +package com.valensas.observability.config + +import brave.baggage.BaggagePropagation +import brave.baggage.BaggagePropagationCustomizer +import brave.propagation.B3Propagation +import org.springframework.beans.factory.ObjectProvider +import org.springframework.beans.factory.annotation.Value +import org.springframework.boot.actuate.autoconfigure.tracing.BraveAutoConfiguration +import org.springframework.boot.autoconfigure.AutoConfigureBefore +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty +import org.springframework.context.annotation.Bean +import org.springframework.context.annotation.Configuration + +@Configuration +@AutoConfigureBefore(BraveAutoConfiguration::class) +open class TracingAutoConfiguration { + @Bean + @ConditionalOnProperty(value = ["management.tracing.propagation.type"], havingValue = "B3", matchIfMissing = false) + open fun propagationFactoryBuilder( + @Value("\${management.tracing.propagation.format:SINGLE}") + format: B3Propagation.Format, + baggagePropagationCustomizers: ObjectProvider + ): BaggagePropagation.FactoryBuilder { + val delegate = B3Propagation.newFactoryBuilder().injectFormat(format).build() + val builder = BaggagePropagation.newFactoryBuilder(delegate) + baggagePropagationCustomizers.orderedStream().forEach { customizer: BaggagePropagationCustomizer -> customizer.customize(builder) } + return builder + } +} diff --git a/src/main/kotlin/com/valensas/observability/config/VersionMetricsAutoConfiguration.kt b/src/main/kotlin/com/valensas/observability/config/VersionMetricsAutoConfiguration.kt new file mode 100644 index 0000000..4937dac --- /dev/null +++ b/src/main/kotlin/com/valensas/observability/config/VersionMetricsAutoConfiguration.kt @@ -0,0 +1,63 @@ +package com.valensas.observability.config + +import io.micrometer.core.instrument.ImmutableTag +import io.micrometer.core.instrument.MeterRegistry +import org.graalvm.home.Version +import org.slf4j.LoggerFactory +import org.springframework.beans.factory.annotation.Value +import org.springframework.boot.SpringBootVersion +import org.springframework.boot.autoconfigure.condition.ConditionalOnBean +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty +import org.springframework.context.annotation.Configuration +import java.io.FileInputStream +import java.util.Properties + +@Configuration +@ConditionalOnBean(MeterRegistry::class) +@ConditionalOnProperty("valensas.observability.version-metrics.enabled", havingValue = "true", matchIfMissing = true) +open class VersionMetricsAutoConfiguration( + private val registry: MeterRegistry, + @Value("\${valensas.observability.version-metric.name:valensas_application}") + private val name: String +) { + private val logger = LoggerFactory.getLogger(javaClass) + + init { + registerVersion("springboot", SpringBootVersion.getVersion() ?: "Unknown") + registerVersion("java", Runtime.version().version().joinToString(".")) + + if (System.getProperty("org.graalvm.home") != null) { + registerVersion("graalvm", Version.getCurrent().toString()) + } + registerPropertyFile("dependency-versions.properties") + registerPropertyFile("project-info.properties") + } + + private fun registerPropertyFile(filename: String) { + val propertyFile = javaClass.classLoader.getResource(filename)?.file + if (propertyFile == null) { + logger.warn("{} does not exist", filename) + return + } + + val prop = Properties() + FileInputStream(propertyFile).use { prop.load(it) } + prop + .stringPropertyNames() + .forEach { registerVersion(it, prop.getProperty(it)) } + } + + private fun registerVersion( + component: String, + version: String + ) { + registry.gauge( + name, + listOf( + ImmutableTag("component", component), + ImmutableTag("version", version) + ), + 1 + ) + } +} diff --git a/src/main/kotlin/com/valensas/observability/plugin/ObservabilityArtifactsPlugin.kt b/src/main/kotlin/com/valensas/observability/plugin/ObservabilityArtifactsPlugin.kt new file mode 100644 index 0000000..865ab78 --- /dev/null +++ b/src/main/kotlin/com/valensas/observability/plugin/ObservabilityArtifactsPlugin.kt @@ -0,0 +1,61 @@ +package com.valensas.observability.plugin + +import org.gradle.api.Plugin +import org.gradle.api.Project +import org.gradle.api.tasks.SourceSetContainer +import java.io.File +import java.nio.file.Path +import java.util.Properties + +class ObservabilityArtifactsPlugin : Plugin { + override fun apply(project: Project) { + project.tasks.register("observabilityArtifacts") { + val sourceSets = project.extensions.getByType(SourceSetContainer::class.java) + val outputResourceDir = + sourceSets + .named("main") + .get() + .output.resourcesDir!! + .toPath() + it.doLast { + outputResourceDir.toFile().mkdirs() + writeDependencyVersions(project, outputResourceDir) + writeProjectInfo(project, outputResourceDir) + } + } + } + + private fun writeDependencyVersions( + project: Project, + outputResourceDir: Path + ) { + val dependencyProperties = Properties() + project.configurations.forEach { configuration -> + configuration.allDependencies.forEach { dependency -> + if (dependency.group != null && dependency.version != null) { + val key = "${dependency.group}:${dependency.name}" + dependencyProperties[key] = dependency.version + } + } + } + val outputFile = File("$outputResourceDir/dependency-versions.properties") + outputFile.writer().use { writer -> + dependencyProperties.store(writer, null) + } + } + + private fun writeProjectInfo( + project: Project, + outputResourceDir: Path + ) { + val projectProperties = Properties() + projectProperties["group"] = project.group + projectProperties["version"] = project.version + projectProperties["name"] = project.rootProject.name + + val projectOutputFile = File("$outputResourceDir/project-info.properties") + projectOutputFile.writer().use { writer -> + projectProperties.store(writer, null) + } + } +} diff --git a/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/src/main/resources/META-INF/additional-spring-configuration-metadata.json new file mode 100644 index 0000000..5b1c116 --- /dev/null +++ b/src/main/resources/META-INF/additional-spring-configuration-metadata.json @@ -0,0 +1,23 @@ +{ + "groups": [], + "properties": [ + { + "name": "management.tracing.propagation.format", + "description": "B3 Header Format.", + "type": "brave.propagation.B3Propagation.Format", + "defaultValue": "Single" + }, + { + "name": "valensas.observability.version-metrics.name", + "description": "Name of the component metric.", + "type": "java.lang.String", + "defaultValue": "valensas_application" + }, + { + "name": "valensas.observability.version-metrics.enabled", + "description": "Enable or disable version metrics.", + "type": "java.lang.Boolean", + "defaultValue": "true" + } + ] +} diff --git a/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports new file mode 100644 index 0000000..5c62ad4 --- /dev/null +++ b/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports @@ -0,0 +1,3 @@ +com.valensas.observability.config.TracingAutoConfiguration +com.valensas.observability.config.VersionMetricsAutoConfiguration +com.valensas.observability.config.FeignMicrometerAutoConfiguration \ No newline at end of file diff --git a/src/test/kotlin/com/valensas/observability/plugin/ObservabilityArtifactsPluginTest.kt b/src/test/kotlin/com/valensas/observability/plugin/ObservabilityArtifactsPluginTest.kt new file mode 100644 index 0000000..54df64b --- /dev/null +++ b/src/test/kotlin/com/valensas/observability/plugin/ObservabilityArtifactsPluginTest.kt @@ -0,0 +1,27 @@ +package com.valensas.observability.plugin + +import org.gradle.testfixtures.ProjectBuilder +import java.io.File +import kotlin.test.Test +import kotlin.test.assertNotNull +import kotlin.test.assertTrue + +class ObservabilityArtifactsPluginTest { + @Test + fun `Plugin registers and successfully executes task to create dependency versions file`() { + val project = ProjectBuilder.builder().build() + project.plugins.apply("java") + project.plugins.apply("com.valensas.observability-artifacts") + + val observabilityArtifactsPlugin = project.tasks.findByName("observabilityArtifacts") + assertNotNull(observabilityArtifactsPlugin) + + observabilityArtifactsPlugin.actions.forEach { action -> action.execute(observabilityArtifactsPlugin) } + + val outputDir = project.file("build/resources/main") + val dependencyVersionsFile = File(outputDir, "dependency-versions.properties") + val projectInfoFile = File(outputDir, "project-info.properties") + assertTrue(dependencyVersionsFile.exists()) + assertTrue(projectInfoFile.exists()) + } +}