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.

Sign up for GitHub

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

Jump to bottom

Report waf init and update success and failure #5388

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Report waf init and update success and failure #5388

wants to merge 7 commits into from

Conversation

IlyasShabi
Copy link
Contributor

@IlyasShabi IlyasShabi commented Mar 11, 2025 •
edited
Loading

What does this PR do?

Report waf related telemetry metrics APPSEC-56986

  • Report waf.init with success:true
  • Report waf.updates with success status
  • Report waf.config_errors on updates failure

Plugin Checklist

Additional Notes

@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 11, 2025 •
edited
Loading

Overall package size

Self size: 8.97 MB
Deduped: 101.5 MB
No deduping: 102.02 MB

Dependency sizes | name | version | self size | total size | |------|---------|-----------|------------| | @datadog/libdatadog | 0.5.0 | 29.83 MB | 29.83 MB | | @datadog/native-appsec | 8.5.0 | 19.26 MB | 19.26 MB | | @datadog/native-iast-taint-tracking | 3.3.0 | 13.77 MB | 13.78 MB | | @datadog/pprof | 5.5.1 | 9.79 MB | 10.17 MB | | @opentelemetry/core | 1.30.1 | 908.66 kB | 7.16 MB | | protobufjs | 7.4.0 | 2.77 MB | 5.42 MB | | @datadog/native-iast-rewriter | 2.8.0 | 2.6 MB | 2.74 MB | | @datadog/native-metrics | 3.1.0 | 1.06 MB | 1.46 MB | | @opentelemetry/api | 1.8.0 | 1.21 MB | 1.21 MB | | import-in-the-middle | 1.13.1 | 117.64 kB | 839.26 kB | | source-map | 0.7.4 | 226 kB | 226 kB | | opentracing | 0.14.7 | 194.81 kB | 194.81 kB | | lru-cache | 7.18.3 | 133.92 kB | 133.92 kB | | pprof-format | 2.1.0 | 111.69 kB | 111.69 kB | | @datadog/sketches-js | 2.1.1 | 109.9 kB | 109.9 kB | | lodash.sortby | 4.7.0 | 75.76 kB | 75.76 kB | | ignore | 5.3.2 | 53.63 kB | 53.63 kB | | istanbul-lib-coverage | 3.2.0 | 29.34 kB | 29.34 kB | | rfdc | 1.4.1 | 27.15 kB | 27.15 kB | | @isaacs/ttlcache | 1.4.1 | 25.2 kB | 25.2 kB | | tlhunter-sorted-set | 0.1.0 | 24.94 kB | 24.94 kB | | dc-polyfill | 0.1.6 | 24.56 kB | 24.56 kB | | shell-quote | 1.8.2 | 23.54 kB | 23.54 kB | | limiter | 1.1.5 | 23.17 kB | 23.17 kB | | retry | 0.13.1 | 18.85 kB | 18.85 kB | | semifies | 1.0.0 | 15.84 kB | 15.84 kB | | jest-docblock | 29.7.0 | 8.99 kB | 12.76 kB | | crypto-randomuuid | 1.0.0 | 11.18 kB | 11.18 kB | | ttl-set | 1.0.0 | 4.61 kB | 9.69 kB | | path-to-regexp | 0.1.12 | 6.6 kB | 6.6 kB | | koalas | 1.0.2 | 6.47 kB | 6.47 kB | | module-details-from-path | 1.0.3 | 4.47 kB | 4.47 kB |

🤖 This report was automatically generated by heaviest-objects-in-the-universe

@codecov Codecov
Copy link

codecov bot commented Mar 11, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.49%. Comparing base (2196c24) to head (0057892).
Report is 4 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #5388      +/-   ##
==========================================
- Coverage   80.70%   79.49%   -1.22%     
==========================================
  Files         493      509      +16     
  Lines       22125    22821     +696     
==========================================
+ Hits        17857    18142     +285     
- Misses       4268     4679     +411

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@datadog-datadog-prod-us1
Copy link

datadog-datadog-prod-us1 bot commented Mar 11, 2025 •
edited
Loading

Datadog Report

Branch report: ishabi/waf-init-update
Commit report: 447ee6f
Test service: dd-trace-js-integration-tests

✅ 0 Failed, 807 Passed, 0 Skipped, 16m 53.12s Total Time

@pr-commenter
Copy link

pr-commenter bot commented Mar 11, 2025 •
edited
Loading

Benchmarks

Benchmark execution time: 2025-03-18 13:03:44

Comparing candidate commit 0057892 in PR branch ishabi/waf-init-update with baseline commit 2196c24 in branch master.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 919 metrics, 14 unstable metrics.

@IlyasShabi IlyasShabi marked this pull request as ready for review March 11, 2025 14:29
@IlyasShabi IlyasShabi requested a review from a team as a code owner March 11, 2025 14:29
@IlyasShabi IlyasShabi changed the title Report waf init and update success Report waf init and update success and failure Mar 14, 2025
@IlyasShabi IlyasShabi marked this pull request as draft March 14, 2025 14:22
@IlyasShabi IlyasShabi marked this pull request as ready for review March 14, 2025 14:59
simon-id
simon-id reviewed Mar 17, 2025
View reviewed changes
packages/dd-trace/src/appsec/reporter.js Outdated
metricsQueue.set('_dd.appsec.event_rules.error_count', diagnosticsRules.failed?.length || 0)
if (diagnosticsRules.failed?.length) {
metricsQueue.set('_dd.appsec.event_rules.errors', JSON.stringify(diagnosticsRules.errors))
function reportWafInit (wafVersion, rulesVersion, diagnosticsRules = {}, success) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uh, having an optional argument not be at the end is weird no ? at this point do this ?

Suggested change
function reportWafInit (wafVersion, rulesVersion, diagnosticsRules = {}, success) {
function reportWafInit (wafVersion, rulesVersion, diagnosticsRules = {}, success = true) {

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes looks weird, done

simon-id
simon-id reviewed Mar 17, 2025
View reviewed changes
packages/dd-trace/src/appsec/waf/waf_manager.js

const { obfuscatorKeyRegex, obfuscatorValueRegex } = this.config
return new DDWAF(rules, { obfuscatorKeyRegex, obfuscatorValueRegex })
} catch (err) {
this.ddwafVersion = this.ddwafVersion || 'unknown'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"unknown" ? this is in the spec and the system tests ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

RFC is not yet updated, but there is an ongoing ST

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@uurien uurien uurien left review comments

@simon-id simon-id simon-id left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
appsec semver-minor
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@IlyasShabi @uurien @simon-id