本章节代码已经上传至 https://github.com/siegrainwong/.NET-Core-with-Docker/tree/master/Part2

系列大纲

还是先介绍一下目录,这次我们讲第二篇:

  1. 用 docker-compose 启动 WebApi 和 SQL Server
  2. 在容器中集成 Skywalking APM
  3. 通过 nginx-proxy 对 ES、Skywalking、WebApi 实现自动反向代理和 HTTPS
  4. 通过 Azure DevOps 进行 CI/CD 和蓝绿发布

按照惯例,故障排除在最后一个章节~

在容器中集成Skywalking

Skywalking 介绍

Skywalking是一个分布式链路追踪系统,在部署分布式系统时能以非常清晰和全面的方式为你展示各种各样的监控数据,且本身接入对代码毫无侵入性,加上docker的部署优势能让你分分钟将这个强大的 APM 集成并启动起来。

配置监控代理

监控代理负责运行在你WebApi容器中并向收集器(Skywalking-OAP)定时发送监控数据。

本节中的F:\path\to\your\project的路径字符串都用来指代你的项目根目录,注意替换

打开程序包管理控制台,安装SkyAPM

Install-Package SkyAPM.Agent.AspNetCore -Version 0.9.0

安装SkyAPM.DotNet.CLI

dotnet tool install -g SkyAPM.DotNet.CLI

添加配置文件

cd F:\path\to\your\project\Core.API
dotnet skyapm config coreapi sw-oap:11800

添加后是这样的,并且记得设置其为始终复制

配置docker-compose

修改你的docker-compose.yml文件成这样:

version: "3.3"
services:
  #coreapi:
  #  container_name: coreapi
  #  image: siegrainwong/coreapi:latest
  #  ports:
  #    - 5000:5000
  #  depends_on:
  #    - sqlserver
  #  links:
  #    - sqlserver
  #  volumes:
  #    - ./Core.API/appsettings.docker.json:/app/appsettings.json:ro
  #  environment:
  #    ASPNETCORE_HOSTINGSTARTUPASSEMBLIES: SkyAPM.Agent.AspNetCore
  #    SKYWALKING__SERVICENAME: coreapi
  #  restart: always
  sqlserver:
    image: mcr.microsoft.com/mssql/server:2017-latest
    container_name: sqlserver
    restart: always
    environment:
      ACCEPT_EULA: Y
      MSSQL_PID: Developer
      SA_PASSWORD: "NetCore123!@#"
    volumes:
      - coredata:/var/opt/mssql
    ports:
      - 1433
  elasticsearch:
    image: docker.elastic.co/elasticsearch/elasticsearch:6.4.3
    container_name: elasticsearch
    restart: always
    ports:
      - 9200:9200
      - 9300:9300
    environment:
      discovery.type: single-node
    ulimits:
      memlock:
        soft: -1
        hard: -1
  sw-oap:
    image: apache/skywalking-oap-server:6.1.0
    container_name: sw-oap
    depends_on:
      - elasticsearch
    links:
      - elasticsearch
    restart: always
    ports:
      - 11800:11800
      - 12800:12800
    environment:
      SW_STORAGE: elasticsearch
      SW_STORAGE_ES_CLUSTER_NODES: elasticsearch:9200
  sw-ui:
    image: apache/skywalking-ui:6.1.0
    container_name: sw-ui
    depends_on:
      - sw-oap
    links:
      - sw-oap
    restart: always
    ports:
      - 8080:8080
    environment:
      SW_OAP_ADDRESS: sw-oap:12800
volumes: coredata:

是的,我们先把这里的coreapi注释掉,方便本地调试

在根目录添加一个名为launch.ps1的脚本:

docker-compose up -d

docker run --rm -it `
	-v F:\path\to\your\project:/app/ `
	-v F:\path\to\your\project\Core.API\appsettings.docker.json:/app/Core.API/appsettings.Development.json:ro `
	-p 5000:5000 `
	--link sw-oap `
	--link sqlserver `
	--name coreapi_dev `
	--network part2_default `
	--env ASPNETCORE_HOSTINGSTARTUPASSEMBLIES=SkyAPM.Agent.AspNetCore `
	--env SKYWALKING__SERVICENAME=coreapi `
 	-w /app/Core.API mcr.microsoft.com/dotnet/core/sdk:2.2-stretch dotnet watch run

