Merge pull request #75 from awslabs/dev

Release 0.1.0
awslabs · Nov 17, 2023 · 235a907 · 235a907
2 parents 2b69afb + 4724c9f
commit 235a907
Show file tree

Hide file tree

Showing 35 changed files with 699 additions and 183 deletions.
diff --git a/.github/workflows/semgrep-analysis.yml b/.github/workflows/semgrep-analysis.yml
@@ -0,0 +1,41 @@
+name: Semgrep
+
+on:
+  # Scan changed files in PRs, block on new issues only (existing issues ignored)
+  pull_request:
+
+  push:
+    branches: ["dev", "main"]
+
+  schedule:
+    - cron: '23 20 * * 1'
+
+  # Manually trigger the workflow
+  workflow_dispatch:
+
+jobs:
+  semgrep:
+    name: Scan
+    permissions:
+      security-events: write
+    runs-on: ubuntu-latest
+    container:
+      image: returntocorp/semgrep
+    # Skip any PR created by dependabot to avoid permission issues
+    if: (github.actor != 'dependabot[bot]')
+    steps:
+      # Fetch project source
+      - uses: actions/checkout@v4
+
+      - run: semgrep ci --sarif > semgrep.sarif
+        env:
+          SEMGREP_RULES: >- # more at semgrep.dev/explore
+            p/security-audit
+            p/secrets
+            p/owasp-top-ten
+
+      - name: Upload SARIF file for GitHub Advanced Security Dashboard
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: semgrep.sarif
+        if: always()
diff --git a/.semgrepignore b/.semgrepignore
@@ -0,0 +1,2 @@
+/sampleapps
+/test
diff --git a/AWS.Messaging.sln b/AWS.Messaging.sln
@@ -31,6 +31,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWS.Messaging.Lambda", "src
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "LambdaMessaging", "sampleapps\LambdaMessaging\LambdaMessaging.csproj", "{F74A4CF0-D814-426E-8149-46758E86AFE3}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWS.Messaging.Telemetry.OpenTelemetry", "src\AWS.Messaging.Telemetry.OpenTelemetry\AWS.Messaging.Telemetry.OpenTelemetry.csproj", "{C529DC6E-72DA-49ED-908A-21DBC40F26C0}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -69,6 +71,10 @@ Global
 		{F74A4CF0-D814-426E-8149-46758E86AFE3}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{F74A4CF0-D814-426E-8149-46758E86AFE3}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{F74A4CF0-D814-426E-8149-46758E86AFE3}.Release|Any CPU.Build.0 = Release|Any CPU
+		{C529DC6E-72DA-49ED-908A-21DBC40F26C0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{C529DC6E-72DA-49ED-908A-21DBC40F26C0}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{C529DC6E-72DA-49ED-908A-21DBC40F26C0}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{C529DC6E-72DA-49ED-908A-21DBC40F26C0}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -82,6 +88,7 @@ Global
 		{A174942B-AF9C-4935-AD7B-AF651BACE63C} = {80DB2C77-6ADD-4A60-B27D-763BDF9659D3}
 		{24FA3671-8C2B-4B64-865C-68FB6237E34D} = {2D0A561B-0B97-4259-8603-3AF5437BB652}
 		{F74A4CF0-D814-426E-8149-46758E86AFE3} = {1AA8985B-897C-4BD5-9735-FD8B33FEBFFB}
+		{C529DC6E-72DA-49ED-908A-21DBC40F26C0} = {2D0A561B-0B97-4259-8603-3AF5437BB652}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {7B2B759D-6455-4089-8173-3F1619567B36}

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1 @@
+# Changelog
diff --git a/public.snk b/public.snk
diff --git a/sampleapps/PublisherAPI/Program.cs b/sampleapps/PublisherAPI/Program.cs
@@ -2,6 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 using System.Text.Json;
+using AWS.Messaging.Telemetry.OpenTelemetry;
+using OpenTelemetry.Resources;
+using OpenTelemetry.Trace;
 using PublisherAPI.Models;
 
 var builder = WebApplication.CreateBuilder(args);
@@ -33,6 +36,11 @@
 // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
 builder.Services.AddEndpointsApiExplorer();
 builder.Services.AddSwaggerGen();
+builder.Services.AddOpenTelemetry()
+    .ConfigureResource(resource => resource.AddService("PublisherAPI"))
+    .WithTracing(tracing => tracing
+        .AddAWSMessagingInstrumentation()
+        .AddConsoleExporter());
 
 var app = builder.Build();
 

diff --git a/sampleapps/PublisherAPI/PublisherAPI.csproj b/sampleapps/PublisherAPI/PublisherAPI.csproj
@@ -7,10 +7,13 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="OpenTelemetry.Exporter.Console" Version="1.6.0" />
+    <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.6.0" />
     <PackageReference Include="Swashbuckle.AspNetCore" Version="6.2.3" />
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\src\AWS.Messaging.Telemetry.OpenTelemetry\AWS.Messaging.Telemetry.OpenTelemetry.csproj" />
     <ProjectReference Include="..\..\src\AWS.Messaging\AWS.Messaging.csproj" />
   </ItemGroup>
 

diff --git a/sampleapps/SubscriberService/Program.cs b/sampleapps/SubscriberService/Program.cs
@@ -2,11 +2,13 @@
 // SPDX-License-Identifier: Apache-2.0
 
 using System.Text.Json;
+using AWS.Messaging.Telemetry.OpenTelemetry;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
-using Microsoft.Extensions.Options;
+using OpenTelemetry.Resources;
+using OpenTelemetry.Trace;
 using SubscriberService.MessageHandlers;
 using SubscriberService.Models;
 
@@ -37,7 +39,12 @@ await Host.CreateDefaultBuilder(args)
                     PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
                 };
             });
