LogDNA LogSpout

A Docker LogSpout image to stream logs from your containers to LogDNA.

How to Use

Environment Variables

The following variables can be used to tune LogSpout for specific use cases.

Log Router Specific

__FILTER_NAME__: Filter by Container Name with Wildcards, Optional
__FILTER_ID__: Filter by Container ID with Wildcards, Optional
__FILTER_SOURCES__: Filter by Comma-Separated List of Sources, Optional
__FILTER_LABELS__: Filter by Comma-Separated List of Labels, Optional

Note: More information can be found here.

Ingestion Specific

__LOGDNA_KEY__: LogDNA Ingestion Key, Required
HOSTNAME: Alternative Hostname, Optional
- Default: System's Hostname
__LOGDNA_URL__: Specific Endpoint to Stream Log into, Optional
- Default: logs.logdna.com/logs/ingest
TAGS: Comma-Separated List of Tags, Optional

Note: Logging the LogSpout Container is recommended to keep track of HTTP Request Errors or Exceptions.

Limits

__FLUSH_INTERVAL__: How frequently batches of logs are sent (in milliseconds), Optional
- Default: 250
HTTP_CLIENT_TIMEOUT: Time limit (in seconds) for requests made by this HTTP Client, Optional
- Default: 30
- Source: net/http/client.go#Timeout
__INACTIVITY_TIMEOUT__: How long to wait for inactivity before declaring failure in the Docker API and restarting, Optional
- Default: 1m
- Note: More information about the possible values can be found here. Also see time.ParseDuration for valid format as recommended here.
MAX_BUFFER_SIZE: The maximum size (in mb) of batches to ship to LogDNA, Optional
- Default: 2
MAX_REQUEST_RETRY: The maximum number of retries for sending a line when there are network failures, Optional
- Default: 5

Docker

Create and run container named logdna from this image using CLI:

sudo docker run --name="logdna" --restart=always \
-d -v=/var/run/docker.sock:/var/run/docker.sock \
-e LOGDNA_KEY="<LogDNA Ingestion Key>" \
logdna/logspout:latest

Docker Cloud

Append the following to your Docker Cloud stackfile:

logdna:
  autoredeploy: true
  deployment_strategy: every_node
  environment:
    - LOGDNA_KEY="<LogDNA Ingestion Key>"
    - TAGS='{{.Container.Config.Hostname}}'
  image: 'logdna/logspout:latest'
  restart: always
  volumes:
    - '/var/run/docker.sock:/var/run/docker.sock'

Elastic Container Service (ECS)

Modify your ECS Cloud Configuration file to have LogDNA Service as described below:

services:
  logdna:
    environment:
        - LOGDNA_KEY="<LogDNA Ingestion Key>"
        - TAGS='{{ if .Container.Config.Labels }}{{index .Container.Config.Labels "com.amazonaws.ecs.task-definition-family"}}:{{index .Container.Config.Labels "com.amazonaws.ecs.container-name"}}{{ else }}{{.ContainerName}}{{ end }}'
    image: logdna/logspout:latest
    restart: always
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
    deploy:
      mode: global

Rancher

Modify your Rancher Compose Stackfile to have LogDNA Service as described below:

version: '2'
services:
  logdna:
    image: logdna/logspout:latest
    environment:
      LOGDNA_KEY="<LogDNA Ingestion Key>"
    restart: always
    labels:
      io.rancher.container.hostname_override: container_name
      io.rancher.container.pull_image: always
      io.rancher.os.scope: system
    volumes:
    - /var/run/docker.sock:/tmp/docker.sock

Docker Swarm

Modify your Docker Swarm Compose file to have LogDNA Service as described below:

version: "3"
networks:
  logging:
services:
  logdna:
    image: logdna/logspout:latest
    networks:
      - logging
    volumes:
      - /etc/hostname:/etc/host_hostname:ro
      - /var/run/docker.sock:/var/run/docker.sock
    environment:
      - LOGDNA_KEY="<LogDNA Ingestion Key>"
    deploy:
      mode: global

Notes

Do not forget to add -u root (in CLI) or user: root (in YAML) in case of having permission issues.

Contributing

Contributions are always welcome. See the contributing guide to learn how you can help. Build instructions for the agent are also in the guide.

logdna / logspout

readme