page_type

languages

products

description

urlFragment

sample

java

Azure Spring Cloud

Deploy Spring microservices using Azure Spring Cloud and MySQL

spring-petclinic-microservices

Deploy Spring Microservices using Azure Spring Cloud and MySQL

Azure Spring Cloud enables you to easily run Spring Boot based microservices application on Azure.

This quickstart shows you how to deploy an existing Java Spring Cloud application to Azure. When you're finished, you can continue to manage the application via the Azure CLI or switch to using the Azure portal.

What will you experience

You will:

Build existing Spring microservices applications
Provision an Azure Spring Cloud service instance
Deploy applications to Azure
Bind applications to Azure Database for MySQL
Open the application
Monitor application using Application Insights or APMs of your choice - New Relic, App Dynamics or Dynatrace.

What you will need

In order to deploy a Java app to cloud, you need an Azure subscription. If you do not already have an Azure subscription, you can activate your MSDN subscriber benefits or sign up for a free Azure account.

In addition, you will need the following:

Install the Azure CLI extension

Install the Azure Spring Cloud extension for the Azure CLI using the following command

    az extension add --name spring-cloud

Clone and build the repo

Create a new folder and clone the sample app repository to your Azure Cloud account

    mkdir source-code
    git clone https://github.com/azure-samples/spring-petclinic-microservices

Change directory and build the project

    cd spring-petclinic-microservices
    mvn clean package -DskipTests -Denv=cloud

This will take a few minutes.

Provision Azure Spring Cloud service instance using Azure CLI

Prepare your environment for deployments

Create a bash script with environment variables by making a copy of the supplied template:

    cp .scripts/setup-env-variables-azure-template.sh .scripts/setup-env-variables-azure.sh

Open .scripts/setup-env-variables-azure.sh and enter the following information:

    export SUBSCRIPTION=subscription-id # customize this
    export RESOURCE_GROUP=resource-group-name # customize this
    ...
    export SPRING_CLOUD_SERVICE=azure-spring-cloud-name # customize this
    ...
    export MYSQL_SERVER_NAME=mysql-servername # customize this
    ...
    export MYSQL_SERVER_ADMIN_NAME=admin-name # customize this
    ...
    export MYSQL_SERVER_ADMIN_PASSWORD=SuperS3cr3t # customize this
    ...
    export APPLICATIONINSIGHTS_CONNECTION_STRING=InstrumentationKey=instrumentation-key # customize this
    ...
    export NEW_RELIC_LICENSE_KEY=license-key # customize this

Then, set the environment:

    source .scripts/setup-env-variables-azure.sh

Login to Azure

Login to the Azure CLI and choose your active subscription. Be sure to choose the active subscription that is whitelisted for Azure Spring Cloud

    az login
    az account list -o table
    az account set --subscription ${SUBSCRIPTION}

Create Azure Spring Cloud service instance

Prepare a name for your Azure Spring Cloud service. The name must be between 4 and 32 characters long and can contain only lowercase letters, numbers, and hyphens. The first character of the service name must be a letter and the last character must be either a letter or a number.

Create a resource group to contain your Azure Spring Cloud service.

    az group create --name ${RESOURCE_GROUP} \
        --location ${REGION}

Create an instance of Azure Spring Cloud.

    az spring-cloud create --name ${SPRING_CLOUD_SERVICE} \
        --resource-group ${RESOURCE_GROUP} \
        --location ${REGION}

The service instance will take around five minutes to deploy.

Set your default resource group name and cluster name using the following commands:

    az configure --defaults \
        group=${RESOURCE_GROUP} \
        location=${REGION} \
        spring-cloud=${SPRING_CLOUD_SERVICE}

Load Spring Cloud Config Server

Use the application.yml in the root of this project to load configuration into the Config Server in Azure Spring Cloud.

    az spring-cloud config-server set \
        --config-file application.yml \
        --name ${SPRING_CLOUD_SERVICE}

Create microservice applications

Create 5 microservice apps.

