Distributed tracing (#17)

* Application changes - Add app insight agent

* Dockerfile changes for integrating App Insights for ACA email processor job

* Terraform - app insights

Author: nickdala

apps/contoso-fiber/pom.xml

@@ -142,6 +142,11 @@
             <artifactId>spring-cloud-azure-starter-storage-blob</artifactId>
         </dependency>
 
+        <dependency>
+            <groupId>com.microsoft.azure</groupId>
+            <artifactId>applicationinsights-runtime-attach</artifactId>
+        </dependency>
+
     </dependencies>
 
     <build>

apps/contoso-fiber/src/main/java/com/contoso/cams/CamsApplication.java

@@ -13,13 +13,16 @@
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
 
+import com.microsoft.applicationinsights.attach.ApplicationInsights;
+
 import nz.net.ultraq.thymeleaf.layoutdialect.LayoutDialect;
 
 @SpringBootApplication
 @EnableCaching
 public class CamsApplication {
 
 	public static void main(String[] args) {
+        ApplicationInsights.attach();
 		SpringApplication.run(CamsApplication.class, args);
 	}
 

apps/contoso-fiber/src/main/java/com/contoso/cams/support/SupportGuideEmailResponseProcessor.java

@@ -29,7 +29,7 @@ public class SupportGuideEmailResponseProcessor {
     Consumer<Message<byte[]>> consumeemailresponse() {
         return message -> {
             Checkpointer checkpointer = (Checkpointer) message.getHeaders().get(CHECKPOINTER);
-            log.info("Received message: {}", message.getPayload());
+            log.info("Received message: {}", new String(message.getPayload()));
 
             EmailResponse emailResponse = parseMessage(message);
 
@@ -43,7 +43,7 @@ Consumer<Message<byte[]>> consumeemailresponse() {
 
             // Checkpoint after processing the message
             checkpointer.success()
-                .doOnSuccess(s -> log.info("Message '{}' successfully checkpointed", message.getPayload()))
+                .doOnSuccess(s -> log.info("Message '{}' successfully checkpointed", new String(message.getPayload())))
                 .doOnError(e -> log.error("Exception found", e))
                 .block();
         };

apps/email-processor/Dockerfile

@@ -1,5 +1,5 @@
 FROM mcr.microsoft.com/openjdk/jdk:17-ubuntu
 VOLUME /tmp
-ARG JAR_FILE
-COPY ${JAR_FILE} app.jar
-ENTRYPOINT ["java","-jar","/app.jar"]
+COPY target/email-processor.jar app.jar
+COPY target/agent/applicationinsights-agent.jar applicationinsights-agent.jar
+ENTRYPOINT ["java", "-javaagent:applicationinsights-agent.jar", "-jar", "/app.jar"]

apps/email-processor/pom.xml

@@ -70,6 +70,30 @@
 				<groupId>org.springframework.boot</groupId>
 				<artifactId>spring-boot-maven-plugin</artifactId>
 			</plugin>
+            <plugin>
+                <artifactId>maven-dependency-plugin</artifactId>
+                <version>3.8.0</version>
+                <executions>
+                  <execution>
+                    <id>copy-agent</id>
+                    <phase>package</phase>
+                    <goals>
+                      <goal>copy</goal>
+                    </goals>
+                  </execution>
+                </executions>
+                <configuration>
+                  <artifactItems>
+                    <artifactItem>
+                      <groupId>com.microsoft.azure</groupId>
+                      <artifactId>applicationinsights-agent</artifactId>
+                      <version>${applicationinsights.version}</version>
+                      <outputDirectory>${project.build.directory}/agent</outputDirectory>
+                      <destFileName>applicationinsights-agent.jar</destFileName>
+                    </artifactItem>
+                  </artifactItems>
+                </configuration>
+              </plugin>
 		</plugins>
 	</build>
 

azure.yaml

@@ -24,5 +24,3 @@ services:
     host: containerapp
     docker:
       path: ./Dockerfile
-      buildArgs:
-        - "JAR_FILE=target/email-processor.jar"

infra/shared/terraform/modules/aca/main.tf

@@ -116,6 +116,10 @@ resource "azurerm_container_app" "container_app" {
         name  = "AZURE_SERVICEBUS_EMAIL_RESPONSE_QUEUE_NAME"
         value = var.email_response_queue_name
       }
+      env {
+        name = "APPLICATIONINSIGHTS_CONNECTION_STRING"
+        value = var.app_insights_connection_string
+      }
     }
     max_replicas = 10
     min_replicas = 1
@@ -150,4 +154,4 @@ resource "azurerm_private_dns_zone_virtual_network_link" "virtual_network_link_a
   private_dns_zone_name = azurerm_private_dns_zone.dns_for_aca[0].name
   virtual_network_id    = var.spoke_vnet_id
   resource_group_name   = var.resource_group
-}
+}

infra/shared/terraform/modules/aca/variables.tf

@@ -19,6 +19,11 @@ variable "application_name" {
   description = "The name of your application"
 }
 
+variable "app_insights_connection_string" {
+  type        = string
+  description = "The app insights connection string"
+}
+
 variable "log_analytics_workspace_id" {
   type        = string
   description = "The ID of the Log Analytics workspace"
@@ -70,4 +75,4 @@ variable "spoke_vnet_id" {
   type        = string
   description = "The ID of the spoke VNET"
   default     = null
-}
+}

infra/terraform/aca.tf

@@ -16,6 +16,7 @@ module  "aca" {
     servicebus_namespace = module.servicebus[0].namespace_name
     container_registry_user_assigned_identity_id = module.acr[0].container_registry_user_assigned_identity_id
     acr_login_server = module.acr[0].acr_login_server
+    app_insights_connection_string = module.hub_app_insights[0].connection_string
     log_analytics_workspace_id  = var.environment == "prod" ? module.hub_app_insights[0].log_analytics_workspace_id:  module.dev_app_insights[0].log_analytics_workspace_id
     servicebus_namespace_primary_connection_string = module.servicebus[0].servicebus_namespace_primary_connection_string
 }
@@ -37,6 +38,7 @@ module  "secondary_aca" {
     container_registry_user_assigned_identity_id = module.acr[0].container_registry_user_assigned_identity_id
     acr_login_server = module.acr[0].acr_login_server
     log_analytics_workspace_id  = module.hub_app_insights[0].log_analytics_workspace_id
+    app_insights_connection_string = module.hub_app_insights[0].connection_string
     servicebus_namespace_primary_connection_string = module.secondary_servicebus[0].servicebus_namespace_primary_connection_string
 }
 
@@ -60,5 +62,6 @@ module  "dev_aca" {
     container_registry_user_assigned_identity_id = module.dev_acr[0].container_registry_user_assigned_identity_id
     acr_login_server = module.dev_acr[0].acr_login_server
     log_analytics_workspace_id  = module.dev_app_insights[0].log_analytics_workspace_id
+    app_insights_connection_string = module.dev_app_insights[0].connection_string
     servicebus_namespace_primary_connection_string = module.dev_servicebus[0].servicebus_namespace_primary_connection_string
 }

pom.xml

@@ -33,6 +33,7 @@
         <commons-lang3.version>3.14.0</commons-lang3.version>
         <spring-cloud-azure.version>5.12.0</spring-cloud-azure.version>
 		<spring-cloud.version>2023.0.1</spring-cloud.version>
+        <applicationinsights.version>3.5.4</applicationinsights.version>
     </properties>
 
     <dependencyManagement>
@@ -66,6 +67,11 @@
 				<artifactId>protobuf-java-util</artifactId>
 				<version>${protobuf.java.util.version}</version>
 			</dependency>
+            <dependency>
+                <groupId>com.microsoft.azure</groupId>
+                <artifactId>applicationinsights-runtime-attach</artifactId>
+                <version>${applicationinsights.version}</version>
+            </dependency>
 		</dependencies>
 	</dependencyManagement>