docker-logging-plugin

Logz.io Docker logging plugin

This Docker plugin ships container logs to your Logz.io account. These instructions are for Linux host systems. For other platforms, see the Docker Engine managed plugin system documentation.

Prerequisites

Here's what you need to run the plugin:

• Docker Engine version 17.05 or later. If you plan to configure this plugin using daemon.json, you need Docker Community Edition (Docker-ce) 18.03 or later.
• A Logz.io account

Install and configure the Logz.io Docker logging plugin

Step 1: Install the plugin

Choose how you want to install the plugin:

• Option 1: Install from the Docker Store
• Option 2: Install from source

Option 1: Install from the Docker Store

1. Pull the plugin from the Docker Store:

$ docker plugin install store/logzio/logzio-logging-plugin:<version> --alias logzio/logzio-logging-plugin

1. Enable the plugin, if needed:

$ docker plugin enable logzio/logzio-logging-plugin

Continue to Step 2: Set configuration variables

Option 2: Install from source

1. Clone the repository and check out release branch:

$ cd docker-logging-plugin
$ git checkout release

1. Build the plugin:

$ make all

1. Enable the plugin:

$ docker plugin logzio/logzio-logging-plugin enable

1. Restart the docker daemon for the changes to apply:

$ service docker restart

Continue to Step 2: Set configuration variables

Step 2: Set configuration variables

Choose how you want to configure the plugin parameters:

• Option 1: Configure all containers with daemon.json
• Option 2: Configure individual containers at run time

Option 1: Configure all containers with daemon.json

The daemon.json file allows you to configure all containers with the same options.

For example:

{
  "log-driver": "logzio/logzio-logging-plugin",
  "log-opts": {
    "logzio-url": "<logzio_account_token>",
    "logzio-token": "<logzio_account_url>",
    "logzio-dir-path": "<dir_path_to_logs_disk_queue>"
  }
}

1. (Optional) Set any environment variables
2. Include all required variables in your configuration and any optional variables.

Continue to Step 3: Run containers

Option 2: Configure individual containers at run time

Configure the plugin separately for each container when using the docker run command. For example:

$ docker run --log-driver=logzio/logzio-logging-plugin --log-opt logzio-token=<logzio_account_token> --log-opt logzio-url=<logzio_account_url> --log-opt logzio-dir-path=<dir_path_for_logs_disk_queue> <your_image>

1. (Optional) Set any environment variables
2. Include all required variables in your configuration and any optional variables.

Continue to Step 3: Run containers

Required Variables

Optional Variables

Advanced options: Environment Variables

Usage example

$ docker run --log-driver=logzio/logzio-logging-plugin \
             --log-opt logzio-token=123456789 \
             --log-opt logzio-url=https://listener.logz.io:8071 \
             --log-opt logzio-dir-path=./docker_logs \
             --log-opt logzio-tag="{{.Name}}/{{.FullID}}" \
             --log-opt labels=region \
             --log-opt env=DEV \
             --env "DEV=true" \
             --label region=us-east-1 \
             <docker_image>

Step 3: Run containers

Now that the plugin is installed and configured, it will send the container while the container is running.

To run your containers, see Docker Documentation.

Credits

This plugin relies on the open source Logz.io go https shipper by Douglas Chimento

Release Notes

• 1.0.3:
  • Update python version for test log generator 3.9.14-slim -> 3.12.2-slim
  • Update alpine base image 3.7 -> 3.15
• 1.0.2: Added a debug option for Logz.io sender logs, helping to reduce the number of logs produced by the driver.
• 1.0.1: Ignore empty lines
• 1.0.0: First version