编者注:New Relic CLI工具是由IBM开发的。它是开源的Apache 2.0许可。
帮助我们的客户走得更快的信心是一个关键的原则,新Relic的精神。我们提供重要数据、统计数据和关键绩效指标(kpi)的可见性,以帮助团队提高部署速度和节奏。但是现代的软件团队也看到了自动化和持续集成和持续交付(CI/CD)流程是支持他们的敏捷实践和DevOps团队的必备工具。团队希望应用相同的自动化概念和工具来操作New Relic,就像他们在管道的其他部分上所做的那样。
但是,要编写所有需要使用的标准样板代码New Relic的REST API(读取配置文件、连接到端点、发送有效负载、接收响应并解析它们)可能是一项繁重的负担和不必要的干扰。幸运的是,IBM云监控团队他注意到多个内部团队为了自动化他们的新Relic工作流程而花费了太多的时间来管理样板代码,所以他们创建了一个解决方案来解决这个问题——一个新的Relic CLI(命令行界面)工具。
通过CLI管理New Relic任务和资源
New Relic CLI它是一个命令行工具,您可以使用它管理新的Relic资源,例如New Relic的人工合成物显示器,New Relic的警报策略和条件,以及用户帐户。您还可以使用CLI备份您的New Relic配置数据,并根据需要进行恢复。
目前,你可以使用New Relic CLI来管理这些资源:
New Relic的资源 | 管理的行动 |
---|---|
New Relic的人工合成物 | 创建、编辑和删除合成监视器 |
#行宽# | 备份和恢复合成监视器 |
New Relic的警报 | 创建、编辑和删除警报条件 |
#行宽# | 创建、编辑和删除警报策略 |
#行宽# | 创建、编辑和删除通知通道 |
#行宽# | 备份和恢复告警策略和条件 |
New Relic Insights仪表板 | 得到指示板 |
#行宽# | 备份和恢复仪表板 |
用户 | 用户列表 |
示例用例1:创建一个合成监视器
这个例子向你展示了如何使用New Relic CLI创建一个合成监视器:
- 设置New Relic管理API密钥(
NEW_RELIC_APIKEY
)为您的环境。这取决于你的操作系统,但在Linux中,你可以使用export命令:出口NEW_RELIC_APIKEY = xxxx-xxxxxxx-xxxxx-xxxxxx
提示:请参阅新文物文献以获得指示定位您的管理API密钥。
- 以JSON格式创建监视器的基本定义(例如
test.json
)。{" name ":“测试monitorURI,“type”:“SIMPLE”“frequency”:5,“uri”:“monitorURI”、“地点”:[“AWS_AP_SOUTH_1”、“AWS_EU_WEST_3”,“AWS_US_WEST_1”),“状态”:“启用”、“slaThreshold”:3,“选项”:{}
提示:请参阅文档公共仆从地点的完整列表。
- 运行文本替换以替换
monitorURI
使用您想要测试的实际URL,并生成一个新文件(在本例中,result.json
)。.awk '{gsub(/monitorURI/,"<要测试的URL >")}1'测试。json > result.json
- 要创建新的监视器,请运行
./nr-cli create monitor -f result.json
从这里开始,您可以根据需要开始使用新的监视器。
示例用例2:合成监视器的每日备份
您还可以使用NewRelic CLI创建合成监视器的每日备份。使用一个简单的shell脚本和一个cron作业,您可以快速设置一个进程,在一个安全的存储库中备份所有的监视器。
这四个步骤描述了如何使用New Relic CLI设置一个每日备份任务,将备份所有监视器到一个单独的文件夹每天:
- 下载备份监视器的shell脚本文件(
backup_monitors.sh
)来自New Relic CLI repo。 - 为脚本添加合适的路径,并将其设置为可执行文件:
$ chmod a+x backup_monitors.sh。
- 在您的操作系统中创建一个新的cron作业来调度刚刚创建的shell脚本。使用
crontab - e
添加新的调度作业。0 0 */1 * * <你的NEW_RELIC_APIKEY="xxx-xxxx-xxx>" /
/backup-monitors.sh 注意:将xxx-xxxx-xxx替换为您自己的NewRelic管理API密钥。
- (可选)如果你不想在cron作业的配置中设置NR API密钥,你可以设置这个密钥
backup_monitors.sh
。注释掉出口NEW_RELIC_APIKEY = " xxx-xxxx-xxx "
条目,用API键替换该值。
cron作业现在应该根据您创建的计划在您的监视器上运行和备份。
一个伟大的添加为您的新遗物工具箱
New Relic CLI还可以让你轻松保存New Relic设置到源码控制工具,如Github或BitBucket;并在多个团队和项目之间共享中心配置和设置。例如,如果您的目标机器不能直接连接到New Relic,您可以配置CLI工具来使用代理。您还可以配置重试以应对超时。CLI还包含返回代码,这对于CI/CD自动化非常有用。
有关开发New Relic CLI的更多细节,请参见在Github回购。