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

new(libsinsp): print LIST() in markdown format for list fields #2091

Merged
merged 1 commit into from
Oct 1, 2024

Conversation

LucaGuerra
Copy link
Contributor

@LucaGuerra LucaGuerra commented Oct 1, 2024

What type of PR is this?

Uncomment one (or more) /kind <> lines:

/kind feature

Any specific area of the project related to this PR?

Uncomment one (or more) /area <> lines:

/area libsinsp

Does this PR require a change in the driver versions?

No

What this PR does / why we need it:

Currently the documentation website lists field arguments as if they were regular. If they are lists of charbufs for example we would like to print LIST(CHARBUF) instead of CHARBUF. This PR does exactly that.

Which issue(s) this PR fixes:

Fixes #2092

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

new(libsinsp): print LIST() in markdown format for list fields

Signed-off-by: Luca Guerra <luca@guerra.sh>
Copy link

github-actions bot commented Oct 1, 2024

Perf diff from master - unit tests

     9.06%     +2.07%  [.] sinsp_parser::reset
     8.85%     -1.92%  [.] sinsp::next
     2.40%     +1.18%  [.] sinsp_thread_manager::find_thread
     4.35%     -0.92%  [.] sinsp_parser::process_event
     1.17%     +0.76%  [.] std::_Sp_counted_base<(__gnu_cxx::_Lock_policy)2>::_M_release
     4.14%     -0.68%  [.] sinsp_evt::load_params
     1.36%     +0.68%  [.] std::_Hashtable<long, std::pair<long const, std::shared_ptr<sinsp_threadinfo> >, std::allocator<std::pair<long const, std::shared_ptr<sinsp_threadinfo> > >, std::__detail::_Select1st, std::equal_to<long>, std::hash<long>, std::__detail::_Mod_range_hashing, std::__detail::_Default_ranged_hash, std::__detail::_Prime_rehash_policy, std::__detail::_Hashtable_traits<false, false, true> >::_M_find_before_node
     4.02%     +0.64%  [.] gzfile_read
     0.54%     -0.45%  [.] std::__detail::_Hashtable_alloc<std::allocator<std::__detail::_Hash_node<std::pair<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const, libsinsp::state::dynamic_struct::field_info>, true> > >::_M_deallocate_nodes
     0.60%     +0.41%  [.] sinsp_filter_check::parse_field_name

Heap diff from master - unit tests

peak heap memory consumption: 0B
peak RSS (including heaptrack overhead): 0B
total memory leaked: 0B

Heap diff from master - scap file

peak heap memory consumption: 0B
peak RSS (including heaptrack overhead): 0B
total memory leaked: 0B

Benchmarks diff from master

Comparing gbench_data.json to /root/actions-runner/_work/libs/libs/build/gbench_data.json
Benchmark                                                         Time             CPU      Time Old      Time New       CPU Old       CPU New
----------------------------------------------------------------------------------------------------------------------------------------------
BM_sinsp_split_mean                                            +0.0562         +0.0562           147           156           147           156
BM_sinsp_split_median                                          +0.0583         +0.0583           147           156           147           156
BM_sinsp_split_stddev                                          +1.1558         +1.1569             0             1             0             1
BM_sinsp_split_cv                                              +1.0411         +1.0422             0             0             0             0
BM_sinsp_concatenate_paths_relative_path_mean                  -0.0096         -0.0096            57            56            57            56
BM_sinsp_concatenate_paths_relative_path_median                -0.0088         -0.0088            57            56            57            56
BM_sinsp_concatenate_paths_relative_path_stddev                -0.2053         -0.2028             0             0             0             0
BM_sinsp_concatenate_paths_relative_path_cv                    -0.1977         -0.1952             0             0             0             0
BM_sinsp_concatenate_paths_empty_path_mean                     -0.0041         -0.0041            25            25            25            25
BM_sinsp_concatenate_paths_empty_path_median                   -0.0013         -0.0013            25            25            25            25
BM_sinsp_concatenate_paths_empty_path_stddev                   -0.2761         -0.2765             0             0             0             0
BM_sinsp_concatenate_paths_empty_path_cv                       -0.2732         -0.2735             0             0             0             0
BM_sinsp_concatenate_paths_absolute_path_mean                  -0.0254         -0.0254            57            55            57            55
BM_sinsp_concatenate_paths_absolute_path_median                -0.0242         -0.0242            56            55            56            55
BM_sinsp_concatenate_paths_absolute_path_stddev                -0.1830         -0.1848             1             0             1             0
BM_sinsp_concatenate_paths_absolute_path_cv                    -0.1617         -0.1636             0             0             0             0
BM_sinsp_split_container_image_mean                            -0.0233         -0.0233           402           393           402           393
BM_sinsp_split_container_image_median                          -0.0262         -0.0262           403           392           403           392
BM_sinsp_split_container_image_stddev                          -0.5739         -0.5738             3             1             3             1
BM_sinsp_split_container_image_cv                              -0.5637         -0.5636             0             0             0             0

Copy link

codecov bot commented Oct 1, 2024

Codecov Report

Attention: Patch coverage is 0% with 8 lines in your changes missing coverage. Please review.

Project coverage is 73.57%. Comparing base (aeb8793) to head (c6e512f).
Report is 2 commits behind head on master.

Files with missing lines Patch % Lines
userspace/libsinsp/filter.cpp 0.00% 8 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2091      +/-   ##
==========================================
- Coverage   73.58%   73.57%   -0.02%     
==========================================
  Files         253      253              
  Lines       31869    31875       +6     
  Branches     5649     5663      +14     
==========================================
- Hits        23452    23451       -1     
- Misses       8416     8424       +8     
+ Partials        1        0       -1     
Flag Coverage Δ
libsinsp 73.57% <0.00%> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@poiana poiana added the lgtm label Oct 1, 2024
@poiana
Copy link
Contributor

poiana commented Oct 1, 2024

LGTM label has been added.

Git tree hash: ae9a0ae521903815de43be20cd35e7b3c207d285

Copy link
Contributor

@FedeDP FedeDP 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 Oct 1, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 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:

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

@FedeDP
Copy link
Contributor

FedeDP commented Oct 1, 2024

/milestone 0.19.0

@poiana poiana added this to the 0.19.0 milestone Oct 1, 2024
@poiana poiana merged commit 6a0df22 into falcosecurity:master Oct 1, 2024
47 of 49 checks passed
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.

LIST fields type not specifically marked in markdown and documentation
4 participants