1. 项目概述为什么我们需要为Ansible日志着色如果你和我一样长期在Windows环境下使用Notepad作为主力文本编辑器同时又深度依赖Ansible进行自动化运维那你一定对下面这种场景不陌生一个Playbook执行后生成的日志文件动辄几百上千行黑底白字的纯文本里错误信息、调试信息、成功提示全都混在一起。每次排查问题眼睛都得像雷达一样在一堆ok、changed、fatal和skipping里扫描效率低下不说还特别容易看漏关键信息。这就是“Notepad自定义ansible输出log日志颜色”这个项目要解决的核心痛点。它不是一个简单的“换肤”游戏而是一个提升运维效率和降低人为失误的实用技巧。通过为Ansible日志中的不同状态成功、变更、失败、跳过等定义独特的颜色高亮我们可以瞬间在视觉上区分出任务的执行结果。想象一下打开日志文件所有失败的任务都以醒目的红色高亮所有成功的任务以柔和的绿色显示所有发生变更的任务用黄色标记——问题在哪一目了然。这比任何复杂的日志分析脚本在初期排查时都更直观、更快速。这个方案特别适合运维工程师、DevOps从业者以及任何需要频繁查看Ansible执行日志的开发者。它无需改动Ansible本身的输出也无需引入额外的日志聚合工具仅仅通过配置你手边最熟悉的编辑器就能获得立竿见影的效果。下面我将带你从零开始一步步实现这个功能并分享我在实践中总结的配置技巧和避坑指南。2. 核心思路与方案选型为何选择自定义语言定义要实现日志着色通常有几种思路使用支持Ansible插件的专用IDE如VS Code、编写外部脚本预处理日志、或者利用文本编辑器的高亮功能。我选择Notepad的“自定义语言”功能主要基于以下几点考量2.1 方案对比与选型理由专用IDE插件VS Code等编辑器确实有优秀的Ansible插件能提供语法高亮、代码提示等。但对于查看生成的纯文本日志文件这一特定场景专门打开一个重型IDE有时显得笨重且插件的高亮规则可能无法完美匹配你实际输出的日志格式尤其是包含了时间戳、主机名等前缀的复杂行。外部预处理脚本可以写一个Python或Shell脚本读取日志用ANSI颜色码包裹不同内容后再输出。这增加了处理链条的复杂度需要额外执行命令且颜色信息可能无法在普通文本文件中持久化保存。Notepad自定义语言这是最轻量、最直接、最持久的方案。Notepad本身轻快启动迅速。“自定义语言”功能允许你基于关键词、运算符、分隔符等规则为特定格式的文件定义一套完整的高亮方案。一旦定义好并关联到.log或.txt后缀以后所有同类型文件打开即自动高亮无需任何额外操作。它直接作用于文件本身不修改原内容只是改变了显示方式完美契合“快速查看、直观分析”的需求。2.2 Notepad自定义语言的工作原理简单来说你可以告诉Notepad“当你看到包含单词fatal的行就把整行染成红色看到ok但后面不接changed的染成绿色。” 这是通过一个XML格式的“用户自定义语言”文件来实现的。该文件定义了分隔符如空格、冒号、方括号等用于划分词汇。关键字列表你可以定义多个列表如List 1, List 2...每个列表可以设置一种颜色和字体样式。我们可以把Ansible的状态词分别放入不同的列表。注释与运算符对于日志着色这部分通常用不上。我们的核心策略就是为Ansible输出中常见的状态关键词ok,changed,fatal,failed,skipping,ignoring等分配不同的颜色并合理设置匹配规则避免误匹配。注意Ansible的默认输出颜色是在终端中由ansible.cfg中的[colors]部分控制的但这只影响执行时的屏幕输出。我们处理的是已经写入文件的、不带颜色代码的纯文本日志。因此我们的着色是完全基于文本模式的匹配是编辑器端的“再渲染”。3. 实操准备理解Ansible日志格式与捕获方法在动手配置之前我们必须先明确我们要着色的对象到底是什么样子。Ansible的输出格式会根据你的设置是否使用-o或--output是否使用了stdout_callback插件而有所不同。3.1 典型Ansible日志行格式分析最常见的日志行格式如下来自于将Ansible执行输出重定向到文件ansible-playbook site.yml -i inventory.ini ansible_run.log 21或者使用tee命令同时输出到屏幕和文件ansible-playbook site.yml -i inventory.ini | tee ansible_run.log此时日志文件中的行通常类似于PLAY [配置所有Web服务器] ********************************************************** TASK [Gathering Facts] ********************************************************* ok: [web-server-01] ok: [web-server-02] TASK [确保nginx服务已安装] ****************************************************** changed: [web-server-01] ok: [web-server-02] TASK [启动nginx服务] ************************************************************ fatal: [web-server-01]: FAILED! {changed: false, msg: Could not find the requested service nginx: host} ... (错误堆栈信息) ... skipping: [web-server-02] PLAY RECAP ********************************************************************* web-server-01 : ok2 changed1 unreachable0 failed1 skipped0 rescued0 ignored0 web-server-02 : ok3 changed0 unreachable0 failed0 skipped1 rescued0 ignored03.2 关键模式提取我们需要从中提取出需要高亮的关键模式状态词通常位于行首或主机名之后如ok:、changed:、fatal:、failed!、skipping:、ignoring:。PLAY和TASK标题行以PLAY [或TASK [开头。我们可以为它们设置一种颜色如蓝色以区分结构。错误堆栈fatal或failed行之后通常跟随多行以 {开头或包含大量错误信息的行。为这些行统一着色如浅红色背景会非常有帮助。PLAY RECAP 总结行以主机名 : ok开头的行包含了最终统计。3.3 高级日志捕获与格式化建议为了获得更整洁、更易于着色的日志我强烈建议在运行Ansible时进行一些优化使用no_log参数保护敏感信息在task中如果涉及密码等敏感数据务必设置no_log: true防止其被明文记录到日志中干扰视线也带来安全风险。考虑使用stdout_callback插件Ansible支持自定义输出回调插件。例如yaml或json回调插件可以将输出格式化为结构化的YAML或JSON虽然对于纯文本高亮可能更复杂但如果你需要后续用脚本解析日志这会非常有用。对于我们的着色目的默认的default回调产生上述文本格式是最合适的。时间戳可以在执行时通过Shell命令为每行添加时间戳但这会增加着色的复杂度因为关键词前面多了前缀。如果确实需要可以在自定义语言规则中考虑时间戳模式。4. 逐步详解创建Notepad Ansible日志着色方案现在进入核心实操环节。我们将手动创建一个XML文件定义我们的自定义语言。4.1 定位Notepad的用户自定义语言目录首先你需要找到Notepad存放用户自定义语言文件的目录。通常路径是C:\Users\你的用户名\AppData\Roaming\Notepad\userDefineLangs或者你可以在Notepad内部通过“语言” - “自定义语言” - “打开自定义语言文件夹”来快速定位。4.2 编写XML定义文件在该目录下创建一个新的XML文件例如命名为AnsibleLog.xml。然后用Notepad或其他文本编辑器打开填入以下内容。我会逐段解释其含义。?xml version1.0 encodingUTF-8 ? NotepadPlus UserLang nameAnsible Log extlog ansible_log txt udlVersion2.1 Settings Global caseIgnoredyes allowFoldOfCommentsno foldCompactno forcePureLC0 decimalSeparator0 / Prefix Keywords1no Keywords2no Keywords3no Keywords4no Keywords5no Keywords6no Keywords7no Keywords8no / /Settings KeywordLists Keywords nameComments00## 01 02## 03/Keywords !-- List 1: 成功与正常信息 (绿色) -- Keywords nameNumbers, operatorsok:/Keywords !-- List 2: 变更信息 (黄色/橙色) -- Keywords nameKeywords1changed:/Keywords !-- List 3: 致命错误与失败 (红色) -- Keywords nameKeywords2fatal: failed!/Keywords !-- List 4: 跳过与忽略 (灰色或青色) -- Keywords nameKeywords3skipping: ignoring:/Keywords !-- List 5: PLAY/TASK 标题 (蓝色) -- Keywords nameKeywords4PLAY TASK/Keywords !-- List 6: PLAY RECAP 开头 (紫色) -- Keywords nameKeywords5PLAY RECAP/Keywords !-- List 7: 错误堆栈标识 (粉红色) -- Keywords nameKeywords6 {/Keywords !-- List 8: 主机名或IP (亮黑色/深青色) -- Keywords nameKeywords7[/Keywords /KeywordLists Styles WordsStyle nameDEFAULT styleID11 fgColor000000 bgColorFFFFFF fontName fontStyle0 fontSize10 / WordsStyle nameCOMMENTS styleID9 fgColor008000 bgColorFFFFFF fontName fontStyle0 / !-- List 1 样式成功 - 绿色 -- WordsStyle nameOPERATORS styleID10 fgColor008000 bgColorFFFFFF fontName fontStyle1 / !-- List 2 样式变更 - 橙色 -- WordsStyle nameKEYWORDS1 styleID5 fgColorFF8000 bgColorFFFFFF fontName fontStyle1 / !-- List 3 样式失败 - 红色 -- WordsStyle nameKEYWORDS2 styleID4 fgColorFF0000 bgColorFFFFFF fontName fontStyle1 / !-- List 4 样式跳过 - 灰色 -- WordsStyle nameKEYWORDS3 styleID3 fgColor808080 bgColorFFFFFF fontName fontStyle0 / !-- List 5 样式标题 - 蓝色 -- WordsStyle nameKEYWORDS4 styleID6 fgColor0000FF bgColorFFFFFF fontName fontStyle1 / !-- List 6 样式RECAP - 紫色 -- WordsStyle nameKEYWORDS5 styleID7 fgColor800080 bgColorFFFFFF fontName fontStyle0 / !-- List 7 样式错误堆栈 - 粉红 -- WordsStyle nameKEYWORDS6 styleID8 fgColorFF00FF bgColorFFFFFF fontName fontStyle0 / !-- List 7 样式主机名括号 - 深青色 -- WordsStyle nameKEYWORDS7 styleID2 fgColor008080 bgColorFFFFFF fontName fontStyle0 / /Styles /UserLang /NotepadPlus4.3 配置文件关键点解析UserLang属性nameAnsible Log这是在Notepad语言菜单中显示的名称。extlog ansible_log txt将此语言定义关联到.log,.ansible_log,.txt后缀的文件。你可以根据需要添加或修改。KeywordLists部分这里定义了8个关键词列表。Keywords nameComments和Numbers, operators是内置列表名有特殊含义。我们从Keywords1开始是自定义列表。我们将不同的Ansible状态词分配到不同的列表以便为它们分别设置样式。注意匹配的精确性例如ok:后面有冒号这是为了避免匹配到单词中间出现的“ok”。failed!包含了感叹号因为Ansible输出中失败的行通常显示为FAILED!。Styles部分这里为每个列表以及默认文本、注释等定义显示样式。styleID是Notepad内部的样式标识我们只需确保与KeywordLists中的名称对应即可如KEYWORDS1对应Keywords1列表。fgColor和bgColor是十六进制的颜色代码格式为RRGGBB。你可以根据个人喜好修改。我提供的配色方案是经过验证比较护眼的008000深绿色成功FF8000橙色变更FF0000红色失败808080灰色跳过0000FF蓝色标题800080紫色RECAPFF00FF粉红色错误堆栈标识008080深青色主机名括号fontStyle1表示粗体0表示常规。4.4 导入与启用自定义语言保存AnsibleLog.xml文件后重启Notepad是必须的步骤因为它只会在启动时加载用户自定义语言文件。重启后打开一个Ansible日志文件。然后点击菜单栏的“语言” - “A” - “Ansible Log”。你应该立即看到日志文件按照我们的规则被着色了。如果“语言”菜单下没有出现“Ansible Log”请检查XML文件是否保存在正确的userDefineLangs目录。XML文件语法是否正确可以使用在线XML验证器检查。是否已经重启了Notepad。5. 高级配置与调优技巧基础的着色已经完成但为了应对更复杂的日志和提升体验我们还需要进行一些优化。5.1 处理多行错误堆栈上面的配置只将 {这一行着色为粉红色。但一个错误堆栈往往有多行。Notepad的自定义语言功能对于“区域”Folding高亮支持有限但我们可以通过一个“折衷”技巧将错误堆栈常见的行首模式也加入高亮。观察错误堆栈其后续行往往以多个空格或\开头。我们可以修改Keywords6列表加入一些常见模式Keywords nameKeywords6 { \ msg\: \ stderr\: \ stdout\:/Keywords这样包含这些常见错误信息字段的行也会被高亮为粉红色使得整个错误块在视觉上更连贯。5.2 区分“ok”与“ok (changed)”有时一个任务状态是ok:但可能因为changed_when或failed_when的条件判断而实际发生了变化。在日志中它们都显示为ok:。我们的规则无法从文本上区分。这是一个已知限制。如果你需要严格区分一个办法是修改Ansible的输出回调插件在ok但实际已变更时输出不同的关键词如ok_changed:但这超出了编辑器着色的范畴。对于大多数情况将ok:统一视为成功绿色是可接受的。5.3 为特定主机或任务组着色如果你经常关注特定主机如db-master-01或特定任务如包含[部署应用]字样的任务可以为他们创建单独的规则。例如将db-master-01添加到Keywords7主机名样式列表中或者创建一个新的关键词列表来高亮特定的任务标签。这需要你根据自己 inventory 和 playbook 的命名习惯来定制。5.4 配色方案调整与导出备份Notepad的自定义语言管理器“语言” - “自定义语言” - “自定义…”提供了一个图形化界面可以修改现有语言定义的颜色和字体而无需直接编辑XML。你可以在这里实时调整颜色直到满意为止。非常重要一旦配置满意请务必将AnsibleLog.xml文件备份到云盘或其他安全位置。重装系统或更换电脑时只需将此文件放回对应的userDefineLangs目录即可恢复你的精心配置。6. 常见问题排查与解决方案实录在实际使用中你可能会遇到一些问题。以下是我遇到过的情况及解决方法6.1 着色不生效或部分生效症状选择了“Ansible Log”语言但文本毫无颜色变化。检查1确认文件后缀名是否在extlog ansible_log txt的定义范围内。如果日志文件是.out后缀需要修改XML中的ext属性或重命名文件。检查2确认日志内容是否匹配关键词。例如你的Ansible可能配置了中文输出 ([确定]、[失败])那么就需要将关键词改为中文。关键词是大小写敏感的除非你在Global caseIgnoredyes中设置了忽略。我们的示例中设置了忽略大小写。检查3重启Notepad。这是最常见的原因。症状只有部分关键词被着色比如“ok:”着色了但“changed:”没有。检查打开“语言” - “自定义语言” - “自定义…”在弹出的对话框中选择“Ansible Log”然后查看各个“关键字列表”是否完整以及对应的“样式”颜色是否设置正确。有时图形界面和XML文件可能不同步。6.2 颜色冲突或误匹配症状一行文字被染成了错误的颜色或者一个单词中间不该高亮的部分被高亮了。原因关键词定义不够精确。例如如果你只定义了ok作为关键词那么像broken单词里的ok也会被高亮。解决尽量使用包含标点符号的完整模式如ok:、[。利用Notepad的“分隔符”设置在自定义语言对话框的“分隔符”选项卡默认的空格、制表符、冒号等作为分隔符能有效防止单词内的部分匹配。6.3 性能问题症状打开非常大的日志文件几十MB以上时Notepad响应变慢或卡顿。原因自定义语言的高亮渲染需要逐行解析匹配文件过大时会有性能开销。解决考虑使用grep、awk或less等命令行工具先过滤出关键部分再在Notepad中查看。对于超大型日志专业的日志查看工具如lnav或ELK等平台可能更合适。Notepad着色更适合日常中小型日志的快速检视。6.4 与其他自定义语言冲突症状之前为其他类型文件如某种自定义配置文件定义的语言干扰了Ansible日志的着色。解决在Notepad的“设置” - “语言” - “文件扩展名”中检查.log扩展名是否被关联到了其他语言。确保它关联的是“Normal text”或者我们的“Ansible Log”。在“自定义语言”对话框中也可以调整不同语言的优先级。7. 超越基础与其它工具链的集成思路虽然Notepad着色方案已经能解决大部分问题但在更复杂的自动化运维场景中我们可以思考如何将其融入更大的工具链。7.1 与日志聚合工具结合如果你使用Fluentd、Logstash或Vector等日志收集工具可以在收集端就为Ansible日志添加标记字段例如level: ERROR、task_status: changed。然后在展示端如Grafana或Kibana利用这些字段进行着色和过滤这比文本匹配更强大、更准确。7.2 编写脚本预处理日志可以编写一个简单的Python脚本在Ansible执行后自动处理日志文件使用正则表达式精确匹配状态行。在匹配行前插入ANSI颜色码例如\033[31m表示红色。输出一个带有颜色码的新文件。在支持ANSI颜色的终端如Windows Terminal, Git Bash中直接用cat或less -R查看这个新文件就能看到彩色输出。这个脚本甚至可以集成到你的CI/CD流水线中。7.3 探索其他编辑器的方案VS Code你可以基于TextMate语法.tmLanguage创建自己的Ansible日志高亮插件功能更强大支持更复杂的嵌套规则和范围匹配。Sublime Text同样支持自定义语法高亮.sublime-syntax文件原理类似。Vim/Neovim通过编写或配置syntax/ansiblelog.vim语法文件可以实现极其精细和高效的高亮并且完全在终端内完成无需GUI。这些方案比Notepad的方案更灵活但配置复杂度也更高。Notepad方案的优势在于其简单、直接、零依赖在Windows图形化环境下开箱即用对于专注于快速查看日志的运维人员来说往往是性价比最高的选择。经过以上步骤你应该已经拥有一个能显著提升Ansible日志阅读效率的Notepad环境了。这套自定义着色方案就像给你的日志装上了高亮雷达能让问题点自动“跳”到你眼前。我自己的经验是在配置好之后排查Playbook执行问题的平均时间至少缩短了三分之一尤其是在处理包含数十个任务的复杂Playbook时视觉疲劳大大减轻。最关键的是这个方案完全属于你你可以随时根据团队的习惯或个人的审美调整颜色和匹配规则打造最趁手的运维利器。