summaryrefslogtreecommitdiffstats
path: root/.github/workflows/compare_index_performance.yml
blob: 7430938e174467e5235ba2fced922c03d5100555 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
name: compare_index_performance

on:
  workflow_dispatch:
    inputs:
      pull_number:
        description: 'Pull request number to test the current side against, ex: 12345 (empty = current branch)'
        required: false
        default: ''
      duration:
        description: 'Duration of each workload run in seconds'
        required: false
        default: '100'
      iterations:
        description: 'Number of iterations per workload (median reported)'
        required: false
        default: '10'
      build_preset:
        description: 'Build preset (must match S3 prebuilt binary)'
        required: false
        type: choice
        options:
          - release
          - relwithdebinfo
          - profile
        default: release
      ref:
        description: 'S3 ref to compare against (e.g. main, stable-26-1-1)'
        required: false
        default: 'main'
      workload:
        description: 'Workload to run'
        required: false
        type: choice
        options:
          - all
          - vector
          - fulltext
        default: all
      rows:
        description: 'Number of rows in generated database'
        required: false
        default: '10000'
      targets:
        description: 'Number of query vectors for vector select'
        required: false
        default: '1000'
      warmup:
        description: 'Warmup duration in seconds before each measured run'
        required: false
        default: '30'
      threads:
        description: 'Number of threads for load testing'
        required: false
        default: '10'
      main_feature_flags:
        description: 'Comma-separated feature flags for main branch (e.g. enable_foo,enable_bar)'
        required: false
        default: ''
      current_feature_flags:
        description: 'Comma-separated feature flags for current branch (e.g. enable_foo,enable_bar)'
        required: false
        default: ''
      main_table_service_config:
        description: 'Comma-separated table_service_config options for main branch (e.g. enable_vector_index_read=true)'
        required: false
        default: ''
      current_table_service_config:
        description: 'Comma-separated table_service_config options for current branch (e.g. enable_vector_index_read=true)'
        required: false
        default: ''
      build_baseline:
        description: 'Build baseline ydbd from the exact resolved commit instead of downloading a prebuilt S3 binary'
        required: false
        type: boolean
        default: true

