Topic Browse

About Topic Browse

Topic Browse is used by Platform Manager to display topic messages in the Self Service UI.

Docker Environment Variables

The table below provides a comprehensive overview of the Docker environment variables available for configuring the Topic Browse container. You can customize the environment variables to match your specific configuration.

Name Possible Values Required Description

LOGGING_LEVEL_ROOT

string
default: "WARN"

No

Root logging level

SERVER_MAX-HTTP-REQUEST-HEADER-SIZE

number
default: 10000KB

No

Maximum size of the HTTP request header

SECURITY_ENABLED

boolean
default: false

No

Enables or disables security features

SECURITY_OPEN_ENDPOINTS

string
default: "/actuator/health,/spec/*"

No

Prometheus open endpoints

MANAGEMENT_SERVER_SSL_ENABLED

boolean
default: false

No

Management server SSL enable

MANAGEMENT_SECURITY_ENABLED

boolean
default: false

No

Management security enable

MANAGEMENT_ENDPOINTS_WEB_EXPOSURE_INCLUDE

string
default: "info,health,prometheus"

No

Actuator Endpoint IDs that should be included or '*' for all

JMX_ENABLED

boolean
default: false

No

JMX enabled

PROMETHEUS_ENABLED

boolean
default: false

No

Prometheus enabled

PROMETHEUS_PORT

number
default: 5555

No

Prometheus scrapes the metrics from this port

JMX_PORT

number
default: 5556

No

Metrics are exposed on this port

Running the Docker Container

The following Docker run command starts the Topic Browse container with minimum essential environment variables and volume mounts.

Example:

docker run --rm --name example-tb-container \
[IMAGE_REGISTRY]/axual/topic-browse:[IMAGE_TAG]

Monitoring Configuration

These environment variables allow you to configure monitoring and metrics-related settings for the Topic Browse container:

# Monitoring configuration
-e JMX_ENABLED=true \
-e PROMETHEUS_ENABLED=true \
-e PROMETHEUS_PORT=5555 \ # You can specify your desired port
-e JMX_PORT=5556 \ # You can specify your desired port