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

examples: add an example plugin - v1 #9815

Closed
wants to merge 1 commit into from

Conversation

jasonish
Copy link
Member

Adds an example plugin, in this case an EVE file type to the source tree.

More details in the commit but:

  • CI is done to build the plugin
  • Gives us an example in the source tree, showing a level of maturity
  • Only built on demand from its directory, so has no affect on people just wanting to build suri

This is an example of what adding plugin examples to the Suricata repo
could look like.

This plugin is an example plugin for an EVE filetype. It could be
extended to support outputs like Redis, syslog, etc.

There is one issue with adding plugins like this to an autotools
project, the project can't be built with --disable-shared, which is
more of an autotools limitation, and not really a Suricata issue.
Suricata built with --disable-shared will load plugins just fine.

Note that the examples directory was added as DIST_SUBDIRS as we don't
want normal builds to recurse into it and attempt to build the plugin,
its just an example, but we still need to keep distcheck happy.
@jasonish jasonish requested a review from a team as a code owner November 16, 2023 19:45
@jasonish
Copy link
Member Author

Still thinking of a way to actually test the plugin in CI.

Copy link

codecov bot commented Nov 16, 2023

Codecov Report

Merging #9815 (fd71790) into master (2f4027c) will increase coverage by 0.00%.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #9815   +/-   ##
=======================================
  Coverage   82.37%   82.37%           
=======================================
  Files         968      968           
  Lines      273866   273866           
=======================================
+ Hits       225585   225586    +1     
+ Misses      48281    48280    -1     
Flag Coverage Δ
fuzzcorpus 64.21% <ø> (+<0.01%) ⬆️
suricata-verify 60.99% <ø> (+0.01%) ⬆️
unittests 62.93% <ø> (ø)

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

@suricata-qa
Copy link

Information: QA ran without warnings.

Pipeline 16570

@victorjulien victorjulien added this to the 8.0 milestone Nov 17, 2023
@victorjulien
Copy link
Member

Merged in #9829, thanks!

@jasonish jasonish deleted the examples/plugins/v1 branch March 11, 2024 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants