Skip to content

Commit 7c408ea

Browse files
gregturngregturn
committed
Add Observability to reference documentation.
See #1250.
1 parent c1e3dbf commit 7c408ea

File tree

3 files changed

+109
-0
lines changed

3 files changed

+109
-0
lines changed

‎spring-data-cassandra-distribution/pom.xml‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@
2222
<properties>
2323
<project.root>${basedir}/..</project.root>
2424
<dist.key>SDCASS</dist.key>
25+
26+
<!-- Observability -->
27+
<micrometer-docs-generator.version>1.0.0-SNAPSHOT</micrometer-docs-generator.version>
28+
<micrometer-docs-generator.inputPath>${maven.multiModuleProjectDirectory}/spring-data-cassandra/
29+
</micrometer-docs-generator.inputPath>
30+
<micrometer-docs-generator.inclusionPattern>.*</micrometer-docs-generator.inclusionPattern>
31+
<micrometer-docs-generator.outputPath>${maven.multiModuleProjectDirectory}/target/
32+
</micrometer-docs-generator.outputPath>
2533
</properties>
2634

2735
<build>
@@ -30,11 +38,103 @@
3038
<groupId>org.apache.maven.plugins</groupId>
3139
<artifactId>maven-assembly-plugin</artifactId>
3240
</plugin>
41+
<plugin>
42+
<groupId>org.codehaus.mojo</groupId>
43+
<artifactId>exec-maven-plugin</artifactId>
44+
<executions>
45+
<execution>
46+
<id>generate-metrics-metadata</id>
47+
<phase>prepare-package</phase>
48+
<goals>
49+
<goal>java</goal>
50+
</goals>
51+
<configuration>
52+
<mainClass>io.micrometer.docs.metrics.DocsFromSources</mainClass>
53+
</configuration>
54+
</execution>
55+
<execution>
56+
<id>generate-tracing-metadata</id>
57+
<phase>prepare-package</phase>
58+
<goals>
59+
<goal>java</goal>
60+
</goals>
61+
<configuration>
62+
<mainClass>io.micrometer.docs.spans.DocsFromSources</mainClass>
63+
</configuration>
64+
</execution>
65+
</executions>
66+
<dependencies>
67+
<dependency>
68+
<groupId>io.micrometer</groupId>
69+
<artifactId>micrometer-docs-generator-spans</artifactId>
70+
<version>${micrometer-docs-generator.version}</version>
71+
<type>jar</type>
72+
</dependency>
73+
<dependency>
74+
<groupId>io.micrometer</groupId>
75+
<artifactId>micrometer-docs-generator-metrics</artifactId>
76+
<version>${micrometer-docs-generator.version}</version>
77+
<type>jar</type>
78+
</dependency>
79+
</dependencies>
80+
<configuration>
81+
<includePluginDependencies>true</includePluginDependencies>
82+
<arguments>
83+
<argument>${micrometer-docs-generator.inputPath}</argument>
84+
<argument>${micrometer-docs-generator.inclusionPattern}</argument>
85+
<argument>${micrometer-docs-generator.outputPath}</argument>
86+
</arguments>
87+
</configuration>
88+
</plugin>
3389
<plugin>
3490
<groupId>org.asciidoctor</groupId>
3591
<artifactId>asciidoctor-maven-plugin</artifactId>
3692
</plugin>
3793
</plugins>
3894
</build>
3995

96+
<repositories>
97+
<repository>
98+
<id>spring-snapshots</id>
99+
<name>Spring Snapshots</name>
100+
<url>https://repo.spring.io/snapshot</url> <!-- For Snapshots -->
101+
<snapshots>
102+
<enabled>true</enabled>
103+
</snapshots>
104+
<releases>
105+
<enabled>false</enabled>
106+
</releases>
107+
</repository>
108+
<repository>
109+
<id>spring-milestones</id>
110+
<name>Spring Milestones</name>
111+
<url>https://repo.spring.io/milestone</url> <!-- For Milestones -->
112+
<snapshots>
113+
<enabled>false</enabled>
114+
</snapshots>
115+
</repository>
116+
</repositories>
117+
118+
<pluginRepositories>
119+
<pluginRepository>
120+
<id>spring-snapshots</id>
121+
<name>Spring Snapshots</name>
122+
<url>https://repo.spring.io/snapshot</url> <!-- For Snapshots -->
123+
<snapshots>
124+
<enabled>true</enabled>
125+
</snapshots>
126+
<releases>
127+
<enabled>false</enabled>
128+
</releases>
129+
</pluginRepository>
130+
<pluginRepository>
131+
<id>spring-milestones</id>
132+
<name>Spring Milestones</name>
133+
<url>https://repo.spring.io/milestone</url> <!-- For Milestones -->
134+
<snapshots>
135+
<enabled>false</enabled>
136+
</snapshots>
137+
</pluginRepository>
138+
</pluginRepositories>
139+
40140
</project>

‎src/main/asciidoc/index.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,4 @@ include::{spring-data-commons-docs}/repository-populator-namespace-reference.ado
4141
include::{spring-data-commons-docs}/repository-query-keywords-reference.adoc[leveloffset=+1]
4242
include::{spring-data-commons-docs}/repository-query-return-types-reference.adoc[leveloffset=+1]
4343
include::reference/migration-guides.adoc[leveloffset=+1]
44+
include::reference/observability.adoc[leveloffset=+1]

‎src/main/asciidoc/reference/observability.adoc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
:root-target: ../../../../target/
2+
3+
[[observability]]
4+
== Observability metadata
5+
6+
include::{root-target}_metrics.adoc[]
7+
8+
include::{root-target}_spans.adoc[]

0 commit comments

Comments
 (0)