Debug线上服务

• 1. 日志
• 2. pprof
  • 2.1 步骤概览
  • 2.2 常见的 pprof 端点
  • 2.3 使用示例
  • 2.4 注意事项
• 3. 使用delve
  • 3.1 步骤概览
  • 3.2 示例
  • 3.3 注意事项

对于已上线的 Go 服务，进行调试通常需要在代码中添加调试信息或者利用已有的日志系统。由于直接使用调试器可能会影响服务的性能或者稳定性，因此需要采用一些谨慎的方法。

1. 日志

在线上服务中，通过日志进行调试是一种常见的方法。以下是一些常用的方法，可以让我们通过日志来进行线上服务的调试：

1. 设置详细的日志级别：
   • 在开发和测试环境中，我们可能会使用较低的日志级别，例如 debug 或 trace，以记录详细的调试信息。
   • 在生产环境，我们可以使用较高的日志级别，例如 info 或 warn，以减少日志量并降低性能开销。
2. 记录关键路径信息：
   • 在代码的关键路径上插入日志语句，这样我们可以追踪程序的执行流程。
   • 记录输入参数和输出结果，以便我们在需要时能够还原问题。
3. 使用结构化日志：
   • 结构化日志使得日志信息更易读和过滤。比如，使用 JSON 或者 key-value 格式。
   • zap 等日志库提供了结构化日志的支持。
4. 记录错误信息：
   • 记录错误时，包含足够的上下文信息，如堆栈跟踪和错误消息。
   • 使用 error 日志级别或更高级别记录错误信息。
5. 配置动态日志级别：
   • 在生产环境中，可以考虑实现动态日志级别调整的功能，以便在需要时能够动态地调整日志级别，而无需重启应用程序。
6. 使用上下文标识符：
   • 在日志中包含上下文标识符，如请求 ID，以便能够追踪相关的日志。
   • 将相关的日志关联到一起，以便更容易地理解问题。
7. 集中化日志：
   • 将日志集中存储在中央位置，如日志服务器或云服务，以便能够更容易地检索和分析。
8. 实时日志查看：
   • 在线上环境中实现实时日志查看功能，以便能够及时地查看日志输出。
   • 使用工具如 ELK Stack（Elasticsearch, Logstash, Kibana）进行实时日志分析。
9. 监控和告警：
   • 设置监控指标，如日志条数、错误频率等，以便能够及时发现问题。
   • 设置告警规则，确保在异常情况下能够及时通知相关人员。
10. 使用 A/B 测试：
    • 在某些情况下，通过 A/B 测试逐步引入日志，以降低对性能的影响。
    • 注意在测试后及时关闭或调整日志记录。

通过以上策略，我们可以更有效地使用日志来进行线上服务的调试和监控。请注意，在生产环境中，要小心处理敏感信息，确保日志中不包含敏感数据。

2. pprof

Go 语言内置了 pprof 包，提供了强大的性能分析功能，通过结合不同的端点，我们可以查看 CPU 使用情况、内存分配情况、goroutine 状态等，这有助于发现和解决线上服务的性能问题。但这样的端点应该受到适当的保护，以免被未授权的用户访问。

2.1 步骤概览

1. 在代码中导入 net/http/pprof 包：
   • 在你的代码中导入 net/http/pprof 包，以便能够通过 HTTP 端点访问 pprof 提供的数据。

    import _ "net/http/pprof"
   

2. 注册 pprof 路由：
   • 在你的 HTTP 路由中注册 pprof 的路由。

    import (
        "net/http"
        _ "net/http/pprof"
    )
   
    func main() {
        go func() {
            http.ListenAndServe("localhost:6060", nil)
        }()
   
        // Your server logic here
    }
   

3. 在服务上添加配置：
   • 确保你的服务在某个端口（例如 6060）上启动了 pprof。
