README.md

Observability to the Rescue! - Conference talk at DeveloperWeek Latin America 2023 by Daniel Dias

This repo contains the sample app for the presentation "Observability to the Rescue! Monitoring and testing APIs with OpenTelemetry" at DeveloperWeek Latin America 2023.

Run this example with:

docker compose up

Requests that you can run this example

Valid payment without risk analysis scenario:

curl --location 'http://localhost:10013/executePaymentOrder' \
--header 'Content-Type: application/json' \
--data '{
    "walletId": 2,
    "yearsAsACustomer": 1
}'

# Output
# {
#     "status": "executed"
# }

Valid payment with risk analysis scenario:

curl --location 'http://localhost:10013/executePaymentOrder' \
--header 'Content-Type: application/json' \
--data '{
    "walletId": 4,
    "yearsAsACustomer": 1
}'

# Output
# {
#     "status": "executed"
# }

Denied payment scenario:

curl --location 'http://localhost:10013/executePaymentOrder' \
--header 'Content-Type: application/json' \
--data '{
    "walletId": 5,
    "yearsAsACustomer": 1
}'

# Output
# {
#     "status": "denied"
# }

Request with error scenario

curl --location 'http://localhost:10013/executePaymentOrder' \
--header 'Content-Type: application/json' \
--data '{
    "walletId": 4,
    "yearsAsACustomer": 0
}'

# Output
# internal error!

Trace-based tests that you can run

There are two tests that you can do to check how these APIs are working, one is the test-with-error, that calls your-api passing the yearsAsACustomer field as zero, causing a error propagation into the API calls:

tracetest test run -w -d ./tracetest/tests/test-with-error.yaml

The second one is test-with-success, with the field yearsAsACustomer greater than 0, causing the services to behave normally:

tracetest test run -w -d ./tracetest/tests/test-with-success.yaml