Introduction to NetEye¶
Welcome to the NetEye product documentation.
The structure of this user guide follows that of the various modules provided in the NetEye distribution, and contains both conceptual and practical information on how to use NetEye system for many purposes you’ll find in the Introduction.
Product Overview¶
NetEye is a comprehensive solution for unified monitoring of your network and infrastructure. Based on Open Source tools, its functionalities allow monitoring of disparate resources: IoT and IIoT devices, remote infrastructure, business services, company assets.
The entire solution is licensed under open source licenses, with the GPLv3 Open Source License being the most used. Continuous improvements, coming from both the community and from Würth Phoenix, are integrated into NetEye to provide added business value to widely-used open source projects.
Real-time dashboards built with the data collected over time, reporting solutions, a powerful tool for complex event management and log analysis, and network traffic analysis complement NetEye’s monitoring features. A deeper description of the NetEye features can be found in the upcoming sections.
NetEye builds around Icinga and Icinga Web 2. Most concepts and set ups valid for the latter are also valid in NetEye. Icinga’s modular architecture allows to reuse all of its modules within NetEye, while NetEye’s team continuously develops new modules and seamlessly integrates them within the existent infrastructure.
Intended Use¶
NetEye is a platform designed to perform a wide range of monitoring activities by means of the software natively developed by the NetEye team, or software integrated with the system. A set of modules available within NetEye allows to provide a full spectrum of monitoring service, depending on your business need.
Below you will find a list of NetEye’s core functionalities, grouped in categories, that will help you construct your monitoring solution with NetEye based on your needs.
You can learn more about the capabilities of NetEye in dedicated chapters of NetEye’s Functional Overview below.
Releases and Latest News¶
NetEye development cycle lasts two months and at the beginning of the even months, a new NetEye release is published and available for installation. After the release has taken place, it is referred to as Current NetEye release, i.e. the latest stable release of a product available to be installed by a customer.
In the NetEye Guide, ‘current’ label indicates the version of the userguide which respectively corresponds the current NetEye release.
Next version, in its turn, corresponds the next coming version of NetEye, which is currently in development. The development cycle ends up with a feature freeze two weeks prior to the official NetEye release, which gives us the opportunity to test out the scope.
Within this two-week period of time the development of an even newer NetEye version starts, which can be referred to as Alpha. Hence, appearance of an ‘Alpha’ version in the userguide indicates that the development cycle for a new NetEye version has started.
A list of the new and changed functionalities in NetEye is compiled for each new public release; it can be found on NetEye’s blog, in the release notes category.
Moreover, the NetEye’s blog features also a series of posts about bug fixes, released as soon as a bug has been corrected and the fix has been released. Each post contains an explanation of the bug and, most important, the list of package(s) that contain the fix.
NetEye Core & Components¶
All the funtionality provided by NetEye is delivered to the users within NetEye Modules.
The Modules that are shipped with the standard NetEye image build NetEye Core. All other Modules are called NetEye Components and can be installed on demand. More information can be found in section Additional NetEye Components.
NetEye Core
NetEye is a flexible solution which allows you to build your own monitoring experience based on the preferred functionality from the scope the product has to offer.
Since all the NetEye functionality is delivered to the users within NetEye Modules, you can choose between acquiring standard NetEye image or customize your experience with extended functionalities.
The Modules that are shipped with the standard NetEye image build NetEye Core.
NetEye Core is the set of most commonly used functionalities offered by the platform, including monitoring, visualization (with dashboards and maps), configuration, reporting, and event handling.
Follow NetEye installation guide to start exploring NetEye Core functionality. You can also learn more about the modules that build the Core in the Core Modules chapters.
Additional Feature Modules
In order to customize your monitoring experience with NetEye, you can go beyond the feature scope the NetEye Core has to offer as a basis.
The NetEye modular architecture supports the installation of additional Feature Modules that extend the NetEye Core functionalities. This separation allows to customize NetEye in order to address specific customer needs.
Each NetEye Feature Module can be purchased separately from NetEye Core and adds a specific set of features. In some cases, the Feature Module contains Open Source, GPL-licensed software. In cases like these the software can be used even after the paid subscription has expired or can even be installed independently.
However, the software is considered as a customisation and is entirely not supported.
You can learn more about installing additional NetEye Feature Modules in our installation guide.