Introduction

Conduktor Gateway is a vendor-agnostic Apache Kafka UI that allows you to gain insight into your Kafka ecosystem and what has happened in the past. 

As Console is deployed with two docker images, conduktor/conduktor-console and conduktor/conduktor-console-cortex, a Postgres database and typically a Single Sign On(SSO) we have some suggested best practices when opening a support case. Please follow these best practices to help us resolve your support case with Console as efficiently as possible.

Best practices

To help us efficiently resolve your support case with Conduktor Console, please follow these best practices:

• Provide background information on the issue you are experiencing so that we can go about reproducing, including the version of Conduktor Console you are using and the expected behavior.

We also ask for the following pieces of information to help us troubleshoot:

• How you are deploying Console, for example via Docker Compose, Kubernetes or a Container Managed Service on a Cloud Provider e.g ECS on AWS or ACI on Azure.
• Capture the logs from the Conduktor Console at the approximate time of the issue you are seeing, we may ask you to change the logging level, shown here, to give more information.  
• If its related to your database, the version of Postgres and how you are deploying Postgres.
• If its related to your SSO and how your users Authenticate, what SSO provider you using and how it is set up.

How to get logs from Console or Cortex?

This depends on how you have started the docker images of Console and Cortex. Please find links to documentation and examples for Docker Compose and Kubernetes deployment methods here. If you are using a managed container service from a Cloud provider it will depend on how you have set up your logging.

If you are using Docker Compose you can use the command as shown in Docker documentation here:

docker compose logs [OPTIONS] [SERVICE...]

For example, docker compose logs conduktor-console cortex 

If you are using Kubernetes, see the documentation here:

kubectl logs [-f] [-p] (POD | TYPE/NAME) [-c CONTAINER]

For example,  kubectl logs conduktor-console

Alternatively you can find the logs inside the Console Container by using either

docker exec -it [Container ID] bash or kubectl exec [OPTIONS] POD_NAME -- COMMAND 

For example,  docker exec -it 411ce78addcc bash or kubectl exec conduktor-console -- bash 

And navigating to the /var/conduktor/log folder you should see a similar setup, we are looking to see the cat console-stdout log unless we otherwise ask for a different one, which may be needed in very specific situations.

Example of Console Logs from Startup

2024-04-30T15:35:30Z [entrypoint] INFO -
Welcome to Conduktor Console !
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣴⡇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣴⠟⢻⡇⠀⠀⠀⠀⣠⡆⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣴⡿⠋⠀⢸⣧⣤⣀⡀⠺⢿⡇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣾⡿⠀⠀⠀⢸⣿⣿⣿⣿⣆⠀⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢸⣿⠇⠀⠀⢀⣼⣿⣿⣿⣿⣿⣷⡄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣿⡿⠀⠀⠴⠿⣿⣿⣦⣄⣠⣿⣿⡇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣾⣿⡇⠀⠀⠀⠀⠀⠈⠉⠉⠛⠛⠿⢿⣦⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢸⣿⣿⠀⠀⠀⠀⠀⠀⠀⢀⡀⠀⠀⠀⠀⢿⣿⣦⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢠⣿⣿⣷⣤⣀⠀⠀⠀⠀⠐⣿⣿⣷⣦⣤⣀⣤⣿⠃⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠚⠛⠛⠛⠛⠛⠛⠂⠀⠀⠀⠘⢿⣿⣿⠋⠉⠉⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⣻⣿⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠐⢦⣤⣀⡀⠀⠀⢀⣤⣾⣿⠟⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠙⢿⣿⣿⣾⣿⣿⠟⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠙⢿⡿⠋⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀

All rights reserved to Conduktor Inc. https://www.conduktor.io
ToS : https://www.conduktor.io/terms-of-service
Privacy Policy : https://www.conduktor.io/privacy-policy
Changelog : https://www.conduktor.io/changelog
Roadmap : https://product.conduktor.help
Support : https://www.conduktor.io/contact/support
Conduktor Platform version: 1.22.0(2cd285be512aa39a626fc2639e2a1a7d52df18e4)
Running user: uid=10001(conduktor-platform) gid=0(root) groups=0(root)
2024-04-30T15:35:30Z [entrypoint] INFO - Init volume directories if needed
2024-04-30T15:35:30Z [entrypoint] INFO - Setup Conduktor Platform
Using default log4rs config
2024-04-30T15:35:30.867+0000 [platform-setup] INFO platform_entrypoint - Startup Conduktor platform with configuration file "/opt/conduktor/platform-config.yaml"
2024-04-30T15:35:30.868+0000 [platform-setup] INFO platform_entrypoint - Read input configuration : "/opt/conduktor/platform-config.yaml"
2024-04-30T15:35:30.949+0000 [platform-setup] WARN platform_cli::system - Could not determine the amount of available RAM: Limit in bytes is not set
2024-04-30T15:35:30.950+0000 [platform-setup] INFO platform_entrypoint - Validate configuration
2024-04-30T15:35:30.951+0000 [platform-setup] INFO platform_entrypoint - Input configuration is valid !
2024-04-30T15:35:30.951+0000 [platform-setup] INFO platform_entrypoint - Create modules configurations

