.NetCore使用skywalking實現實時性能監控

原文: .NetCore使用skywalking實現實時性能監控

1、簡介

好久以前寫了一篇 《.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。

2、安裝環境

要想使用skywalking，首先得安裝相關環境。本文以windows爲例。

一、安裝java sdk（若是不會配置java環境的話，請參考百度百科：https://jingyan.baidu.com/article/08b6a591bdb18314a80922a0.html）

二、java環境安裝完成後，下載Elasticsearch進行安裝 https://www.elastic.co/downloads/elasticsearch （本文使用skywalking 6.x版本，6.x版本對應使用ES 6.x版本，請自行下載對應版本）

三、下載完Elasticsearch 後將Elasticsearch解壓到安裝位置，以我電腦爲例，我安裝在D:\Program Files

四、修改ES配置，進入ES文件下的：\config，找到elasticsearch.yml，打開後修改以下配置：

 1 # ======================== Elasticsearch Configuration =========================
 2 #
 3 # NOTE: Elasticsearch comes with reasonable defaults for most settings.
 4 #       Before you set out to tweak and tune the configuration, make sure you
 5 #       understand what are you trying to accomplish and the consequences.
 6 #
 7 # The primary way of configuring a node is via this file. This template lists
 8 # the most important settings you may want to configure for a production cluster.
 9 #
10 # Please consult the documentation for further information on configuration options:
11 # https://www.elastic.co/guide/en/elasticsearch/reference/index.html
12 #
13 # ---------------------------------- Cluster -----------------------------------
14 #
15 # Use a descriptive name for your cluster:
16 #
17 cluster.name: myskywalking
18 #
19 # ------------------------------------ Node ------------------------------------
20 #
21 # Use a descriptive name for the node:
22 #
23 node.name: node-1
24 #
25 # Add custom attributes to the node:
26 #
27 #node.attr.rack: r1
28 #
29 # ----------------------------------- Paths ------------------------------------
30 #
31 # Path to directory where to store the data (separate multiple locations by comma):
32 #
33 path.data: D:/Program Files/elasticsearch-6.6.2/path/to/data
34 #
35 # Path to log files:
36 #
37 path.logs: D:/Program Files/elasticsearch-6.6.2/path/to/logs
38 #
39 # ----------------------------------- Memory -----------------------------------
40 #
41 # Lock the memory on startup:
42 #
43 bootstrap.memory_lock: false
44 #
45 # Make sure that the heap size is set to about half the memory available
46 # on the system and that the owner of the process is allowed to use this
47 # limit.
48 #
49 # Elasticsearch performs poorly when the system is swapping the memory.
50 #
51 # ---------------------------------- Network -----------------------------------
52 #
53 # Set the bind address to a specific IP (IPv4 or IPv6):
54 #
55 network.host: 0.0.0.0
56 http.port: 9200
57 http.cors.enabled: true 
58 http.cors.allow-origin: "*" 
59 http.cors.allow-methods: OPTIONS,HEAD,GET,POST,PUT,DELETE
60 http.cors.allow-headers: "X-Requested-With, Content-Type, Content-Length, X-Users"
61 
62 #
63 # For more information, consult the network module documentation.
64 #
65 # --------------------------------- Discovery ----------------------------------
66 #
67 # Pass an initial list of hosts to perform discovery when new node is started:
68 # The default list of hosts is ["127.0.0.1", "[::1]"]
69 #
70 #discovery.zen.ping.unicast.hosts: ["host1", "host2"]
71 #
72 # Prevent the "split brain" by configuring the majority of nodes (total number of master-eligible nodes / 2 + 1):
73 #
74 #discovery.zen.minimum_master_nodes: 
75 #
76 # For more information, consult the zen discovery module documentation.
77 #
78 # ---------------------------------- Gateway -----------------------------------
79 #
80 # Block initial recovery after a full cluster restart until N nodes are started:
81 #
82 #gateway.recover_after_nodes: 3
83 #
84 # For more information, consult the gateway module documentation.
85 #
86 # ---------------------------------- Various -----------------------------------
87 #
88 # Require explicit names when deleting indices:
89 #
90 #action.destructive_requires_name: true

View Code

修改好elasticsearch.yml文件後，打開cmd命令，進入到D:\Program Files\elasticsearch-6.6.2\bin，bin文件夾下，輸入以下命令：  elasticsearch-service.bat install  將ES安裝成windows，這樣就能夠方便系統重啓後自動啓動

而後將服務啓動後便可

