feat: Updated Documentation, Added validate-config goal to check on config files, and clean output directory action to delete previously generated files.

[marcuss]

Added validate-config goal to check on config files, and clean output directory action to delete previously generated files.

@dustinbyrne @ptrdvrk

[marcuss]

to review the changes first commit the pending PR #2 to master.

[marcuss]

@dustinbyrne @ptrdvrk could you check this one? I believe is ready to merge!

[ptrdvrk]

Please review and address the inline comments. Thank you!

[dustinbyrne]

Thank you @marcuss! I've added some minor items regarding debug flags.

[dustinbyrne]

appmap.debug won't match up with a logger level (other than INFO). It's expected to be a comma separated list of subsystems to enable verbose logging (hooks,http,locals).

[marcuss]

You are right, but then I should just put logger at INFO level, and omit this until an issue identifying what to log at hooks, HTTP and locals should log, right?

[dustinbyrne]

Check the Maven logic for handling the debug flags:
https://github.com/applandinc/appmap-maven-plugin/blob/master/src/main/java/com/appland/appmap/AppMapAgentMojo.java#L101-L111

In summary: presence of any non-null, non-empty value will introduce -Dappmap.debug, -Dappmap.debug.file=${debugFile}. The value of debug will then be split by comma (the Maven plugin also allows for whitespace but doesn't document it), and appends -Dappmap.debug.hooks, -Dappmap.debug.locals, -Dappmap.debug.http as appropriate if the last token is included in the list.

[marcuss]

I added the changes requested, but let me do some testing first, first time Monday I will address this.

[marcuss]

@dustinbyrne @ptrdvrk finally got to test this properly, there is an issue with the gradle plugin that should be solved once is properly mad public, for now if you want to play with it to you can only do it with groovy gradle scripts (build.gradle) but not with kotlin DSL bild scripts (build.gradle.kts)

For testing I used:
https://github.com/spring-guides/tut-spring-boot-kotlin

but had to change the build.gradle.kts to build.gradle because of the aforementioned, you can use it if you like:

buildscript {
	repositories {
		mavenLocal()
	}
	dependencies {
		classpath "com.appland:appmap-gradle-plugin:1.0.3"
	}
}

plugins {
	id "org.springframework.boot" version "2.4.4"
	id "io.spring.dependency-management" version "1.0.11.RELEASE"
	id "org.jetbrains.kotlin.jvm" version "1.4.32"
	id "org.jetbrains.kotlin.plugin.spring" version "1.4.32"
	id "org.jetbrains.kotlin.plugin.allopen" version "1.4.32"
	id "org.jetbrains.kotlin.plugin.jpa" version "1.4.32"
	id "org.jetbrains.kotlin.kapt" version "1.4.32"
}

group = "com.example"
version = "0.0.1-SNAPSHOT"
java.sourceCompatibility = JavaVersion.VERSION_1_8

repositories {
	mavenCentral()
}

dependencies {
	implementation "org.springframework.boot:spring-boot-starter-data-jpa"
	implementation "org.springframework.boot:spring-boot-starter-mustache"
	implementation "org.springframework.boot:spring-boot-starter-web"
	implementation "com.fasterxml.jackson.module:jackson-module-kotlin"
	implementation "org.jetbrains.kotlin:kotlin-reflect"
	implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8"
	runtimeOnly "com.h2database:h2"
	runtimeOnly "org.springframework.boot:spring-boot-devtools"
	kapt "org.springframework.boot:spring-boot-configuration-processor"
	testImplementation('org.springframework.boot:spring-boot-starter-test') {
		exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
		exclude module: 'mockito-core'
	}
	testImplementation "org.junit.jupiter:junit-jupiter-api"
	testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine"
	testImplementation "com.ninja-squad:springmockk:3.0.1"
	test.useJUnitPlatform()
}

compileKotlin {
	kotlinOptions.freeCompilerArgs =  ['-Xjsr305=strict']
	kotlinOptions.jvmTarget = "1.8"
}

allOpen {
	annotation("javax.persistence.Entity")
	annotation("javax.persistence.Embeddable")
	annotation("javax.persistence.MappedSuperclass")
}

apply plugin: 'com.appland.appmap'

appmap {
	configFile = file("$projectDir/appmap.yml")
	outputDirectory = file("$buildDir/appmap3")
	skip = false
	debug = "info"
	eventValueSize = 1024
}

Once you validate this, please merge

Thanks!

[appland-release]

🎉 This PR is included in version 1.0.0 🎉

The release is available on:

• v1.0.0
• GitHub release

Your semantic-release bot 📦🚀

[appland-release]

🎉 This PR is included in version 1.0.0 🎉

The release is available on:

• v1.0.0
• GitHub release

Your semantic-release bot 📦🚀

[appland-release]

🎉 This PR is included in version 1.0.0 🎉

The release is available on:

• v1.0.0
• GitHub release

Your semantic-release bot 📦🚀