-        });
+        })
+        .AddOpenTelemetry()
+            .ConfigureResource(resource => resource.AddService("SubscriberService"))
+            .WithTracing(tracing => tracing
+                .AddAWSMessagingInstrumentation()
+                .AddConsoleExporter());
     })
     .Build()
     .RunAsync();
diff --git a/sampleapps/SubscriberService/SubscriberService.csproj b/sampleapps/SubscriberService/SubscriberService.csproj
@@ -20,9 +20,12 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="6.0.1" />
     <PackageReference Include="Microsoft.Extensions.Hosting" Version="6.0.1" />
+    <PackageReference Include="OpenTelemetry.Exporter.Console" Version="1.6.0" />
+    <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.6.0" />
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\src\AWS.Messaging.Telemetry.OpenTelemetry\AWS.Messaging.Telemetry.OpenTelemetry.csproj" />
     <ProjectReference Include="..\..\src\AWS.Messaging\AWS.Messaging.csproj" />
   </ItemGroup>
 

diff --git a/src/AWS.Messaging.Lambda/AWS.Messaging.Lambda.csproj b/src/AWS.Messaging.Lambda/AWS.Messaging.Lambda.csproj
@@ -8,6 +8,10 @@
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <RollForward>Major</RollForward>
     <PackageReadmeFile>README.md</PackageReadmeFile>
+    <WarningsAsErrors>CA1727</WarningsAsErrors>
+    <SignAssembly>true</SignAssembly>
+    <AssemblyOriginatorKeyFile>..\..\public.snk</AssemblyOriginatorKeyFile>
+    <Version>0.1.0</Version>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/src/AWS.Messaging.Lambda/DefaultLambdaMessaging.cs b/src/AWS.Messaging.Lambda/DefaultLambdaMessaging.cs
@@ -138,7 +138,7 @@ private string GetSQSQueueUrl(string queueArn)
         Arn arn;
         if (!Arn.TryParse(queueArn, out arn))
         {
-            _logger.LogError("{queueArn} is not a valid SQS queue ARN", queueArn);
+            _logger.LogError("{QueueArn} is not a valid SQS queue ARN", queueArn);
             throw new InvalidSQSQueueArnException($"{queueArn} is not a valid SQS queue ARN");
         }
 

