docker - Is debugging still possible ?

[Gaetanbrl]

The docker readme contains a Developers corner section to explains how to debug a module such as security-proxy, console, etc...

Open docker/docker-compose.yml and identify proxy section.

But docker-compose.yml doesn't have this configuration anymore.

Is it still possible to debug in this way?

Thanks.

[Gaetanbrl]

oh... proxy section is just one example... I guess this works with another

[Gaetanbrl]

After some test, i fail to attach a debug session to a container (gateway in this case).

Steps followed :

• Add gateway JAVA_OPTIONS :

- JAVA_OPTIONS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=0.0.0.0:5005

• In VS Code, try to Run & debug this config :

        {
            "type": "java",
            "name": "Debug Gateway",
            "request": "attach",
            "hostName": "localhost",
            "port": 5005
        },

Here container infos :

CONTAINER ID   IMAGE                                                COMMAND                  CREATED          STATUS                      PORTS                                                                                                         NAMES
9e7037bee034   georchestra/gateway:proconnect                             "/cnb/process/web"       2 minutes ago    Up 2 minutes                0.0.0.0:5005->5005/tcp, :::5005->5005/tcp                                                                     docker-gateway-1

Local geOrchestra is available here :
https://georchestra-127-0-0-1.nip.io/login

I'm not really sur about that the hostName value is correct.

Has someone already tested to debug like that ?

[Gaetanbrl]

I close.

This config works fine to debug gateway :

https://github.com/georchestra/georchestra-gateway/blob/ba9a8c5ff4ed5046d61e437cdf4a14481094d946/docker-compose.yml#L45-L51

1. change georchestra/docker-compose.yaml to use this config (JAVA_TOOLS_OPTIONS and PORTS values are required)

  gateway:
    image: georchestra/gateway:latest
    depends_on:
      - database
    volumes:
      - georchestra_datadir:/etc/georchestra
    environment:
      - DEBUG=yes
      - JAVA_TOOL_OPTIONS=-Dgeorchestra.datadir=/etc/georchestra -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=0.0.0.0:5005
    env_file:
      - .envs-common
      - .envs-ldap
      - .envs-hosts
      - .envs-database-georchestra
    ports:
      - 8080:8080
      - 8090:8090
      - 5005:5005

note : I dunno if 8080, 8090 ports are really required to works

2. Run docker compose up -d from /docker repo

3. With VS Code (because I use it), create debug file :

in georchestra-gateway/.vscode/launch.json :

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "java",
            "name": "Attach",
            "request": "attach",
            "hostName": "localhost",
            "port": "5005"
        }
    ]
}

4. Debug

[pmauduit]

Indeed you will need to configure the jdwp (java debugging wire protocol) to remote debug. Hence the JAVA_TOOL_OPTIONS plus the ports section of your yaml snippet.

FYI you can also find simpler docker composition in a dedicated repository: https://github.com/georchestra/sample-docker-composition/blob/main/gateway/new-app/docker-compose.yaml if you don't want to start the whole geOrchestra composition from georchestra/docker.