logentries/docker-logentries

docker-logentries

轻松将所有容器日志转发至Logentries。

!https://raw.githubusercontent.com/nearform/docker-logentries/master/dashboard.png

查看Logentries社区包：[***]

镜像概述和主要用途

docker-logentries是一个日志转发工具，可收集Docker容器的日志、统计信息和事件，并将其发送至Logentries平台。支持作为容器运行、CLI工具或嵌入式模块使用，提供灵活的过滤和配置选项，适用于各种Docker环境的日志集中管理需求。

核心功能和特性

• 支持收集容器日志、统计信息和事件
• 可使用单个令牌或分别为日志、统计、事件指定不同令牌
• 支持JSON格式日志解析
• 提供容器过滤功能（按名称或镜像匹配/排除）
• 支持统计数据降采样，可配置统计间隔
• 安全增强选项（只读文件系统、禁止新特权）
• 适配受限环境（如Google Compute Engine）的特权模式运行

使用场景和适用范围

• Docker容器集群的日志集中管理
• 容器性能监控数据收集
• 需要将Docker日志集成到Logentries平台的场景
• 开发和生产环境的容器日志分析

使用方法和配置说明

作为容器使用

将所有容器日志转发至Logentries的最简单方法是运行该镜像：

sh
docker run -v /var/run/docker.sock:/var/run/docker.sock \
           --read-only \
           --security-opt=no-new-privileges \
           logentries/docker-logentries \
           -t <TOKEN> \
           -j \
           -a host=`uname -n`

也可对日志、统计和事件使用不同令牌：

sh
docker run -v /var/run/docker.sock:/var/run/docker.sock \
           --read-only \
           --security-opt=no-new-privileges \
           logentries/docker-logentries \
           -l <LOGSTOKEN> \
           -k <STATSTOKEN> \
           -e <EVENTSTOKEN> \
           -j \
           -a host=`uname -n`

安全选项说明：

• --read-only：容器文件系统设为只读，增强安全性（非必需）
• --security-opt=no-new-privileges：阻止进程或其子进程通过setuid/sgid获取额外特权（非必需，增强安全性）

常用参数：

• --no-stats：不发送统计信息（Docker版本<1.5时需要此参数）
• --no-logs：不发送日志
• --no-dockerEvents：不发送事件
• -i/--statsinterval <STATSINTERVAL>：设置统计数据采样间隔，对数据进行平均后发送
• -a/--add：添加固定值到发送的数据，格式为"name=value"（如未指定，默认添加host=uname -n``）

容器过滤选项：

• --matchByName REGEXP：仅转发名称匹配正则表达式的容器日志/统计
• --matchByImage REGEXP：仅转发镜像匹配正则表达式的容器日志/统计
• --skipByName REGEXP：不转发名称匹配正则表达式的容器日志/统计
• --skipByImage REGEXP：不转发镜像匹配正则表达式的容器日志/统计

在受限环境中运行容器

某些环境（如Google Compute Engine）不允许直接访问Docker socket，运行时会出现EACCES错误（Error: read EACCES）。此时需添加--privileged参数：

sh
docker run --privileged \
           -v /var/run/docker.sock:/var/run/docker.sock \
           --read-only \
           --security-opt=no-new-privileges \
           logentries/docker-logentries \
           -t <TOKEN> \
           -j \
           -a host=`uname -n`

作为CLI工具使用

1. 安装：npm install docker-logentries -g
2. 运行：docker-logentries -t TOKEN -a host=\uname -n``

CLI参数（与容器模式类似）：

• -j：启用JSON格式日志解析（如使用bunyan）
• --no-stats/--no-logs/--no-dockerEvents：分别禁用统计/日志/事件发送
• -a/--add：添加固定值，格式"name=value"
• -i/--statsinterval：设置统计采样间隔
• 容器过滤选项：--matchByName/--matchByImage/--skipByName/--skipByImage

嵌入式使用

1. 安装：npm install docker-logentries --save
2. 在JS文件中使用：

javascript
var logentries = require('docker-logentries')({
  json: false, // 设为true以解析JSON格式日志行
  secure: true, // 设为false以使用纯TCP连接
  token: process.env.TOKEN, // Logentries令牌
  newline: true, // 按换行符分割日志条目
  stats: true, // 设为false禁用统计
  add: null, // 要添加到发布数据的对象

  // 以下选项限制匹配的容器，避免收集不需要的容器日志
  matchByName: /hello/, // 可选，按名称匹配
  matchByImage: /matteocollina/, // 可选，按镜像匹配
  skipByName: /.*pasteur.*/, // 可选，按名称排除
  skipByImage: /.*dockerfile.*/ // 可选，按镜像排除
})

// logentries是包含所有日志行的源流

setTimeout(function() {
  logentries.destroy()
}, 5000)

从源码构建镜像

使用普通Dockerfile

首先克隆仓库，然后：

bash
docker build -t logentries .

docker run -v /var/run/docker.sock:/var/run/docker.sock \
           --read-only \
           --security-opt=no-new-privileges \
           logentries \
           -t <TOKEN> \
           -j \
           -a host=`uname -n`

使用Make - 基于官方nodejs onbuild镜像

bash
export BUILD_TYPE=node-onbuild
make build
make test
make tag

使用Make - Alpine Linux构建（约42Mb）

bash
export BUILD_TYPE=alpine-node
make build
make test
make tag

推送到私有仓库

本地构建、测试和标记后：

bash
export DOCKER_REGISTRY_PREFIX=your-dockerhub-user/yourimage-name
make push

工作原理

该模块包装了四个Docker API：

• POST /containers/{id}/attach：获取日志
• GET /containers/{id}/stats：获取容器统计信息
• GET /containers/json：检测模块启动时正在运行的容器
• GET /events：检测模块启动后新启动的容器

模块使用https://github.com/mcollina/docker-loghose%E5%92%8Chttps://github.com/pelger/docker-stats%E8%8E%B7%E5%8F%96%E6%97%A5%E5%BF%97%E5%92%8C%E7%BB%9F%E8%AE%A1%E4%BF%A1%E6%81%AF%EF%BC%8C%E5%BD%A2%E6%88%90%E6%8C%81%E7%BB%AD%E6%95%B0%E6%8D%AE%E6%B5%81%EF%BC%8C%E5%B9%B6%E9%80%9A%E8%BF%87https://github.com/mcollina/never-ending-stream%E5%A4%84%E7%90%86%E6%89%80%E6%9C%89%E6%BA%90%E8%AF%B7%E6%B1%82%E3%80%82

联系支持

如需帮助，请发送邮件至***。

许可证

MIT