> ## Documentation Index
> Fetch the complete documentation index at: https://docs.germainux.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GermainUX Engine

> GermainUX Engine executes monitoring, diagnostic, integration, and automation components close to the systems being monitored.

Components
[`Enterprise – Cloud`](https://docs.germainux.com/main/deployment-on-our-cloud)
[`Enterprise – On-Premise`](https://docs.germainux.com/main/deployment-on-premise)

Availability
2014.1 or later

> **[Architecture](#architecture)**
>
> How it fits

> **[When to use](#when-to-use-germainux-engine)**
>
> Typical cases

> **[Deploy](#deployment-overview)**
>
> Step by step

> **[Security](#security)**
>
> Least access

## Overview

GermainUX Engine executes monitoring, diagnostic, integration, and automation components close to the systems being monitored.

It retrieves its configuration from GermainUX Enterprise, executes the assigned monitoring components, and sends the resulting telemetry to GermainUX for analysis, alerts, reports, and automation.

## What the Engine Can Access

Use GermainUX Engine when monitoring or automation requires access to resources such as:

* Applications
* APIs
* Databases
* Servers
* Operating systems
* Logs

> **Show all 12**
>
> * Files
> * Networks
> * Messaging systems
> * Cloud services
> * Enterprise applications
> * Third-party integrations

An Engine can run inside the same network as the monitored system, allowing GermainUX to collect telemetry without requiring direct access from GermainUX Enterprise to every protected resource.

## Architecture

A typical architecture is:

**Monitored System → GermainUX Engine → GermainUX Enterprise**

Each Engine host includes:

| Component | Purpose |
| - | - |
| **Engine Manager** | Connects the host to GermainUX Enterprise and manages the Engines running on it |
| **Engine** | Executes assigned monitoring and automation components |
| **Monitoring Components** | Perform tasks such as querying databases, reading logs, monitoring APIs, or executing automation |
| **Local State** | Maintains processing state required by applicable monitoring components |

Multiple Engines can run on the same host and can be distributed across:

* Network zones
* Data centers
* Cloud regions
* Production environments
* Non-production environments

## When to Use GermainUX Engine

Deploy an Engine when:

* A monitored resource is not directly accessible from GermainUX Enterprise.
* Monitoring must execute within a protected network.
* Workloads need to be distributed.
* Separate production and non-production monitoring is required.
* Monitoring must operate close to a database, application, service, or infrastructure resource.
* Synthetic or automation tasks need to execute from a particular environment.

## Deployment Options

GermainUX Engine can be deployed on supported:

* Windows systems
* Linux systems
* Docker environments

The deployment method and requirements are documented in the Engine Deployment guide.

## Requirements

At a high level, an Engine host requires:

* A supported operating system or container environment
* Required Java runtime
* Network connectivity to GermainUX Enterprise
* Network access to monitored resources
* Required credentials and permissions
* Appropriate CPU, memory, disk, and network capacity

Detailed requirements belong in the Engine Deployment guide.

## Deployment Overview

A typical deployment consists of:

**1. Select the Engine host**

**2. Review network and software requirements**

**3. Deploy Engine Manager**

**4. Connect the host to GermainUX Enterprise**

**5. Create or enable the required Engines**

**6. Assign monitoring components**

**7. Validate connectivity to monitored resources**

**8. Confirm that monitoring data reaches GermainUX**

## Deployment and Configuration Guides

| Guide | Purpose |
| - | - |
| [**Engine Deployment**](https://docs.germainux.com/main/engine-deployment.md) | Install and deploy Engine Manager and Engines |
| [**Engine Configuration**](https://docs.germainux.com/main/engine-configuration.md) | Configure Engine settings and runtime behavior |
| **Engine Troubleshooting** | Diagnose Engine startup, connectivity, configuration, and execution issues |

## Scaling

Additional Engines can be deployed when required to:

* Reach isolated network zones
* Separate environments
* Distribute monitoring workloads
* Reduce resource contention
* Improve resilience
* Meet regional or data-access requirements

The number and placement of Engines should follow the monitoring architecture rather than a fixed deployment pattern.

## Security

Use only the connectivity and permissions required by the monitoring components assigned to each Engine.

Consider:

* Network segmentation
* Service-account permissions
* Credential management
* TLS
* Proxy configuration
* Access to databases and APIs
* Access to files and logs

Avoid giving an Engine broader access than its assigned monitoring requires.

## Validate

After deployment, confirm:

* Engine Manager is connected to GermainUX Enterprise.
* The expected Engine instances are available.
* Assigned monitoring components are running.
* The Engine can reach the monitored resources.
* Monitoring data is transmitted successfully.
* CPU, memory, and disk utilization are appropriate.

Use Engine Troubleshooting for detailed diagnostic procedures.

## Support

For assistance installing, configuring, or troubleshooting GermainUX-Engine, contact [GermainUX Support](https://docs.germainux.com/main/support.md).

## Get Help

> **[Contact GermainUX Support](https://docs.germainux.com/main/support.md)**
>
> The Germain Team can help you set this up.

> **Can't find what you need?**
>
> Search all GermainUX docs with **Ctrl + K**, or use the feedback buttons at the bottom of this page to tell us what is missing.

The content of this document is proprietary to GERMAIN SOFTWARE.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.