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

DEBUG-2510 Document cbindgen dependency #514

Merged
merged 3 commits into from
Jul 1, 2024
Merged

DEBUG-2510 Document cbindgen dependency #514

merged 3 commits into from
Jul 1, 2024

Conversation

p-datadog
Copy link
Contributor

What does this PR do?

Adds cbindgen and its required version to the readme to the requirements section.

Motivation

Building C headers requires cbindgen which is not mentioned in the readme.

Ubuntu package of cbindgen is of an old version which does not work, producing cryptic errors.

Additional Notes

None

How to test the change?

N/A

@p-datadog p-datadog requested a review from a team as a code owner June 27, 2024 20:41
@pr-commenter
Copy link

pr-commenter bot commented Jun 27, 2024

Benchmarks

Comparison

Parameters

Baseline Candidate
config baseline candidate
git_branch main cbindgen-version
git_commit_date 1719836665 1719839453
git_commit_sha f66cd95 ffa9f74
iterations 705.0 711.0
See matching parameters
Baseline Candidate
ci_job_date 1719839693 1719839693
ci_job_id 558037238 558037238
ci_pipeline_id 37978356 37978356
cpu_model Intel(R) Xeon(R) Platinum 8259CL CPU @ 2.50GHz Intel(R) Xeon(R) Platinum 8259CL CPU @ 2.50GHz

Summary

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

Candidate

Candidate benchmark details

Group 1

iterations config cpu_model ci_job_date ci_job_id ci_pipeline_id git_commit_sha git_commit_date git_branch
711.0 candidate Intel(R) Xeon(R) Platinum 8259CL CPU @ 2.50GHz 1719839693 558037238 37978356 ffa9f74 1719839453 cbindgen-version
scenario metric min mean ± sd median ± mad p75 p95 p99 max peak_to_median_ratio skewness kurtosis cv sem runs sample_size
sql/obfuscate_sql_string execution_time 70.344µs 70.419µs ± 0.031µs 70.420µs ± 0.019µs 70.436µs 70.469µs 70.480µs 70.499µs 0.11% 0.048 -0.296 0.04% 0.003µs 1 100
scenario metric 95% CI mean Shapiro-Wilk pvalue Ljung-Box pvalue (lag=1) Dip test pvalue
sql/obfuscate_sql_string execution_time [70.413µs; 70.425µs] or [-0.008%; +0.008%] None None None

Warnings

Scenario: sql/obfuscate_sql_string, Metric: execution_time

Sample size is 100, which is lower than 105.

The minimal sample size in case of normal distribution to achieve significance
level of 0.05 for difference of means with effect size Cohen's d = 0.5 must be at
least 105.

The conclusions from confidence intervals may be invalid.
---------------------------------------------------------------------------

Baseline

Baseline benchmark details

Group 1

iterations config cpu_model ci_job_date ci_job_id ci_pipeline_id git_commit_sha git_commit_date git_branch
705.0 baseline Intel(R) Xeon(R) Platinum 8259CL CPU @ 2.50GHz 1719839693 558037238 37978356 f66cd95 1719836665 main
scenario metric min mean ± sd median ± mad p75 p95 p99 max peak_to_median_ratio skewness kurtosis cv sem runs sample_size
sql/obfuscate_sql_string execution_time 70.919µs 71.006µs ± 0.035µs 71.004µs ± 0.025µs 71.031µs 71.061µs 71.076µs 71.078µs 0.10% -0.080 -0.326 0.05% 0.004µs 1 100
scenario metric 95% CI mean Shapiro-Wilk pvalue Ljung-Box pvalue (lag=1) Dip test pvalue
sql/obfuscate_sql_string execution_time [70.999µs; 71.013µs] or [-0.010%; +0.010%] None None None

Warnings

Scenario: sql/obfuscate_sql_string, Metric: execution_time

Measurements are autocorrelated.

Autocorrelation is present for lags 1..10.

The measurements are not independent, thus confidence intervals
may be less precise.
---------------------------------------------------------------------------
Scenario: sql/obfuscate_sql_string, Metric: execution_time

Sample size is 100, which is lower than 105.

The minimal sample size in case of normal distribution to achieve significance
level of 0.05 for difference of means with effect size Cohen's d = 0.5 must be at
least 105.

The conclusions from confidence intervals may be invalid.
---------------------------------------------------------------------------

@codecov-commenter
Copy link

codecov-commenter commented Jun 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.38%. Comparing base (f66cd95) to head (ffa9f74).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #514   +/-   ##
=======================================
  Coverage   70.38%   70.38%           
=======================================
  Files         204      204           
  Lines       27835    27835           
=======================================
  Hits        19591    19591           
  Misses       8244     8244           
Components Coverage Δ
crashtracker 16.70% <ø> (ø)
datadog-alloc 98.76% <ø> (ø)
data-pipeline 51.15% <ø> (ø)
data-pipeline-ffi 0.00% <ø> (ø)
ddcommon 86.12% <ø> (ø)
ddcommon-ffi 74.15% <ø> (ø)
ddtelemetry 59.37% <ø> (ø)
ipc 84.66% <ø> (ø)
profiling 78.63% <ø> (ø)
profiling-ffi 58.19% <ø> (ø)
serverless 0.00% <ø> (ø)
sidecar 36.19% <ø> (ø)
sidecar-ffi 0.00% <ø> (ø)
spawn-worker 54.98% <ø> (ø)
trace-mini-agent 69.70% <ø> (ø)
trace-normalization 97.79% <ø> (ø)
trace-obfuscation 95.75% <ø> (ø)
trace-protobuf 77.16% <ø> (ø)
trace-utils 91.21% <ø> (ø)

@p-datadog p-datadog changed the title Document cbindgen dependency DEBUG-2510 Document cbindgen dependency Jul 1, 2024
@p-datadog p-datadog merged commit 8a5d447 into main Jul 1, 2024
32 checks passed
@p-datadog p-datadog deleted the cbindgen-version branch July 1, 2024 19:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants