{"id":18802108,"url":"https://github.com/hilli/axiom-docker-logging-plugin","last_synced_at":"2025-08-16T11:08:45.337Z","repository":{"id":136454150,"uuid":"413801473","full_name":"hilli/axiom-docker-logging-plugin","owner":"hilli","description":"Axiom Docker Logging Driver","archived":false,"fork":false,"pushed_at":"2021-10-09T22:08:21.000Z","size":1773,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-20T06:44:11.427Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hilli.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-05T12:07:08.000Z","updated_at":"2021-10-09T22:08:23.000Z","dependencies_parsed_at":null,"dependency_job_id":"377f7475-a4f2-4b3b-929c-3ba52b7f6ac3","html_url":"https://github.com/hilli/axiom-docker-logging-plugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hilli/axiom-docker-logging-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hilli%2Faxiom-docker-logging-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hilli%2Faxiom-docker-logging-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hilli%2Faxiom-docker-logging-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hilli%2Faxiom-docker-logging-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hilli","download_url":"https://codeload.github.com/hilli/axiom-docker-logging-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hilli%2Faxiom-docker-logging-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270702562,"owners_count":24630877,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-16T02:00:11.002Z","response_time":91,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T22:26:31.657Z","updated_at":"2025-08-16T11:08:45.314Z","avatar_url":"https://github.com/hilli.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Logz.io Docker logging plugin\nThis 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](https://docs.docker.com/engine/extend/).\n\n# Prerequisites\nHere's what you need to run the plugin:\n\n* 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.\n* A [Logz.io](https://logz.io) account\n\n# Install and configure the Logz.io Docker logging plugin\n\n## Step 1: Install the plugin\nChoose how you want to install the plugin:\n* [Option 1: Install from the Docker Store](#option-1-install-from-the-docker-store)\n* [Option 2: Install from source](#option-2-install-from-source)\n\n\n### Option 1: Install from the Docker Store\n\n1. Pull the plugin from the Docker Store:\n  ```\n  $ docker plugin install store/logzio/logzio-logging-plugin:\u003cversion\u003e --alias logzio/logzio-logging-plugin\n  ```\n\n2. Enable the plugin, if needed:\n  ```\n  $ docker plugin enable logzio/logzio-logging-plugin\n  ```\n\nContinue to [Step 2: Set configuration variables](#step-2-set-configuration-variables)\n\n### Option 2: Install from source\n\n1. Clone the repository and check out release branch:\n  ```\n  $ cd docker-logging-plugin\n  $ git checkout release\n  ```\n\n2. Build the plugin:\n  ```\n  $ make all\n  ```\n\n3. Enable the plugin:\n  ```\n  $ docker plugin logzio/logzio-logging-plugin enable\n  ```\n\n4. Restart the docker daemon for the changes to apply:\n  ```\n  $ service docker restart\n  ```\n\nContinue to [Step 2: Set configuration variables](#step-2-set-configuration-variables)\n\n## Step 2: Set configuration variables\nChoose how you want to configure the plugin parameters:\n* [Option 1: Configure all containers with daemon.json](#option-1-configure-all-containers-with-daemonjson)\n* [Option 2: Configure individual containers at run time](#option-2-configure-individual-containers-at-run-time)\n\n\n### Option 1: Configure all containers with daemon.json\nThe `daemon.json` file allows you to configure all containers with the same options.\n\nFor example:\n```\n{\n  \"log-driver\": \"logzio/logzio-logging-plugin\",\n  \"log-opts\": {\n    \"logzio-url\": \"\u003clogzio_account_token\u003e\",\n    \"logzio-token\": \"\u003clogzio_account_url\u003e\",\n    \"logzio-dir-path\": \"\u003cdir_path_to_logs_disk_queue\u003e\"\n  }\n}\n```\n\n1. _(Optional)_ Set any [environment variables](#advanced-options-environment-variables)\n2. Include all [required variables](#required-variables) in your configuration and any [optional variables](#optional-variables).\n\nContinue to [Step 3: Run containers](#step-3-run-containers)\n\n### Option 2: Configure individual containers at run time\n\nConfigure the plugin separately for each container when using the docker run command. For example:\n```\n$ docker run --log-driver=logzio/logzio-logging-plugin --log-opt logzio-token=\u003clogzio_account_token\u003e --log-opt logzio-url=\u003clogzio_account_url\u003e --log-opt logzio-dir-path=\u003cdir_path_for_logs_disk_queue\u003e \u003cyour_image\u003e\n```\n\n1. _(Optional)_ Set any [environment variables](#advanced-options-environment-variables)\n2. Include all [required variables](#required-variables) in your configuration and any [optional variables](#optional-variables).\n\nContinue to [Step 3: Run containers](#step-3-run-containers)\n\n\n#### Required Variables\n\n| Variable | Description | Notes |\n| --- | --- | --- |\n| `logzio-token` | Logz.io account token. | |\n| `logzio-url` | Logz.io listener URL. For the EU region, use `https://listener-eu.logz.io:8071`. Otherwise, use `https://listener.logz.io:8071`. | To find your region, look at your login URL. `app.logz.io` is US. `app-eu.logz.io` is EU. |\n| `logzio-dir-path` | Logs disk path. All the unsent logs are saved to the disk in this location. | |\n\n#### Optional Variables\n\n| Variable | Description | Default value |\n|---|---|---|\n| `logzio-source` | Event source | |\n| `logzio-format` | Log message format, either `json` or `text`. | `text` |\n| `logzio-tag` | See Docker's [log tag option documentation](https://docs.docker.com/v17.09/engine/admin/logging/log_tags/)\t| `{{.ID}}` (12 characters of the container ID) |\n| `labels` | Comma-separated list of labels to be included in the log message. | |\n| `env` | Comma-separated list of environment variables to be included in message. | |\n| `env-regex` | A regular expression to match logging-related environment variables. Used for advanced log tag options. If there is collision between the `label` and `env` keys, `env` wins. Both options add additional fields to the attributes of a logging message. | |\n| `logzio-attributes` | Meta data in a json format that will be part of every log message that is sent to Logz.io account. | |\n\n#### Advanced options: Environment Variables\n\n| Variable | Description | Default value |\n|---|---|---|\n| `LOGZIO_DRIVER_LOGS_DRAIN_TIMEOUT` | Time to sleep between sending attempts | `5s`\n| `LOGZIO_DRIVER_DISK_THRESHOLD` | Above this threshold (in % of disk usage), plugin will start dropping logs | \t`70` |\n| `LOGZIO_DRIVER_CHANNEL_SIZE` | How many pending messages can be in the channel before adding them to the disk queue. | `10000` |\n| `LOGZIO_MAX_MSG_BUFFER_SIZE`\t| Appends logs that are segmented by docker with 16kb limit. It specifies the biggest message, in bytes, that the system can reassemble. 1 MB is the default and the maximum allowed. | `1048576` (1 MB) |\n| `LOGZIO_MAX_PARTIAL_BUFFER__DURATION` | How long the buffer keeps the partial logs before flushing them | `500ms`\n| `LOGZIO_DEBUG` | Enable/disable debug mode | `false`\n\n### Usage example\n\n```\n$ docker run --log-driver=logzio/logzio-logging-plugin \\\n             --log-opt logzio-token=123456789 \\\n             --log-opt logzio-url=https://listener.logz.io:8071 \\\n             --log-opt logzio-dir-path=./docker_logs \\\n             --log-opt logzio-tag=\"{{.Name}}/{{.FullID}}\" \\\n             --log-opt labels=region \\\n             --log-opt env=DEV \\\n             --env \"DEV=true\" \\\n             --label region=us-east-1 \\\n             \u003cdocker_image\u003e\n```\n\n## Step 3: Run containers\n\nNow that the plugin is installed and configured, it will send the container while the container is running.\n\nTo run your containers, see [Docker Documentation](https://docs.docker.com/config/containers/logging/configure/).\n\n## Credits\nThis plugin relies on the open source [Logz.io go https shipper](https://github.com/dougEfresh/logzio-go) by [Douglas Chimento](https://github.com/dougEfresh)\n\n## Release Notes\n- 1.0.2 - Added a debug option for Logz.io sender logs, helping to reduce the number of logs produced by the driver.\n- 1.0.1 - Ignore empty lines\n- 1.0.0 - First version\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhilli%2Faxiom-docker-logging-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhilli%2Faxiom-docker-logging-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhilli%2Faxiom-docker-logging-plugin/lists"}