Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate CodeQL scan to gitlab job #33771

Draft
wants to merge 27 commits into
base: main
Choose a base branch
from

Conversation

ganeshkumarsv
Copy link
Contributor

What does this PR do?

Motivation

Describe how you validated your changes

Possible Drawbacks / Trade-offs

Additional Notes

@github-actions github-actions bot added team/agent-devx-infra medium review PR review might take time labels Feb 6, 2025
Copy link

cit-pr-commenter bot commented Feb 6, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 19c1756a-fa6d-4e62-aa84-a37672d56847

Baseline: e305652
Comparison: 2c9b578
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
tcp_syslog_to_blackhole ingress throughput +1.65 [+1.57, +1.73] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization +1.59 [+0.73, +2.46] 1 Logs
quality_gate_logs % cpu utilization +0.61 [-2.48, +3.70] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput +0.04 [-0.82, +0.89] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.02 [-0.26, +0.29] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.01 [-0.63, +0.65] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.01 [-0.84, +0.86] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.01, +0.01] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.00 [-0.73, +0.72] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.02 [-0.80, +0.76] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.05 [-0.95, +0.84] 1 Logs
quality_gate_idle_all_features memory utilization -0.09 [-0.17, -0.02] 1 Logs bounds checks dashboard
file_tree memory utilization -0.12 [-0.19, -0.05] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.32 [-0.79, +0.14] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.50 [-1.27, +0.27] 1 Logs
quality_gate_idle memory utilization -0.72 [-0.79, -0.64] 1 Logs bounds checks dashboard

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed links
file_to_blackhole_0ms_latency lost_bytes 10/10
file_to_blackhole_0ms_latency memory_usage 10/10
file_to_blackhole_0ms_latency_http1 lost_bytes 10/10
file_to_blackhole_0ms_latency_http1 memory_usage 10/10
file_to_blackhole_0ms_latency_http2 lost_bytes 10/10
file_to_blackhole_0ms_latency_http2 memory_usage 10/10
file_to_blackhole_1000ms_latency memory_usage 10/10
file_to_blackhole_1000ms_latency_linear_load memory_usage 10/10
file_to_blackhole_100ms_latency lost_bytes 10/10
file_to_blackhole_100ms_latency memory_usage 10/10
file_to_blackhole_300ms_latency lost_bytes 10/10
file_to_blackhole_300ms_latency memory_usage 10/10
file_to_blackhole_500ms_latency lost_bytes 10/10
file_to_blackhole_500ms_latency memory_usage 10/10
quality_gate_idle intake_connections 10/10 bounds checks dashboard
quality_gate_idle memory_usage 10/10 bounds checks dashboard
quality_gate_idle_all_features intake_connections 10/10 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 bounds checks dashboard
quality_gate_logs intake_connections 10/10
quality_gate_logs lost_bytes 10/10
quality_gate_logs memory_usage 10/10

Explanation

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

Performance changes are noted in the perf column of each table:

  • ✅ = significantly better comparison variant performance
  • ❌ = significantly worse comparison variant performance
  • ➖ = no significant change in performance

A regression test is an A/B test of target performance in a repeatable rig, where "performance" is measured as "comparison variant minus baseline variant" for an optimization goal (e.g., ingress throughput). Due to intrinsic variability in measuring that goal, we can only estimate its mean value for each experiment; we report uncertainty in that value as a 90.00% confidence interval denoted "Δ mean % CI".

For each experiment, we decide whether a change in performance is a "regression" -- a change worth investigating further -- if all of the following criteria are true:

  1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

  2. Its 90.00% confidence interval "Δ mean % CI" does not contain zero, indicating that if our statistical model is accurate, there is at least a 90.00% chance there is a difference in performance between baseline and comparison variants.

  3. Its configuration does not mark it "erratic".

CI Pass/Fail Decision

Passed. All Quality Gates passed.

  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 6, 2025

Gitlab CI Configuration Changes

Added Jobs

