Skip to content

Commit 002a565

Browse files
committed
Updated metrics docs so that they are configured properly
Updated micrometer doc plugin so it won't impact cloud doc gen
1 parent 2ef9329 commit 002a565

File tree

2 files changed

+21
-45
lines changed

2 files changed

+21
-45
lines changed

docs/pom.xml

Lines changed: 9 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
<asciidoctorj.pdf.version>1.5.0-alpha.16</asciidoctorj.pdf.version>
1818

1919
<!-- Observability -->
20-
<micrometer-docs-generator.version>1.0.0-M6</micrometer-docs-generator.version>
21-
<micrometer-docs-generator.inputPath>${maven.multiModuleProjectDirectory}/spring-cloud-task-core/</micrometer-docs-generator.inputPath>
20+
<micrometer-docs-generator.version>1.0.0-RC1</micrometer-docs-generator.version>
21+
<micrometer-docs-generator.inputPath>${maven.multiModuleProjectDirectory}/spring-cloud-task-core</micrometer-docs-generator.inputPath>
2222
<micrometer-docs-generator.inclusionPattern>.*</micrometer-docs-generator.inclusionPattern>
2323
<micrometer-docs-generator.outputPath>${maven.multiModuleProjectDirectory}/target/</micrometer-docs-generator.outputPath>
2424
</properties>
@@ -57,29 +57,15 @@
5757
<artifactId>exec-maven-plugin</artifactId>
5858
<executions>
5959
<execution>
60-
<id>generate-metrics-metadata</id>
60+
<id>generate-docs</id>
6161
<phase>prepare-package</phase>
6262
<goals>
6363
<goal>java</goal>
6464
</goals>
6565
<configuration>
66-
<mainClass>io.micrometer.docs.metrics.DocsFromSources</mainClass>
67-
<includePluginDependencies>true</includePluginDependencies>
68-
<arguments>
69-
<argument>${micrometer-docs-generator.inputPath}</argument>
70-
<argument>${micrometer-docs-generator.inclusionPattern}</argument>
71-
<argument>${micrometer-docs-generator.outputPath}</argument>
72-
</arguments>
73-
</configuration>
74-
</execution>
75-
<execution>
76-
<id>generate-tracing-metadata</id>
77-
<phase>prepare-package</phase>
78-
<goals>
79-
<goal>java</goal>
80-
</goals>
81-
<configuration>
82-
<mainClass>io.micrometer.docs.spans.DocsFromSources</mainClass>
66+
<mainClass>
67+
io.micrometer.docs.DocsGeneratorCommand
68+
</mainClass>
8369
<includePluginDependencies>true</includePluginDependencies>
8470
<arguments>
8571
<argument>${micrometer-docs-generator.inputPath}</argument>
@@ -91,20 +77,10 @@
9177
</executions>
9278
<dependencies>
9379
<dependency>
94-
<groupId>io.micrometer
95-
</groupId>
96-
<artifactId>micrometer-docs-generator-spans</artifactId>
97-
<type>jar</type>
98-
<version>${micrometer-docs-generator.version}
99-
</version>
100-
</dependency>
101-
<dependency>
102-
<groupId>io.micrometer
103-
</groupId>
104-
<artifactId>micrometer-docs-generator-metrics</artifactId>
80+
<groupId>io.micrometer</groupId>
81+
<artifactId>micrometer-docs-generator</artifactId>
82+
<version>${micrometer-docs-generator.version}</version>
10583
<type>jar</type>
106-
<version>${micrometer-docs-generator.version}
107-
</version>
10884
</dependency>
10985
</dependencies>
11086
</plugin>

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,16 @@ public Class<? extends ObservationConvention<? extends Observation.Context>> get
3939
return DefaultTaskExecutionObservationConvention.class;
4040
}
4141

42+
@Override
43+
public KeyName[] getLowCardinalityKeyNames() {
44+
return TaskKeyValues.values();
45+
}
46+
4247
public String getPrefix() {
4348
return "spring.cloud.task";
4449
}
4550
};
4651

47-
@Override
48-
public KeyName[] getLowCardinalityKeyNames() {
49-
return TaskKeyValues.values();
50-
}
51-
5252
public enum TaskKeyValues implements KeyName {
5353

5454
/**
@@ -115,7 +115,7 @@ public String asString() {
115115
TASK_CF_ORG_NAME {
116116
@Override
117117
public String asString() {
118-
return "cf.org.name";
118+
return "spring.cloud.task.cf.org.name";
119119
}
120120
},
121121

@@ -125,7 +125,7 @@ public String asString() {
125125
TASK_CF_SPACE_ID {
126126
@Override
127127
public String asString() {
128-
return "cf.space.id";
128+
return "spring.cloud.task.cf.space.id";
129129
}
130130
},
131131

@@ -135,7 +135,7 @@ public String asString() {
135135
TASK_CF_SPACE_NAME {
136136
@Override
137137
public String asString() {
138-
return "cf.space.name";
138+
return "spring.cloud.task.cf.space.name";
139139
}
140140
},
141141

@@ -145,7 +145,7 @@ public String asString() {
145145
TASK_CF_APP_NAME {
146146
@Override
147147
public String asString() {
148-
return "cf.app.name";
148+
return "spring.cloud.task.cf.app.name";
149149
}
150150
},
151151

@@ -155,7 +155,7 @@ public String asString() {
155155
TASK_CF_APP_ID {
156156
@Override
157157
public String asString() {
158-
return "cf.app.id";
158+
return "spring.cloud.task.cf.app.id";
159159
}
160160
},
161161

@@ -165,7 +165,7 @@ public String asString() {
165165
TASK_CF_APP_VERSION {
166166
@Override
167167
public String asString() {
168-
return "cf.app.version";
168+
return "spring.cloud.task.cf.app.version";
169169
}
170170
},
171171

@@ -175,7 +175,7 @@ public String asString() {
175175
TASK_CF_INSTANCE_INDEX {
176176
@Override
177177
public String asString() {
178-
return "cf.instance.index";
178+
return "spring.cloud.task.cf.instance.index";
179179
}
180180
}
181181

0 commit comments

Comments
 (0)