通过SkyWalking上报Go应用数据

示例Demo

示例Demo仓库地址：SkyWalking Demo

通过skywalking-go探针上报

1. 下载skywalking-go Agent。

2. 构建Agent。

   cd skywalking-go && make build

3. 在skywalking-go/bin路径下生成可执行文件。

   不同的操作系统对应的可执行文件不同。例如，mac系统需选择skywalking-go-agent--darwin-amd64。

   

4. 打开Go项目，在main package中导入skywalking module。

   方式一

   package main
   
   import (
   	_ "github.com/apache/skywalking-go"
   )

   方式二

   skywalking-go/bin/skywalking-go-agent--darwin-amd64 -inject path/to/your-project

5. 配置config.yaml文件。

   您可以参考示例Demo的skywalking-go/tools/go-agent/config/config.default.yaml文件修改。

   展开查看config.default.yaml文件示例

   agent:
     # Service name is showed in UI.
     service_name: ${SW_AGENT_NAME:Your_ApplicationName}
     # To obtain the environment variable key for the instance name, if it cannot be obtained, an instance name will be automatically generated.
     instance_env_name: SW_AGENT_INSTANCE_NAME
     # Sampling rate of tracing data, which is a floating-point value that must be between 0 and 1.
     sampler: ${SW_AGENT_SAMPLE:1}
     meter:
       # The interval of collecting metrics, in seconds.
       collect_interval: ${SW_AGENT_METER_COLLECT_INTERVAL:20}
   
   reporter:
     grpc:
       # The gRPC server address of the backend service.
       backend_service: ${SW_AGENT_REPORTER_GRPC_BACKEND_SERVICE:127.0.0.1:11800}
       # The maximum count of segment for reporting tracing data.
       max_send_queue: ${SW_AGENT_REPORTER_GRPC_MAX_SEND_QUEUE:5000}
       # The interval(s) of checking service and backend service
       check_interval: ${SW_AGENT_REPORTER_GRPC_CHECK_INTERVAL:20}
       # The authentication string for communicate with backend.
       authentication: ${SW_AGENT_REPORTER_GRPC_AUTHENTICATION:}
       # The interval(s) of fetching dynamic configuration from backend.
       cds_fetch_interval: ${SW_AGENT_REPORTER_GRPC_CDS_FETCH_INTERVAL:20}
       tls:
         # Whether to enable TLS with backend.
         enable: ${SW_AGENT_REPORTER_GRPC_TLS_ENABLE:false}
         # The file path of ca.crt. The config only works when opening the TLS switch.
         ca_path: ${SW_AGENT_REPORTER_GRPC_TLS_CA_PATH:}
         # The file path of client.pem. The config only works when mTLS.
         client_key_path: ${SW_AGENT_REPORTER_GRPC_TLS_CLIENT_KEY_PATH:}
         # The file path of client.crt. The config only works when mTLS.
         client_cert_chain_path: ${SW_AGENT_REPORTER_GRPC_TLS_CLIENT_CERT_CHAIN_PATH:}
         # Controls whether a client verifies the server's certificate chain and host name.
         insecure_skip_verify: ${SW_AGENT_REPORTER_GRPC_TLS_INSECURE_SKIP_VERIFY:false}
   
   log:
     # The type determines which logging type is currently used by the system.
     # The Go agent wourld use this log type to generate custom logs. It supports: "auto", "logrus", or "zap".
     # auto: Automatically identifies the source of the log.
     #       If logrus is present in the project, it wourld automatically use logrus.
     #       If zap has been initialized in the project, it would use the zap framework.
     #       By default, it would use std errors to output log content.
     # logrus: Specifies that the Agent should use the logrus framework.
     # zap: Specifies that the Agent should use the zap framework.
     # The system must have already been initialized through methods such as "zap.New", "zap.NewProduction", etc.
     type: ${SW_AGENT_LOG_TYPE:auto}
     tracing:
       # Whether to automatically integrate Tracing information into the logs.
       enable: ${SW_AGENT_LOG_TRACING_ENABLE:true}
       # If tracing information is enabled, the tracing information would be stored in the current Key in each log.
       key: ${SW_AGENT_LOG_TRACING_KEY:SW_CTX}
     reporter:
       # Whether to upload logs to the backend.
       enable: ${SW_AGENT_LOG_REPORTER_ENABLE:true}
       # The fields name list that needs to added to the label of the log.(multiple split by ",")
       label_keys: ${SW_AGENT_LOG_REPORTER_LABEL_KEYS:}
   
   plugin:
     # List the names of excluded plugins, multiple plugin names should be splitted by ","
     # NOTE: This parameter only takes effect during the compilation phase.
     excluded: ${SW_AGENT_PLUGIN_EXCLUDES:}
     config:
       http:
         # Collect the parameters of the HTTP request on the server side
         server_collect_parameters: ${SW_AGENT_PLUGIN_CONFIG_HTTP_SERVER_COLLECT_PARAMETERS:false}
       mongo:
         # Collect the statement of the MongoDB request
         collect_statement: ${SW_AGENT_PLUGIN_CONFIG_MONGO_COLLECT_STATEMENT:false}
       sql:
         # Collect the parameter of the SQL request
         collect_parameter: ${SW_AGENT_PLUGIN_CONFIG_SQL_COLLECT_PARAMETER:false}
   

   设置参数有以下两种方式，例如，如果要配置service_name，配置方法如下：

   方式一（推荐）：直接在config.yaml中添加参数

   agent:
     service_name: ${SW_AGENT_NAME:<your_service_name>}

   方式二：配置系统环境变量

   export SW_AGENT_NAME=<your_service_name>

   接入可观测链路 OpenTelemetry 版控制台需要设置以下参数：

   • service_name: ${SW_AGENT_NAME:Your_ApplicationName}：服务名称。

   • backend_service: ${SW_AGENT_REPORTER_GRPC_BACKEND_SERVICE:127.0.0.1:11800}：接入点的Endpoint。

   • authentication: ${SW_AGENT_REPORTER_GRPC_AUTHENTICATION:}：接入点鉴权Token。

   skywalking-go Agent默认对所有的插件自动埋点，若需要移除特定插件，可以设置excluded参数，例如：

   # 如果想要关闭sql plugin
   plugin:
     excluded: ${SW_AGENT_PLUGIN_EXCLUDES:sql}
   
   # 如果想同时关闭多个plugin，使用,分隔
   plugin:
     excluded: ${SW_AGENT_PLUGIN_EXCLUDES:sql,gorm}