run_codeql_scan
run_codeql_scan:
  allow_failure: true
  artifacts:
    paths:
    - go.sarif
    - javascript.sarif
    - python.sarif
    - cpp.sarif
  image: registry.ddbuild.io/ci/datadog-agent-buildimages/deb_x64$DATADOG_AGENT_BUILDIMAGES_SUFFIX:$DATADOG_AGENT_BUILDIMAGES
  needs:
  - go_deps
  - go_tools_deps
  rules:
  - when: on_success
  script:
  - mkdir -p $GOPATH/pkg/mod/cache && tar xJf modcache.tar.xz -C $GOPATH/pkg/mod/cache
    || exit 101
  - rm -f modcache.tar.xz
  - mkdir -p $GOPATH/pkg/mod/cache && tar xJf modcache_tools.tar.xz -C $GOPATH/pkg/mod/cache
    || exit 101
  - rm -f modcache_tools.tar.xz
  - git config --global url."https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.ddbuild.io/DataDog/".insteadOf
    "https://github.com/DataDog/"
  - git clone https://github.com/DataDog/codescanning.git --depth 1 --single-branch
    --branch=main /tmp/codescanning
  - curl -L $CODEQL_BUNDLE_URL -o /tmp/codeql.tar.gz && tar -zxf /tmp/codeql.tar.gz
    -C /usr/local && rm /tmp/codeql.tar.gz
  - echo "CGO_LDFLAGS=${CGO_LDFLAGS}"
  - echo "CGO_CFLAGS=${CGO_CFLAGS}"
  - export CGO_LDFLAGS="-L${PWD}/rtloader/build/rtloader -ldl"
  - export CGO_CFLAGS="-I${PWD}/rtloader/include -I${PWD}/rtloader/common"
  - echo "CGO_LDFLAGS=${CGO_LDFLAGS}"
  - echo "CGO_CFLAGS=${CGO_CFLAGS}"
  - invoke install-tools
  - rm -rf /tmp/codeql.*
  - df -h /tmp
  - ls -ld /tmp
  - $CODEQL database create "$CODEQL_DB" $DB_CONFIGS --command="inv -e agent.build
    --build-exclude=systemd"
  - $CODEQL database analyze "$CODEQL_DB"/go "$GO_CUSTOM_QLPACK" $SCAN_CONFIGS --sarif-category="go"
    --output="/tmp/go.sarif"
  - $CODEQL database analyze "$CODEQL_DB"/javascript codeql/javascript-queries $SCAN_CONFIGS
    --sarif-category="javascript" --output="/tmp/javascript.sarif"
  - $CODEQL database analyze "$CODEQL_DB"/python "$PYTHON_CUSTOM_QLPACK" $SCAN_CONFIGS
    --sarif-category="python" --output="/tmp/python.sarif"
  - $CODEQL database analyze "$CODEQL_DB"/cpp codeql/cpp-queries $SCAN_CONFIGS --sarif-category="cpp"
    --output="/tmp/cpp.sarif"
  - mv /tmp/go.sarif .
  - mv /tmp/javascript.sarif .
  - mv /tmp/python.sarif .
  - mv /tmp/cpp.sarif .
  stage: source_test
  tags:
  - arch:amd64
  variables:
    ARCH: arm64
    BASE_REF: main
    CODEQL: /usr/local/codeql/codeql
    CODEQL_BUNDLE_URL: https://github.com/github/codeql-action/releases/download/codeql-bundle-v2.20.4/codeql-bundle-linux64.tar.gz
    CODEQL_DB: /tmp/datadog-agent.codeql
    DB_CONFIGS: --threads 8 --ram 96000 --db-cluster --language=go,python,javascript,cpp
    GITHUB_APP_PRIVATE_KEY_NAME: csec.codescanning.githubapp.privatekey
    GOMAXPROCS: 10
    GO_CUSTOM_QLPACK: /tmp/codescanning/qlpacks/golang/codeql-suites/dd-source.qls
    KUBERNETES_CPU_LIMIT: 10
    KUBERNETES_CPU_REQUEST: 10
    KUBERNETES_MEMORY_LIMIT: 64Gi
    KUBERNETES_MEMORY_REQUEST: 64Gi
    PYTHON_CUSTOM_QLPACK: /tmp/codescanning/qlpacks/python/codeql-suites/custom.qls
    SCAN_CONFIGS: --format sarifv2.1.0 --threads 8 --ram 96000 --no-tuple-counting
    UPLOAD_CONFIGS: -upload_sarif=true

Changes Summary

Removed Modified Added Renamed
0 0 1 0

ℹ️ Diff available in the job log.

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 6, 2025

Uncompressed package size comparison

Comparison with ancestor e305652b1fe275fb27009d4e6153cacecb503ae4

Diff per package
package diff status size ancestor threshold
datadog-agent-amd64-deb 0.00MB 873.66MB 873.66MB 0.50MB
datadog-agent-x86_64-rpm 0.00MB 883.40MB 883.40MB 0.50MB
datadog-agent-x86_64-suse 0.00MB 883.40MB 883.40MB 0.50MB
datadog-agent-arm64-deb 0.00MB 861.54MB 861.54MB 0.50MB
datadog-agent-aarch64-rpm 0.00MB 871.26MB 871.26MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 59.10MB 59.10MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 59.18MB 59.18MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 59.18MB 59.18MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 56.57MB 56.57MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 446.05MB 446.05MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 86.47MB 86.47MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 86.54MB 86.54MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 86.54MB 86.54MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 82.74MB 82.74MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 82.81MB 82.81MB 0.50MB

Decision

✅ Passed

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 6, 2025

Static quality checks ✅

Please find below the results from static quality gates

Info

Result Quality gate On disk size On disk size limit On wire size On wire size limit
static_quality_gate_agent_deb_amd64 845.07MiB 858.45MiB 203.57MiB 214.3MiB
static_quality_gate_docker_agent_amd64 929.32MiB 942.69MiB 310.71MiB 321.56MiB

@KevinFairise2 KevinFairise2 force-pushed the SINT-2999-migrate-codeql-scan-to-gitlab-job branch from 3752d2b to d707b0c Compare February 6, 2025 10:27
@ganeshkumarsv ganeshkumarsv changed the title Sint 2999 migrate codeql scan to gitlab job Migrate CodeQL scan to gitlab job Feb 9, 2025
@KevinFairise2 KevinFairise2 force-pushed the SINT-2999-migrate-codeql-scan-to-gitlab-job branch 4 times, most recently from c8f5780 to 259f759 Compare February 12, 2025 14:34
@KevinFairise2 KevinFairise2 force-pushed the SINT-2999-migrate-codeql-scan-to-gitlab-job branch from 259f759 to 582aaeb Compare February 12, 2025 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants