GitHub Copilot 提示文件实现「日志脱敏」:写法与调用
如果你在代码、配置与云环境里反复做日志脱敏,可以考虑把经验沉淀为一个 Skill:写清触发条件、步骤、输出格式和边界,让智能体代劳重复部分,人只负责把关。
本文介绍如何在 GitHub Copilot 指令与提示文件 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。
这个技能做什么
| 项目 | 说明 |
|---|---|
| 技能 | 日志脱敏(log-pii-scrub) |
| 作用 | 检查日志中是否记录了敏感信息并给出脱敏方案 |
| 输入 | 日志样本与代码 |
| 输出 | 脱敏方案 |
| 形态 | 纯提示词 |
| 风险 | 中 |
| 适用人群 | 安全工程师与开发团队 |
处理流程分四步:
- 识别敏感字段
- 定位输出位置
- 设计掩码规则
- 验证效果
这个技能纯指令型,不需要额外脚本或外部连接,复制到大多数平台都能用;属于中等风险:结果会影响业务判断,建议在输出前设置人工审核点。
在 GitHub Copilot 指令与提示文件 中是什么形态
GitHub Copilot 支持仓库级自定义指令文件 .github/copilot-instructions.md,以及放在 .github/prompts/ 下、以 .prompt.md 结尾的可复用提示文件,适合把固定流程交给 Copilot Chat 或智能体模式执行。
仓库级指令对该仓库的对话默认生效;提示文件需要在支持的编辑器中手动调用,具体支持情况以 Copilot 文档为准。
示例配置
.github/prompts/log-pii-scrub.prompt.md 示例(示意):
---
description: 日志脱敏
---
请对我提供的日志样本与代码执行「日志脱敏」:
1. 识别敏感字段
2. 定位输出位置
3. 设计掩码规则
4. 验证效果
输出格式:脱敏方案。
- 扫描结论需人工复核,涉及生产的动作走变更流程。
- 结论中不确定的部分单独列出,标注「需人工确认」。
示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在安全工程师与开发团队提出相关请求时能对上号;二是约束部分要写进「扫描结论需人工复核,涉及生产的动作走变更流程」这类领域规矩,避免智能体自作主张。
安装与启用步骤
- 在
.github/copilot-instructions.md中写入团队通用约定 - 新建
.github/prompts/log-pii-scrub.prompt.md写入本技能流程 - 在编辑器的 Copilot Chat 中调用该提示文件
- 检查输出是否遵循步骤与格式
- 提交到仓库并在 PR 中说明用途
实操:一次完整的运行
假设你在代码、配置与云环境中发出这样的请求(虚构示例):
用日志脱敏技能处理这份日志样本与代码,输出脱敏方案。
智能体识别到任务与「日志脱敏」相关后,会依次识别敏感字段、定位输出位置、设计掩码规则、验证效果。最终交付脱敏方案,并在末尾列出需要人工确认的内容。你的工作是对照原始日志样本与代码抽查两三处关键信息,确认无误后再使用。
测试与验收
在 Copilot Chat 中分别以有、无提示文件的方式处理同一任务,对比差异是否符合预期。
针对这个技能,还建议额外准备:
- 一份信息齐全的标准日志样本与代码,检查输出是否完整
- 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
- 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效
常见坑
- 仓库级指令写得过细,与提示文件互相矛盾。
- 以为提示文件会自动生效,实际需要手动调用。
- 只写了步骤,没写交付格式,导致每次输出的脱敏方案结构不同。
- 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。
延伸阅读
- 日志脱敏 · 定制指南
- 日志脱敏 · AGENTS.md 版
- 日志脱敏 · Function Calling 版
- 内容安全策略 · GitHub Copilot 指令与提示文件 版
- SSH 加固建议 · GitHub Copilot 指令与提示文件 版
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。