diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..00a51af --- /dev/null +++ b/.gitattributes @@ -0,0 +1,6 @@ +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# These are explicitly windows files and should use crlf +*.bat text eol=crlf + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..145e6f5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +# Ignore Gradle project-specific cache directory +.gradle +.idea +# Ignore Gradle build output directory +build diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..7454180 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..05679dc --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.1.1-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..744e882 --- /dev/null +++ b/gradlew @@ -0,0 +1,185 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or 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 UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +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 +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# 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"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# 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" + which java >/dev/null 2>&1 || 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 + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@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=. +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%" == "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%"=="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! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/plugin/build.gradle.kts b/plugin/build.gradle.kts new file mode 100644 index 0000000..652c1cd --- /dev/null +++ b/plugin/build.gradle.kts @@ -0,0 +1,75 @@ +import org.jetbrains.kotlin.gradle.tasks.KotlinCompile + +plugins { + `java-gradle-plugin` + `maven-publish` + + id("org.jetbrains.kotlin.jvm") version "1.4.31" +} +tasks.withType { + kotlinOptions.jvmTarget = "1.8" +} + +repositories { + // Use Maven Central for resolving dependencies. + mavenCentral() +} +project.version = "0.0.1-SNAPSHOT" +project.group="io.opentelemetry" + +dependencies { + implementation(platform("org.jetbrains.kotlin:kotlin-bom")) + implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8") + + implementation(platform("io.opentelemetry:opentelemetry-bom:1.4.1")) + implementation("io.opentelemetry:opentelemetry-api") + implementation("io.opentelemetry:opentelemetry-sdk") + implementation("io.opentelemetry:opentelemetry-exporter-logging") + implementation("io.opentelemetry:opentelemetry-exporter-zipkin") + implementation("io.opentelemetry:opentelemetry-exporter-otlp-trace") + implementation("io.grpc:grpc-netty-shaded:1.34.1") + + testImplementation("org.jetbrains.kotlin:kotlin-test") + testImplementation("org.jetbrains.kotlin:kotlin-test-junit") +} + +gradlePlugin { + // Define the plugin + val tracing by plugins.creating { + id = "io.opentelemetry.gradle.tracing" + implementationClass = "io.opentelemetry.gradle.tracing.OtelTracingPlugin" + } +} + +// Add a source set for the functional test suite +val functionalTestSourceSet = sourceSets.create("functionalTest") { +} + +gradlePlugin.testSourceSets(functionalTestSourceSet) +configurations["functionalTestImplementation"].extendsFrom(configurations["testImplementation"]) + +// Add a task to run the functional tests +val functionalTest by tasks.registering(Test::class) { + testClassesDirs = functionalTestSourceSet.output.classesDirs + classpath = functionalTestSourceSet.runtimeClasspath +} + +tasks.check { + // Run the functional tests as part of `check` + dependsOn(functionalTest) +} + +publishing { + repositories { + mavenLocal() + } + publications { + register("pluginPublication") { + groupId = "io.opentelemetry" + artifactId = "gradle-tracing-plugin" + plugins.withId("java-gradle-plugin") { + from(components["java"]) + } + } + } +} diff --git a/plugin/src/functionalTest/kotlin/io/opentelemetry/gradle/tracing/GradleOtelTracingPluginFunctionalTest.kt b/plugin/src/functionalTest/kotlin/io/opentelemetry/gradle/tracing/GradleOtelTracingPluginFunctionalTest.kt new file mode 100644 index 0000000..a5dbd64 --- /dev/null +++ b/plugin/src/functionalTest/kotlin/io/opentelemetry/gradle/tracing/GradleOtelTracingPluginFunctionalTest.kt @@ -0,0 +1,37 @@ +/* + * This Kotlin source file was generated by the Gradle 'init' task. + */ +package io.opentelemetry.gradle.tracing + +import java.io.File +import org.gradle.testkit.runner.GradleRunner +import kotlin.test.Test +import kotlin.test.assertTrue + +/** + * A simple functional test for the 'io.opentelemetry.gradle.tracing.greeting' plugin. + */ +class GradleOtelTracingPluginFunctionalTest { + @Test fun `can run task`() { + // Setup the test build + val projectDir = File("build/functionalTest") + projectDir.mkdirs() + projectDir.resolve("settings.gradle").writeText("") + projectDir.resolve("build.gradle").writeText(""" + plugins { + id('io.opentelemetry.gradle.tracing.greeting') + } + """) + + // Run the build + val runner = GradleRunner.create() + runner.forwardOutput() + runner.withPluginClasspath() + runner.withArguments("greeting") + runner.withProjectDir(projectDir) + val result = runner.build(); + + // Verify the result + assertTrue(result.output.contains("Hello from plugin 'io.opentelemetry.gradle.tracing.greeting'")) + } +} diff --git a/plugin/src/main/kotlin/io/opentelemetry/gradle/tracing/OtelTracingPlugin.kt b/plugin/src/main/kotlin/io/opentelemetry/gradle/tracing/OtelTracingPlugin.kt new file mode 100644 index 0000000..ae2f3d0 --- /dev/null +++ b/plugin/src/main/kotlin/io/opentelemetry/gradle/tracing/OtelTracingPlugin.kt @@ -0,0 +1,102 @@ +package io.opentelemetry.gradle.tracing + +import io.opentelemetry.api.common.AttributeKey +import io.opentelemetry.api.common.Attributes +import io.opentelemetry.api.trace.Span +import io.opentelemetry.api.trace.Tracer +import io.opentelemetry.context.Context +import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter +import io.opentelemetry.sdk.OpenTelemetrySdk +import io.opentelemetry.sdk.resources.Resource +import io.opentelemetry.sdk.trace.SdkTracerProvider +import io.opentelemetry.sdk.trace.export.BatchSpanProcessor +import org.gradle.BuildListener +import org.gradle.BuildResult +import org.gradle.api.Plugin +import org.gradle.api.Project +import org.gradle.api.Task +import org.gradle.api.initialization.Settings +import org.gradle.api.invocation.Gradle +import org.gradle.api.plugins.ExtensionAware +import org.gradle.api.plugins.ExtraPropertiesExtension + +class OtelTracingPlugin : Plugin { + override fun apply(project: Project) { + val openTelemetry: OpenTelemetrySdk = initializeOpenTelemetry(project) + + val tracer: Tracer = openTelemetry.getTracer("opentelemetry-build") + val rootProjectSpan: Span = tracer.spanBuilder(project.displayName).startSpan() + project.gradle.addBuildListener(object : BuildListener { + override fun settingsEvaluated(settings: Settings) {} + + override fun projectsLoaded(gradle: Gradle) {} + + override fun projectsEvaluated(gradle: Gradle) {} + + override fun buildFinished(result: BuildResult) { + rootProjectSpan.end() + openTelemetry.sdkTracerProvider.forceFlush() + } + }) + val spansByTask: MutableMap = mutableMapOf() + project.gradle.taskGraph.beforeTask { + val projectSpan: Span + val taskProject = it.project + if (taskProject.extra.has("projectSpan")) { + projectSpan = taskProject.extra["projectSpan"] as Span + } else { + projectSpan = tracer.spanBuilder(taskProject.displayName) + .setParent(Context.current().with(rootProjectSpan)) + .startSpan() + taskProject.extra["projectSpan"] = projectSpan + //todo: would be better to end this at the end of the last task...but how? + projectSpan.end() + } + val span = tracer.spanBuilder(taskProject.displayName + " : " + it.name) + .setParent(Context.current().with(projectSpan)) + .startSpan() + spansByTask[it] = span + } + project.gradle.taskGraph.afterTask { + val span = spansByTask[it] + if (span != null) { + val failure = it.state.failure + if (failure != null) { + span.setStatus(io.opentelemetry.api.trace.StatusCode.ERROR) + span.recordException(failure) + span.setAttribute("error.message", failure.message ?: "None") + if (failure.cause != null) { + span.setAttribute("error.cause", failure.cause?.message ?: "Unknown") + } + } + span.end() + spansByTask.remove(it) + } + } + + } + + private fun initializeOpenTelemetry(project: Project): OpenTelemetrySdk { + val openTelemetry: OpenTelemetrySdk = OpenTelemetrySdk.builder() + .setTracerProvider( + SdkTracerProvider.builder() + .addSpanProcessor( + BatchSpanProcessor.builder( + OtlpGrpcSpanExporter.builder().build() + ).build() + ) + .setResource( + Resource.create( + Attributes.of( + AttributeKey.stringKey("service.name"), + project.name + " Build" + ) + ) + ) + .build() + ).build() + return openTelemetry + } +} +private val ExtensionAware.extra: ExtraPropertiesExtension + get() = extensions.extraProperties diff --git a/plugin/src/test/kotlin/io/opentelemetry/gradle/tracing/OtelTracingPluginTest.kt b/plugin/src/test/kotlin/io/opentelemetry/gradle/tracing/OtelTracingPluginTest.kt new file mode 100644 index 0000000..9c904d0 --- /dev/null +++ b/plugin/src/test/kotlin/io/opentelemetry/gradle/tracing/OtelTracingPluginTest.kt @@ -0,0 +1,22 @@ +/* + * This Kotlin source file was generated by the Gradle 'init' task. + */ +package io.opentelemetry.gradle.tracing + +import org.gradle.testfixtures.ProjectBuilder +import kotlin.test.Test +import kotlin.test.assertNotNull + +/** + * A simple unit test for the 'io.opentelemetry.gradle.tracing.greeting' plugin. + */ +class OtelTracingPluginTest { + @Test fun `plugin registers task`() { + // Create a test project and apply the plugin + val project = ProjectBuilder.builder().build() + project.plugins.apply("io.opentelemetry.gradle.tracing.greeting") + + // Verify the result + assertNotNull(project.tasks.findByName("greeting")) + } +} diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..4565f59 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,11 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * The settings file is used to specify which projects to include in your build. + * + * Detailed information about configuring a multi-project build in Gradle can be found + * in the user manual at https://docs.gradle.org/7.1.1/userguide/multi_project_builds.html + */ + +rootProject.name = "gradle-otel-tracing" +include("plugin")