Note - there is a known Azure Spring Cloud CLI bug, --enable-persistent-storage true does not enable persistent storage. Until that is fixed, you have to go to the Azure Portal, open the Azure Spring Cloud instance that you created, go to the Apps blade and explicity enable persistent storage under Configuration/Persistent Storage.

    az spring-cloud app create --name ${API_GATEWAY} --instance-count 1 --is-public true \
        --memory 2 \
        --jvm-options='-Xms2048m -Xmx2048m' \
        --enable-persistent-storage true
    
    az spring-cloud app create --name ${ADMIN_SERVER} --instance-count 1 --is-public true \
        --memory 2 \
        --jvm-options='-Xms2048m -Xmx2048m' \
        --enable-persistent-storage true
    
    az spring-cloud app create --name ${CUSTOMERS_SERVICE} --instance-count 1 --is-public true \
        --memory 2 \
        --jvm-options='-Xms2048m -Xmx2048m' \
        --enable-persistent-storage true
    
    az spring-cloud app create --name ${VETS_SERVICE} --instance-count 1 --is-public true \
        --memory 2 \
        --jvm-options='-Xms2048m -Xmx2048m' \
        --enable-persistent-storage true
    
    az spring-cloud app create --name ${VISITS_SERVICE} --instance-count 1 --is-public true \
        --memory 2 \
        --jvm-options='-Xms2048m -Xmx2048m' \
        --enable-persistent-storage true

Upload Application Performance Monitoring (APM) JARS

Download APM JARS

Download Application Insights JAR or New Relic JAR or both.

    # // Get Application Insights JAR
    mkdir apm
    cd apm
    wget https://github.com/microsoft/ApplicationInsights-Java/releases/download/3.0.0-PREVIEW.5/applicationinsights-agent-3.0.0-PREVIEW.5.jar
    
    # // Get New Relic JAR
    curl -O https://download.newrelic.com/newrelic/java-agent/newrelic-agent/current/newrelic-java.zip
    unzip newrelic-java.zip 
    cp newrelic/newrelic.jar .

Upload APM JARS

Deploy a simple Java app that provides a Web user interface for uploading APM JARS and upload them. Credits to callicoder.

    az spring-cloud app deploy --name ${API_GATEWAY} \
        --jar-path ${FILE_UPLOAD_JAR}
    
    az spring-cloud app show --name ${API_GATEWAY} | grep url

Open the API Gateway app using the URL provided by the previous command and upload APM JARs.

   az spring-cloud app deploy --name ${ADMIN_SERVER} \
           --jar-path ${FILE_UPLOAD_JAR}
           
   az spring-cloud app show --name ${ADMIN_SERVER} | grep url

Open the Admin Server app using the URL provided by the previous command and upload APM JARs.

    az spring-cloud app deploy --name ${CUSTOMERS_SERVICE} \
        --jar-path ${FILE_UPLOAD_JAR}
            
   az spring-cloud app show --name ${CUSTOMERS_SERVICE} | grep url

Open the Customers Service app using the URL provided by the previous command and upload APM JARs.

    az spring-cloud app deploy --name ${VETS_SERVICE} \
            --jar-path ${FILE_UPLOAD_JAR}
            
   az spring-cloud app show --name ${VETS_SERVICE} | grep url

Open the Vets Service app using the URL provided by the previous command and upload APM JARs.

    az spring-cloud app deploy --name ${VISITS_SERVICE} \
            --jar-path ${FILE_UPLOAD_JAR}
            
   az spring-cloud app show --name ${VISITS_SERVICE} | grep url

Open the Visits Service app using the URL provided by the previous command and upload APM JARs.

Disable public URIs for Customers, Vets and Visits service.

    az spring-cloud app update --name ${CUSTOMERS_SERVICE} --is-public false
    az spring-cloud app update --name ${VETS_SERVICE} --is-public false
    az spring-cloud app update --name ${VISITS_SERVICE} --is-public false

Create MySQL Database