4. 在线上服务中访问 pprof 数据：
   • 在浏览器中访问 http://your-service-address:6060/debug/pprof/ 来查看 pprof 提供的数据。

2.2 常见的 pprof 端点

• /debug/pprof/：显示所有可用的 pprof 端点列表。
• /debug/pprof/profile：生成 CPU 采样文件。
• /debug/pprof/heap：查看堆内存分配情况。
• /debug/pprof/goroutine：查看 goroutine 的堆栈跟踪。
• /debug/pprof/block：查看导致阻塞的堆栈跟踪。
• /debug/pprof/threadcreate：查看线程创建的堆栈跟踪。

2.3 使用示例

1. 生成 CPU 采样文件：

    go tool pprof http://your-service-address:6060/debug/pprof/profile
   

2. 查看堆内存分配情况：

    go tool pprof http://your-service-address:6060/debug/pprof/heap
   

3. 查看 goroutine 的堆栈跟踪：

    go tool pprof http://your-service-address:6060/debug/pprof/goroutine
   

4. 查看导致阻塞的堆栈跟踪：

    go tool pprof http://your-service-address:6060/debug/pprof/block
   

2.4 注意事项

• 访问 pprof 端点可能需要合适的权限或身份验证，确保你的线上环境中已经配置了适当的安全策略。
• 在生产环境中，避免一直开启 pprof，而是在需要时启用并及时关闭。
• 谨慎处理 pprof 提供的信息，避免泄露敏感信息。

3. 使用delve

Delve是一款用于Go语言的调试工具，它可以实现类似Visual Studio的断点调试功能，并可以用来在程序崩溃时生成Coredump文件。Delve适合用于调试Web Server等应用场景。通过Delve，我们可以在程序运行时查看变量的值、执行流程和函数调用堆栈等信息，从而帮助快速定位和解决问题。Delve的使用非常灵活，可以在编写代码时进行调试，也可以在程序已经运行时进行调试。此外，Delve还支持远程调试功能，可以方便地对部署在远程服务器上的Go应用程序进行调试。

3.1 步骤概览

1. 在代码中导入 github.com/go-delve/delve/service 包：
   • 在你的代码中导入 Delve 的服务包。

    import _ "github.com/go-delve/delve/service"
   

2. 使用 dlv 启动 Delve 服务器：
   • 在服务器上运行 dlv 命令，启动 Delve 服务器。

    dlv --listen=:2345 --headless=true --api-version=2 exec ./your-binary
   

   • 注意：确保防火墙或网络策略允许在指定的端口上进行调试。
3. 在本地使用 Delve 进行调试：
   • 在本地终端中运行 Delve 客户端，连接到远程 Delve 服务器。

    dlv connect remote-server:2345
   

   • 在本地可以使用 Delve 的调试功能了。

3.2 示例

1. 在远程服务器上启动 Delve 服务器：

    dlv --listen=:2345 --headless=true --api-version=2 exec ./your-binary
   

2. 在本地连接到 Delve 服务器：

    dlv connect remote-server:2345
   

3. 在本地使用 Delve 进行调试：

    # 设置断点
    break main.main
   
    # 运行
    continue
   
    # 查看变量
    print variableName
   
    # 等等...
   

3.3 注意事项

• 安全性：在生产环境中谨慎使用 Delve，因为它会暴露调试器接口，可能导致潜在的安全问题。最好只在需要时启用，并在调试完成后关闭。
• 网络策略：确保服务器上的网络策略或防火墙允许远程 Delve 服务器的监听端口被本地 Delve 客户端访问。
• 版本兼容性：确保你使用的 Delve 版本与你的 Go 版本兼容。
• 稳定性：Delve 的稳定性可能因版本而异，建议在生产环境中使用时进行充分的测试。

声明：本作品采用署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0)进行许可，使用时请注明出处。
Author: mengbin
blog: mengbin
Github: mengbin92
cnblogs: 恋水无意
腾讯云开发者社区：孟斯特