2022-06-30 16:45:49 +00:00
= Logray Quick Start
2022-02-24 19:10:04 +00:00
2022-06-30 16:45:49 +00:00
Logray is a sibling application for Wireshark which focuses on log messages.
2022-04-04 19:16:59 +00:00
It helps people understand, troubleshoot, and secure their systems via log messages similar to the way Wireshark helps people understand, troubleshoot, and secure their networks via packets.
2022-02-24 19:10:04 +00:00
2022-06-30 16:45:49 +00:00
This document provides brief instructions for building Logray until more complete documentation comparable to the Wireshark Developer’ s and User’ s Guides can be written.
2022-02-24 19:10:04 +00:00
2022-06-30 16:45:49 +00:00
== Building Logray
2022-02-24 19:10:04 +00:00
2022-06-30 16:45:49 +00:00
Logray requires the same build environment as Wireshark.
2022-02-24 19:10:04 +00:00
See the https://www.wireshark.org/docs/wsdg_html_chunked/[Wireshark Developer’ s Guide] for instructions on setting that up.
2022-04-04 19:16:59 +00:00
It additionally requires libsinsp and libscap from https://github.com/falcosecurity/libs/[falcosecurity/libs] and any desired plugins from https://github.com/falcosecurity/plugins/[falcosecurity/plugins].
2022-02-24 19:10:04 +00:00
2022-06-30 16:45:49 +00:00
In order to build Logray, do the following:
2022-02-24 19:10:04 +00:00
1. https://falco.org/docs/getting-started/source/[Build falcosecurity/libs].
2. Build falcosecurity/plugins.
3. Build the Wireshark sources with the following CMake options:
+
--
[horizontal]
2022-06-30 16:45:49 +00:00
BUILD_logray:: Must be enabled, e.g. set to ON
2022-02-24 19:10:04 +00:00
SINSP_INCLUDEDIR:: The path to your local falcosecurity/libs directory
SINSP_LIBDIR:: The path to your falcosecurity/libs build directory
--
2022-06-30 16:45:49 +00:00
4. Create a directory named `falco` in your Logray plugins directory, and either copy in or symlink any desired Falco plugins.
2022-02-24 19:10:04 +00:00
.Example 1: Building on macOS using Ninja
[sh]
----
cmake -G Ninja \
2022-06-30 16:45:49 +00:00
-DBUILD_logray=ON \
2022-02-24 19:10:04 +00:00
-DSINSP_INCLUDEDIR=/path/to/falcosecurity/libs \
-DSINSP_LIBDIR=/path/to/falcosecurity/libs/build \
..
ninja
2022-06-30 16:45:49 +00:00
mkdir run/Logray.app/Contents/PlugIns/logray/3-7/falco
(cd run/Logray.app/Contents/PlugIns/logray/3-7/falco ; ln -sn /path/to/falcosecurity-plugins/plugins/cloudtrail/libcloudtrail.so )
2022-02-24 19:10:04 +00:00
----
.Example 2: Building on Linux using Make
[sh]
----
cmake \
2022-06-30 16:45:49 +00:00
-DBUILD_logray=ON \
2022-02-24 19:10:04 +00:00
-DSINSP_INCLUDEDIR=/path/to/falcosecurity/libs \
-DSINSP_LIBDIR=/path/to/falcosecurity/libs/build \
..
make -j $(getconf _NPROCESSORS_ONLN)
2022-04-04 19:16:59 +00:00
mkdir run/plugins/3.7/falco
(cd run/plugins/3.7/falco ; ln -sn /path/to/falcosecurity-plugins/plugins/cloudtrail/libcloudtrail.so )
2022-02-24 19:10:04 +00:00
----