com.google.cloud.spring.autoconfigure.metrics.GcpStackdriverMetricsAutoConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-cloud-gcp-autoconfigure Show documentation
Spring Framework on Google Cloud
There is a newer version: 5.6.1
Show newest version
/*
 * Copyright 2017-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.cloud.spring.autoconfigure.metrics;

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.stackdriver.StackdriverConfig;
import io.micrometer.stackdriver.StackdriverMeterRegistry;
import java.io.IOException;
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.AutoConfiguration;
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
import org.springframework.boot.autoconfigure.AutoConfigureBefore;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;

/**
 * Provides auto-detection for `project-id` and `credentials`.
 *
 * @since 1.2.4
 */
@AutoConfiguration
@AutoConfigureBefore(StackdriverMetricsExportAutoConfiguration.class)
@AutoConfigureAfter(MetricsAutoConfiguration.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 {

  private final StackdriverProperties stackdriverProperties;

  private final String projectId;

  private final CredentialsProvider credentialsProvider;

  public GcpStackdriverMetricsAutoConfiguration(
      GcpMetricsProperties gcpMetricsProperties,
      StackdriverProperties stackdriverProperties,
      GcpProjectIdProvider gcpProjectIdProvider,
      CredentialsProvider credentialsProvider)
      throws IOException {
    this.stackdriverProperties = stackdriverProperties;
    this.projectId =
        (gcpMetricsProperties.getProjectId() != null)
            ? gcpMetricsProperties.getProjectId()
            : gcpProjectIdProvider.getProjectId();
    this.credentialsProvider =
        gcpMetricsProperties.getCredentials().hasKey()
            ? new DefaultCredentialsProvider(gcpMetricsProperties)
            : credentialsProvider;
  }

  @Bean
  @ConditionalOnMissingBean
  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();
  }
}