.NetCore使用skywalking实现实时性能监控

一、简介

很久之前写了一篇 《.Net Core 2.0+ InfluxDB+Grafana+App Metrics 实现跨平台的实时性能监控》关于NetCore性能监控的文章，使用Influxdb+AppMetrics进行项目性能监控，由于技术有限，在正式环境使用一段时间后，莫名的AppMetrics就没办法往influxdb中插入数据了，后来我也在App Metrics作者的github上留言了，并且作者也根据我阐述的情况做了测试，没有复现我的问题，最后这个问题就不了了知了，然后项目性能监控这个事搁置了一段时间，直到2018年参加上海.net线下技术沙龙，在会场首次听到skywalking，那时候skywalking正在做NetCore的支持，会后回到公司便开始关注skywalking，知道skywalking支持NetCore后，第一时间在公司的项目中运用了skywalking。

二、安装环境

要想使用skywalking，首先得安装相关环境。本文以windows为例。

1、安装java sdk（如果不会配置java环境的话，请参考百度百科：https://jingyan.baidu.com/article/08b6a591bdb18314a80922a0.html）

2、java环境安装完成后，下载Elasticsearch进行安装 https://www.elastic.co/downloads/elasticsearch （本文使用skywalking 6.x版本，6.x版本对应使用ES 6.x版本，请自行下载对应版本）

3、下载完Elasticsearch 后将Elasticsearch解压到安装位置，以我电脑为例，我安装在D:\Program Files

4、修改ES配置，进入ES文件下的：\config，找到elasticsearch.yml，打开后修改如下配置：

 # ======================== Elasticsearch Configuration =========================
 #
 # NOTE: Elasticsearch comes with reasonable defaults for most settings.
 #       Before you set out to tweak and tune the configuration, make sure you
 #       understand what are you trying to accomplish and the consequences.
 #
 # The primary way of configuring a node is via this file. This template lists
 # the most important settings you may want to configure for a production cluster.
 #
 # Please consult the documentation for further information on configuration options:
 # https://www.elastic.co/guide/en/elasticsearch/reference/index.html
 #
 # ---------------------------------- Cluster -----------------------------------
 #
 # Use a descriptive name for your cluster:
 #
 cluster.name: myskywalking
 #
 # ------------------------------------ Node ------------------------------------
 #
 # Use a descriptive name for the node:
 #
 node.name: node-
 #
 # Add custom attributes to the node:
 #
 #node.attr.rack: r1
 #
 # ----------------------------------- Paths ------------------------------------
 #
 # Path to directory where to store the data (separate multiple locations by comma):
 #
 path.data: D:/Program Files/elasticsearch-6.6./path/to/data
 #
 # Path to log files:
 #
 path.logs: D:/Program Files/elasticsearch-6.6./path/to/logs
 #
 # ----------------------------------- Memory -----------------------------------
 #
 # Lock the memory on startup:
 #
 bootstrap.memory_lock: false
 #
 # Make sure that the heap size is set to about half the memory available
 # on the system and that the owner of the process is allowed to use this
 # limit.
 #
 # Elasticsearch performs poorly when the system is swapping the memory.
 #
 # ---------------------------------- Network -----------------------------------
 #
 # Set the bind address to a specific IP (IPv4 or IPv6):
 #
 network.host: 0.0.0.0
 http.port:
 http.cors.enabled: true
 http.cors.allow-origin: "*"
 http.cors.allow-methods: OPTIONS,HEAD,GET,POST,PUT,DELETE
 http.cors.allow-headers: "X-Requested-With, Content-Type, Content-Length, X-Users"

 #
 # For more information, consult the network module documentation.
 #
 # --------------------------------- Discovery ----------------------------------
 #
 # Pass an initial list of hosts to perform discovery when new node is started:
 # The default list of hosts is ["127.0.0.1", "[::1]"]
 #
 #discovery.zen.ping.unicast.hosts: ["host1", "host2"]
 #
 # Prevent the "split brain" by configuring the majority of nodes (total number of master-eligible nodes /  + ):
 #
 #discovery.zen.minimum_master_nodes:
 #
 # For more information, consult the zen discovery module documentation.
 #
 # ---------------------------------- Gateway -----------------------------------
 #
 # Block initial recovery after a full cluster restart until N nodes are started:
 #
 #gateway.recover_after_nodes:
 #
 # For more information, consult the gateway module documentation.
 #
 # ---------------------------------- Various -----------------------------------
 #
 # Require explicit names when deleting indices:
 #
 #action.destructive_requires_name: true

修改好elasticsearch.yml文件后，打开cmd命令，进入到D:\Program Files\elasticsearch-6.6.2\bin，bin文件夹下，输入如下命令：  elasticsearch-service.bat install  将ES安装成windows，这样就可以方便系统重启后自动启动

然后将服务启动后即可

5、接下来下载skywalking，http://skywalking.apache.org/downloads/

选择版本为 ：6.0.0-GA 的下载

三、配置和效果

1、在本地电脑中创建一个文件夹（注意：本人亲自躺过的坑，skywalking服务必须放在无空格的文件夹，比如：Program Files这个文件是绝对不能放的，不然服务运行的时候只会一闪而过，连log日志都不会生成，切记！切记！切记！）

我在D盘下创建了一个叫skyworkingService文件，路径如下：D:\skyworkingService

将下好的skywalking解压到该目录下，命名为skywalking-apm-GA，路径如下：D:\skyworkingService\skywalking-apm-GA

接着，打开config文件，找到application.yml文件，修改其配置如下：

 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
 # regarding copyright ownership.  The ASF licenses this file
 # to you under the Apache License, Version 2.0 (the
 # "License"); you may not use this file except in compliance
 # with the License.  You may obtain a copy of the License at
 #
 #     http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.

 cluster:
   standalone:
   # Please check your ZooKeeper is 3.5+, However, it is also compatible with ZooKeeper 3.4.x. Replace the ZooKeeper 3.5+
   # library the oap-libs folder with your ZooKeeper 3.4.x library.
 #  zookeeper:
 #    nameSpace: ${SW_NAMESPACE:""}
 #    hostPort: ${SW_CLUSTER_ZK_HOST_PORT:localhost:}
 #    #Retry Policy
 #    baseSleepTimeMs: ${SW_CLUSTER_ZK_SLEEP_TIME:} # initial amount of time to wait between retries
 #    maxRetries: ${SW_CLUSTER_ZK_MAX_RETRIES:} # max number of times to retry
 #  kubernetes:
 #    watchTimeoutSeconds: ${SW_CLUSTER_K8S_WATCH_TIMEOUT:}
 #    namespace: ${SW_CLUSTER_K8S_NAMESPACE:default}
 #    labelSelector: ${SW_CLUSTER_K8S_LABEL:app=collector,release=skywalking}
 #    uidEnvName: ${SW_CLUSTER_K8S_UID:SKYWALKING_COLLECTOR_UID}
 #  consul:
 #    serviceName: ${SW_SERVICE_NAME:"SkyWalking_OAP_Cluster"}
 #     Consul cluster nodes, example: 10.0.0.1:,10.0.0.2:,10.0.0.3:
 #    hostPort: ${SW_CLUSTER_CONSUL_HOST_PORT:localhost:}
 core:
   default:
     restHost: ${SW_CORE_REST_HOST:0.0.0.0}
     restPort: ${SW_CORE_REST_PORT:}
     restContextPath: ${SW_CORE_REST_CONTEXT_PATH:/}
     gRPCHost: ${SW_CORE_GRPC_HOST:0.0.0.0}
     gRPCPort: ${SW_CORE_GRPC_PORT:}
     downsampling:
     - Hour
     - Day
     - Month
     # Set a timeout on metric data. After the timeout has expired, the metric data will automatically be deleted.
     recordDataTTL: ${SW_CORE_RECORD_DATA_TTL:} # Unit is minute
     minuteMetricsDataTTL: ${SW_CORE_MINUTE_METRIC_DATA_TTL:} # Unit is minute
     hourMetricsDataTTL: ${SW_CORE_HOUR_METRIC_DATA_TTL:} # Unit is hour
     dayMetricsDataTTL: ${SW_CORE_DAY_METRIC_DATA_TTL:} # Unit is day
     monthMetricsDataTTL: ${SW_CORE_MONTH_METRIC_DATA_TTL:} # Unit is month
 storage:
   # h2:
     # driver: ${SW_STORAGE_H2_DRIVER:org.h2.jdbcx.JdbcDataSource}
     # url: ${SW_STORAGE_H2_URL:jdbc:h2:mem:skywalking-oap-db}
     # user: ${SW_STORAGE_H2_USER:sa}
  elasticsearch:
    nameSpace: ${SW_NAMESPACE:"myskywalking"}
    clusterNodes: ${SW_STORAGE_ES_CLUSTER_NODES:localhost:}
    indexShardsNumber: ${SW_STORAGE_ES_INDEX_SHARDS_NUMBER:}
    indexReplicasNumber: ${SW_STORAGE_ES_INDEX_REPLICAS_NUMBER:}
    # Batch process setting, refer to https://www.elastic.co/guide/en/elasticsearch/client/java-api/5.5/java-docs-bulk-processor.html
    bulkActions: ${SW_STORAGE_ES_BULK_ACTIONS:} # Execute the bulk every  requests
    bulkSize: ${SW_STORAGE_ES_BULK_SIZE:} # flush the bulk every 20mb
    flushInterval: ${SW_STORAGE_ES_FLUSH_INTERVAL:} # flush the bulk every  seconds whatever the number of requests
    concurrentRequests: ${SW_STORAGE_ES_CONCURRENT_REQUESTS:} # the number of concurrent requests
 receiver-register:
   default:
 receiver-trace:
   default:
     bufferPath: ${SW_RECEIVER_BUFFER_PATH:../trace-buffer/}  # Path to trace buffer files, suggest to use absolute path
     bufferOffsetMaxFileSize: ${SW_RECEIVER_BUFFER_OFFSET_MAX_FILE_SIZE:} # Unit is MB
     bufferDataMaxFileSize: ${SW_RECEIVER_BUFFER_DATA_MAX_FILE_SIZE:} # Unit is MB
     bufferFileCleanWhenRestart: ${SW_RECEIVER_BUFFER_FILE_CLEAN_WHEN_RESTART:false}
     sampleRate: ${SW_TRACE_SAMPLE_RATE:} # The sample rate precision is /.  means % sample in default.
 receiver-jvm:
   default:
 #service-mesh:
 #  default:
 #    bufferPath: ${SW_SERVICE_MESH_BUFFER_PATH:../mesh-buffer/}  # Path to trace buffer files, suggest to use absolute path
 #    bufferOffsetMaxFileSize: ${SW_SERVICE_MESH_OFFSET_MAX_FILE_SIZE:} # Unit is MB
 #    bufferDataMaxFileSize: ${SW_SERVICE_MESH_BUFFER_DATA_MAX_FILE_SIZE:} # Unit is MB
 #    bufferFileCleanWhenRestart: ${SW_SERVICE_MESH_BUFFER_FILE_CLEAN_WHEN_RESTART:false}
 #istio-telemetry:
 #  default:
 #receiver_zipkin:
 #  default:
 #    host: ${SW_RECEIVER_ZIPKIN_HOST:0.0.0.0}
 #    port: ${SW_RECEIVER_ZIPKIN_PORT:}
 #    contextPath: ${SW_RECEIVER_ZIPKIN_CONTEXT_PATH:/}
 query:
   graphql:
     path: ${SW_QUERY_GRAPHQL_PATH:/graphql}
 alarm:
   default:
 telemetry:
   none:

修改完成后，进入到bin文件中，右键单击startup.bat，以管理员权限运行，即可看到如下弹框

弹出这两个框说明服务已经启动了

这个时候访问http://localhost:8080，即可看到如下界面：

默认账号admin，密码admin，登录后看看到想要的监控数据和各服务直接的拓扑图，因为我的服务跑了一段时间，所以下面的界面是有数据的：

2、由于启动skywalking后会弹出两个命令窗口，所以如果运维人员不小心关了窗口的话服务自然就停掉了，所以为了避免这种问题，我们还可以将bin文件夹下的oapService.bat和webappService.bat进行配置，如下：

 @REM
 @REM  Licensed to the Apache Software Foundation (ASF) under one or more
 @REM  contributor license agreements.  See the NOTICE file distributed with
 @REM  this work for additional information regarding copyright ownership.
 @REM  The ASF licenses this file to You under the Apache License, Version 2.0
 @REM  (the "License"); you may not use this file except in compliance with
 @REM  the License.  You may obtain a copy of the License at
 @REM
 @REM      http://www.apache.org/licenses/LICENSE-2.0
 @REM
 @REM  Unless required by applicable law or agreed to in writing, software
 @REM  distributed under the License is distributed on an "AS IS" BASIS,
 @REM  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 @REM  See the License for the specific language governing permissions and
 @REM  limitations under the License.

 @echo off

 setlocal
 set OAP_PROCESS_TITLE=Skywalking-Collector
 set OAP_HOME=%~dp0%..
 set OAP_OPTS="-Xms256M -Xmx512M -Doap.logDir=%OAP_HOME%\logs"

 set CLASSPATH=%OAP_HOME%\config;.;
 set CLASSPATH=%OAP_HOME%\oap-libs\*;%CLASSPATH%

 if defined JAVA_HOME (
  set _EXECJAVA="%JAVA_HOME%\bin\javaw"
 )

 if not defined JAVA_HOME (
  echo "JAVA_HOME not set."
  set _EXECJAVA=javaw
 )

 start "%OAP_PROCESS_TITLE%" %_EXECJAVA% "%OAP_OPTS%" -cp "%CLASSPATH%" org.apache.skywalking.oap.server.starter.OAPServerStartUp
 endlocal