docker run这条命令的意思是以交互模式将当前目录挂载到docker中执行dotnet watch run,并在执行完成后(或按 Ctrl+C 退出时)移除该容器,一般我们开发中就都是通过这种命令将应用程序快速运行在容器中。

还需要注意的是,这里手动指定了容器的网络(--network),只有运行在同一网络内的容器才能利用容器名在容器内网互相通信,你可以用docker network ls看看有哪些容器网络,之前我们用docker-compose创建起来的所有容器都在一个网络中,这个网络的名称一般是当前你的项目根目录名_default,所以我的就叫part2_default,你需要将其改为你的网络名称。

想验证容器之间的网络是否通畅,比如想测试从 coreapi 到 sqlserver 的连接,只需要docker exec coreapi_dev curl sqlserver:1433即可。

其他命令的意思你应该很轻松就能猜到的,如果不明白可以对照一下上一章中文注释过的docker-compose.yml文件,就不多解释了。

我们执行这个脚本后,访问localhost:8080,不出意外将出现Skywalking的登录界面:

输入 admin/admin 登录:

然后就能看到这个酷炫的页面了,不过此时你很有可能看不见数据,别急,我们先去http://localhost:5000/api/values页面刷两下,回来再将右下角的 UTC+8 改为 UTC+0,因为 ES 跟 OAP 的默认时区都是 UTC+0,这个我们后面再解决,现在刷新看是不是有数据了。

里面具体有什么就自己探索吧,这里主要讲部署方法,具体使用方法也有很多其他博主写过了,就不多讲了。

纠正时区为 UTC+8

纠正时区的原理非常简单,就是靠命令修改容器虚拟机的时区。 这需要我们在 oap 跟 es 的 Dockerfile 中执行这两条命令:

ln -sf /usr/share/zoneinfo/Asia/Shanghai  /etc/localtime
echo Asia/Shanghai > /etc/timezone

好消息是其实这些活儿也是有人做好了的,直接拿来用就是了。

修改 ES 的容器镜像为:

elasticsearch:
  image: wutang/elasticsearch-shanghai-zone:6.3.2

修改 OAP 的容器镜像为:

sw-oap:
  image: siegrainwong/skywalking-oap:6.1.0

再去划拉两下,是不是时间就正确了?

具体的修改方式可以参考这个commit以及这个repo,其实在有官方的容器化之前一直是这位大佬在维护的,大家要感谢他,本来当时我也是跟着这个 Repo 学习的,文章也写到一半了,结果发现官方容器化后又重新走了一遍 23333。

故障排除

  1. 通过查看Core.API\logs\skyapm-xxx.log排错,一般都是代理连不上 oap 等类似错误,重新修改下你的gRPC/Servers直到连通为止(不过这里好像有点 bug,有时候莫名其妙日志就不生成了~),如果有这样的日志,就说明代理连上 oap 了
org.apache.skywalking.oap.server.receiver.register.provider.handler.v5.grpc.InstanceDiscoveryServiceHandler -13182375 [grpc-default-executor-43] INFO [] - register service instance id=16 [UUID:23e8d5461f0049cfa708d5ec782a6a8b]
  1. 通过docker logs命令查看sw-oap或者sw-ui的日志,看看是不是有什么错误,一般也还是连不通的错误,oap 连不上 es 呀,ui 连不上 oap 啊,等等

  2. 参考 skywalking-docker 官方repo

  3. 参考 SkyAPM 官方repo

  4. 如果你的 skywalking 没有 CLR 信息,可能是你混用的 5.x 版本的监控代理,那个程序集叫 Skywalking.xxxxx,接入时还需要修改 Startup.cs 文件,发生这种情况用最新的 Agent 即可