SpringCloud/spring-cloud-task
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated metrics docs so that they are configured properly

Browse Source 
Updated micrometer doc plugin so it won't impact cloud doc gen
This commit is contained in:
Glenn Renfro
2022-10-10 19:43:29 -04:00
parent 2ef93291fc
commit 002a565a15
2 changed files with 21 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
docs/pom.xml
View File

@@ -17,8 +17,8 @@
<asciidoctorj.pdf.version>1.5.0-alpha.16</asciidoctorj.pdf.version>
<!-- Observability -->
<micrometer-docs-generator.version>1.0.0-M6</micrometer-docs-generator.version>
<micrometer-docs-generator.inputPath>${maven.multiModuleProjectDirectory}/spring-cloud-task-core/</micrometer-docs-generator.inputPath>
<micrometer-docs-generator.version>1.0.0-RC1</micrometer-docs-generator.version>
<micrometer-docs-generator.inputPath>${maven.multiModuleProjectDirectory}/spring-cloud-task-core</micrometer-docs-generator.inputPath>
<micrometer-docs-generator.inclusionPattern>.*</micrometer-docs-generator.inclusionPattern>
<micrometer-docs-generator.outputPath>${maven.multiModuleProjectDirectory}/target/</micrometer-docs-generator.outputPath>
</properties>
@@ -57,29 +57,15 @@
<artifactId>exec-maven-plugin</artifactId>
<executions>
<execution>
<id>generate-metrics-metadata</id>
<id>generate-docs</id>
<phase>prepare-package</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<mainClass>io.micrometer.docs.metrics.DocsFromSources</mainClass>
<includePluginDependencies>true</includePluginDependencies>
<arguments>
<argument>${micrometer-docs-generator.inputPath}</argument>
<argument>${micrometer-docs-generator.inclusionPattern}</argument>
<argument>${micrometer-docs-generator.outputPath}</argument>
</arguments>
</configuration>
</execution>
<execution>
<id>generate-tracing-metadata</id>
<phase>prepare-package</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<mainClass>io.micrometer.docs.spans.DocsFromSources</mainClass>
<mainClass>
io.micrometer.docs.DocsGeneratorCommand
</mainClass>
<includePluginDependencies>true</includePluginDependencies>
<arguments>
<argument>${micrometer-docs-generator.inputPath}</argument>
@@ -91,20 +77,10 @@
</executions>
<dependencies>
<dependency>
<groupId>io.micrometer
</groupId>
<artifactId>micrometer-docs-generator-spans</artifactId>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-docs-generator</artifactId>
<version>${micrometer-docs-generator.version}</version>
<type>jar</type>
<version>${micrometer-docs-generator.version}
</version>
</dependency>
<dependency>
<groupId>io.micrometer
</groupId>
<artifactId>micrometer-docs-generator-metrics</artifactId>
<type>jar</type>
<version>${micrometer-docs-generator.version}
</version>
</dependency>
</dependencies>
</plugin>

24
spring-cloud-task-core/src/main/java/org/springframework/cloud/task/listener/TaskExecutionObservation.java
View File

@@ -39,16 +39,16 @@ public enum TaskExecutionObservation implements ObservationDocumentation {
return DefaultTaskExecutionObservationConvention.class;
}
@Override
public KeyName[] getLowCardinalityKeyNames() {
return TaskKeyValues.values();
}
public String getPrefix() {
return "spring.cloud.task";
}
};
@Override
public KeyName[] getLowCardinalityKeyNames() {
return TaskKeyValues.values();
}
public enum TaskKeyValues implements KeyName {
/**
@@ -115,7 +115,7 @@ public enum TaskExecutionObservation implements ObservationDocumentation {
TASK_CF_ORG_NAME {
@Override
public String asString() {
return "cf.org.name";
return "spring.cloud.task.cf.org.name";
}
},
@@ -125,7 +125,7 @@ public enum TaskExecutionObservation implements ObservationDocumentation {
TASK_CF_SPACE_ID {
@Override
public String asString() {
return "cf.space.id";
return "spring.cloud.task.cf.space.id";
}
},
@@ -135,7 +135,7 @@ public enum TaskExecutionObservation implements ObservationDocumentation {
TASK_CF_SPACE_NAME {
@Override
public String asString() {
return "cf.space.name";
return "spring.cloud.task.cf.space.name";
}
},
@@ -145,7 +145,7 @@ public enum TaskExecutionObservation implements ObservationDocumentation {
TASK_CF_APP_NAME {
@Override
public String asString() {
return "cf.app.name";
return "spring.cloud.task.cf.app.name";
}
},
@@ -155,7 +155,7 @@ public enum TaskExecutionObservation implements ObservationDocumentation {
TASK_CF_APP_ID {
@Override
public String asString() {
return "cf.app.id";
return "spring.cloud.task.cf.app.id";
}
},
@@ -165,7 +165,7 @@ public enum TaskExecutionObservation implements ObservationDocumentation {
TASK_CF_APP_VERSION {
@Override
public String asString() {
return "cf.app.version";
return "spring.cloud.task.cf.app.version";
}
},
@@ -175,7 +175,7 @@ public enum TaskExecutionObservation implements ObservationDocumentation {
TASK_CF_INSTANCE_INDEX {
@Override
public String asString() {
return "cf.instance.index";
return "spring.cloud.task.cf.instance.index";
}
}