GeneXus integrates with AWS Distro for OpenTelemetry to compile metrics and traces of applications, offering a comprehensive approach to application observability. This guide outlines the steps to configure and utilize AWS Distro for OpenTelemetry with your GeneXus applications.
Follow these steps for a successful integration:
- Set the Observability Provider Property: Choose 'AWS Distro for OpenTelemetry' as your observability provider.
- Execute the AWS OpenTelemetry Collector: Install and run the AWS Otel collector based on the official guide.
- Configure the Environment Variables: Set necessary environment variables in your app’s Docker image.
- Configure AWS Credentials: Ensure your collector has the appropriate AWS credentials with minimal required permissions.
- Execute the App’s Docker Image: Run your application’s Docker image with the configured settings.
Select AWS Distro for OpenTelemetry in the Observability Provider property to integrate AWS telemetry services with your application.
Refer to this guide to install and run the AWS OpenTelemetry collector, which is essential for telemetry data collection.
Set the following environment variables in your application's Docker image for proper telemetry data export:
OTEL_EXPORTER_OTLP_ENDPOINT=http://aws-ot-collector:4317
OTEL_METRICS_EXPORTER=otlp
OTEL_RESOURCE_ATTRIBUTES=service.namespace=GeneXus,service.name=sample-app,service.version=1.0.1
For detailed information on SDK configuration, visit: SDK Configuration.
Assign the necessary AWS Credentials to the collector. These credentials should adhere to the minimal IAM Policy requirements for security and efficiency.
Finally, execute your application's Docker image with the configured settings.
It is possible to execute OpenTelemetry through Docker Compose.
You may execute the following compose.yaml that has the configured collector connected to the GeneXus application to be deployed.
compose.yaml:
version: "2"
services:
# ADOT Collector
aws-ot-collector:
image: public.ecr.aws/aws-observability/aws-otel-collector:latest
environment:
- AWS_REGION=us-east-1
- AWS_ACCESS_KEY_ID=XXXXX
- AWS_SECRET_ACCESS_KEY=XXXXXXXXXX
ports:
- "4317:4317"
smaplegenexusapp:
build:
context: .
environment:
- OTEL_EXPORTER_OTLP_ENDPOINT=http://aws-ot-collector:4317
- OTEL_RESOURCE_ATTRIBUTES=service.namespace=GeneXus,service.name=sample-app,service.version=1.0.1
- OTEL_METRICS_EXPORTER=otlp
- GX_LOG_LEVEL=info
- GX_LOG_LEVEL_USER=debug
- GX_LOG_OUTPUT=ConsoleAppender
ports:
- "80:80"
https://aws-otel.github.io/docs/setup/permissions
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"logs:PutLogEvents",
"logs:CreateLogGroup",
"logs:CreateLogStream",
"logs:DescribeLogStreams",
"logs:DescribeLogGroups",
"logs:PutRetentionPolicy",
"xray:PutTraceSegments",
"xray:PutTelemetryRecords",
"xray:GetSamplingRules",
"xray:GetSamplingTargets",
"xray:GetSamplingStatisticSummaries",
"ssm:GetParameters"
],
"Resource": "*"
}
]
}
Generator: Java, .NET
This functionality is available since GeneXus 18 Upgrade 4.