Spring Boot アプリケーションをお手軽に本番運用 ~ AWS App Runner と AWS CDK の活用 ~ 最終回

watch curl -s https://xxx.xxx.awsapprunner.com # App Runner にデプロイしたサービスのURL

...
    const instanceRole = new iam.Role(this, 'InstanceRole', {
    ...
    });
    // サービスが X-Ray にトレース情報を公開できるよう権限を追加する
    instanceRole.addManagedPolicy(iam.ManagedPolicy.fromAwsManagedPolicyName("AWSXRayDaemonWriteAccess"));
    
    // X-Ray 機能を有効化する、App Runner のオブザーバビリティ設定を追加
    const appRunnerObservability = new apprunner.CfnObservabilityConfiguration(this, 'ObservabilityConfiguration', {
      traceConfiguration: {
        vendor: "AWSXRAY",
      },
    });
    ...
    
    // App Runner サービスを作成
    const service = new apprunner.CfnService(this, 'Service', {
      sourceConfiguration: {
      ...
      },
      
      // 上記で定義したオブザーバビリティの設定をサービスに組み込む
      observabilityConfiguration: {
        observabilityEnabled: true,
        observabilityConfigurationArn: appRunnerObservability.attrObservabilityConfigurationArn,
      },
      ...

npx cdk deploy --all

java -javaagent <ADOT のエージェントの jar> -jar <アプリケーションのjar>

repositories {
    mavenCentral()
}

// Java エージェントのjarを格納する依存関係グループ
configurations {
    javaAgent
}

dependencies {
    ...
    
    // ADOT Java エージェントのダウンロード
    javaAgent('software.amazon.opentelemetry:aws-opentelemetry-agent:1.30.0')
}

// ダウンロードした ADOT Java エージェントをコピー
task agentLibs(type: Copy) {
    from configurations.javaAgent.singleFile
    into layout.buildDirectory.dir('libs')
    rename 'aws-opentelemetry-agent-.*\\.jar', 'aws-opentelemetry-agent.jar'
}

// アプリケーションの jar をビルドした際に ADOT の jar も取得する
bootJar {
    dependsOn agentLibs
}

 // App Runner サービスを作成
    const service = new apprunner.CfnService(this, 'Service', {
      sourceConfiguration: {
        ...
        codeRepository: {
          ...
          codeConfiguration: {
            configurationSource: "API",
            codeConfigurationValues: {
              ...
              runtimeEnvironmentVariables: [
                // Java エージェントを設定
                {
                  name: "JAVA_TOOL_OPTIONS",
                  value: "-javaagent:/app/aws-opentelemetry-agent.jar",
                },
                // トレースに X-Ray を設定
                {
                  name: "OTEL_PROPAGATORS",
                  value: "xray",
                },
                // OpenTelemetry はトレース以外にメトリクスも本来出力できるが、App Runner の
                // OpenTelemetry サポートはメトリクスに対応していないため無効化する
                {
                  name: "OTEL_METRICS_EXPORTER",
                  value: "none",
                },
                // X-Ray 上のサービス名を設定
                {
                  name: "OTEL_RESOURCE_ATTRIBUTES",
                  value: "service.name=expt_apprunner_springboot",
                },
              ],
              ...

npx cdk deploy --all

watch curl -s https://xxx.xxx.awsapprunner.com # App Runner にデプロイしたサービスのURL

dependencyManagement {
    imports {
        mavenBom 'io.awspring.cloud:spring-cloud-aws-dependencies:2.4.4'
    }
}

dependencies {
    ...
    implementation('io.awspring.cloud:spring-cloud-starter-aws')
    implementation('org.springframework.boot:spring-boot-starter-actuator')
    implementation('io.micrometer:micrometer-registry-cloudwatch')
    ...
}

...
spring:
  redis:
    host: ${CACHE_HOST:localhost}
    port: ${CACHE_PORT:6379}
    password: ${CACHE_PASSWORD:}
management:
  endpoint:
    health:
      show-details: always
  metrics:
    enable:
      process: true
      spring: true
      tomcat: true
      jvm: true
    export:
      cloudwatch:
        namespace: expt-apprunner-springboot
        enabled: true
        step: 1s

    const instanceRole = new iam.Role(this, 'InstanceRole', {
      assumedBy: new iam.ServicePrincipal('tasks.apprunner.amazonaws.com'),
      inlinePolicies: {
        ....
        
        cloudwatch: new iam.PolicyDocument({
          statements: [
            new iam.PolicyStatement({
              effect: iam.Effect.ALLOW,
              actions: [ "cloudwatch:PutMetricData" ],
              resources: [ "*" ],
            }),
          ],
        }),
      },
    });

dependencies {
    ....
    // AppConfig の SDK
    implementation('software.amazon.awssdk:appconfigdata:2.20.162')
    runtimeOnly('software.amazon.awssdk:sts:2.20.162')
    ...
}

package com.example.exptapprunnerspringboot;

import java.util.Map;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class FeatureOneController {

    @Autowired
    private FeatureFlag featureFlag;
    
    @GetMapping("/feature1")
    public Map<String, Boolean> root() throws InterruptedException {
        if (featureFlag.isFeatureOneEnabled()) {
            // The feature is assumed to consume a bit time.
            Thread.sleep(3000);
        }
        return Map.of("feature1", featureFlag.isFeatureOneEnabled());
    }
}

package com.example.exptapprunnerspringboot;

import java.io.UncheckedIOException;
import java.io.Serializable;
import java.util.Map;

import com.fasterxml.jackson.annotation.JsonProperty;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;

import software.amazon.awssdk.services.appconfigdata.AppConfigDataClient;
import software.amazon.awssdk.services.appconfigdata.model.GetLatestConfigurationResponse;
import software.amazon.awssdk.services.appconfigdata.model.ResourceNotFoundException;
import software.amazon.awssdk.services.appconfigdata.model.StartConfigurationSessionRequest;

@Component
public class FeatureFlag {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    private final ObjectMapper objectMapper;

    private final AppConfigDataClient client = AppConfigDataClient.builder().build();

    private final String appName;
    private final String envName;

    private String sessionToken;

    private volatile boolean feature1 = false;

    public FeatureFlag(@Autowired ObjectMapper objectMapper,
            @Value("${settings.app.name}") String appName,
            @Value("${settings.env.name}") String envName) {
        this.objectMapper = objectMapper;
        this.appName = appName;
        this.envName = envName;
    }
    
    @Scheduled(fixedRate = 5000)
    public void scheduling() {
        String configurationProfile = "feature1";
        try {
            refresh(appName, envName, configurationProfile);
        } catch (ResourceNotFoundException ex) {
            logger.warn("The AppConfig resource has not been deployed: {}, {}, {}, {}",
                appName, envName,  configurationProfile, ex.getMessage());
        }
    }

    public void refresh(String appName, String envName, String configurationProfile) {
        if (this.sessionToken == null) {
            StartConfigurationSessionRequest request = StartConfigurationSessionRequest.builder()
                .applicationIdentifier(appName)
                .environmentIdentifier(envName)
                .configurationProfileIdentifier(configurationProfile)
                .build();
                this.sessionToken = client.startConfigurationSession(request).initialConfigurationToken();
        }

        GetLatestConfigurationResponse response = client.getLatestConfiguration((s) -> {
            s.configurationToken(this.sessionToken);
        });

        if (response.configuration().asByteArray().length > 0) {
            String featureValue = response.configuration().asUtf8String();
            logger.info("AppConfig changed: {}", featureValue);

            try {
                FeatureMode featureOne = objectMapper.readValue(featureValue, FeatureMode.class);
                this.feature1 = featureOne.isEnabled();
            } catch (JsonProcessingException | UncheckedIOException e) {
                throw new RuntimeException(e);
            }
        }

        this.sessionToken = response.nextPollConfigurationToken();
    }

    public boolean isFeatureOneEnabled() {
        return this.feature1;
    }

    private static class FeatureMode implements Serializable {
        @JsonProperty
        private Map<String, Boolean> mode;

        public boolean isEnabled() {
            if (mode != null) {
                return mode.get("enabled");
            } else {
                return false;
            }
        }
    }
}

settings:
  app:
    name: expt-apprunner-springboot
  env:
    name: ${APPCONFIG_ENV_NAME:dev}

 const instanceRole = new iam.Role(this, 'InstanceRole', {
      assumedBy: new iam.ServicePrincipal('tasks.apprunner.amazonaws.com'),
      inlinePolicies: {
        appconfig: new iam.PolicyDocument({
          statements: [
            new iam.PolicyStatement({
              effect: iam.Effect.ALLOW,
              actions: [
                "appconfig:GetLatestConfiguration",
                "appconfig:StartConfigurationSession",
              ],
              resources: [ "*" ],
            }),
          ],
        }),
        
....

          codeConfiguration: {
            configurationSource: "API",
            codeConfigurationValues: {
              runtime: "CORRETTO_11",
              buildCommand: "./gradlew bootJar && cp build/libs/*.jar ./",
              startCommand: "java -jar ./expt-apprunner-springboot.jar",
              runtimeEnvironmentVariables: [
              ...
                {
                  name: "APPCONFIG_ENV_NAME",
                  value: "prod",
                },

npx cdk deploy --all

watch curl -s https://xxx.xxx.awsapprunner.com/feature1 # App Runner にデプロイしたサービスのURL

{"feature1":false}

watch curl -s https://xxx.xxx.awsapprunner.com/feature1 # App Runner にデプロイしたサービスのURL

{"feature1":true}