diff --git a/src/AWS.Messaging.Telemetry.OpenTelemetry/AWS.Messaging.Telemetry.OpenTelemetry.csproj b/src/AWS.Messaging.Telemetry.OpenTelemetry/AWS.Messaging.Telemetry.OpenTelemetry.csproj
@@ -0,0 +1,38 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net6.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <IsPackable>true</IsPackable>
+    <Product>AWS Message Processing Framework Instrumention for OpenTelemetry</Product>
+    <PackageProjectUrl>https://github.com/awslabs/aws-dotnet-messaging</PackageProjectUrl>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <RollForward>Major</RollForward>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <WarningsAsErrors>CA1727</WarningsAsErrors>
+    <SignAssembly>true</SignAssembly>
+    <AssemblyOriginatorKeyFile>..\..\public.snk</AssemblyOriginatorKeyFile>
+    <Version>0.1.0</Version>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="OpenTelemetry" Version="1.6.0" />
+    <PackageReference Include="OpenTelemetry.Api" Version="1.6.0" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\AWS.Messaging\AWS.Messaging.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Include="..\..\LICENSE" Pack="true" PackagePath="" />
+    <None Include="..\..\NOTICE" Pack="true" PackagePath="" />
+    <None Include="..\..\THIRD_PARTY_LICENSES" Pack="true" PackagePath="" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Include=".\README.md" Pack="true" PackagePath="" />
+  </ItemGroup>
+
+</Project>
diff --git a/src/AWS.Messaging.Telemetry.OpenTelemetry/Constants.cs b/src/AWS.Messaging.Telemetry.OpenTelemetry/Constants.cs
@@ -0,0 +1,15 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+namespace AWS.Messaging.Telemetry.OpenTelemetry;
+
+/// <summary>
+/// Constants related to the OpenTelemetry instrumentation for AWS.Messaging
+/// </summary>
+public class Constants
+{
+    /// <summary>
+    /// OpenTelemetry activity source name
+    /// </summary>
+    public const string SourceName = "AWS.Messaging";
+}
diff --git a/src/AWS.Messaging.Telemetry.OpenTelemetry/OpenTelemetryProvider.cs b/src/AWS.Messaging.Telemetry.OpenTelemetry/OpenTelemetryProvider.cs
@@ -0,0 +1,83 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+using System.Diagnostics;
+using OpenTelemetry;
+using OpenTelemetry.Context.Propagation;
+
+namespace AWS.Messaging.Telemetry.OpenTelemetry;
+
+/// <summary>
+/// Creates OpenTelemetry traces
+/// </summary>
+public class OpenTelemetryProvider : ITelemetryProvider
+{
+    private static readonly ActivitySource _activitySource = new ActivitySource(Constants.SourceName, TelemetryKeys.AWSMessagingAssemblyVersion);
+
+    /// <inheritdoc/>
+    public ITelemetryTrace Trace(string traceName)
+    {
+        var activity = _activitySource.StartActivity(traceName, ActivityKind.Producer);
+        if (activity != null)
+        {
+            return new OpenTelemetryTrace(activity);
+        }
+
+        // If we initially failed to create an activity, attempt to force creation with 
+        // a link to the current activity, see https://opentelemetry.io/docs/instrumentation/net/manual/#creating-new-root-activities
+        var parentActivity = Activity.Current;
+        Activity.Current = null;
+        ActivityLink[]? links = null;
+        if (parentActivity != null)
+        {
+            links = new[] { new ActivityLink(parentActivity.Context) };
+        }
+
+        activity = _activitySource.StartActivity(traceName, ActivityKind.Producer, parentContext: default, links: links);
+
+        return new OpenTelemetryTrace(activity, parentActivity);
+    }
+
+    /// <inheritdoc/>
+    public ITelemetryTrace Trace(string traceName, MessageEnvelope envelope)
+    {
+        var propogatedContext = Propagators.DefaultTextMapPropagator.Extract(default, envelope, ExtractTraceContextFromEnvelope);
+        Baggage.Current = propogatedContext.Baggage;
+
+        var activity = _activitySource.StartActivity(traceName, ActivityKind.Consumer, parentContext: propogatedContext.ActivityContext);
+        if (activity != null)
+        {
+            return new OpenTelemetryTrace(activity);
+        }
+
+        // If we initially failed to create an activity, attempt to force creation with 
+        // a link to the current activity, see https://opentelemetry.io/docs/instrumentation/net/manual/#creating-new-root-activities
+        var parentActivity = Activity.Current;
+        Activity.Current = null;
+        ActivityLink[]? links = null;
+        if (parentActivity != null)
+        {
+            links = new[] { new ActivityLink(parentActivity.Context) };
+        }
+
+        activity = _activitySource.StartActivity(traceName, ActivityKind.Consumer, parentContext: propogatedContext.ActivityContext, links: links);
+
+        return new OpenTelemetryTrace(activity, parentActivity);
+    }
+
+    /// <summary>
+    /// Extracts propagation context from a <see cref="MessageEnvelope"/>, meant to be used with <see cref="TextMapPropagator"/>
+    /// </summary>
+    /// <param name="envelope">Inbound message envelope</param>
+    /// <param name="key">Context key</param>
+    /// <returns>Context value</returns>
+    private IEnumerable<string> ExtractTraceContextFromEnvelope(MessageEnvelope envelope, string key)
+    {
+        if (envelope.Metadata.TryGetValue(key, out var jsonElement))
+        {
+            return new string[] { jsonElement.ToString() };
+        }
+
+        return Enumerable.Empty<string>();
+    }
+}