在asp.net core中使用skywalking(及问题)
摘自:https://www.cnblogs.com/landonzeng/p/10616644.html
一、简介#
很久之前写了一篇 《.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.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文件,修改其配置如下:
修改完成后,进入到bin文件中,右键单击startup.bat,以管理员权限运行,即可看到如下弹框
弹出这两个框说明服务已经启动了
这个时候访问http://localhost:8080,即可看到如下界面:
默认账号admin,密码admin,登录后看看到想要的监控数据和各服务直接的拓扑图,因为我的服务跑了一段时间,所以下面的界面是有数据的:
2、由于启动skywalking后会弹出两个命令窗口,所以如果运维人员不小心关了窗口的话服务自然就停掉了,所以为了避免这种问题,我们还可以将bin文件夹下的oapService.bat和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:11800
其中192.168.0.1:11800是上面我们安装完成的skywalking服务端里配置的,将这个ip改成上面服务器的ip即可
执行完上面的命令后,项目下会生成一个名为skyapm.json的文件,其中的代码如下:
skyapm.json文件不一定要使用命令生成,也可自己在项目中创建一个名为skyapm.json的文件,然后将上面代码复制进去,修改其ip即可
在vs中右键单击skyapm.json,选择属性——》复制到输出目录——》如果较新则复制
然后选择控制台运行项目即可
运行代码后,项目根目录下会自动生成logs文件夹,该日志文件已skyapm- 为开头命名,打开后可以查看当前服务的skywalking探针运行情况,
五、结束#
日志如上图所示,即证明skywalking探针已经成功,接下来请求一下你的接口,然后进入skywalking的ui中看看你的成果吧!
(
如果服务运行在docker中,请在docker-compose中设置环境变量,不然skywalking是运行不起来的,我们是将docker环境变量存入到一个.env文件中,如图
这样docker运行之后会就会有相关环境变量了
)
------------------------------------------
问题一:launchSettings.json中的环境变量问题
问题描述,在开发环境下,skywalking读取了launchSettings.json中的配置:
"ASPNETCORE_HOSTINGSTARTUPASSEMBLIES": "SkyAPM.Agent.AspNetCore",
"SKYWALKING__SERVICENAME": "Web"
发布到iis后,由于缺乏这两个配置,导致没能记录skywalking日志,最后在iis中添加环境变量后解决。
看这一篇:https://blog.csdn.net/lilinoscar/article/details/108362211
也可以直接在iis网站目录下配置web.config目录,如下截图
问题二:skywalking日志的存储形式改为elasticsearch,启动skywalking后总是报错。
检查skywalking日志发现一个错误
Caused by: java.lang.RuntimeException: {"error":{"root_cause":[{"type":"invalid_alias_name_exception","reason":"Invalid alias name [myskywalking_alarm_record], an index exists with the same name as the alias","index_uuid":"TDUg1LwNSi-52eonoRygqQ","index":"myskywalking_alarm_record"}],"type":"invalid_alias_name_exception","reason":"Invalid alias name [myskywalking_alarm_record], an index exists with the same name as the alias","index_uuid":"TDUg1LwNSi-52eonoRygqQ","index":"myskywalking_alarm_record"},"status":400}
怀疑是本人改过cluster-name,导致有重名的index,于是删除旧的elasticsearch,问题解决。