User Guide Functional Overview Requirements Architecture System Installation NetEye Additional Components Installation Setup The neteye Command Director NetEye Self Monitoring Tornado Business Service Monitoring IT Operation Analytics - Telemetry Geo Maps NagVis Audit Log Shutdown Manager Reporting ntopng Visual Monitoring with Alyvix Elastic Stack IT Operations (Command Orchestrator) Asset Management Service Level Management Cyber Threat Intelligence - SATAYO NetEye Update & Upgrade How To NetEye Extension Packs Troubleshooting Security Policy Glossary
module icon NetEye Extension Packs
Introduction to NEP Getting Started with NEPs Online Resources Obtaining NEP Insights Available Packages Advanced Topics Upgrade to NetEye 4.31
NetEye Update & Upgrade How To NetEye Extension Packs Troubleshooting Security Policy Glossary Introduction to NetEye Monitoring Business Service Monitoring IT Operation Analytics Visualization Network Visibility Log Management & Security Orchestrated Datacenter Shutdown Application Performance Monitoring User Experience Service Management Service Level Management & Reporting Requirements for a Node Cluster Requirements and Best Practices NetEye Satellite Requirements TCP and UDP Ports Requirements Additional Software Installation Introduction Single Node Cluster NetEye Master Master-Satellite Architecture Underlying Operating System Acquiring NetEye ISO Image Installing ISO Image Single Nodes and Satellites Cluster Nodes Configuration of Tenants Satellite Nodes Only Nodes behind a Proxy Additional NetEye Components Single Node Cluster Node Satellites Nodes only Verify if a module is running correctly Accessing the New Module Cluster Satellite Security Identity and Access Management External Identity Providers Configure federated LDAP/AD Emergency Reset of Keycloak Configuration Advanced Configuration Authorization Resources Tuning Advanced Topics Basic Concepts & Usage Advanced Topics Monitoring Environment Templates Monitored Objects Import Monitored Objects Data Fields Deployment Icinga 2 Agents Configuration Baskets Dashboard Monitoring Status VMD Permissions Notifications Jobs API Configuring Icinga Monitoring Retention Policy NetEye Self Monitoring 3b Concepts Collecting Events Add a Filter Node WHERE Conditions Iterating over Event fields Retrieving Payload of an Event Extract Variables Create a Rule Tornado Actions Test your Configuration Export and Import Configuration Example Under the hood Development Retry Strategy Configuration Thread Pool Configuration API Reference Configure a new Business Process Create your first Business Process Node Importing Processes Operators The ITOA Module Configuring User Permissions Telegraf Metrics in NetEye Telegraf Configuration Telegraf on Monitored Hosts Visualizing Dashboards Customizing Performance Graph The NetEye Geo Map Visualizer Map Viewer Configuring Geo Maps NagVis 3b Audit Log 3b Overview Shutdown Manager user Shutdown Manager GUI Shutdown Commands Advanced Topics Overview User Role Management Cube Use Cases ntopng and NetEye Integration Permissions Retention Advanced Topics Overview User Roles Nodes Test Cases Dashboard Use Cases Overview Architecture Authorization Elasticsearch Overview Enabling El Proxy Sending custom logs to El Proxy Configuration files Commands Elasticsearch Templates and Retentions El Proxy DLQ Blockchain Verification Handling Blockchain Corruptions El Proxy Metrics El Proxy Security El Proxy REST Endpoints Agents Logstash Elastic APM Elastic RUM Log Manager - Deprecated Overview Authorization in the Command Orchestrator Module Configuring CLI Commands Executing Commands Overview Permissions Installation Single Tenancy Multitenancy Communication through a Satellite Asset collection methods Display asset information in monitoring host page Overview Customers Availability Event Adjustment Outages Resource Advanced Topics Introduction Getting Started SATAYO Items Settings Managed Service Mitre Attack Coverage Changelog Before you start Update Procedure Single Node Upgrade from 4.41 to 4.42 Cluster Upgrade from 4.41 to 4.42 Satellite Upgrade from 4.41 to 4.42 DPO machine Upgrade from 4.41 to 4.42 Create a mirror of the RPM repository Sprint Releases Feature Troubleshooting Tornado Networking Service Management - Incident Response IT Operation Analytics - Telemetry Identity Provider (IdP) Configuration Introduction to NEP Getting Started with NEPs Online Resources Obtaining NEP Insights Available Packages Advanced Topics Upgrade to NetEye 4.31 Setup Configure swappiness Restarting Stopped Services Enable stack traces in web UI How to access standard logs Director does not deploy when services assigned to a host have the same name How to enable/disable debug logging Activate Debug Logging for Tornado Modules/Services do not start Sync Rule fails when trying to recreate Icinga object How to disable InfluxDB query logging Managing an Elasticsearch Cluster with a Full Disk Some logs are not indexed in Elasticsearch Elasticsearch is not functioning properly Reporting: Error when opening a report Debugging Logstash file input filter Bugfix Policy Reporting Vulnerabilities Glossary 3b

