diff --git a/.github/workflows/python-ec2-adot-sigv4-test.yml b/.github/workflows/python-ec2-adot-sigv4-test.yml new file mode 100644 index 000000000..6febd034e --- /dev/null +++ b/.github/workflows/python-ec2-adot-sigv4-test.yml @@ -0,0 +1,235 @@ +## Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +## SPDX-License-Identifier: Apache-2.0 + +# This is a reusable workflow for running the Python Enablement Canary test for Application Signals. +# It is meant to be called from another workflow. +# Read more about reusable workflows: https://docs.github.com/en/actions/using-workflows/reusing-workflows#overview +name: Python EC2 ADOT SigV4 (Stand-Alone ADOT) Use Case +on: + workflow_call: + inputs: + caller-workflow-name: + required: true + type: string + python-version: + description: "Currently support version 3.8, 3.9, 3.10, 3.11, 3.12" + required: false + type: string + default: '3.9' + cpu-architecture: + description: "Permitted values: x86_64 or arm64" + required: false + type: string + default: "x86_64" + staging-wheel-name: + required: false + default: 'aws-opentelemetry-distro' + type: string + +permissions: + id-token: write + contents: read + +env: + E2E_TEST_AWS_REGION: 'us-west-2' + CALLER_WORKFLOW_NAME: ${{ inputs.caller-workflow-name }} + PYTHON_VERSION: ${{ inputs.python-version }} + CPU_ARCHITECTURE: ${{ inputs.cpu-architecture }} + ADOT_WHEEL_NAME: ${{ inputs.staging-wheel-name }} + E2E_TEST_ACCOUNT_ID: ${{ secrets.APPLICATION_SIGNALS_E2E_TEST_ACCOUNT_ID }} + E2E_TEST_ROLE_NAME: ${{ secrets.APPLICATION_SIGNALS_E2E_TEST_ROLE_NAME }} + METRIC_NAMESPACE: ApplicationSignals + LOG_GROUP_NAME: aws/spans + TEST_RESOURCES_FOLDER: ${GITHUB_WORKSPACE} + +jobs: + python-ec2-adot-sigv4: + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - uses: actions/checkout@v4 + with: + repository: 'aws-observability/aws-application-signals-test-framework' + ref: ${{ inputs.caller-workflow-name == 'main-build' && 'main' || github.ref }} + fetch-depth: 0 + + # We initialize Gradlew Daemon early on during the workflow because sometimes initialization + # fails due to transient issues. If it fails here, then we will try again later before the validators + - name: Initiate Gradlew Daemon + id: initiate-gradlew + uses: ./.github/workflows/actions/execute_and_retry + continue-on-error: true + with: + command: "./gradlew :validator:build" + cleanup: "./gradlew clean" + max_retry: 3 + sleep_time: 60 + + - name: Generate testing id + run: echo TESTING_ID="${{ github.run_id }}-${{ github.run_number }}-${RANDOM}" >> $GITHUB_ENV + + - name: Refresh AWS Credentials + uses: aws-actions/configure-aws-credentials@v4 + with: + role-to-assume: arn:aws:iam::${{ env.E2E_TEST_ACCOUNT_ID }}:role/${{ env.E2E_TEST_ROLE_NAME }} + aws-region: ${{ env.E2E_TEST_AWS_REGION }} + + - name: Set Get ADOT Wheel command environment variable + run: | + if [ "${{ github.event.repository.name }}" = "aws-otel-python-instrumentation" ]; then + # Reusing the adot-main-build-staging-jar bucket to store the python wheel file + echo GET_ADOT_WHEEL_COMMAND="aws s3 cp s3://adot-main-build-staging-jar/${{ env.ADOT_WHEEL_NAME }} ./${{ env.ADOT_WHEEL_NAME }} && sudo python${{ env.PYTHON_VERSION }} -m pip install ${{ env.ADOT_WHEEL_NAME }}" >> $GITHUB_ENV + else + latest_release_version=$(curl -sL https://github.com/aws-observability/aws-otel-python-instrumentation/releases/latest | grep -oP '/releases/tag/v\K[0-9]+\.[0-9]+\.[0-9]+' | head -n 1) + echo "The latest version is $latest_release_version" + echo GET_ADOT_WHEEL_COMMAND="wget -O ${{ env.ADOT_WHEEL_NAME }} https://github.com/aws-observability/aws-otel-python-instrumentation/releases/latest/download/aws_opentelemetry_distro-$latest_release_version-py3-none-any.whl \ + && sudo python${{ env.PYTHON_VERSION }} -m pip install ${{ env.ADOT_WHEEL_NAME }}" >> $GITHUB_ENV + fi + + - name: Set up terraform + uses: ./.github/workflows/actions/execute_and_retry + with: + command: "wget -O- https://apt.releases.hashicorp.com/gpg | sudo gpg --dearmor -o /usr/share/keyrings/hashicorp-archive-keyring.gpg" + post-command: 'echo "deb [signed-by=/usr/share/keyrings/hashicorp-archive-keyring.gpg] https://apt.releases.hashicorp.com $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/hashicorp.list + && sudo apt update && sudo apt install terraform' + sleep_time: 60 + + - name: Initiate Terraform + uses: ./.github/workflows/actions/execute_and_retry + with: + command: "cd ${{ env.TEST_RESOURCES_FOLDER }}/terraform/python/ec2/adot-sigv4 && terraform init && terraform validate" + cleanup: "rm -rf .terraform && rm -rf .terraform.lock.hcl" + max_retry: 6 + sleep_time: 60 + + - name: Deploy sample app via terraform and wait for endpoint to come online + working-directory: terraform/python/ec2/adot-sigv4 + run: | + # Attempt to deploy the sample app on an EC2 instance and wait for its endpoint to come online. + # There may be occasional failures due to transitivity issues, so try up to 2 times. + # deployment_failed of 0 indicates that both the terraform deployment and the endpoint are running, while 1 indicates + # that it failed at some point + retry_counter=0 + max_retry=2 + while [ $retry_counter -lt $max_retry ]; do + echo "Attempt $retry_counter" + deployment_failed=0 + terraform apply -auto-approve \ + -var="aws_region=${{ env.E2E_TEST_AWS_REGION }}" \ + -var="test_id=${{ env.TESTING_ID }}" \ + -var="sample_app_zip=s3://aws-appsignals-sample-app-prod-us-east-1/python-sample-app.zip" \ + -var="get_adot_wheel_command=${{ env.GET_ADOT_WHEEL_COMMAND }}" \ + -var="language_version=${{ env.PYTHON_VERSION }}" \ + -var="cpu_architecture=${{ env.CPU_ARCHITECTURE }}" \ + || deployment_failed=$? + + if [ $deployment_failed -eq 1 ]; then + echo "Terraform deployment was unsuccessful. Will attempt to retry deployment." + fi + + # If the success is 1 then either the terraform deployment or the endpoint connection failed, so first destroy the + # resources created from terraform and try again. + if [ $deployment_failed -eq 1 ]; then + echo "Destroying terraform" + terraform destroy -auto-approve \ + -var="test_id=${{ env.TESTING_ID }}" + + retry_counter=$(($retry_counter+1)) + else + # If deployment succeeded, then exit the loop + break + fi + + if [ $retry_counter -eq $max_retry ]; then + echo "Max retry reached, failed to deploy terraform and connect to the endpoint. Exiting code" + exit 1 + fi + done + + - name: Get the ec2 instance ami id + run: | + echo "EC2_INSTANCE_AMI=$(terraform output ec2_instance_ami)" >> $GITHUB_ENV + working-directory: terraform/python/ec2/adot-sigv4 + + - name: Get the sample app endpoint + run: | + echo "REMOTE_SERVICE_IP=$(terraform output sample_app_remote_service_private_ip)" >> $GITHUB_ENV + echo "MAIN_SERVICE_INSTANCE_ID=$(terraform output main_service_instance_id)" >> $GITHUB_ENV + working-directory: terraform/python/ec2/adot-sigv4 + + - name: Initiate Gradlew Daemon + if: steps.initiate-gradlew == 'failure' + uses: ./.github/workflows/actions/execute_and_retry + continue-on-error: true + with: + command: "./gradlew :validator:build" + cleanup: "./gradlew clean" + max_retry: 3 + sleep_time: 60 + + # Validation for pulse telemetry data + - name: Validate generated EMF logs + id: log-validation + run: ./gradlew validator:run --args='-c python/ec2/adot-sigv4/log-validation.yml + --testing-id ${{ env.TESTING_ID }} + --endpoint http://localhost:8000 + --remote-service-deployment-name ${{ env.REMOTE_SERVICE_IP }}:8001 + --region ${{ env.E2E_TEST_AWS_REGION }} + --metric-namespace ${{ env.METRIC_NAMESPACE }} + --log-group ${{ env.LOG_GROUP_NAME }} + --service-name python-sample-application-${{ env.TESTING_ID }} + --remote-service-name python-sample-remote-application-${{ env.TESTING_ID }} + --query-string ip=${{ env.REMOTE_SERVICE_IP }}&testingId=${{ env.TESTING_ID }} + --instance-ami ${{ env.EC2_INSTANCE_AMI }} + --instance-id ${{ env.MAIN_SERVICE_INSTANCE_ID }} + --rollup' + + - name: Validate generated metrics + id: metric-validation + if: (success() || steps.log-validation.outcome == 'failure') && !cancelled() + run: ./gradlew validator:run --args='-c python/ec2/adot-sigv4/metric-validation.yml + --testing-id ${{ env.TESTING_ID }} + --endpoint http://localhost:8000 + --remote-service-deployment-name ${{ env.REMOTE_SERVICE_IP }}:8001 + --region ${{ env.E2E_TEST_AWS_REGION }} + --metric-namespace ${{ env.METRIC_NAMESPACE }} + --log-group ${{ env.LOG_GROUP_NAME }} + --service-name python-sample-application-${{ env.TESTING_ID }} + --remote-service-name python-sample-remote-application-${{ env.TESTING_ID }} + --query-string ip=${{ env.REMOTE_SERVICE_IP }} + --instance-ami ${{ env.EC2_INSTANCE_AMI }} + --instance-id ${{ env.MAIN_SERVICE_INSTANCE_ID }} + --rollup' + + - name: Validate generated traces + id: trace-validation + if: (success() || steps.log-validation.outcome == 'failure' || steps.metric-validation.outcome == 'failure') && !cancelled() + run: ./gradlew validator:run --args='-c python/ec2/adot-sigv4/trace-validation.yml + --testing-id ${{ env.TESTING_ID }} + --endpoint http://localhost:8000 + --remote-service-deployment-name ${{ env.REMOTE_SERVICE_IP }}:8001 + --region ${{ env.E2E_TEST_AWS_REGION }} + --account-id ${{ env.E2E_TEST_ACCOUNT_ID }} + --metric-namespace ${{ env.METRIC_NAMESPACE }} + --log-group ${{ env.LOG_GROUP_NAME }} + --service-name python-sample-application-${{ env.TESTING_ID }} + --remote-service-name python-sample-remote-application-${{ env.TESTING_ID }} + --query-string ip=${{ env.REMOTE_SERVICE_IP }}&testingId=${{ env.TESTING_ID }} + --instance-ami ${{ env.EC2_INSTANCE_AMI }} + --instance-id ${{ env.MAIN_SERVICE_INSTANCE_ID }} + --rollup' + + - name: Refresh AWS Credentials + uses: aws-actions/configure-aws-credentials@v4 + with: + role-to-assume: arn:aws:iam::${{ env.E2E_TEST_ACCOUNT_ID }}:role/${{ env.E2E_TEST_ROLE_NAME }} + aws-region: ${{ env.E2E_TEST_AWS_REGION }} + + # Clean up Procedures + - name: Terraform destroy + if: always() + continue-on-error: true + working-directory: terraform/python/ec2/adot-sigv4 + run: | + terraform destroy -auto-approve \ + -var="test_id=${{ env.TESTING_ID }}" \ No newline at end of file diff --git a/terraform/python/ec2/adot-sigv4/main.tf b/terraform/python/ec2/adot-sigv4/main.tf new file mode 100644 index 000000000..50b51e36f --- /dev/null +++ b/terraform/python/ec2/adot-sigv4/main.tf @@ -0,0 +1,354 @@ +# ------------------------------------------------------------------------ +# Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"). +# You may not use this file except in compliance with the License. +# A copy of the License is located at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# or in the "license" file accompanying this file. This file is distributed +# on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +# express or implied. See the License for the specific language governing +# permissions and limitations under the License. +# ------------------------------------------------------------------------- + +terraform { + required_providers { + aws = { + source = "hashicorp/aws" + } + } +} + +# Define the provider for AWS +provider "aws" {} + +resource "aws_default_vpc" "default" {} + +resource "tls_private_key" "ssh_key" { + algorithm = "RSA" + rsa_bits = 4096 +} + +resource "aws_key_pair" "aws_ssh_key" { + key_name = "instance_key-${var.test_id}" + public_key = tls_private_key.ssh_key.public_key_openssh +} + +locals { + ssh_key_name = aws_key_pair.aws_ssh_key.key_name + private_key_content = tls_private_key.ssh_key.private_key_pem +} + +data "aws_ami" "ami" { + owners = ["amazon"] + most_recent = true + filter { + name = "name" + values = ["al20*-ami-minimal-*-${var.cpu_architecture}"] + } + filter { + name = "state" + values = ["available"] + } + filter { + name = "architecture" + values = [var.cpu_architecture] + } + filter { + name = "image-type" + values = ["machine"] + } + + filter { + name = "root-device-name" + values = ["/dev/xvda"] + } + + filter { + name = "root-device-type" + values = ["ebs"] + } + + filter { + name = "virtualization-type" + values = ["hvm"] + } +} + +resource "aws_instance" "main_service_instance" { + ami = data.aws_ami.ami.id # Amazon Linux 2 (free tier) + instance_type = var.cpu_architecture == "x86_64" ? "t3.micro" : "t4g.micro" + key_name = local.ssh_key_name + iam_instance_profile = "APP_SIGNALS_EC2_TEST_ROLE" + vpc_security_group_ids = [aws_default_vpc.default.default_security_group_id] + associate_public_ip_address = true + instance_initiated_shutdown_behavior = "terminate" + + metadata_options { + http_tokens = "required" + } + + root_block_device { + volume_size = 5 + } + + tags = { + Name = "main-service-${var.test_id}" + } +} + +resource "null_resource" "main_service_setup" { + connection { + type = "ssh" + user = var.user + private_key = local.private_key_content + host = aws_instance.main_service_instance.public_ip + } + + provisioner "remote-exec" { + inline = [ + <<-EOF + #!/bin/bash + + # Install Python and wget + sudo yum install wget -y + sudo yum install unzip -y + + # Dnf does not have the module for python 3.10, 3,10, 3.12, therefore we need to manually install it by downloading the package from the python website. + # Building and installing the package takes longer then installing it through dnf, so a seperate installation process was made. + # The canary should run on a version without the manual installation process + if [ "${var.language_version}" == "3.8" ] || [ "${var.language_version}" = "3.10" ] || [ "${var.language_version}" = "3.12" ]; then + # Install modules required to compile Python and also run the sample app + sudo dnf groupinstall "Development Tools" -y + sudo dnf install openssl-devel sqlite-devel libffi-devel -y + + # Download the Python package + cd /usr/src + sudo wget https://www.python.org/ftp/python/${var.language_version}.0/Python-${var.language_version}.0.tgz + sudo tar xzf Python-${var.language_version}.0.tgz + + # Compile and install Python using c++ + cd Python-${var.language_version}.0 + sudo ./configure + sudo make install + + # Return back to ec2-user directory + cd ~ + else + sudo dnf install -y python${var.language_version} + sudo dnf install -y python${var.language_version}-pip + fi + + # enable ec2 instance connect for debug + sudo yum install ec2-instance-connect -y + + # Install modules with specific version so that it doesn't cause errors with Python 3.8 + sudo python${var.language_version} -m pip install importlib-metadata==8.4.0 "protobuf>=3.19,<5.0" + sudo python${var.language_version} -m pip install grpcio --only-binary=:all: + + # Get ADOT Wheel and install it + ${var.get_adot_wheel_command} + + # Get and run the sample application with configuration + aws s3 cp ${var.sample_app_zip} ./python-sample-app.zip + unzip -o python-sample-app.zip + + # Export environment variables for instrumentation + cd ./django_frontend_service + sudo python${var.language_version} -m pip install -r ec2-requirements.txt + export DJANGO_SETTINGS_MODULE="django_frontend_service.settings" + export OTEL_PYTHON_DISTRO="aws_distro" + export OTEL_PYTHON_CONFIGURATOR="aws_configurator" + export OTEL_AWS_APPLICATION_SIGNALS_ENABLED=false + export OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf \ + export OTEL_LOGS_EXPORT=none \ + export OTEL_METRICS_EXPORTER=none \ + export OTEL_TRACES_EXPORTER=otlp + export OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=https://xray.${var.aws_region}.amazonaws.com/v1/traces \ + export OTEL_SERVICE_NAME=python-sample-application-${var.test_id} + export OTEL_TRACES_SAMPLER=always_on + python${var.language_version} manage.py migrate + nohup opentelemetry-instrument python${var.language_version} manage.py runserver 0.0.0.0:8000 --noreload & + + # The application needs time to come up and reach a steady state, this should not take longer than 30 seconds + sleep 30 + + # Check if the application is up. If it is not up, then exit 1. + attempt_counter=0 + max_attempts=30 + until $(curl --output /dev/null --silent --head --fail --max-time 5 $(echo "http://localhost:8000" | tr -d '"')); do + if [ $attempt_counter -eq $max_attempts ];then + echo "Failed to connect to endpoint." + exit 1 + fi + echo "Attempting to connect to the main endpoint. Tried $attempt_counter out of $max_attempts" + attempt_counter=$(($attempt_counter+1)) + sleep 10 + done + + echo "Successfully connected to main endpoint" + + EOF + ] + } + + depends_on = [aws_instance.main_service_instance] +} + +resource "aws_instance" "remote_service_instance" { + ami = data.aws_ami.ami.id # Amazon Linux 2 (free tier) + instance_type = var.cpu_architecture == "x86_64" ? "t3.micro" : "t4g.micro" + key_name = local.ssh_key_name + iam_instance_profile = "APP_SIGNALS_EC2_TEST_ROLE" + vpc_security_group_ids = [aws_default_vpc.default.default_security_group_id] + associate_public_ip_address = true + instance_initiated_shutdown_behavior = "terminate" + + metadata_options { + http_tokens = "required" + } + + root_block_device { + volume_size = 5 + } + + tags = { + Name = "remote-service-${var.test_id}" + } +} + +resource "null_resource" "remote_service_setup" { + connection { + type = "ssh" + user = var.user + private_key = local.private_key_content + host = aws_instance.remote_service_instance.public_ip + } + + provisioner "remote-exec" { + inline = [ + <<-EOF + #!/bin/bash + + # Install Python and wget + sudo yum install wget -y + sudo yum install unzip -y + + # Dnf does not have the module for python 3.10, 3,10, 3.12, therefore we need to manually install it by downloading the package from the python website. + # Building and installing the package takes longer then installing it through dnf, so a seperate installation process was made. + # The canary should run on a version without the manual installation process + if [ "${var.language_version}" == "3.8" ] || [ "${var.language_version}" = "3.10" ] || [ "${var.language_version}" = "3.12" ]; then + # Install modules required to compile Python and also run the sample app + sudo dnf groupinstall "Development Tools" -y + sudo dnf install openssl-devel sqlite-devel libffi-devel -y + + # Download the Python package + cd /usr/src + sudo wget https://www.python.org/ftp/python/${var.language_version}.0/Python-${var.language_version}.0.tgz + sudo tar xzf Python-${var.language_version}.0.tgz + + # Compile and install Python using c++ + cd Python-${var.language_version}.0 + sudo ./configure + sudo make install + + # Return back to ec2-user directory + cd ~ + else + sudo dnf install -y python${var.language_version} + sudo dnf install -y python${var.language_version}-pip + fi + + # enable ec2 instance connect for debug + sudo yum install ec2-instance-connect -y + + # Install modules with specific version so that it doesn't cause errors with Python 3.8 + sudo python${var.language_version} -m pip install importlib-metadata==8.4.0 "protobuf>=3.19,<5.0" + sudo python${var.language_version} -m pip install grpcio --only-binary=:all: + + # Get ADOT Wheel and install it + ${var.get_adot_wheel_command} + + # Get and run the sample application with configuration + aws s3 cp ${var.sample_app_zip} ./python-sample-app.zip + unzip -o python-sample-app.zip + + # Export environment variables for instrumentation + cd ./django_remote_service + sudo python${var.language_version} -m pip install -r requirements.txt --force-reinstall + sudo python${var.language_version} -m pip install "boto3~=1.34.3" + export DJANGO_SETTINGS_MODULE="django_remote_service.settings" + export OTEL_PYTHON_DISTRO="aws_distro" + export OTEL_PYTHON_CONFIGURATOR="aws_configurator" + export OTEL_AWS_APPLICATION_SIGNALS_ENABLED=false + export OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf \ + export OTEL_LOGS_EXPORT=none \ + export OTEL_METRICS_EXPORTER=none \ + export OTEL_TRACES_EXPORTER=otlp + export OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=https://xray.${var.aws_region}.amazonaws.com/v1/traces \ + export OTEL_SERVICE_NAME=python-sample-remote-application-${var.test_id} + export OTEL_TRACES_SAMPLER=always_on + python${var.language_version} manage.py migrate + nohup opentelemetry-instrument python${var.language_version} manage.py runserver 0.0.0.0:8001 --noreload & + + # The application needs time to come up and reach a steady state, this should not take longer than 30 seconds + sleep 30 + + # Check if the application is up. If it is not up, then exit 1. + attempt_counter=0 + max_attempts=30 + until $(curl --output /dev/null --silent --head --fail --max-time 5 $(echo "http://localhost:8001/healthcheck" | tr -d '"')); do + if [ $attempt_counter -eq $max_attempts ];then + echo "Failed to connect to endpoint." + exit 1 + fi + echo "Attempting to connect to the remote endpoint. Tried $attempt_counter out of $max_attempts" + attempt_counter=$(($attempt_counter+1)) + sleep 10 + done + + echo "Successfully connected to remote endpoint" + + sleep 30 + + EOF + ] + } + + depends_on = [aws_instance.remote_service_instance] +} + +resource "null_resource" "traffic_generator_setup" { + connection { + type = "ssh" + user = var.user + private_key = local.private_key_content + host = aws_instance.main_service_instance.public_ip + } + + provisioner "remote-exec" { + inline = [ + <<-EOF + sudo yum install nodejs aws-cli unzip tmux -y + + # Bring in the traffic generator files to EC2 Instance + aws s3 cp s3://aws-appsignals-sample-app-prod-us-east-1/traffic-generator.zip ./traffic-generator.zip + unzip ./traffic-generator.zip -d ./ + + # Install the traffic generator dependencies + npm install + + tmux new -s traffic-generator -d + tmux send-keys -t traffic-generator "export MAIN_ENDPOINT=\"localhost:8000\"" C-m + tmux send-keys -t traffic-generator "export REMOTE_ENDPOINT=\"${aws_instance.remote_service_instance.private_ip}\"" C-m + tmux send-keys -t traffic-generator "export ID=\"${var.test_id}\"" C-m + tmux send-keys -t traffic-generator "npm start" C-m + + EOF + ] + } + + depends_on = [null_resource.main_service_setup, null_resource.remote_service_setup] +} diff --git a/terraform/python/ec2/adot-sigv4/output.tf b/terraform/python/ec2/adot-sigv4/output.tf new file mode 100644 index 000000000..be572868a --- /dev/null +++ b/terraform/python/ec2/adot-sigv4/output.tf @@ -0,0 +1,26 @@ +# ------------------------------------------------------------------------ +# Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"). +# You may not use this file except in compliance with the License. +# A copy of the License is located at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# or in the "license" file accompanying this file. This file is distributed +# on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +# express or implied. See the License for the specific language governing +# permissions and limitations under the License. +# ------------------------------------------------------------------------- + +output "sample_app_remote_service_private_ip" { + value = aws_instance.remote_service_instance.private_ip +} + +output "main_service_instance_id" { + value = aws_instance.main_service_instance.id +} + +output "ec2_instance_ami" { + value = data.aws_ami.ami.id +} \ No newline at end of file diff --git a/terraform/python/ec2/adot-sigv4/variables.tf b/terraform/python/ec2/adot-sigv4/variables.tf new file mode 100644 index 000000000..82284ce3c --- /dev/null +++ b/terraform/python/ec2/adot-sigv4/variables.tf @@ -0,0 +1,46 @@ +# ------------------------------------------------------------------------ +# Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"). +# You may not use this file except in compliance with the License. +# A copy of the License is located at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# or in the "license" file accompanying this file. This file is distributed +# on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +# express or implied. See the License for the specific language governing +# permissions and limitations under the License. +# ------------------------------------------------------------------------- + +variable "test_id" { + default = "dummy-123" +} + +variable "aws_region" { + default = "" +} + +variable "user" { + default = "ec2-user" +} + +variable "sample_app_zip" { + default = "s3:///" +} + +variable "get_adot_wheel_command" { + default = "aws s3 cp s3:/// ./ && pip install " +} + +variable "canary_type" { + default = "python-ec2-default" +} + +variable "language_version" { + default = "3.9" +} + +variable "cpu_architecture" { + default = "x86_64" +} \ No newline at end of file diff --git a/validator/src/main/java/com/amazon/aoc/fileconfigs/PredefinedExpectedTemplate.java b/validator/src/main/java/com/amazon/aoc/fileconfigs/PredefinedExpectedTemplate.java index 2bd01de29..4e890a2e6 100644 --- a/validator/src/main/java/com/amazon/aoc/fileconfigs/PredefinedExpectedTemplate.java +++ b/validator/src/main/java/com/amazon/aoc/fileconfigs/PredefinedExpectedTemplate.java @@ -201,6 +201,26 @@ public enum PredefinedExpectedTemplate implements FileConfig { PYTHON_EC2_ASG_CLIENT_CALL_METRIC("/expected-data-template/python/ec2/asg/client-call-metric.mustache"), PYTHON_EC2_ASG_CLIENT_CALL_TRACE("/expected-data-template/python/ec2/asg/client-call-trace.mustache"), + /** Python EC2 ADOT SigV4 (Stand Alone ADOT) Test Case Validations */ + PYTHON_EC2_ADOT_SIGV4_OUTGOING_HTTP_CALL_LOG( + "/expected-data-template/python/ec2/adot-sigv4/outgoing-http-call-log.mustache"), + PYTHON_EC2_ADOT_SIGV4_OUTGOING_HTTP_CALL_METRIC( + "/expected-data-template/python/ec2/adot-sigv4/outgoing-http-call-metric.mustache"), + PYTHON_EC2_ADOT_SIGV4_OUTGOING_HTTP_CALL_TRACE( + "/expected-data-template/python/ec2/adot-sigv4/outgoing-http-call-trace.mustache"), + + PYTHON_EC2_ADOT_SIGV4_AWS_SDK_CALL_LOG("/expected-data-template/python/ec2/adot-sigv4/aws-sdk-call-log.mustache"), + PYTHON_EC2_ADOT_SIGV4_AWS_SDK_CALL_METRIC("/expected-data-template/python/ec2/adot-sigv4/aws-sdk-call-metric.mustache"), + PYTHON_EC2_ADOT_SIGV4_AWS_SDK_CALL_TRACE("/expected-data-template/python/ec2/adot-sigv4/aws-sdk-call-trace.mustache"), + + PYTHON_EC2_ADOT_SIGV4_REMOTE_SERVICE_LOG("/expected-data-template/python/ec2/adot-sigv4/remote-service-log.mustache"), + PYTHON_EC2_ADOT_SIGV4_REMOTE_SERVICE_METRIC("/expected-data-template/python/ec2/adot-sigv4/remote-service-metric.mustache"), + PYTHON_EC2_ADOT_SIGV4_REMOTE_SERVICE_TRACE("/expected-data-template/python/ec2/adot-sigv4/remote-service-trace.mustache"), + + PYTHON_EC2_ADOT_SIGV4_CLIENT_CALL_LOG("/expected-data-template/python/ec2/adot-sigv4/client-call-log.mustache"), + PYTHON_EC2_ADOT_SIGV4_CLIENT_CALL_METRIC("/expected-data-template/python/ec2/adot-sigv4/client-call-metric.mustache"), + PYTHON_EC2_ADOT_SIGV4_CLIENT_CALL_TRACE("/expected-data-template/python/ec2/adot-sigv4/client-call-trace.mustache"), + /** Python K8S Test Case Validations */ PYTHON_K8S_OUTGOING_HTTP_CALL_LOG("/expected-data-template/python/k8s/outgoing-http-call-log.mustache"), PYTHON_K8S_OUTGOING_HTTP_CALL_METRIC("/expected-data-template/python/k8s/outgoing-http-call-metric.mustache"), diff --git a/validator/src/main/java/com/amazon/aoc/validators/CWLogValidator.java b/validator/src/main/java/com/amazon/aoc/validators/CWLogValidator.java index 156644dfb..c5ea44e1a 100644 --- a/validator/src/main/java/com/amazon/aoc/validators/CWLogValidator.java +++ b/validator/src/main/java/com/amazon/aoc/validators/CWLogValidator.java @@ -71,8 +71,26 @@ public void validate() throws Exception { String remoteResourceType = (String) expectedAttributes.get("RemoteResourceType"); String remoteResourceIdentifier = (String) expectedAttributes.get("RemoteResourceIdentifier"); - Map actualLog = - this.getActualLog(operation, remoteService, remoteOperation, remoteResourceType, remoteResourceIdentifier); + Map actualLog; + + // Parsing unique identifiers in OTLP spans + if (operation == null) { + operation = (String) expectedAttributes.get("attributes[\\\"aws.local.operation\\\"]"); + remoteService = (String) expectedAttributes.get("attributes[\\\"aws.remote.service\\\"]"); + remoteOperation = (String) expectedAttributes.get("attributes[\\\"aws.remote.operation\\\"]"); + // Runtime metrics have no operation at all, we must ensure we are in the proper use case + if (operation != null) { + actualLog = this.getActualOtelSpanLog(operation, remoteService, remoteOperation); + } else { + // No operation at all -> Runtime metric + actualLog = + this.getActualLog(operation, remoteService, remoteOperation, remoteResourceType, remoteResourceIdentifier); + } + } + else { + actualLog = + this.getActualLog(operation, remoteService, remoteOperation, remoteResourceType, remoteResourceIdentifier); + } log.info("Value of an actual log: {}", actualLog); if (actualLog == null) throw new BaseException(ExceptionCode.EXPECTED_LOG_NOT_FOUND); @@ -140,7 +158,7 @@ private Map getActualLog( if (remoteService == null && remoteOperation == null) { dependencyFilter = "&& ($.RemoteService NOT EXISTS) && ($.RemoteOperation NOT EXISTS)"; } else { - dependencyFilter = String.format("&& ($.RemoteService = \"%s\") && ($.RemoteOperation = \"%s\")", remoteService, remoteOperation); + dependencyFilter = String.format(" && ($.RemoteService = \"%s\") && ($.RemoteOperation = \"%s\")", remoteService, remoteOperation); } if (remoteResourceType != null && remoteResourceIdentifier != null) { @@ -171,6 +189,40 @@ private Map getActualLog( return JsonFlattener.flattenAsMap(retrievedLogs.get(0).getMessage()); } + private Map getActualOtelSpanLog(String operation, String remoteService, String remoteOperation) throws Exception { + String dependencyFilter = null; + + if (operation != null) { + dependencyFilter = String.format("&& ($.attributes.['aws.local.operation'] = \"%s\")", operation); + } + if (remoteService != null) { + dependencyFilter += String.format("&& ($.attributes.['aws.remote.service'] = \"%s\")", remoteService); + } else { + dependencyFilter += "&& ($.attributes.['aws.remote.service'] NOT EXISTS)"; + } + if (remoteOperation != null) { + dependencyFilter += String.format("&& ($.attributes.['aws.remote.operation'] = \"%s\")", remoteOperation); + } else { + dependencyFilter += "&& ($.attributes.['aws.remote.operation'] NOT EXISTS)"; + } + + String filterPattern = String.format("{ ($.attributes.['aws.local.service'] = %s) %s }", context.getServiceName(), dependencyFilter); + log.info("Filter Pattern for Log Search: " + filterPattern); + + List retrievedLogs = + this.cloudWatchService.filterLogs( + context.getLogGroup(), + filterPattern, + System.currentTimeMillis() - TimeUnit.MINUTES.toMillis(5), + 10); + + if (retrievedLogs == null || retrievedLogs.isEmpty()) { + throw new BaseException(ExceptionCode.EMPTY_LIST); + } + + return JsonFlattener.flattenAsMap(retrievedLogs.get(0).getMessage()); + } + @Override public void init( Context context, diff --git a/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/aws-sdk-call-log.mustache b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/aws-sdk-call-log.mustache new file mode 100644 index 000000000..a9c944359 --- /dev/null +++ b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/aws-sdk-call-log.mustache @@ -0,0 +1,49 @@ +[{ + "name": "GET aws-sdk-call", + "kind": "SERVER", + "resource": { + "attributes": { + "aws.local.service": "{{serviceName}}", + "service.name": "{{serviceName}}", + "cloud.provider": "aws", + "cloud.region": "{{region}}", + "cloud.account.id": "{{accountId}}", + "cloud.platform": "aws_ec2" + } + }, + "attributes": { + "aws.local.service": "{{serviceName}}", + "aws.local.environment": "ec2:default", + "aws.local.operation": "GET aws-sdk-call", + "aws.span.kind": "LOCAL_ROOT", + "http.url": "^{{endpoint}}/aws-sdk-call\\?ip=(([0-9]{1,3}.){3}[0-9]{1,3})&testingId={{testingId}}$", + "http.route": "aws-sdk-call", + "http.method": "GET", + "PlatformType": "AWS::EC2" + } +}, +{ + "name": "S3.GetBucketLocation", + "kind": "CLIENT", + "resource": { + "attributes": { + "aws.local.service": "{{serviceName}}", + "service.name": "{{serviceName}}", + "cloud.provider": "aws", + "cloud.region": "{{region}}", + "cloud.account.id": "{{accountId}}", + "cloud.platform": "aws_ec2" + } + }, + "attributes": { + "aws.local.service": "{{serviceName}}", + "aws.local.operation": "UnmappedOperation", + "aws.remote.service": "AWS::S3", + "aws.remote.operation": "GetBucketLocation", + "aws.local.environment": "ec2:default", + "aws.s3.bucket": "e2e-test-bucket-name-{{testingId}}", + "aws.span.kind": "CLIENT", + "aws.region": "us-east-1", + "PlatformType": "AWS::EC2" + } +}] \ No newline at end of file diff --git a/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/aws-sdk-call-metric.mustache b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/aws-sdk-call-metric.mustache new file mode 100644 index 000000000..92e8104d3 --- /dev/null +++ b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/aws-sdk-call-metric.mustache @@ -0,0 +1,227 @@ +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Operation + value: GET aws-sdk-call + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Operation + value: UnmappedOperation + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteOperation + value: GetBucketLocation + - + name: RemoteService + value: AWS::S3 + +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteService + value: AWS::S3 + +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteOperation + value: GetBucketLocation + - + name: RemoteService + value: AWS::S3 + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Operation + value: GET aws-sdk-call + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Operation + value: UnmappedOperation + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteOperation + value: GetBucketLocation + - + name: RemoteService + value: AWS::S3 + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteService + value: AWS::S3 + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteOperation + value: GetBucketLocation + - + name: RemoteService + value: AWS::S3 + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Operation + value: GET aws-sdk-call + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Operation + value: UnmappedOperation + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteOperation + value: GetBucketLocation + - + name: RemoteService + value: AWS::S3 + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteService + value: AWS::S3 + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteOperation + value: GetBucketLocation + - + name: RemoteService + value: AWS::S3 \ No newline at end of file diff --git a/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/aws-sdk-call-trace.mustache b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/aws-sdk-call-trace.mustache new file mode 100644 index 000000000..b38dccc35 --- /dev/null +++ b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/aws-sdk-call-trace.mustache @@ -0,0 +1,65 @@ +[{ + "name": "^{{serviceName}}$", + "http": { + "request": { + "url": "^{{endpoint}}/aws-sdk-call\\?ip=(([0-9]{1,3}.){3}[0-9]{1,3})&testingId={{testingId}}$", + "method": "^GET$" + } + }, + "aws": { + "ec2": { + "instance_id": "^{{instanceId}}$" + }, + "span.kind": "^LOCAL_ROOT$" + }, + "annotations": { + "aws.local.service": "^{{serviceName}}$", + "aws.local.operation": "^GET aws-sdk-call$", + "aws.local.environment": "^ec2:default$", + "span.name": "^GET aws-sdk-call$", + "span.kind": "^SERVER$" + }, + "metadata": { + "http.url": "^{{endpoint}}/aws-sdk-call\\?ip=(([0-9]{1,3}.){3}[0-9]{1,3})&testingId={{testingId}}$", + "http.method": "^GET$", + "http.route": "^aws-sdk-call$", + "service.name": "^{{serviceName}}$", + "cloud.provider": "^aws$", + "cloud.account.id": "^{{accountId}}$", + "cloud.region": "^{{region}}$", + "cloud.platform": "^aws_ec2$", + "PlatformType": "^AWS::EC2$" + }, + "subsegments": [ + { + "name": "^S3$", + "aws": { + "bucket_name": "^e2e-test-bucket-name-{{testingId}}$", + "s3.bucket": "^e2e-test-bucket-name-{{testingId}}$", + "span.kind": "^CLIENT$" + }, + "annotations": { + "aws.local.service": "^{{serviceName}}$", + "aws.local.operation": "^UnmappedOperation$", + "aws.remote.service": "^AWS::S3$", + "aws.remote.operation": "^GetBucketLocation$", + "aws.local.environment": "^ec2:default$", + "span.name": "^S3.GetBucketLocation$", + "span.kind": "^CLIENT$" + }, + "namespace": "^aws$" + } + ] +}, +{ + "name": "^S3$", + "aws": { + "bucket_name": "^e2e-test-bucket-name-{{testingId}}$", + "s3.bucket": "^e2e-test-bucket-name-{{testingId}}$", + "span.kind": "^CLIENT$" + }, + "annotations": { + "aws.local.service": "^AWS::S3$", + "aws.local.operation": "^GetBucketLocation$" + } +}] \ No newline at end of file diff --git a/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/client-call-log.mustache b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/client-call-log.mustache new file mode 100644 index 000000000..991b4041d --- /dev/null +++ b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/client-call-log.mustache @@ -0,0 +1,49 @@ +[{ + "name": "GET client-call", + "kind": "SERVER", + "resource": { + "attributes": { + "aws.local.service": "{{serviceName}}", + "service.name": "{{serviceName}}", + "cloud.provider": "aws", + "cloud.region": "{{region}}", + "cloud.account.id": "{{accountId}}", + "cloud.platform": "aws_ec2" + } + }, + "attributes": { + "aws.local.service": "{{serviceName}}", + "aws.local.environment": "ec2:default", + "aws.local.operation": "GET client-call", + "aws.span.kind": "LOCAL_ROOT", + "http.url": "{{endpoint}}/client-call", + "http.route": "client-call", + "http.method": "GET", + "PlatformType": "AWS::EC2" + } +}, +{ + "name": "GET", + "kind": "CLIENT", + "resource": { + "attributes": { + "aws.local.service": "{{serviceName}}", + "service.name": "{{serviceName}}", + "cloud.provider": "aws", + "cloud.region": "{{region}}", + "cloud.account.id": "{{accountId}}", + "cloud.platform": "aws_ec2" + } + }, + "attributes": { + "aws.local.service": "{{serviceName}}", + "aws.local.operation": "InternalOperation", + "aws.remote.service": "local-root-client-call", + "aws.remote.operation": "GET /", + "aws.local.environment": "ec2:default", + "aws.span.kind": "LOCAL_ROOT", + "http.url": "http://local-root-client-call/", + "http.method": "GET", + "PlatformType": "AWS::EC2" + } +}] \ No newline at end of file diff --git a/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/client-call-metric.mustache b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/client-call-metric.mustache new file mode 100644 index 000000000..86fa8bbf5 --- /dev/null +++ b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/client-call-metric.mustache @@ -0,0 +1,227 @@ +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Operation + value: InternalOperation + - + name: Environment + value: ec2:default + +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Operation + value: InternalOperation + - + name: Environment + value: ec2:default + - + name: RemoteService + value: local-root-client-call + - + name: RemoteOperation + value: GET / + +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteService + value: local-root-client-call + - + name: RemoteOperation + value: GET / + +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteService + value: local-root-client-call + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Operation + value: InternalOperation + - + name: Environment + value: ec2:default + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Operation + value: InternalOperation + - + name: Environment + value: ec2:default + - + name: RemoteService + value: local-root-client-call + - + name: RemoteOperation + value: GET / + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteService + value: local-root-client-call + - + name: RemoteOperation + value: GET / + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteService + value: local-root-client-call + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Operation + value: InternalOperation + - + name: Environment + value: ec2:default + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Operation + value: InternalOperation + - + name: Environment + value: ec2:default + - + name: RemoteService + value: local-root-client-call + - + name: RemoteOperation + value: GET / + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteService + value: local-root-client-call + - + name: RemoteOperation + value: GET / + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteService + value: local-root-client-call \ No newline at end of file diff --git a/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/client-call-trace.mustache b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/client-call-trace.mustache new file mode 100644 index 000000000..261cfbac2 --- /dev/null +++ b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/client-call-trace.mustache @@ -0,0 +1,71 @@ +[{ + "name": "^{{serviceName}}$", + "aws": { + "ec2": { + "instance_id": "^{{instanceId}}$" + } + }, + "annotations": { + "aws.local.service": "^{{serviceName}}$", + "aws.local.operation": "^InternalOperation$", + "aws.local.environment": "^ec2:default$", + "span.name": "^InternalOperation$", + "span.kind": "^SERVER$" + }, + "metadata": { + "service.name": "^{{serviceName}}$", + "cloud.provider": "^aws$", + "cloud.account.id": "^{{accountId}}$", + "cloud.region": "^{{region}}$", + "cloud.platform": "^aws_ec2$" + }, + "subsegments": [ + { + "name": "^local-root-client-call$", + "http": { + "request": { + "url": "^http://local-root-client-call/$", + "method": "^GET$" + } + }, + "aws": { + "ec2": { + "instance_id": "^{{instanceId}}$" + }, + "span.kind": "^LOCAL_ROOT$" + }, + "annotations": { + "aws.local.service": "^{{serviceName}}$", + "aws.local.operation": "^InternalOperation$", + "aws.remote.service": "^local-root-client-call$", + "aws.remote.operation": "GET /", + "aws.local.environment": "^ec2:default$", + "span.name": "^GET$", + "span.kind": "^CLIENT$" + }, + "metadata": { + "service.name": "^{{serviceName}}$", + "http.url": "^http://local-root-client-call/$", + "http.method": "^GET$", + "cloud.provider": "^aws$", + "cloud.account.id": "^{{accountId}}$", + "cloud.region": "^{{region}}$", + "cloud.platform": "^aws_ec2$" + }, + "namespace": "^remote$" + } + ] +}, +{ + "name": "^local-root-client-call$", + "http": { + "request": { + "url": "^http://local-root-client-call/$", + "method": "^GET$" + } + }, + "annotations": { + "aws.local.service": "^local-root-client-call$", + "aws.local.operation": "^GET /$" + } +}] \ No newline at end of file diff --git a/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/outgoing-http-call-log.mustache b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/outgoing-http-call-log.mustache new file mode 100644 index 000000000..48f9df70a --- /dev/null +++ b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/outgoing-http-call-log.mustache @@ -0,0 +1,49 @@ +[{ + "name": "GET outgoing-http-call", + "kind": "SERVER", + "resource": { + "attributes": { + "aws.local.service": "{{serviceName}}", + "service.name": "{{serviceName}}", + "cloud.provider": "aws", + "cloud.region": "{{region}}", + "cloud.account.id": "{{accountId}}", + "cloud.platform": "aws_ec2" + } + }, + "attributes": { + "aws.local.service": "{{serviceName}}", + "aws.local.environment": "ec2:default", + "aws.local.operation": "GET outgoing-http-call", + "aws.span.kind": "LOCAL_ROOT", + "http.url": "{{endpoint}}/outgoing-http-call", + "http.route": "outgoing-http-call", + "http.method": "GET", + "PlatformType": "AWS::EC2" + } +}, +{ + "name": "GET", + "kind": "CLIENT", + "resource": { + "attributes": { + "aws.local.service": "{{serviceName}}", + "service.name": "{{serviceName}}", + "cloud.provider": "aws", + "cloud.region": "{{region}}", + "cloud.account.id": "{{accountId}}", + "cloud.platform": "aws_ec2" + } + }, + "attributes": { + "aws.local.service": "{{serviceName}}", + "aws.local.operation": "UnmappedOperation", + "aws.remote.service": "www.amazon.com", + "aws.remote.operation": "GET /", + "aws.local.environment": "ec2:default", + "aws.span.kind": "CLIENT", + "http.url": "https://www.amazon.com/", + "http.method": "GET", + "PlatformType": "AWS::EC2" + } +}] \ No newline at end of file diff --git a/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/outgoing-http-call-metric.mustache b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/outgoing-http-call-metric.mustache new file mode 100644 index 000000000..f4ce2515b --- /dev/null +++ b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/outgoing-http-call-metric.mustache @@ -0,0 +1,227 @@ +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Operation + value: GET outgoing-http-call + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Operation + value: UnmappedOperation + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteOperation + value: GET / + - + name: RemoteService + value: www.amazon.com + +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteOperation + value: GET / + - + name: RemoteService + value: www.amazon.com + +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteService + value: www.amazon.com + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Operation + value: GET outgoing-http-call + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Operation + value: UnmappedOperation + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteOperation + value: GET / + - + name: RemoteService + value: www.amazon.com + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteOperation + value: GET / + - + name: RemoteService + value: www.amazon.com + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteService + value: www.amazon.com + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Operation + value: GET outgoing-http-call + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Operation + value: UnmappedOperation + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteOperation + value: GET / + - + name: RemoteService + value: www.amazon.com + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteOperation + value: GET / + - + name: RemoteService + value: www.amazon.com + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteService + value: www.amazon.com diff --git a/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/outgoing-http-call-trace.mustache b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/outgoing-http-call-trace.mustache new file mode 100644 index 000000000..831649e19 --- /dev/null +++ b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/outgoing-http-call-trace.mustache @@ -0,0 +1,57 @@ +[{ + "name": "^{{serviceName}}$", + "http": { + "request": { + "url": "^{{endpoint}}/outgoing-http-call$", + "method": "^GET$" + } + }, + "aws": { + "ec2": { + "instance_id": "^{{instanceId}}$" + }, + "span.kind": "^LOCAL_ROOT$" + }, + "annotations": { + "aws.local.service": "^{{serviceName}}$", + "aws.local.operation": "^GET outgoing-http-call$", + "aws.local.environment": "^ec2:default$", + "span.name": "^GET outgoing-http-call$", + "span.kind": "^SERVER$" + }, + "metadata": { + "http.url": "^{{endpoint}}/outgoing-http-call$", + "http.method": "^GET$", + "http.route": "^outgoing-http-call$", + "service.name": "^{{serviceName}}$", + "cloud.provider": "^aws$", + "cloud.account.id": "^{{accountId}}$", + "cloud.region": "^{{region}}$", + "cloud.platform": "^aws_ec2$", + "PlatformType": "^AWS::EC2$" + }, + "subsegments": [ + { + "name": "^www.amazon.com$", + "http": { + "request": { + "url": "^https://www.amazon.com/$", + "method": "^GET$" + } + }, + "annotations": { + "aws.local.service": "^{{serviceName}}$", + "aws.local.operation": "^UnmappedOperation$", + "aws.remote.service": "^www.amazon.com$", + "aws.remote.operation": "^GET /$", + "aws.local.environment": "^ec2:default$", + "span.name": "^GET$", + "span.kind": "^CLIENT$" + }, + "namespace": "^remote$" + } + ] +}, +{ + "name": "^www.amazon.com$" +}] diff --git a/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/remote-service-log.mustache b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/remote-service-log.mustache new file mode 100644 index 000000000..8c342d820 --- /dev/null +++ b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/remote-service-log.mustache @@ -0,0 +1,49 @@ +[{ + "name": "GET remote-service", + "kind": "SERVER", + "resource": { + "attributes": { + "aws.local.service": "{{serviceName}}", + "service.name": "{{serviceName}}", + "cloud.provider": "aws", + "cloud.region": "{{region}}", + "cloud.account.id": "{{accountId}}", + "cloud.platform": "aws_ec2" + } + }, + "attributes": { + "aws.local.service": "{{serviceName}}", + "aws.local.environment": "ec2:default", + "aws.local.operation": "GET remote-service", + "aws.span.kind": "LOCAL_ROOT", + "http.url": "{{endpoint}}/remote-service", + "http.route": "remote-service", + "http.method": "GET", + "PlatformType": "AWS::EC2" + } +}, +{ + "name": "GET", + "kind": "CLIENT", + "resource": { + "attributes": { + "aws.local.service": "{{serviceName}}", + "service.name": "{{serviceName}}", + "cloud.provider": "aws", + "cloud.region": "{{region}}", + "cloud.account.id": "{{accountId}}", + "cloud.platform": "aws_ec2" + } + }, + "attributes": { + "aws.local.service": "{{serviceName}}", + "aws.local.operation": "UnmappedOperation", + "aws.remote.service": "{{remoteServiceDeploymentName}}", + "aws.remote.operation": "GET /healthcheck", + "aws.local.environment": "ec2:default", + "aws.span.kind": "CLIENT", + "http.url": "http://{{remoteServiceDeploymentName}}/healthcheck", + "http.method": "GET", + "PlatformType": "AWS::EC2" + } +}] \ No newline at end of file diff --git a/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/remote-service-metric.mustache b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/remote-service-metric.mustache new file mode 100644 index 000000000..0d3714f71 --- /dev/null +++ b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/remote-service-metric.mustache @@ -0,0 +1,326 @@ +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Operation + value: GET remote-service + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Operation + value: UnmappedOperation + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteOperation + value: GET /healthcheck + - + name: RemoteService + value: {{remoteServiceDeploymentName}} + +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Environment + value: ec2:default + - + name: Operation + value: GET healthcheck + - + name: Service + value: {{remoteServiceName}} + +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{remoteServiceName}} + - + name: Environment + value: ec2:default + +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteService + value: {{remoteServiceDeploymentName}} + +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteOperation + value: GET /healthcheck + - + name: RemoteService + value: {{remoteServiceDeploymentName}} + +- + metricName: Latency + namespace: {{metricNamespace}} + dimensions: + - + name: RemoteService + value: {{remoteServiceDeploymentName}} + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Operation + value: GET remote-service + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Operation + value: UnmappedOperation + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteOperation + value: GET /healthcheck + - + name: RemoteService + value: {{remoteServiceDeploymentName}} + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Environment + value: ec2:default + - + name: Operation + value: GET healthcheck + - + name: Service + value: {{remoteServiceName}} + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{remoteServiceName}} + - + name: Environment + value: ec2:default + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteService + value: {{remoteServiceDeploymentName}} + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteOperation + value: GET /healthcheck + - + name: RemoteService + value: {{remoteServiceDeploymentName}} + +- + metricName: Error + namespace: {{metricNamespace}} + dimensions: + - + name: RemoteService + value: {{remoteServiceDeploymentName}} + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Operation + value: GET remote-service + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Operation + value: UnmappedOperation + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteOperation + value: GET /healthcheck + - + name: RemoteService + value: {{remoteServiceDeploymentName}} + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Environment + value: ec2:default + - + name: Operation + value: GET healthcheck + - + name: Service + value: {{remoteServiceName}} + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{remoteServiceName}} + - + name: Environment + value: ec2:default + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteService + value: {{remoteServiceDeploymentName}} + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: Service + value: {{serviceName}} + - + name: Environment + value: ec2:default + - + name: RemoteOperation + value: GET /healthcheck + - + name: RemoteService + value: {{remoteServiceDeploymentName}} + +- + metricName: Fault + namespace: {{metricNamespace}} + dimensions: + - + name: RemoteService + value: {{remoteServiceDeploymentName}} diff --git a/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/remote-service-trace.mustache b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/remote-service-trace.mustache new file mode 100644 index 000000000..e56772553 --- /dev/null +++ b/validator/src/main/resources/expected-data-template/python/ec2/adot-sigv4/remote-service-trace.mustache @@ -0,0 +1,72 @@ +[{ + "name": "^{{serviceName}}$", + "http": { + "request": { + "url": "^{{endpoint}}/remote-service\\?ip=(([0-9]{1,3}.){3}[0-9]{1,3})&testingId={{testingId}}$", + "method": "^GET$" + }, + "response": { + "status": "^200$" + } + }, + "aws": { + "ec2": { + "instance_id": "^{{instanceId}}$" + }, + "span.kind": "^LOCAL_ROOT$" + }, + "annotations": { + "aws.local.service": "^{{serviceName}}$", + "aws.local.operation": "^GET remote-service$", + "aws.local.environment": "^ec2:default$", + "span.name": "^GET remote-service$", + "span.kind": "^SERVER$" + }, + "metadata": { + "http.url": "^{{endpoint}}/remote-service\\?ip=(([0-9]{1,3}.){3}[0-9]{1,3})&testingId={{testingId}}$", + "http.method": "^GET$", + "http.route": "^remote-service$", + "service.name": "^{{serviceName}}$", + "cloud.provider": "^aws$", + "cloud.account.id": "^{{accountId}}$", + "cloud.region": "^{{region}}$", + "cloud.platform": "^aws_ec2$", + "PlatformType": "^AWS::EC2$" + }, + "subsegments": [ + { + "name": "^{{remoteServiceDeploymentName}}$", + "http": { + "request": { + "url": "^http://{{remoteServiceDeploymentName}}/healthcheck$", + "method": "^GET$" + } + }, + "annotations": { + "aws.local.service": "^{{serviceName}}$", + "aws.local.operation": "^UnmappedOperation$", + "aws.remote.service": "^{{remoteServiceDeploymentName}}$", + "aws.remote.operation": "^GET /healthcheck$", + "aws.local.environment": "^ec2:default$", + "span.name": "^GET$", + "span.kind": "^CLIENT$" + }, + "namespace": "^remote$" + } + ] +}, +{ + "name": "^{{remoteServiceName}}$", + "http": { + "request": { + "url": "^http://{{remoteServiceDeploymentName}}/healthcheck$", + "method": "^GET$" + } + }, + "annotations": { + "aws.local.service": "^{{remoteServiceName}}$", + "aws.local.operation": "^GET healthcheck$" + } +}] + + diff --git a/validator/src/main/resources/validations/python/ec2/adot-sigv4/log-validation.yml b/validator/src/main/resources/validations/python/ec2/adot-sigv4/log-validation.yml new file mode 100644 index 000000000..98cdb5af0 --- /dev/null +++ b/validator/src/main/resources/validations/python/ec2/adot-sigv4/log-validation.yml @@ -0,0 +1,24 @@ +- + validationType: "cw-log" + httpPath: "outgoing-http-call" + httpMethod: "get" + callingType: "http" + expectedLogStructureTemplate: "PYTHON_EC2_ADOT_SIGV4_OUTGOING_HTTP_CALL_LOG" +- + validationType: "cw-log" + httpPath: "aws-sdk-call" + httpMethod: "get" + callingType: "http-with-query" + expectedLogStructureTemplate: "PYTHON_EC2_ADOT_SIGV4_AWS_SDK_CALL_LOG" +- + validationType: "cw-log" + httpPath: "remote-service" + httpMethod: "get" + callingType: "http-with-query" + expectedLogStructureTemplate: "PYTHON_EC2_ADOT_SIGV4_REMOTE_SERVICE_LOG" +- + validationType: "cw-log" + httpPath: "client-call" + httpMethod: "get" + callingType: "http" + expectedLogStructureTemplate: "PYTHON_EC2_ADOT_SIGV4_CLIENT_CALL_LOG" \ No newline at end of file diff --git a/validator/src/main/resources/validations/python/ec2/adot-sigv4/metric-validation.yml b/validator/src/main/resources/validations/python/ec2/adot-sigv4/metric-validation.yml new file mode 100644 index 000000000..76ea8b183 --- /dev/null +++ b/validator/src/main/resources/validations/python/ec2/adot-sigv4/metric-validation.yml @@ -0,0 +1,24 @@ +- + validationType: "cw-metric" + httpPath: "outgoing-http-call" + httpMethod: "get" + callingType: "http" + expectedMetricTemplate: "PYTHON_EC2_ADOT_SIGV4_OUTGOING_HTTP_CALL_METRIC" +- + validationType: "cw-metric" + httpPath: "aws-sdk-call" + httpMethod: "get" + callingType: "http-with-query" + expectedMetricTemplate: "PYTHON_EC2_ADOT_SIGV4_AWS_SDK_CALL_METRIC" +- + validationType: "cw-metric" + httpPath: "remote-service" + httpMethod: "get" + callingType: "http-with-query" + expectedMetricTemplate: "PYTHON_EC2_ADOT_SIGV4_REMOTE_SERVICE_METRIC" +- + validationType: "cw-metric" + httpPath: "client-call" + httpMethod: "get" + callingType: "http" + expectedMetricTemplate: "PYTHON_EC2_ADOT_SIGV4_CLIENT_CALL_METRIC" \ No newline at end of file diff --git a/validator/src/main/resources/validations/python/ec2/adot-sigv4/trace-validation.yml b/validator/src/main/resources/validations/python/ec2/adot-sigv4/trace-validation.yml new file mode 100644 index 000000000..3abe2c925 --- /dev/null +++ b/validator/src/main/resources/validations/python/ec2/adot-sigv4/trace-validation.yml @@ -0,0 +1,24 @@ +- + validationType: "trace" + httpPath: "outgoing-http-call" + httpMethod: "get" + callingType: "http" + expectedTraceTemplate: "PYTHON_EC2_ADOT_SIGV4_OUTGOING_HTTP_CALL_TRACE" +- + validationType: "trace" + httpPath: "aws-sdk-call" + httpMethod: "get" + callingType: "http-with-query" + expectedTraceTemplate: "PYTHON_EC2_ADOT_SIGV4_AWS_SDK_CALL_TRACE" +- + validationType: "trace" + httpPath: "remote-service" + httpMethod: "get" + callingType: "http-with-query" + expectedTraceTemplate: "PYTHON_EC2_ADOT_SIGV4_REMOTE_SERVICE_TRACE" +- + validationType: "trace" + httpPath: "client-call" + httpMethod: "get" + callingType: "http" + expectedTraceTemplate: "PYTHON_EC2_ADOT_SIGV4_CLIENT_CALL_TRACE" \ No newline at end of file