五、接下來下載skywalking，http://skywalking.apache.org/downloads/

選擇版本爲 ：6.0.0-GA 的下載

3、配置和效果

一、在本地電腦中建立一個文件夾（注意：本人親自躺過的坑，skywalking服務必須放在無空格的文件夾，好比：Program Files這個文件是絕對不能放的，否則服務運行的時候只會一閃而過，連log日誌都不會生成，切記！切記！切記！）

我在D盤下建立了一個叫skyworkingService文件，路徑以下：D:\skyworkingService

將下好的skywalking解壓到該目錄下，命名爲skywalking-apm-GA，路徑以下：D:\skyworkingService\skywalking-apm-GA

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

 1 # Licensed to the Apache Software Foundation (ASF) under one
 2 # or more contributor license agreements.  See the NOTICE file
 3 # distributed with this work for additional information
 4 # regarding copyright ownership.  The ASF licenses this file
 5 # to you under the Apache License, Version 2.0 (the
 6 # "License"); you may not use this file except in compliance
 7 # with the License.  You may obtain a copy of the License at
 8 #
 9 #     http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16 
17 cluster:
18   standalone:
19   # Please check your ZooKeeper is 3.5+, However, it is also compatible with ZooKeeper 3.4.x. Replace the ZooKeeper 3.5+
20   # library the oap-libs folder with your ZooKeeper 3.4.x library.
21 #  zookeeper:
22 #    nameSpace: ${SW_NAMESPACE:""}
23 #    hostPort: ${SW_CLUSTER_ZK_HOST_PORT:localhost:2181}
24 #    #Retry Policy
25 #    baseSleepTimeMs: ${SW_CLUSTER_ZK_SLEEP_TIME:1000} # initial amount of time to wait between retries
26 #    maxRetries: ${SW_CLUSTER_ZK_MAX_RETRIES:3} # max number of times to retry
27 #  kubernetes:
28 #    watchTimeoutSeconds: ${SW_CLUSTER_K8S_WATCH_TIMEOUT:60}
29 #    namespace: ${SW_CLUSTER_K8S_NAMESPACE:default}
30 #    labelSelector: ${SW_CLUSTER_K8S_LABEL:app=collector,release=skywalking}
31 #    uidEnvName: ${SW_CLUSTER_K8S_UID:SKYWALKING_COLLECTOR_UID}
32 #  consul:
33 #    serviceName: ${SW_SERVICE_NAME:"SkyWalking_OAP_Cluster"}
34 #     Consul cluster nodes, example: 10.0.0.1:8500,10.0.0.2:8500,10.0.0.3:8500
35 #    hostPort: ${SW_CLUSTER_CONSUL_HOST_PORT:localhost:8500}
36 core:
37   default:
38     restHost: ${SW_CORE_REST_HOST:0.0.0.0}
39     restPort: ${SW_CORE_REST_PORT:12800}
40     restContextPath: ${SW_CORE_REST_CONTEXT_PATH:/}
41     gRPCHost: ${SW_CORE_GRPC_HOST:0.0.0.0}
42     gRPCPort: ${SW_CORE_GRPC_PORT:11800}
43     downsampling:
44     - Hour
45     - Day
46     - Month
47     # Set a timeout on metric data. After the timeout has expired, the metric data will automatically be deleted.
48     recordDataTTL: ${SW_CORE_RECORD_DATA_TTL:90} # Unit is minute
49     minuteMetricsDataTTL: ${SW_CORE_MINUTE_METRIC_DATA_TTL:90} # Unit is minute
50     hourMetricsDataTTL: ${SW_CORE_HOUR_METRIC_DATA_TTL:36} # Unit is hour
51     dayMetricsDataTTL: ${SW_CORE_DAY_METRIC_DATA_TTL:45} # Unit is day
52     monthMetricsDataTTL: ${SW_CORE_MONTH_METRIC_DATA_TTL:18} # Unit is month
53 storage:
54   # h2:
55     # driver: ${SW_STORAGE_H2_DRIVER:org.h2.jdbcx.JdbcDataSource}
56     # url: ${SW_STORAGE_H2_URL:jdbc:h2:mem:skywalking-oap-db}
57     # user: ${SW_STORAGE_H2_USER:sa}
58  elasticsearch:
59    nameSpace: ${SW_NAMESPACE:"myskywalking"}
60    clusterNodes: ${SW_STORAGE_ES_CLUSTER_NODES:localhost:9200}
61    indexShardsNumber: ${SW_STORAGE_ES_INDEX_SHARDS_NUMBER:2}
62    indexReplicasNumber: ${SW_STORAGE_ES_INDEX_REPLICAS_NUMBER:0}
63    # Batch process setting, refer to https://www.elastic.co/guide/en/elasticsearch/client/java-api/5.5/java-docs-bulk-processor.html
64    bulkActions: ${SW_STORAGE_ES_BULK_ACTIONS:2000} # Execute the bulk every 2000 requests
65    bulkSize: ${SW_STORAGE_ES_BULK_SIZE:20} # flush the bulk every 20mb
66    flushInterval: ${SW_STORAGE_ES_FLUSH_INTERVAL:10} # flush the bulk every 10 seconds whatever the number of requests
67    concurrentRequests: ${SW_STORAGE_ES_CONCURRENT_REQUESTS:2} # the number of concurrent requests
68 receiver-register:
69   default:
70 receiver-trace:
71   default:
72     bufferPath: ${SW_RECEIVER_BUFFER_PATH:../trace-buffer/}  # Path to trace buffer files, suggest to use absolute path
73     bufferOffsetMaxFileSize: ${SW_RECEIVER_BUFFER_OFFSET_MAX_FILE_SIZE:100} # Unit is MB
74     bufferDataMaxFileSize: ${SW_RECEIVER_BUFFER_DATA_MAX_FILE_SIZE:500} # Unit is MB
75     bufferFileCleanWhenRestart: ${SW_RECEIVER_BUFFER_FILE_CLEAN_WHEN_RESTART:false}
76     sampleRate: ${SW_TRACE_SAMPLE_RATE:10000} # The sample rate precision is 1/10000. 10000 means 100% sample in default.
77 receiver-jvm:
78   default:
79 #service-mesh:
80 #  default:
81 #    bufferPath: ${SW_SERVICE_MESH_BUFFER_PATH:../mesh-buffer/}  # Path to trace buffer files, suggest to use absolute path
82 #    bufferOffsetMaxFileSize: ${SW_SERVICE_MESH_OFFSET_MAX_FILE_SIZE:100} # Unit is MB
83 #    bufferDataMaxFileSize: ${SW_SERVICE_MESH_BUFFER_DATA_MAX_FILE_SIZE:500} # Unit is MB
84 #    bufferFileCleanWhenRestart: ${SW_SERVICE_MESH_BUFFER_FILE_CLEAN_WHEN_RESTART:false}
85 #istio-telemetry:
86 #  default:
87 #receiver_zipkin:
88 #  default:
89 #    host: ${SW_RECEIVER_ZIPKIN_HOST:0.0.0.0}
90 #    port: ${SW_RECEIVER_ZIPKIN_PORT:9411}
91 #    contextPath: ${SW_RECEIVER_ZIPKIN_CONTEXT_PATH:/}
92 query:
93   graphql:
94     path: ${SW_QUERY_GRAPHQL_PATH:/graphql}
95 alarm:
96   default:
97 telemetry:
98   none:

View Code

 修改完成後，進入到bin文件中，右鍵單擊startup.bat，以管理員權限運行，便可看到以下彈框

彈出這兩個框說明服務已經啓動了

這個時候訪問http://localhost:8080，便可看到以下界面：

默認帳號admin，密碼admin，登陸後看看到想要的監控數據和各服務直接的拓撲圖，由於個人服務跑了一段時間，因此下面的界面是有數據的：

二、因爲啓動skywalking後會彈出兩個命令窗口，因此若是運維人員不當心關了窗口的話服務天然就停掉了，因此爲了不這種問題，咱們還能夠將bin文件夾下的oapService.bat和webappService.bat進行配置，以下：

 1 @REM
 2 @REM  Licensed to the Apache Software Foundation (ASF) under one or more
 3 @REM  contributor license agreements.  See the NOTICE file distributed with
 4 @REM  this work for additional information regarding copyright ownership.
 5 @REM  The ASF licenses this file to You under the Apache License, Version 2.0
 6 @REM  (the "License"); you may not use this file except in compliance with
 7 @REM  the License.  You may obtain a copy of the License at
 8 @REM
 9 @REM      http://www.apache.org/licenses/LICENSE-2.0
10 @REM
11 @REM  Unless required by applicable law or agreed to in writing, software
12 @REM  distributed under the License is distributed on an "AS IS" BASIS,
13 @REM  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 @REM  See the License for the specific language governing permissions and
15 @REM  limitations under the License.
16 
17 @echo off
18 
19 setlocal
20 set OAP_PROCESS_TITLE=Skywalking-Collector
21 set OAP_HOME=%~dp0%..
22 set OAP_OPTS="-Xms256M -Xmx512M -Doap.logDir=%OAP_HOME%\logs"
23 
24 set CLASSPATH=%OAP_HOME%\config;.;
25 set CLASSPATH=%OAP_HOME%\oap-libs\*;%CLASSPATH%
26 
27 if defined JAVA_HOME (
28  set _EXECJAVA="%JAVA_HOME%\bin\javaw"
29 )
30 
31 if not defined JAVA_HOME (
32  echo "JAVA_HOME not set."
33  set _EXECJAVA=javaw
34 )
35 
36 start "%OAP_PROCESS_TITLE%" %_EXECJAVA% "%OAP_OPTS%" -cp "%CLASSPATH%" org.apache.skywalking.oap.server.starter.OAPServerStartUp
37 endlocal