oapService.bat

 @REM
 @REM  Licensed to the Apache Software Foundation (ASF) under one or more
 @REM  contributor license agreements.  See the NOTICE file distributed with
 @REM  this work for additional information regarding copyright ownership.
 @REM  The ASF licenses this file to You under the Apache License, Version 2.0
 @REM  (the "License"); you may not use this file except in compliance with
 @REM  the License.  You may obtain a copy of the License at
 @REM
 @REM      http://www.apache.org/licenses/LICENSE-2.0
 @REM
 @REM  Unless required by applicable law or agreed to in writing, software
 @REM  distributed under the License is distributed on an "AS IS" BASIS,
 @REM  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 @REM  See the License for the specific language governing permissions and
 @REM  limitations under the License.

 @echo off

 setlocal
 set WEBAPP_PROCESS_TITLE=Skywalking-Webapp
 set WEBAPP_HOME=%~dp0%..
 set JARPATH=%WEBAPP_HOME%\webapp
 set WEBAPP_LOG_DIR=%WEBAPP_HOME%\logs

 if exist "%WEBAPP_LOG_DIR%" (
     mkdir "%WEBAPP_LOG_DIR%"
 )

 set LOG_FILE_LOCATION=%WEBAPP_LOG_DIR%\webapp.log

 if defined JAVA_HOME (
  set _EXECJAVA="%JAVA_HOME%\bin\javaw"
 )

 if not defined JAVA_HOME (
  echo "JAVA_HOME not set."
  set _EXECJAVA=javaw
 )

 start "%WEBAPP_PROCESS_TITLE%" %_EXECJAVA%  -jar %JARPATH%/skywalking-webapp.jar --spring.config.location=%JARPATH%/webapp.yml --logging.file=%LOG_FILE_LOCATION%
 endlocal

