Multiple fixes for the metrics auto-config and sample

Author: meltsufin

docs/src/main/asciidoc/metrics.adoc

@@ -2,7 +2,9 @@
 
 Google Cloud Platform provides a service called https://cloud.google.com/monitoring/[Stackdriver Monitoring], and https://micrometer.io/docs/registry/stackdriver[Micrometer] can be used with it to easily instrument Spring Boot applications for observability.
 
-Spring Boot already provides auto-configuration for Stackdriver. This module enables to auto-detect the `project-id` and `credentials`. Also, it can be customized.
+Spring Boot already provides auto-configuration for Stackdriver.
+This module enables auto-detection of the `project-id` and `credentials`.
+Also, it can be customized.
 
 Maven coordinates, using <<getting-started.adoc#_bill_of_materials, Spring Cloud GCP BOM>>:
 
@@ -26,30 +28,10 @@ dependencies {
 You must enable Stackdriver Monitoring API from the Google Cloud Console in order to capture metrics.
 Navigate to the https://console.cloud.google.com/apis/api/monitoring.googleapis.com/overview[Stackdriver Monitoring API] for your project and make sure it’s enabled.
 
-This starter requires `org.springframework.boot:spring-boot-starter-actuator` dependency to activate. Make sure the dependency is being declared.
-
-Maven coordinates:
-
-----
-<dependency>
-    <groupId>org.springframework.boot</groupId>
-    <artifactId>spring-boot-starter-actuator</artifactId>
-</dependency>
-----
-
-Gradle coordinates:
-
-[source,subs="normal"]
-----
-dependencies {
-    implementation("org.springframework.boot:spring-boot-starter-actuator")
-}
-----
-
-=== Spring Boot Starter for Stackdriver Monitoring
-
 Spring Boot Starter for Stackdriver Monitoring uses Micrometer.
 
+=== Configuration
+
 All configurations are optional:
 
 |===
@@ -63,3 +45,7 @@ All configurations are optional:
 
 You can use core Spring Boot Actuator properties to control reporting frequency, etc.
 Read https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#production-ready-metrics-export-stackdriver[Spring Boot Actuator documentation] for more information on Stackdriver Actuator configurations.
+
+=== Sample
+
+A https://github.com/GoogleCloudPlatform/spring-cloud-gcp/tree/master/spring-cloud-gcp-samples/spring-cloud-gcp-metrics-sample[sample application] is available.

spring-cloud-gcp-autoconfigure/src/main/java/com/google/cloud/spring/autoconfigure/metrics/GcpStackdriverMetricsAutoConfiguration.java

@@ -19,13 +19,16 @@
 import java.io.IOException;
 
 import com.google.api.gax.core.CredentialsProvider;
+import com.google.cloud.monitoring.v3.MetricServiceSettings;
 import com.google.cloud.spring.core.DefaultCredentialsProvider;
 import com.google.cloud.spring.core.GcpProjectIdProvider;
+import com.google.cloud.spring.core.UserAgentHeaderProvider;
 import io.micrometer.core.instrument.Clock;
-import io.micrometer.core.instrument.step.StepMeterRegistry;
 import io.micrometer.stackdriver.StackdriverConfig;
+import io.micrometer.stackdriver.StackdriverMeterRegistry;
 
 import org.springframework.boot.actuate.autoconfigure.metrics.MetricsAutoConfiguration;
+import org.springframework.boot.actuate.autoconfigure.metrics.export.ConditionalOnEnabledMetricsExport;
 import org.springframework.boot.actuate.autoconfigure.metrics.export.stackdriver.StackdriverMetricsExportAutoConfiguration;
 import org.springframework.boot.actuate.autoconfigure.metrics.export.stackdriver.StackdriverProperties;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
@@ -47,8 +50,9 @@
 @Configuration(proxyBeanMethods = false)
 @AutoConfigureBefore(StackdriverMetricsExportAutoConfiguration.class)
 @AutoConfigureAfter(MetricsAutoConfiguration.class)
-@ConditionalOnClass({StepMeterRegistry.class, StackdriverConfig.class})
+@ConditionalOnClass(StackdriverMeterRegistry.class)
 @ConditionalOnBean(Clock.class)
+@ConditionalOnEnabledMetricsExport("stackdriver")
 @EnableConfigurationProperties({GcpMetricsProperties.class, StackdriverProperties.class})
 @ConditionalOnProperty(value = "spring.cloud.gcp.metrics.enabled", matchIfMissing = true, havingValue = "true")
 public class GcpStackdriverMetricsAutoConfiguration {
@@ -75,4 +79,19 @@ public StackdriverConfig stackdriverConfig() {
 		return new GcpStackdriverPropertiesConfigAdapter(this.stackdriverProperties, this.projectId, this.credentialsProvider);
 	}
 
+	@Bean
+	@ConditionalOnMissingBean
+	public MetricServiceSettings metricServiceSettings() throws IOException {
+		return MetricServiceSettings.newBuilder().setHeaderProvider(new UserAgentHeaderProvider(GcpStackdriverMetricsAutoConfiguration.class)).build();
+	}
+
+	@Bean
+	@ConditionalOnMissingBean
+	public StackdriverMeterRegistry stackdriverMeterRegistry(StackdriverConfig stackdriverConfig, Clock clock, MetricServiceSettings metricServiceSettings) {
+		return StackdriverMeterRegistry.builder(stackdriverConfig)
+				.clock(clock)
+				.metricServiceSettings(() -> metricServiceSettings)
+				.build();
+	}
+
 }

spring-cloud-gcp-autoconfigure/src/test/java/com/google/cloud/spring/autoconfigure/pubsub/it/PubSubTemplateDocumentationIntegrationTests.java

@@ -42,7 +42,6 @@
 import com.google.pubsub.v1.Topic;
 import org.awaitility.Awaitility;
 import org.awaitility.Duration;
-import org.jetbrains.annotations.NotNull;
 import org.junit.BeforeClass;
 import org.junit.Test;
 
@@ -298,7 +297,7 @@ public PubSubMessageHandler pubSubMessageHandler(PubSubTemplate pubSubTemplate)
 			// tag::adapter_callback[]
 			adapter.setPublishCallback(new ListenableFutureCallback<String>() {
 				@Override
-				public void onFailure(@NotNull Throwable ex) {
+				public void onFailure(Throwable ex) {
 				}
 
 				@Override

spring-cloud-gcp-samples/spring-cloud-gcp-metrics-sample/README.adoc

@@ -16,14 +16,16 @@ Run the sample application from Maven:
 $ mvn spring-boot:run
 ----
 
-Then, issue a request to `localhost:8080/` endpoint and verify that a label appears in Stackdriver:
+Then, issue a request to `localhost:8080/{custom metric name}` endpoint and verify that the metric appears in Stackdriver:
 
 ----
-$ curl localhost:8080/
+$ curl localhost:8080/my_ping_counter
 ----
 
+Metrics are reported to Stackdriver every 60 seconds.
+So, wait a minute for the custom metric to be reported.
 To see the metrics, navigate to the https://console.cloud.google.com/monitoring/metrics-explorer[Monitoring section of the Cloud Console].
-Select the `custom/ping` metric to see the tracked metric.
+Select the `custom/my_ping_counter` metric to see the tracked metric.
 
 === Running on Google Cloud Platform
 

spring-cloud-gcp-samples/spring-cloud-gcp-metrics-sample/pom.xml

@@ -28,10 +28,6 @@
     </dependencyManagement>
 
     <dependencies>
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-actuator</artifactId>
-        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-web</artifactId>

spring-cloud-gcp-samples/spring-cloud-gcp-metrics-sample/src/main/java/com/example/ExampleController.java

@@ -18,8 +18,8 @@
 
 import io.micrometer.core.instrument.MeterRegistry;
 
+import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
-import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RestController;
 
 @RestController
@@ -31,9 +31,9 @@ public ExampleController(MeterRegistry meterRegistry) {
 		this.meterRegistry = meterRegistry;
 	}
 
-	@PostMapping("/{id}")
+	@GetMapping("/{id}")
 	public String counter(@PathVariable String id) {
 		this.meterRegistry.counter(id).increment();
-		return "Ping return successfully";
+		return "Incremented " + id + " counter successfully";
 	}
 }

spring-cloud-gcp-samples/spring-cloud-gcp-metrics-sample/src/main/resources/application.properties

@@ -1 +1,2 @@
-management.endpoints.web.exposure.include=*
+# (optional) enable access to http://localhost:8080/actuator/metrics
+management.endpoints.web.exposure.include=metrics

spring-cloud-gcp-samples/spring-cloud-gcp-metrics-sample/src/test/java/com/example/MetricsSampleApplicationIntegrationTests.java

@@ -82,7 +82,7 @@ public void testMetricRecordedInStackdriver() {
 		String id = "integration_test_" + UUID.randomUUID().toString().replace('-', '_');
 		String url = String.format("http://localhost:%s/%s", this.port, id);
 
-		ResponseEntity<String> responseEntity = this.testRestTemplate.postForEntity(url, null, String.class);
+		ResponseEntity<String> responseEntity = this.testRestTemplate.getForEntity(url, String.class, String.class);
 		assertThat(responseEntity.getStatusCode().is2xxSuccessful()).isTrue();
 
 		String metricType = "custom.googleapis.com/" + id;

spring-cloud-gcp-starters/spring-cloud-gcp-starter-metrics/pom.xml

@@ -22,5 +22,9 @@
 			<groupId>io.micrometer</groupId>
 			<artifactId>micrometer-registry-stackdriver</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-actuator</artifactId>
+		</dependency>
 	</dependencies>
 </project>

spring-cloud-gcp-vision/src/main/java/com/google/cloud/spring/vision/OcrPageRange.java

@@ -16,6 +16,7 @@
 
 package com.google.cloud.spring.vision;
 
+import java.nio.charset.StandardCharsets;
 import java.util.List;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -96,7 +97,7 @@ private static List<TextAnnotation> parseJsonBlob(Blob blob)
 			throws InvalidProtocolBufferException {
 
 		AnnotateFileResponse.Builder annotateFileResponseBuilder = AnnotateFileResponse.newBuilder();
-		String jsonContent = new String(blob.getContent());
+		String jsonContent = new String(blob.getContent(), StandardCharsets.UTF_8);
 		JsonFormat.parser().ignoringUnknownFields().merge(jsonContent, annotateFileResponseBuilder);
 
 		AnnotateFileResponse annotateFileResponse = annotateFileResponseBuilder.build();