Create a MySQL database in Azure Database for MySQL.

    // create mysql server
    az mysql server create --resource-group ${RESOURCE_GROUP} \
     --name ${MYSQL_SERVER_NAME}  --location ${REGION} \
     --admin-user ${MYSQL_SERVER_ADMIN_NAME} \
     --admin-password ${MYSQL_SERVER_ADMIN_PASSWORD} \
     --sku-name GP_Gen5_2 \
     --ssl-enforcement Disabled \
     --version 5.7
    
    // allow access from Azure resources
    az mysql server firewall-rule create --name allAzureIPs \
     --server ${MYSQL_SERVER_NAME} \
     --resource-group ${RESOURCE_GROUP} \
     --start-ip-address 0.0.0.0 --end-ip-address 0.0.0.0
    
    // allow access from your dev machine for testing
    az mysql server firewall-rule create --name devMachine \
     --server ${MYSQL_SERVER_NAME} \
     --resource-group ${RESOURCE_GROUP} \
     --start-ip-address <ip-address-of-your-dev-machine> \
     --end-ip-address <ip-address-of-your-dev-machine>
    
    // increase connection timeout
    az mysql server configuration set --name wait_timeout \
     --resource-group ${RESOURCE_GROUP} \
     --server ${MYSQL_SERVER_NAME} --value 2147483
    
    // SUBSTITUTE values
    mysql -u ${MYSQL_SERVER_ADMIN_LOGIN_NAME} \
     -h ${MYSQL_SERVER_FULL_NAME} -P 3306 -p
    
    Enter password:
    Welcome to the MySQL monitor.  Commands end with ; or \g.
    Your MySQL connection id is 64379
    Server version: 5.6.39.0 MySQL Community Server (GPL)
    
    Copyright (c) 2000, 2018, Oracle and/or its affiliates. All rights reserved.
    
    Oracle is a registered trademark of Oracle Corporation and/or its
    affiliates. Other names may be trademarks of their respective
    owners.
    
    Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
    
    mysql> CREATE DATABASE petclinic;
    Query OK, 1 row affected (0.10 sec)
    
    mysql> CREATE USER 'root' IDENTIFIED BY 'petclinic';
    Query OK, 0 rows affected (0.11 sec)
    
    mysql> GRANT ALL PRIVILEGES ON petclinic.* TO 'root';
    Query OK, 0 rows affected (1.29 sec)
    
    mysql> CALL mysql.az_load_timezone();
    Query OK, 3179 rows affected, 1 warning (6.34 sec)
    
    mysql> SELECT name FROM mysql.time_zone_name;
    ...
    
    mysql> quit
    Bye
    
    
    az mysql server configuration set --name time_zone \
     --resource-group ${RESOURCE_GROUP} \
     --server ${MYSQL_SERVER_NAME} --value "US/Pacific"

Deploy applications and set environment variables

Deploy microservice applications to Azure.

    az spring-cloud app deploy --name ${API_GATEWAY} \
        --jar-path ${API_GATEWAY_JAR} \
        --jvm-options='-Xms2048m -Xmx2048m -Dspring.profiles.active=mysql -javaagent:/persistent/apm/applicationinsights-agent-3.0.0-PREVIEW.5.jar -javaagent:/persistent/apm/newrelic.jar' \
        --env APPLICATIONINSIGHTS_CONNECTION_STRING=${APPLICATIONINSIGHTS_CONNECTION_STRING} \
              APPLICATIONINSIGHTS_ROLE_NAME=${API_GATEWAY} \
              NEW_RELIC_LICENSE_KEY=${NEW_RELIC_LICENSE_KEY} \
              NEW_RELIC_APP_NAME=${API_GATEWAY}
    
    az spring-cloud app deploy --name ${ADMIN_SERVER} \
        --jar-path ${ADMIN_SERVER_JAR} \
        --jvm-options='-Xms2048m -Xmx2048m -Dspring.profiles.active=mysql -javaagent:/persistent/apm/applicationinsights-agent-3.0.0-PREVIEW.5.jar -javaagent:/persistent/apm/newrelic.jar' \
        --env APPLICATIONINSIGHTS_CONNECTION_STRING=${APPLICATIONINSIGHTS_CONNECTION_STRING} \
              APPLICATIONINSIGHTS_ROLE_NAME=${ADMIN_SERVER} \
              NEW_RELIC_LICENSE_KEY=${NEW_RELIC_LICENSE_KEY} \
              NEW_RELIC_APP_NAME=${ADMIN_SERVER}
    
    az spring-cloud app deploy --name ${CUSTOMERS_SERVICE} \
        --jar-path ${CUSTOMERS_SERVICE_JAR} \
        --jvm-options='-Xms2048m -Xmx2048m -Dspring.profiles.active=mysql -javaagent:/persistent/apm/applicationinsights-agent-3.0.0-PREVIEW.5.jar -javaagent:/persistent/apm/newrelic.jar' \
        --env MYSQL_SERVER_FULL_NAME=${MYSQL_SERVER_FULL_NAME} \
              MYSQL_DATABASE_NAME=${MYSQL_DATABASE_NAME} \
              MYSQL_SERVER_ADMIN_LOGIN_NAME=${MYSQL_SERVER_ADMIN_LOGIN_NAME} \
              MYSQL_SERVER_ADMIN_PASSWORD=${MYSQL_SERVER_ADMIN_PASSWORD} \
              APPLICATIONINSIGHTS_CONNECTION_STRING=${APPLICATIONINSIGHTS_CONNECTION_STRING} \
              APPLICATIONINSIGHTS_ROLE_NAME=${CUSTOMERS_SERVICE} \
              NEW_RELIC_LICENSE_KEY=${NEW_RELIC_LICENSE_KEY} \
              NEW_RELIC_APP_NAME=${CUSTOMERS_SERVICE}
    
    az spring-cloud app deploy --name ${VETS_SERVICE} \
        --jar-path ${VETS_SERVICE_JAR} \
        --jvm-options='-Xms2048m -Xmx2048m -Dspring.profiles.active=mysql -javaagent:/persistent/apm/applicationinsights-agent-3.0.0-PREVIEW.5.jar -javaagent:/persistent/apm/newrelic.jar' \
        --env MYSQL_SERVER_FULL_NAME=${MYSQL_SERVER_FULL_NAME} \
              MYSQL_DATABASE_NAME=${MYSQL_DATABASE_NAME} \
              MYSQL_SERVER_ADMIN_LOGIN_NAME=${MYSQL_SERVER_ADMIN_LOGIN_NAME} \
              MYSQL_SERVER_ADMIN_PASSWORD=${MYSQL_SERVER_ADMIN_PASSWORD} \
              APPLICATIONINSIGHTS_CONNECTION_STRING=${APPLICATIONINSIGHTS_CONNECTION_STRING} \
              APPLICATIONINSIGHTS_ROLE_NAME=${VETS_SERVICE} \
              NEW_RELIC_LICENSE_KEY=${NEW_RELIC_LICENSE_KEY} \
              NEW_RELIC_APP_NAME=${VETS_SERVICE}
    
    az spring-cloud app deploy --name ${VISITS_SERVICE} \
        --jar-path ${VISITS_SERVICE_JAR} \
        --jvm-options='-Xms2048m -Xmx2048m -Dspring.profiles.active=mysql -javaagent:/persistent/apm/applicationinsights-agent-3.0.0-PREVIEW.5.jar -javaagent:/persistent/apm/newrelic.jar' \
        --env MYSQL_SERVER_FULL_NAME=${MYSQL_SERVER_FULL_NAME} \
              MYSQL_DATABASE_NAME=${MYSQL_DATABASE_NAME} \
              MYSQL_SERVER_ADMIN_LOGIN_NAME=${MYSQL_SERVER_ADMIN_LOGIN_NAME} \
              MYSQL_SERVER_ADMIN_PASSWORD=${MYSQL_SERVER_ADMIN_PASSWORD} \
              APPLICATIONINSIGHTS_CONNECTION_STRING=${APPLICATIONINSIGHTS_CONNECTION_STRING} \
              APPLICATIONINSIGHTS_ROLE_NAME=${VISITS_SERVICE} \
              NEW_RELIC_LICENSE_KEY=${NEW_RELIC_LICENSE_KEY} \
              NEW_RELIC_APP_NAME=${VISITS_SERVICE}

    az spring-cloud app show --name ${API_GATEWAY} | grep url

