Skip to content

build.md

Latest commit

 

History

History
111 lines (80 loc) · 4.54 KB

build.md

File metadata and controls

111 lines (80 loc) · 4.54 KB
Raw

Description

Build images used for system tests.

Usage

    ./build.sh <library_name> [--images <image_names>] [--weblog-variant <variant_name>]

Options

  • <library_name>: library to test. See LIBRARIES section.
  • -i: Comma separated list of images you need to build. See Image names section for possible values. Default: all of them
  • --images: Same as -i
  • -w: Name of a weblog variation
  • --weblog-variant: same as -w

Image names

  • weblog: Web app that ships the library.
  • agent: Host for datadog agent.
  • runner: Test runner.

Libraries names

  • c
  • dotnet
  • golang
  • java
  • nodejs
  • php
  • python
  • ruby
  • rust

cpp is not available for build.sh because only parametric tests are runnable for dd-trace-cpp.

Weblog variants

  • For c: perl-mojolicious (default)
  • For dotnet: poc (default), uds
  • For golang: net-http (default), gin, echo, chi
    • Specific to the GRAPHQL_APPSEC scenario: gqlgen, graph-gophers, graphql-go
  • For java: spring-boot (default),akka-http,jersey-grizzly2,play,ratpack,resteasy-netty3,spring-boot-3-native,spring-boot-jetty,spring-boot-openliberty,spring-boot-payara,spring-boot-undertow,spring-boot-wildfly,uds-spring-boot,vertx3,vertx4
  • For nodejs: express4 (default), express4-typescript, express5, nextjs, fastify
  • For php: apache-mod-8.0 (default), apache-mod-8.1, apache-mod-8.2, apache-mod-7.4, apache-mod-7.3, apache-mod-7.2, apache-mod-7.1, apache-mod-7.0, apache-mod-8.2-zts, apache-mod-8.1-zts, apache-mod-8.0-zts, apache-mod-7.4-zts, apache-mod-7.3-zts, apache-mod-7.2-zts, apache-mod-7.1-zts, apache-mod-7.0-zts, php-fpm-8.5, php-fpm-8.2, php-fpm-8.1, php-fpm-8.0, php-fpm-7.4, php-fpm-7.3, php-fpm-7.2, php-fpm-7.1, php-fpm-7.0, laravel11x, symfony7x
  • For python: flask-poc (default), fastapi, uwsgi-poc, django-poc, python3.12
  • For ruby: rails70 (default), rack, sinatra21, and lot of other sinatra/rails versions
  • For rust: axum (default)

dd-trace-c packages

Build the native C tracer workload with:

./build.sh c -w perl-mojolicious

The production build uses the published apm-library-c-package:latest and apm-inject-package:latest images from install.datadoghq.com. Run ./utils/scripts/load-binary.sh c to validate and record both production image references in binaries/. For a development build, set LIBRARY_TARGET_BRANCH, AUTO_INJECT_TARGET_BRANCH, or both before running the loader. Each branch override is resolved to an immutable commit-SHA tag from installtesting.datad0g.com (with a zero in datad0g); components without a branch override continue to use the production latest image.

The perl-mojolicious workload supports DEFAULT, SAMPLING, and IPV6. It uses Perl and Mojolicious without a Datadog Perl tracer; all tracing comes from dd-trace-c's native socket instrumentation. Auto-inject loads that native library when DD_INJECT_NATIVE=always and DD_TRACE_HOOK_MODULES=socket are set; the library is not added directly to LD_PRELOAD. The workload also enables 128-bit trace ID generation. Unsupported product capabilities and workload-only gaps are recorded in manifests/c.yml.

Real life examples

By default, all images will uses production version of components (library and agent). You can use a specific version of a component by adding it inside binaries/ (documentation). The main idea behind this behavior is to test a specific version against production version of other components.

Environement variables

You can define your setup in environment variable in a .env file. Here is the mapping:

  • <library_name> => TEST_LIBRARY
  • -i/--images => BUILD_IMAGES
  • -w/--weblog-variant => WEBLOG_VARIANT

Authentication for pulling images

Some images are hosted at Github. Those images require authentication.

If you find an error messages like:

Error response from daemon: Head "https://ghcr.io/v2/datadog/system-tests-apps-ruby/rails70/manifests/latest": unauthorized

You have to make to sure to authenticate before pulling the images.

  1. Create a Github token. The token has to have package read and write perimssions. You can create the token using this link: https://github.com/settings/tokens/new?scopes=write:packages
  2. Make sure to enable SSO for the new token.
  3. Authenticate docker: 3.1 docker login ghcr.io 3.2 paste your Github username 3.2 paste the token string from step 1.