maulc/docker-logentries

docker-logentries

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

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

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

镜像概述和主要用途

docker-logentries是一个用于将Docker容器的日志、统计信息和事件转发至Logentries平台的工具。它提供多种使用方式，包括作为Docker容器运行、作为命令行工具(CLI)使用或嵌入到Node.js应用中，实现容器日志的集中收集与管理。

核心功能和特性

• 多类型数据转发：支持容器日志、统计信息和事件的转发
• 灵活的过滤机制：可通过容器名称或镜像的正则表达式筛选需要转发的容器
• JSON格式支持：可解析JSON格式日志（如bunyan日志）
• 自定义附加字段：允许添加固定键值对到转发数据中
• 统计采样：支持统计信息的降采样，收集样本并取平均值后发送
• 环境适应性：支持受限环境（如Google Compute Engine）的特权模式运行

使用场景和适用范围

• Docker容器日志的集中管理与监控
• 容器性能统计数据的实时分析
• Docker事件跟踪与审计
• 需要将多容器日志聚合到Logentries平台的场景
• 适用于Docker 1.5及以上版本（低于1.5版本需使用--no-stats标志）

使用方法和配置说明

作为容器运行

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

sh
docker run -v /var/run/docker.sock:/var/run/docker.sock logentries/docker-logentries -t <TOKEN> -j -a host=`uname -n`

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

sh
docker run -v /var/run/docker.sock:/var/run/docker.sock logentries/docker-logentries -l <LOGSTOKEN> -k <STATSTOKEN> -e <EVENTSTOKEN> -j -a host=`uname -n`

常用参数说明

• --no-stats：不每秒向Logentries发布统计信息（Docker版本<1.5必需）
• --no-logs：不向Logentries发布日志
• --no-dockerEvents：不向Logentries发布事件
• -i/--statsinterval <STATSINTERVAL>：对发送到Logentries的统计信息进行降采样
• -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 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、-i/--statsinterval、-a/--add及容器过滤参数）

嵌入式使用

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

javascript
var logentries = require('docker-logentries')({
  json: false, // 设为true以解析JSON格式行
  secure: false, // 设为true以使用安全连接
  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 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%E6%9D%A5%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%E3%80%82%E6%89%80%E6%9C%89%E5%8E%9F%E5%A7%8B%E8%AF%B7%E6%B1%82%E9%83%BD%E5%B0%81%E8%A3%85%E5%9C%A8https://github.com/mcollina/never-ending-stream%E4%B8%AD%E3%80%82

许可证

MIT