Introduction to NEP

NetEye helps you take care of several aspects of IT Service Management, from monitoring to log analysis and asset/resource management, with a free form approach. However, because of its wide range of features, building and maintaining an efficient design can become quite challenging:

  • What’s the best layout for arranging objects, reducing both the initial implementation effort and future management effort?

  • Does the chosen strategy allow for easy management of each object’s lifecycle?

  • Can the chosen strategy easily and efficiently accommodate future growth, in terms of number of managed objects and of new functionalities?

Every day, we at Wuerth Phoenix deal with these questions, and our accumulated experience is then condensed into a common design that can be delivered to end users via modular packages, along with best practices and suggestions to get the most out of them. This enables:

  • Fast implementation of an initial design

  • The ability to include only the required components, keeping the design’s footprint as small as possible

  • A predefined approach to object creation and management, resulting in a clear understanding of the required effort for both

  • A standard method to extend the design without breaking it, or causing conflicts with future upgrades/updates

This kind of logic not only applies to Monitoring, but also to all the other NetEye modules. In the end, this approach reduces the initial startup time and ongoing maintenance effort, resulting in a lower TCO for the whole solution itself.

What are NetEye Extension Packs?

Essentially, a NetEye Extension Pack is the way Wuerth Phoenix delivers to end users all our accumulated NetEye experience in the form of a modular design. In short, it is the crystallization of all experience accumulated by Wuerth Phoenix in a specific field with NetEye, with an easy setup. It aims to build a new design for a fresh installation as fast as possible while keeping it in line with a standard that allows for easy management, extensibility and upgradeability. It can be used both within a brand new deployed NetEye infrastructure and can also be easily integrated into an existing setup.

The idea behind NEPs

As mentioned above, the main idea is to make a brand new NetEye Infrastructure deployment ready to perform in the shortest time possible while keeping its setup as identical as possible to existing ones, maximizing reusability and standardizing the approach. To achieve this, some best practices and strong design rules had to be created and enforced to become the base of this design. The main driver is an easy and uniform user experience while designing and using NetEye, and second is a simple and neat approach to update procedures.

The fundamental unit: NEP Package

The fundamental unit of NetEye Extension Pack is the Package itself: abbreviated NEP, it is a package containing everything needed to perform a specific duty. There is a base package that contains the foundation of the design, while all the other packages extend it. This means any package requires one or more other packages to be installed on the system itself in order to work as intended. The package containing the common foundation is called nep-common.

All packages are based on NetEye and thus compatible with one specific version of it. This doesn’t mean they are not usable outside a NetEye environment: with a little effort, a package can be installed on third-party systems as long as it uses the same open-source software contained into NetEye.

A NEP can ship a number of Extension contents of predefined type, providing support specific to them. Over time, this support will be extended, and the number of supported types will increase. Therefore, each NEP has a package version that describes which Extension contents are supported. To see the list of supported Extension contents, read more in the Advanced Topics section.

Package management

For all NetEye-based setups, NEP provides a package management software that can perform all the basic tasks related to NEP maintenance. The tool is named nep-setup and can manage the three main operations required for package managements: install, reinstall and update.

With nep-setup is possible to view the list of installed packages and install the required ones. Also, in case a newer version of a Package is available on your system, it can also import the updated definitions.

In the unforeseen case that a change in some Director Object brokes the whole configuration, nep-setup is able to restore the currently installed version to its original state: if all objects follows the NE building rules, nothing will be lost.