oapService.bat

 1 @REM
 2 @REM  Licensed to the Apache Software Foundation (ASF) under one or more
 3 @REM  contributor license agreements.  See the NOTICE file distributed with
 4 @REM  this work for additional information regarding copyright ownership.
 5 @REM  The ASF licenses this file to You under the Apache License, Version 2.0
 6 @REM  (the "License"); you may not use this file except in compliance with
 7 @REM  the License.  You may obtain a copy of the License at
 8 @REM
 9 @REM      http://www.apache.org/licenses/LICENSE-2.0
10 @REM
11 @REM  Unless required by applicable law or agreed to in writing, software
12 @REM  distributed under the License is distributed on an "AS IS" BASIS,
13 @REM  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 @REM  See the License for the specific language governing permissions and
15 @REM  limitations under the License.
16 
17 @echo off
18 
19 setlocal
20 set WEBAPP_PROCESS_TITLE=Skywalking-Webapp
21 set WEBAPP_HOME=%~dp0%..
22 set JARPATH=%WEBAPP_HOME%\webapp
23 set WEBAPP_LOG_DIR=%WEBAPP_HOME%\logs
24 
25 if exist "%WEBAPP_LOG_DIR%" (
26     mkdir "%WEBAPP_LOG_DIR%"
27 )
28 
29 set LOG_FILE_LOCATION=%WEBAPP_LOG_DIR%\webapp.log
30 
31 if defined JAVA_HOME (
32  set _EXECJAVA="%JAVA_HOME%\bin\javaw"
33 )
34 
35 if not defined JAVA_HOME (
36  echo "JAVA_HOME not set."
37  set _EXECJAVA=javaw
38 )
39 
40 start "%WEBAPP_PROCESS_TITLE%" %_EXECJAVA%  -jar %JARPATH%/skywalking-webapp.jar --spring.config.location=%JARPATH%/webapp.yml --logging.file=%LOG_FILE_LOCATION%
41 endlocal

webappService.bat

其實只是將文件裏的java改爲了javaw，這樣就能夠在後臺運行了，保存後再次運行startup.bat文件，這個時候界面上會有個cmd命令界面一閃而過，不要慌，咱們打開資源管理器看看，會發現進程中多了兩個名爲「javaw.exe」的進程

這個時候訪問：http://localhost:8080 同樣能夠看到上面的ui界面！

至此，skywalking的全部環境皆搭建完畢，接下來，在咱們項目中添加skywalking的探針，方便skywalking收集咱們項目中的數據

4、項目引用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:11800

其中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
      }
    }
  }
}

View Code

skyapm.json文件不必定要使用命令生成，也可本身在項目中建立一個名爲skyapm.json的文件，而後將上面代碼複製進去，修改其ip便可

 

在vs中右鍵單擊skyapm.json，選擇屬性——》複製到輸出目錄——》若是較新則複製

而後選擇控制檯運行項目便可

運行代碼後，項目根目錄下會自動生成logs文件夾，該日誌文件已skyapm- 爲開頭命名，打開後能夠查看當前服務的skywalking探針運行狀況，

日誌如上圖所示，即證實skywalking探針已經成功，接下來請求一下你的接口，而後進入skywalking的ui中看看你的成果吧！

（

　　若是服務運行在docker中，請在docker-compose中設置環境變量，否則skywalking是運行不起來的，咱們是將docker環境變量存入到一個.env文件中，如圖

　　

　　

　　這樣docker運行以後會就會有相關環境變量了

）