6. 重新构建项目。

   # 需要使用-toolexec
   sudo go build -toolexec "path/to/skywalking-go-agent -config path/to/config.yaml" -a

   • path/to/skywalking-go-agent：上文步骤1可执行文件的绝对路径。

   • path/to/config.yaml：skywalking-go Agent的参数配置文件的绝对路径。

7. 启动项目。此时SkyWalking数据将会上报至可观测链路 OpenTelemetry 版控制台。

参考信息

skywalking-go探针的部分属性列表，NULL表示默认值未设置：

通过Go2Sky探针上报

1. Go2Sky同时支持配置参数硬编码到项目或通过环境变量自动配置两种方法。

   配置参数硬编码

   ### 使用reporter.WithParameter()导入参数
   report, err := reporter.NewGRPCReporter(
       <your-backend-server-address>,
       reporter.WithAuthentication(<your-auth-token>))

   环境变量自动配置

   ### 目前go2sky支持从环境变量获取以下参数
   SW_AGENT_AUTHENTICATION
   SW_AGENT_LAYER
   SW_AGENT_COLLECTOR_HEARTBEAT_PERIOD
   SW_AGENT_COLLECTOR_GET_AGENT_DYNAMIC_CONFIG_INTERVAL
   SW_AGENT_COLLECTOR_BACKEND_SERVICES
   SW_AGENT_COLLECTOR_MAX_SEND_QUEUE_SIZE
   SW_AGENT_PROCESS_STATUS_HOOK_ENABLE
   SW_AGENT_PROCESS_LABELS
   
   ### 配置环境变量，以macOS为例
   # 方法1:写入环境变量配置文件（持久化）
   vim ~/.bash_profile
   export SW_AGENT_COLLECTOR_BACKEND_SERVICES=<your-collector-address>
   source ~/.bash_profile
   # 方法2:打开终端，命令行配置（临时生效，打开新的终端失效）
   export SW_AGENT_COLLECTOR_BACKEND_SERVICES=<your-collector-address>

2. 配置ServiceName，用于识别具体的应用。

   ServiceName := <your-service-name>
   tracer, err := go2sky.NewTracer(ServiceName, go2sky.WithReporter(report))

3. 添加Go2Sky-Plugin Hook。

   Go2Sky开发了众多库的插件，但是需要在项目源代码中添加埋点。如何添加埋点请参见Go2Sky-Plugins的Github仓库。在每个插件的plugin文件夹下，README.md文件给了简单的使用示例。

   以gin框架为例：

   1. 进入/gin文件夹，查看/gin/v3/README.md文件。

   2. 添加Middleware的Hook：v3.Middleware(r, tracer)。

      package main
      
      import (
      	"log"
      
      	"github.com/SkyAPM/go2sky"
      	v3 "github.com/SkyAPM/go2sky-plugins/gin/v3"
      	"github.com/SkyAPM/go2sky/reporter"
      	"github.com/gin-gonic/gin"
      )
      
      func main() {
      	// Use gRPC reporter for production
      	re, err := reporter.NewLogReporter()
      	if err != nil {
      		log.Fatalf("new reporter error %v \n", err)
      	}
      	defer re.Close()
      
      	tracer, err := go2sky.NewTracer("gin-server", go2sky.WithReporter(re))
      	if err != nil {
      		log.Fatalf("create tracer error %v \n", err)
      	}
      
      	gin.SetMode(gin.ReleaseMode)
      	r := gin.New()
      
      	//Use go2sky middleware with tracing
      	r.Use(v3.Middleware(r, tracer))
      
      	// do something
      }

4. 重新启动应用。

参考信息

Go2Sky的Agent属性配置表，NULL表示默认值未设置：

常见问题

• 使用skywalking-go时报错如下：

  

  如果使用inject方式报错，您可以通过import在main package中导入skywalking module。

• 跨进程调用时，为什么通过Go2Sky上报可观测链路 OpenTelemetry 版控制台无法显示正确的调用链？

  全链路追踪通过TraceId将整个链路串联起来，而TraceId通过HTTP请求携带传递。如果调用链不正确，说明TraceId没有正确传递，需要设置合理的Span埋点。

  通过合理使用下面两个重要的接口，可以将跨进程的调用链正确的串联起来：

  • CreateEntrySpan：入口Span，可以通过该接口从HTTP请求中提取得到链路追踪上下文（包含TraceId）。

  • CreateExitSpan：出口Span，可以通过该接口向HTTP请求注入链路追踪上下文（包含TraceId）。

  // 进程内，使用CreateLocalSpan创建一个跨度（Span）。
  span, ctx, err := tracer.CreateLocalSpan(context.Background())
  subSpan, newCtx, err := tracer.CreateLocalSpan(ctx)
  
  // 跨进程，使用入口Span从CreateEntrySpan从Http请求中提取上下文，使用出口Span向CreateExitSpan向Http请求中注入上下文。
  span, ctx, err := tracer.CreateEntrySpan(r.Context(), "/api/login", func(key string) (string, error) {
      return r.Header.Get(key), nil
  })
  span, err := tracer.CreateExitSpan(req.Context(), "/service/validate", "tomcat-service:8080", func(key, value string) error {
  		req.Header.Set(key, value)
  		return nil
  })

  跨进程的项目，不同进程之间需要传递TraceId才能将调用链串联起来，所以需要用到上面的接口将上下文注入到HTTP请求中随着请求在进程间传递。

相关文档

• SkyWalking官网

• skywalking-go的Github仓库

• skywalking-go的官方文档

• Go2Sky的Github仓库

• Go2Sky-Plugins的Github仓库