jobs:
  compare:
    name: Compare performance (${{ inputs.ref || 'main' }} vs ${{ inputs.pull_number && format('PR {0}', inputs.pull_number) || 'current' }})
    runs-on: [ self-hosted, auto-provisioned, "build-preset-${{ inputs.build_preset || 'release' }}" ]
    timeout-minutes: 1200
    steps:
      - name: Resolve checkout ref
        id: resolve-ref
        env:
          PULL_REQUEST_NUMBER: ${{ inputs.pull_number || '' }}
          INPUT_REF: ${{ inputs.ref || 'main' }}
          GITHUB_TOKEN: ${{ github.token }}
        run: |
          # Resolve the baseline SHA (HEAD of the S3 ref branch).
          BASELINE_SHA=$(curl --retry 5 --retry-all-errors --retry-delay 10 --fail --show-error -s \
            -H "Authorization: token $GITHUB_TOKEN" \
            "https://api.github.com/repos/${GITHUB_REPOSITORY}/commits/${INPUT_REF}" \
            | jq -r '.sha')
          echo "baseline_sha=$BASELINE_SHA" >> "$GITHUB_OUTPUT"

          # When a pull_number is given, run the current side against the PR's
          # merge commit (mirrors run_tests.yml); otherwise use the triggering ref.
          if [[ -n "$PULL_REQUEST_NUMBER" ]] && [[ "$PULL_REQUEST_NUMBER" =~ ^[0-9]+$ ]]; then
            PR_DATA=$(curl --retry 5 --retry-all-errors --retry-delay 10 --fail --show-error -s \
              -H "Authorization: token $GITHUB_TOKEN" \
              "https://api.github.com/repos/${GITHUB_REPOSITORY}/pulls/$PULL_REQUEST_NUMBER")
            MERGE_SHA=$(echo "$PR_DATA" | jq -r '.merge_commit_sha')
            if [ -n "$MERGE_SHA" ] && [ "$MERGE_SHA" != "null" ]; then
              echo "Testing PR #$PULL_REQUEST_NUMBER at merge commit $MERGE_SHA"
              echo "checkout_ref=$MERGE_SHA" >> "$GITHUB_OUTPUT"
            else
              echo "Failed to get merge commit for PR $PULL_REQUEST_NUMBER"
              exit 1
            fi
          else
            echo "checkout_ref=" >> "$GITHUB_OUTPUT"
          fi

      - name: Checkout
        uses: actions/checkout@v5
        with:
          ref: ${{ steps.resolve-ref.outputs.checkout_ref }}

      - name: Build baseline ydbd
        id: build-baseline
        if: ${{ inputs.build_baseline != 'false' }}
        env:
          BASELINE_SHA: ${{ steps.resolve-ref.outputs.baseline_sha }}
          INPUT_BUILD_PRESET: ${{ inputs.build_preset || 'release' }}
        run: |
          git fetch --depth=1 origin "$BASELINE_SHA"
          git worktree add ../baseline "$BASELINE_SHA"
          cd ../baseline
          ./ya make --build "$INPUT_BUILD_PRESET" ydb/apps/ydbd
          BINARY=$(find . -name ydbd -path '*/ydb/apps/ydbd/ydbd' -not -path '*/ydb/apps/ydbd/ydbd/*' 2>/dev/null | head -1)
          BINARY=$(realpath "$BINARY")
          echo "binary=$BINARY" >> "$GITHUB_OUTPUT"

      - name: Run performance comparison
        env:
          INPUT_DURATION: ${{ inputs.duration || '100' }}
          INPUT_BUILD_PRESET: ${{ inputs.build_preset || 'release' }}
          INPUT_REF: ${{ inputs.ref || 'main' }}
          INPUT_WORKLOAD: ${{ inputs.workload || 'all' }}
          INPUT_ROWS: ${{ inputs.rows || '10000' }}
          INPUT_TARGETS: ${{ inputs.targets || '1000' }}
          INPUT_ITERATIONS: ${{ inputs.iterations || '10' }}
          INPUT_WARMUP: ${{ inputs.warmup || '30' }}
          INPUT_THREADS: ${{ inputs.threads || '10' }}
          INPUT_MAIN_FEATURE_FLAGS: ${{ inputs.main_feature_flags || '' }}
          INPUT_CURRENT_FEATURE_FLAGS: ${{ inputs.current_feature_flags || '' }}
          INPUT_MAIN_TABLE_SERVICE_CONFIG: ${{ inputs.main_table_service_config || '' }}
          INPUT_CURRENT_TABLE_SERVICE_CONFIG: ${{ inputs.current_table_service_config || '' }}
          INPUT_BASELINE_SHA: ${{ steps.resolve-ref.outputs.baseline_sha }}
          INPUT_CURRENT_SHA: ${{ steps.resolve-ref.outputs.checkout_ref }}
          INPUT_BASELINE_YDBD: ${{ steps.build-baseline.outputs.binary }}
        run: |
          # The feature-flag / table_service_config inputs are comma-separated
          # strings; the test splits them itself, so they are passed through as-is.
          EXTRA_PARAMS=""
          if [[ -n "$INPUT_BASELINE_YDBD" ]]; then
            EXTRA_PARAMS="--test-param compare_baseline_ydbd=$INPUT_BASELINE_YDBD"
          fi
          ./ya make --build "$INPUT_BUILD_PRESET" -tA --test-disable-timeout \
            ydb/tests/stress/compare_index_performance/tests \
            --test-param compare_duration="$INPUT_DURATION" \
            --test-param compare_build_preset="$INPUT_BUILD_PRESET" \
            --test-param compare_ref="$INPUT_REF" \
            --test-param compare_targets="$INPUT_TARGETS" \
            --test-param compare_workload="$INPUT_WORKLOAD" \
            --test-param compare_rows="$INPUT_ROWS" \
            --test-param compare_iterations="$INPUT_ITERATIONS" \
            --test-param compare_warmup="$INPUT_WARMUP" \
            --test-param compare_threads="$INPUT_THREADS" \
            --test-param compare_baseline_feature_flags="$INPUT_MAIN_FEATURE_FLAGS" \
            --test-param compare_current_feature_flags="$INPUT_CURRENT_FEATURE_FLAGS" \
            --test-param compare_baseline_table_service_config="$INPUT_MAIN_TABLE_SERVICE_CONFIG" \
            --test-param compare_current_table_service_config="$INPUT_CURRENT_TABLE_SERVICE_CONFIG" \
            --test-param compare_baseline_sha="$INPUT_BASELINE_SHA" \
            --test-param compare_current_sha="$INPUT_CURRENT_SHA" \
            $EXTRA_PARAMS

      - name: Post results to job summary
        if: always()
        run: |
          RESULTS_DIR=ydb/tests/stress/compare_index_performance/tests/test-results
          # `test-results` and the files under it are ya-build symlinks, so find
          # must follow symlinks (-L) — otherwise it never descends into them.
          REPORTS=$(find -L "$RESULTS_DIR" -name 'report_*.md' -path "*/testing_out_stuff/*" 2>/dev/null | sort)
          if [[ -n "$REPORTS" ]]; then
            for r in $REPORTS; do
              cat "$r" >> "$GITHUB_STEP_SUMMARY"
              echo "" >> "$GITHUB_STEP_SUMMARY"
            done
          else
            echo "No report generated." >> "$GITHUB_STEP_SUMMARY"
          fi

      - name: Post results to pull request
        if: always() && inputs.pull_number != ''
        env:
          PR_NUMBER: ${{ inputs.pull_number }}
          BUILD_PRESET: ${{ inputs.build_preset || 'release' }}
          GITHUB_TOKEN: ${{ github.token }}
        run: |
          pip install PyGithub
          RESULTS_DIR=ydb/tests/stress/compare_index_performance/tests/test-results
          REPORTS=$(find -L "$RESULTS_DIR" -name 'report_*.md' -path "*/testing_out_stuff/*" 2>/dev/null | sort)
          run_url="https://github.com/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}"
          {
            echo "### Index performance comparison"
            echo ""
            if [[ -n "$REPORTS" ]]; then
              for r in $REPORTS; do
                cat "$r"
                echo ""
              done
            else
              echo "No report generated."
            fi
            echo "[Workflow run](${run_url})"
          } | .github/scripts/tests/comment-pr.py --rewrite --no-timestamp

      - name: Upload benchmark logs
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: benchmark-results
          path: ydb/tests/stress/compare_index_performance/tests/test-results/**/testing_out_stuff/
          retention-days: 30