webappService.bat

其实只是将文件里的java改成了javaw，这样就可以在后台运行了，保存后再次运行startup.bat文件，这个时候界面上会有个cmd命令界面一闪而过，不要慌，我们打开资源管理器看看，会发现进程中多了两个名为“javaw.exe”的进程

这个时候访问：http://localhost:8080 一样可以看到上面的ui界面！

至此，skywalking的所有环境皆搭建完毕，接下来，在我们项目中添加skywalking的探针，方便skywalking收集我们项目中的数据

四、项目引用skywalking探针

新建一个NetCore的webapi，然后在引用中引用 SkyWalking.AspNetCore（已过期）SkyAPM.Agent.AspNetCore 0.8.0 如图：

项目引用后，在项目中添加环境变量，可以使用skywalking 官网使用说明书中的命令，进入项目文件夹，给项目配置环境变量并运行

（

set ASPNETCORE_HOSTINGSTARTUPASSEMBLIES=SkyAPM.Agent.AspNetCore
set SKYWALKING__SERVICENAME=sample_app
dotnet run

）

也可以自己手动给项目添加环境变量，本文以给项目添加环境变量为例：

在项目的Properties下找到launchSettings.json，按上图所示，在environmentVariables节点下分别添加一下环境变量：

"ASPNETCORE_HOSTINGSTARTUPASSEMBLIES": "SkyAPM.Agent.AspNetCore",
"SKYWALKING__SERVICENAME": "sample_app"

添加完环境变量后，打开cmd，进入到项目根目录（比如我项目是在F:\NEW_TMS\OtherProject\V1.0\XiangYu.AreaModules\WebApi.AreaServer 这个目录下，切记一定要进入到项目根目录，不然配置文件就生成到别的地方去了）

运行一下代码 安装SkyAPM.Dotnet.CLI：

dotnet tool install -g SkyAPM.DotNet.CLI

然使用skyapm生成配置文件，命令如下：

dotnet skyapm config sample_app 192.168.0.1:

其中192.168.0.1:11800是上面我们安装完成的skywalking服务端里配置的，将这个ip改成上面服务器的ip即可

执行完上面的命令后，项目下会生成一个名为skyapm.json的文件，其中的代码如下：

{
  "SkyWalking": {
    "ServiceName": "sample_app",
    "Namespace": "",
    "HeaderVersions": [
      "sw6"
    ],
    "Sampling": {
      "SamplePer3Secs": -1,
      "Percentage": -1.0
    },
    "Logging": {
      "Level": "Information",
      "FilePath": "logs\\skyapm-{Date}.log"
    },
    "Transport": {
      "Interval": 3000,
      "ProtocolVersion": "v6",
      "QueueSize": 30000,
      "BatchSize": 3000,
      "gRPC": {
        "Servers": "192.168.0.1:11800",
        "Timeout": 10000,
        "ConnectTimeout": 10000,
        "ReportTimeout": 600000
      }
    }
  }
}

skyapm.json文件不一定要使用命令生成，也可自己在项目中创建一个名为skyapm.json的文件，然后将上面代码复制进去，修改其ip即可

在vs中右键单击skyapm.json，选择属性——》复制到输出目录——》如果较新则复制

然后选择控制台运行项目即可

运行代码后，项目根目录下会自动生成logs文件夹，该日志文件已skyapm- 为开头命名，打开后可以查看当前服务的skywalking探针运行情况，

五、结束

日志如上图所示，即证明skywalking探针已经成功，接下来请求一下你的接口，然后进入skywalking的ui中看看你的成果吧！

（

　　如果服务运行在docker中，请在docker-compose中设置环境变量，不然skywalking是运行不起来的，我们是将docker环境变量存入到一个.env文件中，如图

　　

　　

　　这样docker运行之后会就会有相关环境变量了

）