NXLog Platform architecture on Linux

NXLog Platform installations on Linux use Podman for container management and Docker Compose for orchestration. This page describes the components and network configuration of the NXLog Platform stack.

Components

All NXLog Platform components run as containers under the Docker Compose project nxlog-<version>, where <version> is your current NXLog Platform version. The following table lists the NXLog Platform components and their corresponding containers.

Component Container(s) Description

Component	Container(s)	Description
Portal	`nxlog--portal-frontend-1` `nxlog--portal-backend-1` `nxlog--broker-1` `nxlog--sidecar-logging-audit-backend-1`	NXLog Platform UI and backend applications.
Agent management	`nxlog--agent-manager-frontend-1` `nxlog--agent-manager-backend-1`	Agent management UI and API.
Log management	`nxlog--log-management-1` `nxlog--sidecar-logging-audit-log_management-1`	ClickHouse and Portal application middleware that exposes HTTP APIs related to log search, log retention management, and custom dashboards.
Agent relay	`nxlog--external-nxlog-1` `nxlog--internal-nxlog-1`	NXLog Agent instances for collecting and processing internal and external telemetry data.
nginx	`nxlog-*-ingress-1`	Ingress to the NXLog Platform UI and APIs.
Postgres	`nxlog-*-postgres-1`	Database for storing user-specific metadata, such as saved searches, custom dashboards, filters, and log retention.
ClickHouse	`nxlog-*-clickhouse-1`	Database for log storage.
Vault	`nxlog--vault-1` `nxlog--vault-agent-1`	Manages secrets and protects sensitive data.

Portal

nxlog-*-portal-frontend-1

nxlog-*-portal-backend-1

nxlog-*-broker-1

nxlog-*-sidecar-logging-audit-backend-1

NXLog Platform UI and backend applications.

Agent management

nxlog-*-agent-manager-frontend-1

nxlog-*-agent-manager-backend-1

Agent management UI and API.

Log management

nxlog-*-log-management-1

nxlog-*-sidecar-logging-audit-log_management-1

ClickHouse and Portal application middleware that exposes HTTP APIs related to log search, log retention management, and custom dashboards.

Agent relay

nxlog-*-external-nxlog-1

nxlog-*-internal-nxlog-1

NXLog Agent instances for collecting and processing internal and external telemetry data.

nginx

nxlog-*-ingress-1

Ingress to the NXLog Platform UI and APIs.

Postgres

nxlog-*-postgres-1

Database for storing user-specific metadata, such as saved searches, custom dashboards, filters, and log retention.

ClickHouse

nxlog-*-clickhouse-1

Database for log storage.

Vault

nxlog-*-vault-1

nxlog-*-vault-agent-1

Manages secrets and protects sensitive data.

Network

The NXLog Platform stack operates within an internal Podman bridge network. The following diagram shows a non-exhaustive list of the network configuration:

Figure 1. NXLog Platform network

The host network routes incoming traffic to the NXLog Platform stack, such as:

Client requests to the NXLog Platform web interface.
NXLog Agent communication with Agent Management.
NXLog Agent forwarding logs to NXLog Platform.

The internal Podman network allows the NXLog Platform containers to communicate between them, receive requests through the reverse proxy, and communicate with external services.