Access Container Logs

This topic provides sample commands that you can use to view and aggregate logs from your APIIDA API Gateway Manager installation. The logs may contain container-specific error messages, event messages, and warnings as well as the log of the Gateway Manager itself.

Viewing Logs

The container can log to any external logging system supported by Docker. Use the docker-compose logs command to view logs.

The following command prints the logs for all services that are defined in the docker-compose.yml file:

$ docker-compose logs --follow

The following command prints logs for the service named "aagm" defined in the docker-compose.yml file:

$ docker-compose --file docker-compose.yml logs --follow aagm

The following command prints the last 100 lines of logs for the service named "aagm" defined in the docker-compose.yml file:

$ docker-compose --file docker-compose.yml logs --tail 100 --follow aagm

Aggregating Logs

Container logs can be aggregated and sent to any external logging system supported by Docker. The following example aggregates and sends the container logs to the syslog server "syslog-server.example.com" on port 123.

docker-compose.yml

services:
  aagm:
    image: apiida/aagm:latest
    logging:
      driver: syslog
      options:
        syslog-address: "tcp://syslog-server.example.com:123"

Logs for APIIDA Support

If the APIIDA support asks you to provide additional logs, please execute following commands:

docker-compose exec aagm cat /var/www/html/var/logs/nostromo-$(date +%Y-%m-%d).log > nostromo-$(date +%Y-%m-%d).log
docker-compose logs aagm> aagm-log-$(date +%Y-%m-%d).log
docker-compose logs aagmdb > aagmdb-log-$(date +%Y-%m-%d).log

Please provide the APIIDA support the following files:

nostromo-{date}.log
aagm-log-{date}.log
aagmdb-log-{date}.log