[Benchmarks] Add Micro-benchmarks (#6802)

## Summary of changes
https://datadoghq.atlassian.net/browse/APMSP-1712
This PR introduces running benchmarks through the Benchmarking-platform
all while keeping the current benchmarks running.
The tests are setup to run:

- On commit to the master branch
- On schedule if BENCHMARK_RUN is set to "true" for the scheduled
pipeline.
- On manual trigger (keep in mind that it requires build artifacts from
the Azure Pipeline)

## Reason for change
Related to efforts to use Gitlab as our main CI Provider.
## Implementation details

## Test coverage

## Other details
Results from the benchmarks report do differ as we do not run on master
currently so the comparaison is done against an old seeded run
<!-- Fixes #{issue} -->

<!-- ⚠️ Note: where possible, please obtain 2 approvals prior to
merging. Unless CODEOWNERS specifies otherwise, for external teams it is
typically best to have one review from a team member, and one review
from apm-dotnet. Trivial changes do not require 2 reviews. -->

---------

Co-authored-by: Kevin Gosse <kevin.gosse@datadoghq.com>
Co-authored-by: Brice Friha <37577669+bricefriha@users.noreply.github.com>

Author: 3 people

.gitlab-ci.yml

@@ -213,4 +213,17 @@ macrobenchmarks:
     - if: '$CI_PIPELINE_SOURCE == "schedule" && $BENCHMARK_RUN == "true"'
       when: always
     - when: manual
+
+microbenchmarks:
+  stage: benchmarks
+  needs: [ ]
+  trigger:
+    include: .gitlab/benchmarks/microbenchmarks.yml
+  allow_failure: true
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == "master"'
+      when: always
+    - if: '$CI_PIPELINE_SOURCE == "schedule" && $BENCHMARK_RUN == "true"'
+      when: always
+    - when: manual
 

.gitlab/benchmarks/microbenchmarks.yml

@@ -0,0 +1,61 @@
+stages:
+  - benchmarks
+
+run-benchmarks:
+  stage: benchmarks
+  tags: ["arch:amd64"]
+  interruptible: true
+  timeout: 1h
+  # Image created in the following job https://gitlab.ddbuild.io/DataDog/benchmarking-platform-tools/-/jobs/869830045
+  image: registry.ddbuild.io/images/benchmarking-platform-tools-ubuntu:dotnet-microbenchmarks
+
+  script:
+    - git clone --branch fayssal/test-micro-delivery https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.ddbuild.io/DataDog/benchmarking-platform platform
+    - ./platform/steps/launch-instance.sh
+    - ./platform/steps/post-pr-comment.sh
+    # Temporarely commented out pending issue resolution with sending files to backend
+    # - ./platform/steps/upload-to-bp-ui.sh
+    
+  rules:
+    - when: on_success
+  variables:
+    FF_USE_LEGACY_KUBERNETES_EXECUTION_STRATEGY: "true"
+    AWS_REGION: "us-east-1"
+    CLEANUP: "false"
+    AWS_EPHEMERAL_INFRA_PROFILE_SSM_PARAMETER: "ci.dd-trace-dotnet.ephemeral-infra-ci.dd-trace-dotnet-profile"
+    AWS_EPHEMERAL_INFRA_PROFILE_NAME: "ephemeral-infra-ci"
+    AWS_EPHEMERAL_INFRA_ARTIFACTS_BUCKET_URI: "s3://windows-benchmarking-results/$CI_PROJECT_NAME/$CI_COMMIT_REF_NAME/$CI_JOB_ID"
+    AWS_EPHEMERAL_INFRA_REGION: "us-east-1"
+
+upload-to-bp-ui:
+  stage: benchmarks
+  tags: ["arch:amd64"]
+  interruptible: true
+  timeout: 1h
+  # Image created in the following job https://gitlab.ddbuild.io/DataDog/benchmarking-platform-tools/-/jobs/869830045
+  image: registry.ddbuild.io/images/benchmarking-platform-tools-ubuntu:dotnet-microbenchmarks
+
+  script:
+    - git clone --branch fayssal/test-micro-delivery https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.ddbuild.io/DataDog/benchmarking-platform platform
+    # - ./platform/steps/launch-instance.sh
+    # - ./platform/steps/post-pr-comment.sh
+    # Temporarely commented out pending issue resolution with sending files to backend
+    - ./platform/steps/upload-to-bp-ui.sh
+
+  artifacts:
+    name: "artifacts"
+    when: always
+    paths:
+      - candidate-results/
+    expire_in: 3 months
+    
+  rules:
+    - when: manual
+  variables:
+    FF_USE_LEGACY_KUBERNETES_EXECUTION_STRATEGY: "true"
+    AWS_REGION: "us-east-1"
+    CLEANUP: "false"
+    AWS_EPHEMERAL_INFRA_PROFILE_SSM_PARAMETER: "ci.dd-trace-dotnet.ephemeral-infra-ci.dd-trace-dotnet-profile"
+    AWS_EPHEMERAL_INFRA_PROFILE_NAME: "ephemeral-infra-ci"
+    AWS_EPHEMERAL_INFRA_ARTIFACTS_BUCKET_URI: "s3://windows-benchmarking-results/$CI_PROJECT_NAME/$CI_COMMIT_REF_NAME/$CI_JOB_ID"
+    AWS_EPHEMERAL_INFRA_REGION: "us-east-1"

tracer/build/_build/Build.GitHub.cs

@@ -986,6 +986,28 @@ await client.Issue.Milestone.Update(
              await ReplaceCommentInPullRequest(prNumber, $"## Benchmarks Report for " + BenchmarkCategory, markdown);
          });
 
+    Target CompareBenchmarksResultsBP => _ => _
+         .Unlisted()
+         .DependsOn(CreateRequiredDirectories)
+         .Requires(() => GitHubRepositoryName)
+         .Requires(() => BenchmarkCategory)
+         .Executes(() =>
+         {
+             if (!int.TryParse(Environment.GetEnvironmentVariable("PR_NUMBER"), out var prNumber))
+             {
+                 Logger.Warning("No PR_NUMBER variable found. Skipping benchmark comparison");
+                 return;
+             }
+
+             var masterDir = BuildDataDirectory / "previous_benchmarks";
+             var prDir = BuildDataDirectory / "benchmarks";
+
+             var markdown = CompareBenchmarks.GetMarkdown(masterDir, prDir, prNumber, "master", GitHubRepositoryName, BenchmarkCategory);
+             string filePath = Path.Combine(Path.GetTempPath(), "benchmarks_report.md");
+             Console.WriteLine($"The file was stored at: {filePath}");
+             File.WriteAllText(filePath, markdown);
+         });
+
     Target CompareThroughputResults => _ => _
          .Unlisted()
          .DependsOn(CreateRequiredDirectories)

tracer/build/_build/Build.cs

@@ -572,7 +572,7 @@ void DeleteReparsePoints(string path)
                     .SetFramework(framework)
                     .EnableNoRestore()
                     .EnableNoBuild()
-                    .SetApplicationArguments($"-r {runtimes} -m -f {Filter ?? "*"} --anyCategories {BenchmarkCategory ?? "tracer"} --iterationTime 2000")
+                    .SetApplicationArguments($"-r {runtimes} -m -f {Filter ?? "*"} --anyCategories {BenchmarkCategory ?? "tracer"} --iterationTime 200")
                     .SetProcessEnvironmentVariable("DD_SERVICE", "dd-trace-dotnet")
                     .SetProcessEnvironmentVariable("DD_ENV", "CI")
                     .SetProcessEnvironmentVariable("DD_DOTNET_TRACER_HOME", MonitoringHome)