Example of Cortex Logs from startup

Platform log level set to INFO
2024-04-30T15:35:28Z [entrypoint] INFO -
Welcome to Conduktor Platform Cortex !
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣴⡇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣴⠟⢻⡇⠀⠀⠀⠀⣠⡆⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣴⡿⠋⠀⢸⣧⣤⣀⡀⠺⢿⡇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣾⡿⠀⠀⠀⢸⣿⣿⣿⣿⣆⠀⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢸⣿⠇⠀⠀⢀⣼⣿⣿⣿⣿⣿⣷⡄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣿⡿⠀⠀⠴⠿⣿⣿⣦⣄⣠⣿⣿⡇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣾⣿⡇⠀⠀⠀⠀⠀⠈⠉⠉⠛⠛⠿⢿⣦⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢸⣿⣿⠀⠀⠀⠀⠀⠀⠀⢀⡀⠀⠀⠀⠀⢿⣿⣦⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢠⣿⣿⣷⣤⣀⠀⠀⠀⠀⠐⣿⣿⣷⣦⣤⣀⣤⣿⠃⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠚⠛⠛⠛⠛⠛⠛⠂⠀⠀⠀⠘⢿⣿⣿⠋⠉⠉⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⣻⣿⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠐⢦⣤⣀⡀⠀⠀⢀⣤⣾⣿⠟⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠙⢿⣿⣿⣾⣿⣿⠟⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠙⢿⡿⠋⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀

All rights reserved to Conduktor Inc. https://www.conduktor.io
ToS : https://www.conduktor.io/terms-of-service
Privacy Policy : https://www.conduktor.io/privacy-policy
Changelog : https://www.conduktor.io/changelog
Roadmap : https://product.conduktor.help
Support : https://www.conduktor.io/contact/support
Conduktor Platform version: 1.22.0(2cd285be512aa39a626fc2639e2a1a7d52df18e4)
Running user: uid=10001(conduktor-platform) gid=0(root) groups=0(root)
2024-04-30T15:35:29Z [entrypoint] INFO - Init volume directories if needed
2024-04-30T15:35:29Z [entrypoint] INFO - Setup Conduktor Platform Cortex
Using default log4rs config
2024-04-30T15:35:29.304+0000 [setup] INFO monitoring_entrypoint - Startup Cortex,Prometheus and Alert manager
2024-04-30T15:35:29.337+0000 [setup] INFO monitoring_entrypoint - Running with embedded (filesystem) monitoring storage
2024-04-30T15:35:29.338+0000 [setup] WARN monitoring_entrypoint - WARNING :

No external monitoring storage is configured. When not configured, you risk losing monitoring history upon upgrade.
To avoid this, we recommend configuring a volume or defining external storage (e.g. s3, gcs, azure).
Conduktor highly recommends usage of external storage for production. See our production requirements documentation for more details.

2024-04-30T15:35:29.338+0000 [setup] INFO monitoring_entrypoint - Create modules configurations
2024-04-30T15:35:29Z [entrypoint] INFO - Start services. This may take some time...
2024-04-30 15:35:31,030 INFO Included extra file "/etc/supervisor/conf.d/alert-manager.conf" during parsing
2024-04-30 15:35:31,031 INFO Included extra file "/etc/supervisor/conf.d/cortex.conf" during parsing
2024-04-30 15:35:31,031 INFO Included extra file "/etc/supervisor/conf.d/prometheus.conf" during parsing
2024-04-30 15:35:31,031 INFO Set uid to user 10001 succeeded
2024-04-30 15:35:31,071 INFO RPC interface 'supervisor' initialized
2024-04-30 15:35:31,072 INFO supervisord started with pid 1
2024-04-30 15:35:32,077 INFO spawned: 'prometheus' with pid 68
2024-04-30 15:35:32,080 INFO spawned: 'alertmanager' with pid 69
2024-04-30 15:35:32,083 INFO spawned: 'cortex' with pid 70
2024-04-30 15:35:33,090 INFO success: prometheus entered RUNNING state, process has stayed up for > than 1 seconds (startsecs)
2024-04-30 15:35:33,093 INFO success: alertmanager entered RUNNING state, process has stayed up for > than 1 seconds (startsecs)
2024-04-30 15:35:33,093 INFO success: cortex entered RUNNING state, process has stayed up for > than 1 seconds (startsecs)
2024-04-30 15:35:33,269 DEBG 'alertmanager' stdout output:
ts=2024-04-30T15:35:33.265895226Z caller=main.go:201 level=info msg="Starting Cortex" version="(version=1.16.0, branch=HEAD, revision=279ed56)"

2024-04-30 15:35:33,269 DEBG 'cortex' stdout output:
ts=2024-04-30T15:35:33.268704035Z caller=main.go:201 level=info msg="Starting Cortex" version="(version=1.16.0, branch=HEAD, revision=279ed56)"