Code Monkey home page Code Monkey logo

elos's Introduction

build

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

./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 ./elos/ci/docker-target-run.sh and/or consult the documentation https://elektrobit.github.io/elos .

Building

elos uses CMake for building:

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

or use the CI hooks

./elos/ci/build.sh [Release]

Development

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

./elos/ci/docker-run.sh

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

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

To start elosd and play with your changes:

ci@62209400:/base$ ./elos/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/compile_commands.json
    

Dependencies

Folders

ci

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

documentation

More detailed documentation on the event logging and management system.

packaging

Contains some files to help out some external build systems which are not part of this project.

src

Contains the actual productive sources.

src/common

Contains common shared code.

src/demo

Contains simple demonstration applications.

src/elosd

The sources for the event logging and management system daemon itself.

src/libelos

Contains header and source files for a shared library that can be used to communicate with the event logging and management system daemon (elosd).

src/log

A log library used by elos to consolidate logging.

src/scanner

Contains the sources for event logging and management system specific shared libraries, these are responsible for monitoring for different events on the target system.

src/version

The sources to manage the version always in the same way.

test

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

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
  • 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.

elos's People

Contributors

gehwolf avatar friedz avatar anton-hillebrand avatar vigsrox avatar thomasbrinker avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.