Application debugging¶

The goal of this document is to give some troubleshooting tips.

Browser¶

You can use the browser-integrated debugging tool, usually available with the F12 key.

Sources map¶

For debugging purposes, it is better to have all the JavaScript and Style Sheets in separated, non-minified files. To achieve this, you can use the sources maps, a function activable in the browser’s debugging tool.

Webpack¶

To have faster builds, you need to use the Webpack dev server; you can achieve this as follows.

In the file geoportal/demo_geoportal/static-ngeo/js/apps/<interface>.html.ejs, remove the ng-strict-di in the html tag.

If it is not already done, copy the file docker-compose.override.sample.yaml to docker-compose.override.yaml. Be sure that the service webpack_dev_server is present and uncommented.

Restart your application as usual.

Open the application at the following URL: https://172.17.0.1:8484/dev/<interface>.html.

Pyramid debugtoolbar¶

If it is not already done, copy the file docker-compose.override.sample.yaml to docker-compose.override.yaml.

Then the error is directly shown in the query that fails.

You can also open the debugtoolbar at https://172.17.0.1:8484/_debug_toolbar/

Authentication¶

For better security, the session cookie is accessible only via http protocol (meaning, not in JavaScript), and is secure (meaning, the cookie is transmitted only in https requests, not in http requests). For this reason, you should have your application running on https also in your development environment.

To achieve that, if it is not already done, copy the file docker-compose.override.sample.yaml to docker-compose.override.yaml.

Then access the application on https://172.17.0.1:8484/.

Mapserver¶

Sometimes, more information can be obtained by using this command:

docker-compose exec mapserver shp2img -m /etc/mapserver/mapserver.map -o /tmp/test.png ${'\\'}
    -e 500000 100000 700000 300000 -s 1000 1000 [-l <layers>]

You may also activate MapServer’s debug mode and set the environment variable MS_DEBUGLEVEL of the MapServer container DEBUG to 5 (most verbose level, default is 0).

More information

PostgreSQL¶

In the configuration file /etc/postgresql/9.*/main/postgresql.conf, you can set log_statement to all to see all the called statements. This file must be edited using the postgres user.

Reloading PostgreSQL is required so that the new configuration is taken into account:

sudo /etc/init.d/postgres reload

Logs are available in the /var/log/postgresql/postgresql-9.*-main.log file.

Makefile¶

To obtain additional debug messages, you can rebuild your project as follows:

./docker-run --env=DEBUG=TRUE make ...

This will add a message at the start of each rule with the list of files that required an update, e.-g.:

Build /build/c2ctemplate-cache.json due modification on vars.yaml
-rw-r--r-- 1 sbrunner geomapfish 1321 2019-01-09 16:59:20.845623078 +0000 /build/c2ctemplate-cache.json
-rw-rw-r-- 1 sbrunner geomapfish 1299 2019-01-10 08:31:35.707376156 +0000 vars.yaml

Docker-compose¶

Logs¶

With the following command, you can access the logs:

docker-compose logs [<service_name>]

Go inside a container¶

With the following command, you can get a terminal in a container:

docker-compose exec [--user=root] <service_name> bash

Multiple dev on one server¶

When you want to run multiple instances on the same server, you should:

Use a different docker tag for each instance
Use a different project name for each instance

Use a different docker tag¶

To use a different docker tag, define an environment variable in the build:

DOCKER_TAG=<tag> ./docker-run make build

Developing in Python¶

Create a development docker-compose.override.yaml¶

If it is not already done, copy the file docker-compose.override.sample.yaml to docker-compose.override.yaml.

Be sure that the volume for the project is not commented.

You can also do a graceful restart of the running webserver (gunicorn in this case):

docker-compose exec geoportal bash
kill -s HUP `ps aux|grep gunicorn|head --lines=1|awk '{print $2}'`  # graceful

And finally, if you restart the container, you will see your modifications:

docker-compose restart geoportal

Working on c2cgeoportal itself¶

Clone and build c2cgeoportal, see Server-side development.

If it is not already done, copy the file docker-compose.override.sample.yaml to docker-compose.override.yaml. Be sure that the volumes for c2cgeoportal are uncommented.

Access to a hidden service¶

Within the Docker composition, you can access a port of a container; you can achieve this via curl, e.-g.:

You can also expose a service out of the Docker composition. For that, add a port in your docker-compose.yaml, e.g.:

services:
  <service>:
    port:
      - 8086:8080

Be careful, each port can be open only one time on a server.

Use a specific version of ngeo¶

Clone ngeo and build:

cd geoportal
git clone https://github.com/camptocamp/ngeo.git
cd ngeo
git check <branch>
cd ../..

Add the following alias in your webpack.apps.js.mako file:

 resolve: {
   alias: {
     <package>: ...,
+    ngeo: path.resolve(__dirname, 'ngeo/src'),
+    gmf: path.resolve(__dirname, 'ngeo/contribs/gmf/src'),
   }
 }

Force rebuild the application:

./docker-run rm /build/apps.<interface>.timestamp
./docker-run make build

Performance or network error¶

For performance and proxy issues, make sure that all internal URLs in the config file use localhost (use curl "http://localhost/<path>" --header Host:<server_name> to test it).

TileCloud chain¶

Points to check with TileCloud chain:

Disabling metatiles should be avoided.
Make sure that empty_metatile_detection and empty_tile_detection are configured correctly.
Make sure to not generate tiles with a resolution higher than the one in the raster sources.