Skip to content

Latest commit

 

History

History
219 lines (155 loc) · 6.62 KB

README.md

File metadata and controls

219 lines (155 loc) · 6.62 KB
Raw

build documentation AUR Ubuntu PPA

Event Logging and Management System (elos)

elos is a tool to collect, store and publish various system events (i.e. syslogs, core dumps, measurements obtained from proc- and sys-fs, …) while providing easy access to the collected data.

Documentation

The elos documentation can be found here: https://elektrobit.github.io/elos/

Quick start

Try elos

./ci/docker-target-run.sh
...
ci@2153762153:/$ elosc -f "1 1 EQ"
...
ci@2153762153:/$ elosc -s "1 1 EQ"

On a second shell attach to the running container

docker exec -ti <elos_container_name> bash
ci@2153762153:/$ elosc -p '{"payload": "Hello elos"}'

For detailed build instructions have a look into ./ci/docker-target-run.sh and/or consult the documentation https://elektrobit.github.io/elos .

Install Elos

See Elosd Installation & Setup for supported Linux distributions and how to build from source.

Depenencies

The dependencies safu, samconf, cmocka_mocks and cmocka_extensions must be installed. One way to to so is the script install_deps.py from the ci folder which installs them in build/deps/.

From the root folder run:

./ci/install_deps.py

for more information read the documentation for install_deps.py

Building

elos uses CMake for building:

cmake -B ./build ./
make -C ./build all
make -C ./build install

Development

For a quick start to get hands on the code and start coding use :

./ci/docker-run.sh

You are now in a ready to use development environment. To build elos and all dependencies run:

ci@62209400:/base$ ./ci/build.sh

To start elosd and play with your changes:

ci@62209400:/base$ ./test/smoketest/smoketest_interactive.sh
[elos-interactive]$ elosd&
...
[elos-interactive]$ elosc -f "1 1 EQ"
...
[elos-interactive]$ elosc -s "1 1 EQ"&
...
[elos-interactive]$ elosc -p '{"payload": "Hello elos"}'
...
[elos-interactive]$ elosc # be creative

Be aware this is a smoketest environment so it is very verbose.

Workspace setup

  1. Please run the following git commands after cloning the repository:

    git config core.hooksPath .githooks

    to set the commit message template and to setup the project specific git hooks.

  2. Usually it is a good idea to create a symlink to the compilation database created by cmake in the build directory. Run therefore:

    ln -s build/<BUILD_TYPE>/cmake/compile_commands.json

Folders

In general each folder and subfolder should contain a index.rst or .md files to explain there content by themself. This shall give a brief overview where to start when looking for something specific.

ci

Scripts to be used by CI pipelines to build, run various tests and checks.

cmake

Contains cmake extensions and scripts to simplify and generalize recurring tasks.

doc

Contains :

  • static assets for the documentation
  • the Architecture Design Records
  • documentation on the documentation itself
  • other documents

debian.native

Contains Debian packaging scripts for building the current source tree as .deb packages. This is primarily for CI pipelines to automatically verify if the packages are buildable or if anything needs to be changed.

See debian.native/README.md for more information.

src

Contains the actual productive sources.

test

Contains all test related sources. See the documentation for details.

Roadmap

  • SMART (storage health) – a scanner plugin to report SMART status changes
  • temperature – scanner plugin to report high and normal temperature
  • panic() / kexec – a plugin to report a system crash after recovering
  • in memory storage – i.e. record elos internal events
  • mqtt backend – deliver events to MQTT broker
  • Unix-Domain socket support – alternative client connection to TCP
  • shared memory – with elos protocol
  • coredumper – manage core dumps and publish events created/dropped/discarded
  • notify about OOM-Killer invocation
  • notify about high CPU load
  • notify about high disk load / disk full
  • notify about network package drops
  • graceful integration with other logging systems (syslog-ng, journald, kerneld)
  • process monitoring – life cycle / highest load ( memory, cpu, network, storage usage)
  • improve plugin development support (API, SDK, Repos) – multi language bindings (rust , python, ...)

License

MIT License

Copyright (c) [2023] [emlix GmbH, Elektrobit Automotive GmbH]

The full text of the license can be found in the LICENSE file in the repository root directory.

Powered by EB

elos is powered by elektrobit automotive gmbh. Elektrobit is an automotive software company and developer of embedded software products for ECU, AUTOSAR, automated driving, connected vehicles and UX. elos isan integrated part of EB corbos Linux – built on Ubuntu is an open-source operating system for high-performance computing, leveraging the rich functionality of Linux while meeting security and industry regulations.

Maintainers

Credits

  • Andreas Schickedanz
  • Andreas Zdziarstek
  • Anja Lehwess-Litzmann
  • Annika Schmitt
  • Anton Hillerband
  • Benedikt Braunger
  • Christian Steiger
  • Daniel Glöckner
  • Fabian Godehardt
  • Friedrich Schwedler
  • Isaac True
  • Joerg Vehlow
  • Maryniuk Bogdan
  • Rainer Müller
  • Sabrina Otto
  • Thomas Brinker
  • Vignesh Jayaraman
  • Wolfgang Gehrhardt

Artwork

The elos logo is the Vombatus ursinus, also known as the bare-nosed wombat, designed from the handwriting word elos. Originator is Anja Lehwess-Litzmann (emlix GmbH). Year 2023. It is licensed under Creative Commons No Derivatives (CC-nd). It shall be used in black on white or HKS43 color.