Local Development

When developing a component which is using GELF logging, you need the GELF server to listen to its messages. You can use the following two servers:

Using Mock Server with Docker Compose

A convenient way to use the mock server is using Docker Compose. That way you can set both your docker image and the log server to run together and set the networking stuff automatically. Each of our sample repositories mentioned above contains a docker-compose.yml sample which you can use to derive your own. To give an example, the sample PHP client contains the following docker-compose.yml:

  image: "quay.io/keboola/docs-example-logging-mock-server:master"
    - 12202:12202/tcp
    SERVER_TYPE: tcp
  image: "quay.io/keboola/docs-example-logging-php:master"
    - server:log-server
    KBC_LOGGER_ADDR: log-server
    KBC_LOGGER_PORT: 12202

This instructs docker to create two containers: server and client. The important part is links: server:log-server that links the server container to the client container with the DNS name log-server. When you run the above setup (the current directory should be the root of the docs-example-logging-php repository) with

docker-compose up

you will obtain an output like this:

Creating docsexampleloggingphp_server_1
Creating docsexampleloggingphp_client_1
Attaching to docsexampleloggingphp_server_1, docsexampleloggingphp_client_1
server_1  | array(6) {
server_1  |   ["version"]=>
server_1  |   string(3) "1.0"
server_1  |   ["host"]=>
server_1  |   string(12) "590227a73319"
server_1  |   ["short_message"]=>
server_1  |   string(26) "A sample emergency message"
server_1  |   ["level"]=>
server_1  |   int(0)
server_1  |   ["timestamp"]=>
server_1  |   float(1464443278.9355)
server_1  |   ["_some"]=>
server_1  |   array(1) {
server_1  |     ["structured"]=>
server_1  |     string(4) "data"
server_1  |   }
server_1  | }
docsexampleloggingphp_client_1 exited with code 0

This will first start the GELF mock server, then the client. All the example client does is log A sample emergency message to the server and terminate, which is indicated by the message docsexampleloggingphp_client_1 exited with code 0. The GELF mock server just prints every received message to the standard output, so you can see that it indeed received the messages from the client. The server will keep running until you press CTRL+C and terminate it.

The above setup can be modified simply by changing the image of the client in the docker-compose.yml so that your own image is used. Note that the port 12202 in the mock server may be changed by setting PORT environment variable in docker-compose.yml.

Using Mock Server Manually

If you want to set things manually, start the mock server by the following command:

docker run -e SERVER_TYPE=tcp quay.io/keboola/docs-example-logging-mock-server

This will print

TCP Server listening on port 12202 .

The command (and server) will keep running. To run your client, you need to know the server’s IP address. Therefore run another command line instance and find the container ID with

docker ps

which will give you

CONTAINER ID        IMAGE                                              COMMAND                  CREATED             STATUS              PORTS                  NAMES
6cc7c2af97cb        quay.io/keboola/docs-example-logging-mock-server   "/bin/sh -c ./start.s"   4 seconds ago       Up 2 seconds        12202/tcp, 12202/udp   drunk_hopper

Then find out the IP address of the running container, for instance by running docker inspect

docker inspect --format '{{ .NetworkSettings.IPAddress }}' 6cc

which will give you, for example:

(Note: use double quotes in the above command when running on Windows) You can now start your client using that address as KBC_LOGGER_ADDR environment variable together with (KBC_LOGGER_PORT set to 12202), for example:

docker run -e KBC_LOGGER_ADDR= -e KBC_LOGGER_PORT=12202 quay.io/keboola/docs-example-logging-php:master

You will now see messages printed in the output of your server.