A powerful, easily deployable network traffic analysis tool suite for network security monitoring
OpenSearch Dashboards is an open-source fork of Kibana, which is no longer open-source software.
Visualizations and dashboards can be easily created in OpenSearch Dashboards using its drag-and-drop WYSIWYG tools. Assuming users have created a new dashboard to package with Malcolm, the dashboard and its visualization components can be exported using the dashboard export API:
Identify the ID of the dashboard (found in the URL: e.g., for /dashboards/app/dashboards#/view/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx the ID would be xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
Using a web browser, enter the URL https://localhost/mapi/dashboard-export/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, replacing localhost with the IP address or hostname of your Malcolm instance and the placeholder dashboard ID with the ID you identified in the previous step. Save the raw JSON document returned as ./dashboards/dashboards/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.json (using the actual ID) under your Malcolm directory.
OR
./dashboards/dashboards/ directory with the following command:export DASHID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx && \
docker compose exec api curl -sSL -XGET "http://localhost:5000/mapi/dashboard-export/$DASHID" > \
./dashboards/dashboards/$DASHID.json
./dashboards/dashboards/ directory or by rebuilding the dashboards-helper image. Dashboards are imported the first time Malcolm starts up.Malcolm’s dashboards share one navigation pane, defined in dashboards/dashboards/navigation.md. When dashboards are imported, the MALCOLM_NAVIGATION_MARKDOWN_REPLACER placeholder in each dashboard’s navigation markdown is replaced with the contents of that file. So:
navigation.md, under the appropriate heading. Protocol dashboards go on the Common Protocols or ICS/IoT Protocols line in alphabetical order, separated by ` ● , e.g., Foo`.MALCOLM_NAVIGATION_MARKDOWN_REPLACER placeholder in that panel rather than the expanded navigation text.For a dashboard that goes with a new Zeek parser, see Adding a new Zeek parser.
The dashboards.Dockerfile installs the OpenSearch Dashboards plugins used by Malcolm (search for opensearch-dashboards-plugin install in that file). Additional Dashboards plugins could be installed by modifying this Dockerfile and rebuilding the dashboards image.