Navigate to the URL provided by the previous command to open the Pet Clinic microservice application.

Monitor Spring Microservices using Application Insights or New Relic APMs

Open Application Insights and navigate to Application Map:

Navigate to Performance:

Navigate to Performance/Dependenices - you can see the performance number for dependencies:

Navigate to Failures/Exceptions - you can see a collection of exceptions:

Click on an exception to see the end-to-end transaction and stacktrace in context:

Navigate to Metrics - you can see metrics contributed by Spring Boot apps, Spring Cloud modules, dependencies and custome metrics published by your code. The chart below shows gateway-requests (Spring Cloud Gateway), hikaricp_connections (JDBC Connections) and http_client_requests.

Navigate to Live Metrics - you can see live metrics on screen with low latencies < 60 seconds:

Open New Relic and navigate to 'Service Maps':

Open api-gateway app - you can see Web transactions time, Apdex score, Throughput and Transactions:

Open customers-service app - you can see Web transactions time, Apdex score, Throughput and Transactions:

Navigate to 'Transactions' for customers-service app - you can see Web calls by wall clock and Throughput:

Select a Web call /owners(GET) to learn more details:

Navigate to Databases to identify SQL calls:

SORT BY - Slowest query time to rank calls by query time:

Click Show all database operations table... to find all SQL calls:

Navigate to JVMs - you can see JVM metrics:

Navigate to Error analytics - you can see exceptions thrown by app code:

Select one of the errors on the bottom right - you can see more details about the exception or error:

Navigate to Reports - SLA - you can daily SLA:

Navigate to Reports - Web transactions - you can see a summary of transactions:

Select one of the transaction, say /owners(GET), you can see its breakdown:

Open you iPhone New Relic app to monitor apps using your mobile:

Next Steps

In this quickstart, you've deployed an existing Spring microservices app using Azure CLI. To learn more about Azure Spring Cloud, go to:

Credits

This Spring microservices sample is forked from spring-petclinic/spring-petclinic-microservices - see Petclinic README.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

selvasingh/spring-petclinic-microservices