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.

Configuration

Required

Description

Default Value

SPRING_CONFIG_ADDITIONALLOCATION

No

Spring additional config location

<no default>

LOGGING_LEVEL_ROOT

No

Root logging level

WARN

LOGGING_CONFIG

No

Logging configuration file location

classpath:logback-spring.xml

SERVER_PORT

No

Port to be used to connect to Topic Browse

8080

SERVER_MAX-HTTP-REQUEST-HEADER-SIZE

No

Maximum size of the HTTP request header

10000KB

SECURITY_ENABLED

No

Enables or disables security features

false

SECURITY_OPEN_ENDPOINTS

No

Prometheus open endpoints

/actuator/health,/spec/*

MANAGEMENT_SERVER_PORT

No

Management server port

8086

MANAGEMENT_SERVER_SSL_ENABLED

No

Management server SSL enable

false

MANAGEMENT_SECURITY_ENABLED

No

Management security enable

false

MANAGEMENT_ENDPOINTS_WEB_EXPOSURE_INCLUDE

No

Management open endpoints

info,health,prometheus

JMX_ENABLED

No

JMX enabled

false

PROMETHEUS_ENABLED

No

Prometheus enabled

false

PROMETHEUS_PORT

No

Prometheus scrapes the metrics from this port

5555

JMX_PORT

No

Metrics are exposed on this port

5556

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