newrelic/mysql-plugin

New Relic MySQL插件

镜像概述和主要用途

这是用于监控MySQL数据库的New Relic插件，与https://rpm.newrelic.com/plugins及GitHub上的https://github.com/newrelic-platform/newrelic_mysql_java_plugin完全一致，但打包为Docker容器镜像以简化部署和使用。使用前需拥有有效的New Relic账户和New Relic许可证密钥。

核心功能和特性

• 监控MySQL数据库关键性能指标
• 通过环境变量实现灵活配置
• 支持HTTP代理环境下的网络连接
• 可监控MySQL主从复制状态（如复制延迟、中继日志量）
• 日志输出至Docker日志系统，避免占用容器文件系统

使用场景和适用范围

• 需要对MySQL数据库进行性能监控的生产环境
• 采用Docker容器化部署监控工具的场景
• 需要集中管理MySQL主从复制状态的环境

使用方法和配置说明

环境变量配置

必选环境变量

• NEW_RELIC_LICENSE_KEY: New Relic账户的许可证密钥
• AGENT_HOST: MySQL数据库主机地址
• AGENT_USER: 用于连接MySQL的用户名
• AGENT_PASSWD: 用于连接MySQL的密码

可选环境变量

• NEW_RELIC_LOG_LEVEL: 日志级别，默认值为info
• AGENT_NAME: 插件报告的名称，用于标识不同的监控实例
• AGENT_METRICS: 监控指标集，详情参见https://github.com/newrelic-platform/newrelic_mysql_java_plugin/blob/master/config/metric.category.json，默认值为`newrelic,status`

部署示例

shell
$ docker run -d \
  -e NEW_RELIC_LICENSE_KEY=你的许可证密钥 \
  -e AGENT_HOST=你的数据库主机地址 \
  -e AGENT_USER=newrelic \
  -e AGENT_PASSWD=你的数据库密码 \
  newrelic/mysql-plugin

额外配置

HTTP代理

若插件部署在需通过代理访问外部网络的环境，可配置以下环境变量：

• PROXY_HOST: 代理服务器主机地址（如webcache.example.com）
• PROXY_PORT: 代理服务器端口，若设置了PROXY_HOST则默认值为80
• PROXY_USERNAME: 代理服务器认证用户名
• PROXY_PASSWORD: 代理服务器认证密码

监控MySQL复制

默认不监控复制相关指标（如复制延迟、中继日志量）。需通过修改AGENT_METRICS变量启用：

• MySQL从库：AGENT_METRICS="newrelic,status,slave"
• MySQL主库：AGENT_METRICS="newrelic,status,master"

日志和故障排除

容器内不存储本地日志，所有日志均发送至Docker日志系统。默认日志级别为info，排查问题时可设置NEW_RELIC_LOG_LEVEL=debug。

若插件无法正常上报数据，建议使用终端模式运行（替换-d为-t）以实时查看日志：

shell
docker run -t \
  -e NEW_RELIC_LOG_LEVEL=debug \
  -e NEW_RELIC_LICENSE_KEY=你的许可证密钥 \
  -e AGENT_HOST=你的数据库主机地址（可故意设置错误地址测试连接） \
  -e AGENT_USER=newrelic \
  -e AGENT_PASSWD=你的数据库密码 \
  docker.xuanyuan.run/newrelic/mysql-plugin

贡献

欢迎提交pull请求。提交即表示您授予New Relic非排他、不可撤销、免费的许可，允许其在产品中使用代码、算法、专利及相关思想。代码按原样提供，不保证其适用于任何特定用途或正确性。