logdna/logspout

LogDNA LogSpout

一个Docker LogSpout镜像，用于将容器日志流式传输到LogDNA。

变更日志

v1.3.0 - 2021年4月20日发布

• 添加Makefile以支持多架构（amd64、arm64）构建
  • 修正CI工作流以通过Makefile进行构建
  • 使用docker manifest控制标签

v1.2.0 - 2020年2月20日发布

• 更新许可证
• 更新发布流水线
• 移除日志行清理
• 更新HTTP POST请求及重试机制
• 为POST请求添加User-Agent头
• 更新认证机制

v1.1.0 - 2018年12月6日发布

• 从模板获取标签

v1.0.0 - 2018年8月29日发布

• 初始版本

使用方法

环境变量

以下变量可用于针对特定场景调整LogSpout。

日志路由特定

• FILTER_NAME: 按容器名称（支持通配符）过滤，可选
• FILTER_ID: 按容器ID（支持通配符）过滤，可选
• FILTER_SOURCES: 按逗号分隔的源列表过滤，可选
• FILTER_LABELS: 按逗号分隔的标签列表过滤，可选

注意: 更多信息可参考https://github.com/gliderlabs/logspout/tree/0da75a223db992cd5abc836796174588ddfc62b4/routesapi#routes-resource%E3%80%82

摄入特定

• LOGDNA_KEY: LogDNA摄入密钥，必填
• HOSTNAME: 替代主机名，可选
  • 默认值: 系统主机名
• LOGDNA_URL: 日志流式传输的特定端点，可选
  • 默认值: logs.logdna.com/logs/ingest
• TAGS: 逗号分隔的标签列表，可选

注意: 建议记录LogSpout容器日志，以跟踪HTTP请求错误或异常。

限制

• FLUSH_INTERVAL: 日志批处理发送频率（以毫秒为单位），可选
  • 默认值: 250
• HTTP_CLIENT_TIMEOUT: 此HTTP客户端请求的时间限制（以秒为单位），可选
  • 默认值: 30
  • 来源: https://github.com/golang/go/blob/master/src/net/http/client.go#L89-L104
• INACTIVITY_TIMEOUT: Docker API无活动时等待多久后判定失败并重启，可选
  • 默认值: 1m
  • 注意: 关于可能值的更多信息可参考https://github.com/gliderlabs/logspout#detecting-timeouts-in-docker-log-streams%E3%80%82%E5%8F%A6%E8%AF%B7%E5%8F%82%E9%98%85%60time.ParseDuration%60%E4%BA%86%E8%A7%A3%E6%8E%A8%E8%8D%90%E7%9A%84%E6%9C%89%E6%95%88%E6%A0%BC%E5%BC%8F%EF%BC%8C%E5%A6%82https://github.com/gliderlabs/logspout/blob/e671009d9df10e8139f6a4bea8adc9c7878ff4e9/router/pump.go#L112-L116%E6%89%80%E7%A4%BA%E3%80%82
• MAX_BUFFER_SIZE: 发送到LogDNA的批处理最大大小（以mb为单位），可选
  • 默认值: 2
• MAX_REQUEST_RETRY: 网络故障时发送日志行的最大重试次数，可选
  • 默认值: 5

Docker

通过CLI创建并运行名为logdna的容器：

bash
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

将以下内容添加到Docker Cloud栈文件：

yaml
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'

弹性容器服务（ECS）

修改ECS云配置文件，添加如下LogDNA服务：

yaml
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

修改Rancher Compose栈文件，添加如下LogDNA服务：

yaml
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

修改Docker Swarm Compose文件，添加如下LogDNA服务：

yaml
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

注意事项

若遇到权限问题，请添加-u root（CLI中）或user: root（YAML中）。

贡献

始终欢迎贡献。请参阅贡献指南了解如何提供帮助。代理的构建说明也在该指南中。