-
Notifications
You must be signed in to change notification settings - Fork 0
Add execution report heartbeat alerts #119
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| name: Execution Report Heartbeat | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
| lookback_hours: | ||
| description: "Report lookback window in hours." | ||
| required: false | ||
| type: string | ||
| default: "36" | ||
| fail_workflow_on_alert: | ||
| description: "Fail this workflow when an alert is emitted." | ||
| required: false | ||
| type: choice | ||
| default: "true" | ||
| options: | ||
| - "true" | ||
| - "false" | ||
| schedule: | ||
| - cron: "25 23 * * 1-5" | ||
|
|
||
| env: | ||
| GCP_PROJECT_ID: longbridgequant | ||
| GCP_WORKLOAD_IDENTITY_PROVIDER: projects/252919773759/locations/global/workloadIdentityPools/github-actions/providers/github-main | ||
| GCP_WORKLOAD_IDENTITY_SERVICE_ACCOUNT: longbridge-platform-deploy@longbridgequant.iam.gserviceaccount.com | ||
|
|
||
| jobs: | ||
| heartbeat: | ||
| name: Check ${{ matrix.target.label }} execution report heartbeat | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| target: | ||
| - label: PAPER | ||
| environment: longbridge-paper | ||
| - label: HK | ||
| environment: longbridge-hk | ||
| - label: SG | ||
| environment: longbridge-sg | ||
| permissions: | ||
| contents: read | ||
| id-token: write | ||
| environment: ${{ matrix.target.environment }} | ||
| env: | ||
| RUNTIME_HEARTBEAT_NAME: LongBridgePlatform ${{ matrix.target.label }} | ||
| RUNTIME_HEARTBEAT_REPORT_PLATFORM: longbridge | ||
| RUNTIME_HEARTBEAT_ACCOUNT_SCOPE: ${{ vars.ACCOUNT_REGION }} | ||
| RUNTIME_HEARTBEAT_REQUIRED_SERVICES: ${{ vars.RUNTIME_HEARTBEAT_REQUIRED_SERVICES || vars.CLOUD_RUN_SERVICE }} | ||
| RUNTIME_HEARTBEAT_GCS_URIS: ${{ vars.RUNTIME_HEARTBEAT_GCS_URIS || vars.EXECUTION_REPORT_GCS_URI }} | ||
| RUNTIME_HEARTBEAT_LOOKBACK_HOURS: ${{ inputs.lookback_hours || vars.RUNTIME_HEARTBEAT_LOOKBACK_HOURS || '36' }} | ||
| RUNTIME_HEARTBEAT_FAIL_WORKFLOW_ON_ALERT: ${{ inputs.fail_workflow_on_alert || vars.RUNTIME_HEARTBEAT_FAIL_WORKFLOW_ON_ALERT || 'true' }} | ||
| RUNTIME_HEARTBEAT_ACCEPT_STATUSES: ${{ vars.RUNTIME_HEARTBEAT_ACCEPT_STATUSES }} | ||
| RUNTIME_HEARTBEAT_REJECT_STATUSES: ${{ vars.RUNTIME_HEARTBEAT_REJECT_STATUSES }} | ||
| CLOUD_RUN_SERVICE: ${{ vars.CLOUD_RUN_SERVICE }} | ||
| GLOBAL_TELEGRAM_CHAT_ID: ${{ vars.GLOBAL_TELEGRAM_CHAT_ID }} | ||
| CRISIS_ALERT_TELEGRAM_CHAT_IDS: ${{ vars.CRISIS_ALERT_TELEGRAM_CHAT_IDS }} | ||
| CRISIS_ALERT_TELEGRAM_API_BASE_URL: ${{ vars.CRISIS_ALERT_TELEGRAM_API_BASE_URL }} | ||
| TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }} | ||
| CRISIS_ALERT_TELEGRAM_BOT_TOKEN: ${{ secrets.CRISIS_ALERT_TELEGRAM_BOT_TOKEN }} | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v6 | ||
|
|
||
| - name: Authenticate to Google Cloud | ||
| uses: google-github-actions/auth@v3 | ||
| with: | ||
| workload_identity_provider: ${{ env.GCP_WORKLOAD_IDENTITY_PROVIDER }} | ||
| service_account: ${{ env.GCP_WORKLOAD_IDENTITY_SERVICE_ACCOUNT }} | ||
|
|
||
| - name: Set up gcloud | ||
| uses: google-github-actions/setup-gcloud@v3 | ||
|
|
||
| - name: Check recent execution report | ||
| run: python scripts/execution_report_heartbeat.py | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With the scheduled job running only once per weekday at 23:25 UTC, the 36-hour default can let yesterday's accepted report satisfy today's check. For example, if the PAPER/US service wrote a report after Monday's close and then misses all Tuesday scheduler runs, Tuesday's heartbeat still finds that report within 36 hours and returns OK, so the missed daily completion is not alerted. Use a window that cannot include the prior trading day's completion, or derive the expected window per market/day.
Useful? React with 👍 / 👎.