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

chore(ci,docs): disable ToC in perf gh pages. #1930

Merged
merged 3 commits into from
Jun 21, 2024
Merged

Conversation

FedeDP
Copy link
Contributor

@FedeDP FedeDP commented Jun 21, 2024

What type of PR is this?

/kind cleanup

Any specific area of the project related to this PR?

/area CI

Does this PR require a change in the driver versions?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

@FedeDP
Copy link
Contributor Author

FedeDP commented Jun 21, 2024

/milestone 0.18.0

@poiana poiana added this to the 0.18.0 milestone Jun 21, 2024
@poiana poiana added the size/XS label Jun 21, 2024
@@ -106,11 +106,11 @@ jobs:
run: |
python3 .github/generate_inline_svg_md.py trace_tests.svg
mv out.md docs/unit_tests.md
rm -rf out.md
sed -i '1s/^/---\nhide:\n- toc\n---\n\n/' docs/unit_tests.md
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same as for kernel testing matrixes.

Every PR will have a comment with the perf diff from master for multiple aspects, while on master the flamegraph are pushed to this github pages.

Navigate to the perf reports on the left, or click these links:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Properly render bullet list.

@FedeDP
Copy link
Contributor Author

FedeDP commented Jun 21, 2024

/cc @LucaGuerra @Andreagit97

@poiana poiana requested review from Andreagit97 and LucaGuerra June 21, 2024 10:18
Copy link

Perf diff from master - unit tests

    12.70%     -1.98%  [.] sinsp_parser::reset
     9.02%     -1.49%  [.] sinsp_thread_manager::find_thread
     0.66%     +1.33%  [.] scap_event_decode_params
     0.53%     +0.87%  [.] scap_event_encode_params_v
     4.11%     +0.71%  [.] sinsp_parser::process_event
     0.40%     +0.58%  [.] sinsp_threadinfo::get_fd
     0.13%     +0.57%  [.] sinsp_container_info::~sinsp_container_info
     3.25%     +0.56%  [.] sinsp_evt::load_params
     0.79%     -0.49%  [.] sinsp_fdtable::add_ref
     3.57%     -0.44%  [.] std::_Sp_counted_base<(__gnu_cxx::_Lock_policy)2>::_M_release

Perf diff from master - scap file

    13.60%     -7.55%  [.] libsinsp::runc::match_container_id
    10.47%     -5.11%  [.] sinsp_filter_check_event::extract_single
    10.40%     -5.09%  [.] sinsp::next
    10.15%     -4.87%  [.] gzfile_read
     3.51%     +3.07%  [.] sinsp_filter_check::tostring
     6.92%     -2.26%  [.] sinsp_filter_check::rawval_to_string
    13.77%     -1.63%  [.] sinsp_filter_check::extract
    10.16%     +1.02%  [.] sinsp_filter_check_thread::extract_single
     3.51%     +0.34%  [.] sinsp_parser::reset
     3.50%     +0.29%  [.] sinsp_parser::process_event

jasondellaluce
jasondellaluce previously approved these changes Jun 21, 2024
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Locally testing with mkdocs build and mkdocs serve; it seems like it is able to create a bundle site/ with proper link to svg images; we don't need to inline them anymore.

rm -rf out.md

mv trace_tests.svg docs/trace_tests.svg
echo '![unit tests](./trace_tests.svg)' > docs/unit_tests.md
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Create the unit_tests.md file that references the svg image. Same below for scap file.

Copy link

Perf diff from master - unit tests

     9.15%     -1.83%  [.] sinsp_thread_manager::find_thread
    12.89%     -1.50%  [.] sinsp_parser::reset
     4.04%     +1.05%  [.] sinsp_thread_manager::get_thread_ref
     0.67%     +1.02%  [.] scap_event_decode_params
     8.16%     -0.92%  [.] sinsp::next
     0.88%     -0.64%  [.] sinsp_filter_check::parse_field_name
     3.30%     +0.56%  [.] sinsp_evt::load_params
     1.48%     -0.50%  [.] libsinsp::events::names_to_event_set
     4.17%     +0.48%  [.] sinsp_parser::process_event
     2.36%     -0.48%  [.] libsinsp::sinsp_suppress::process_event

Perf diff from master - scap file

     4.14%     +7.03%  [.] sinsp_evt::get_param_as_str
    12.63%     -5.60%  [.] sinsp::next
    12.25%     -5.36%  [.] sinsp_evt_formatter::tostring_withformat
    12.72%     +3.92%  [.] sinsp_filter_check_event::extract_single
    12.33%     -3.18%  [.] gzfile_read
     4.26%     +2.16%  [.] sinsp_filter_check::tostring
    16.52%     -1.15%  [.] libsinsp::runc::match_container_id
    16.74%     -0.92%  [.] sinsp_filter_check::extract
     8.40%     -0.48%  [.] sinsp_filter_check::rawval_to_string

@FedeDP
Copy link
Contributor Author

FedeDP commented Jun 21, 2024

/hold
while i test other improvements.

Andreagit97
Andreagit97 previously approved these changes Jun 21, 2024
Copy link
Member

@Andreagit97 Andreagit97 left a comment

Choose a reason for hiding this comment

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

/approve

rm -rf out.md

mv trace_tests.svg docs/trace_tests.svg
echo '<object data="../trace_tests.svg" type="image/svg+xml" id="unit_tests"></object>' > docs/unit_tests.md
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Using the object tag, we have an interactive svg!

Copy link

Perf diff from master - unit tests

     7.05%     -1.67%  [.] next
     0.67%     +1.23%  [.] scap_event_decode_params
     3.28%     -1.13%  [.] sinsp_evt::load_params
     0.94%     +0.73%  [.] sinsp_fdtable::find_ref
     3.60%     -0.67%  [.] std::_Sp_counted_base<(__gnu_cxx::_Lock_policy)2>::_M_release
     2.35%     -0.64%  [.] libsinsp::sinsp_suppress::process_event
     0.54%     +0.62%  [.] scap_event_encode_params_v
     0.81%     -0.62%  [.] sinsp_evt::get_direction
     2.00%     +0.57%  [.] sinsp_parser::event_cleanup
     8.13%     +0.51%  [.] sinsp::next

Perf diff from master - scap file

     3.94%     +7.23%  [.] sinsp_filter_check::tostring
    11.39%     -5.61%  [.] gzfile_read
    11.67%     -5.53%  [.] sinsp::next
    11.75%     +4.67%  [.] sinsp_filter_check_event::extract_single
    15.26%     -3.32%  [.] libsinsp::runc::match_container_id
    15.46%     -2.93%  [.] sinsp_filter_check::extract
    11.40%     -2.70%  [.] sinsp_filter_check_thread::extract_single
     3.93%     -0.30%  [.] sinsp_parser::process_event
     7.76%     -0.19%  [.] sinsp_filter_check::rawval_to_string
     3.88%     -0.10%  [.] sinsp_thread_manager::get_thread_ref

@FedeDP
Copy link
Contributor Author

FedeDP commented Jun 21, 2024

/unhold
this is ready!

Copy link
Member

@Andreagit97 Andreagit97 left a comment

Choose a reason for hiding this comment

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

/approve

@poiana
Copy link
Contributor

poiana commented Jun 21, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Andreagit97, FedeDP, LucaGuerra

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:
  • OWNERS [Andreagit97,FedeDP,LucaGuerra]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@poiana poiana merged commit dcf250a into master Jun 21, 2024
41 checks passed
@poiana poiana deleted the chore/disable_toc_perf branch June 21, 2024 14:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants