Report ML-powered query enablement in the init status report
#907
Conversation
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
We report this information in the `init` status report rather than the `analyze` status report so we can gather data about timeouts.
aeisenberg
reviewed
Feb 3, 2022
Contributor
aeisenberg
left a comment
aeisenberg
left a comment
There was a problem hiding this comment.
Just a minor thing, otherwise looks good.
Contributor
|
I believe you also need a PR such as https://github.com/github/hydro-schemas/pull/1845 to add the new field to the database and also a |
Contributor
Author
Thanks, these are in the works (see the internal tracking issue)! |
When multiple ML-powered JS packs are in scope (an unsupported scenario), the status report is "multiple".
aeisenberg
reviewed
Feb 4, 2022
Some platforms that ingest this status report charge based on the cardinality of the fields, so here we restrict the version strings we support to a fixed set.
aeisenberg
approved these changes
Feb 7, 2022
Also be more explicit about which version strings are reportable in the code.
henrymercer
deleted the
henrymercer/report-ml-powered-query-enablement
branch
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds information about whether ML-powered JS queries are enabled to the
initstatus report. This will improve our observability by allowing us to compare metrics between runs with ML-powered JS queries on and off.Specifically, we add a
ml_powered_js_queriesfield to theinitstatus report that contains:We report this information in the
initstatus report rather than theanalyzestatus report so we can gather data about timeouts.Example status report:
{ "workflow_run_id": 1790730464, "workflow_name": "Code Scanning - Action", "job_name": "CodeQL-Build", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "commit_oid": "6a99ab511b076566d0b9259a4102ac7f5c4b3e0c", "ref": "refs/heads/main", "action_name": "init", "action_ref": "1cddec9558c522dd219349d2149a48c46e203a8a", "action_oid": "unknown", "started_at": "2022-02-03T17:08:30.984Z", "action_started_at": "2022-02-03T17:08:30.984Z", "status": "success", "completed_at": "2022-02-03T17:08:37.758Z", "matrix_vars": "null", "disable_default_queries": "", "languages": "javascript", "ml_powered_js_queries": "~0.0.2" /* NEW */, "paths": "", "paths_ignore": "", "queries": "security-extended", "tools_input": "latest", "tools_resolved_version": "20220120", "workflow_languages": "javascript" }Merge / deployment checklist