NetPro.Checker
6.0.5-beta.4
.NET 6.0
This package targets .NET 6.0. The package is compatible with this framework or higher.
.NET Core 3.1
This package targets .NET Core 3.1. The package is compatible with this framework or higher.
This is a prerelease version of NetPro.Checker.
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package NetPro.Checker --version 6.0.5-beta.4
NuGet\Install-Package NetPro.Checker -Version 6.0.5-beta.4
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="NetPro.Checker" Version="6.0.5-beta.4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NetPro.Checker --version 6.0.5-beta.4
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: NetPro.Checker, 6.0.5-beta.4"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install NetPro.Checker as a Cake Addin
#addin nuget:?package=NetPro.Checker&version=6.0.5-beta.4&prerelease
// Install NetPro.Checker as a Cake Tool
#tool nuget:?package=NetPro.Checker&version=6.0.5-beta.4&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Checker使用
各类检查,环境信息检测,支持 对Microsoft.AspNetCore.Diagnostics.HealthChecks的强化和redis,mongodb检查的完善
使用
- 基于NetPro.Startup为基座的程序,如果已添加环境变量ASPNETCORE_HOSTINGSTARTUPASSEMBLIES=NetPro.Satrtup 启用自动初始化,添加appsetting.json 配置即可
appsetting.json
- 增加以下配置节点
"NetProCheckerOption": {
"Enabled": true,
"HealthPath": "/health",
"InfoPath": "/info",
"EnvPath": "/Env"
}
- 基于原生使用,需要按以下方式注入服务,并添加上一条appsetting.json 节点配置即可
启用服务
以检测redis;mongodb的健康为例:
public void ConfigureServices(IServiceCollection services)
{
var healthbuild = services.AddHealthChecks();
//健康检查redis
healthbuild.AddMongoDb(mongoDbOptions.ConnectionString, tags: new string[] { "mongodb" });
//健康检查mongodb
healthbuild.AddRedis($"{redisconnection}", name:$"redis-{Guid.NewGuid()}")//健康检查redis
//健康检查url,两种方式
//1、
healthbuild.AddUrl(new List<string> {
"htttp://www.douying.com"
,"htttp://www.baidu.com" }
,timeout:System.TimeSpan.FromSeconds(5));//检查
//2、
healthbuild.AddUrlGroup(new Uri("https://localhost:44318/weatherforecast"), "Example endpoint")// should return status code 200
//检查其他组件,引用相关nuget即可
}
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
application.UseCheck(envPath:"/env",infoPath:"/info",health:"/health");//envPath:应用环境地址;infoPath:应用自身信息地址;health:健康检查地址
}
除以上方式实现健康检查,另一种健康检查: 以检查apollo健康程度为例:
HealthCheckRegistry.RegisterHealthCheck("apollo", () =>
{
var uri = new Uri(configuration.GetValue<string>("Apollo:MetaServer"));
using (var tcpClient = new System.Net.Sockets.TcpClient(uri.Host, uri.Port))
{
if (tcpClient.Connected)
{
Console.WriteLine($"[{DateTime.Now:HH:mm:ss}] pollo:Env={configuration.GetValue<string>("Apollo:Env")}");
Console.WriteLine($"[{DateTime.Now:HH:mm:ss}] Apollo:Cluster={configuration.GetValue<string>("Apollo:Cluster")}");
return HealthResponse.Healthy($"{uri.Host}:{uri.Port}connection successful; pollo:Env={configuration.GetValue<string>("Apollo:Env")}--Apollo:Cluster={configuration.GetValue<string>("Apollo:Cluster")}");
}
return HealthResponse.Unhealthy($"Apollo{uri.Host}:{uri.Port} connection failed");
}
});
访问 /health
得到以下检查结果,可根据此来判断组件健康程度来做下一步处理
{
"status": "Unhealthy",
"totalDuration": "00:00:10.0147119",
"entries": {
"redis-192.168.66.33:6665": {
"data": {
},
"description": "It was not possible to connect to the redis server(s). UnableToConnect on 192.168.66.33:6665/Interactive, Initializing/NotStarted, last: NONE, origin: BeginConnectAsync, outstanding: 0, last-read: 0s ago, last-write: 0s ago, keep-alive: 60s, state: Connecting, mgr: 10 of 10 available, last-heartbeat: never, global: 0s ago, v: 2.1.30.38891",
"duration": "00:00:10.0141772",
"exception": "It was not possible to connect to the redis server(s). UnableToConnect on 192.168.66.33:6665/Interactive, Initializing/NotStarted, last: NONE, origin: BeginConnectAsync, outstanding: 0, last-read: 0s ago, last-write: 0s ago, keep-alive: 60s, state: Connecting, mgr: 10 of 10 available, last-heartbeat: never, global: 0s ago, v: 2.1.30.38891",
"status": "Unhealthy"
},
"redis-192.168.66.66:6666": {
"data": {
},
"description": "It was not possible to connect to the redis server(s). UnableToConnect on 192.168.66.66:6666/Interactive, Initializing/NotStarted, last: NONE, origin: BeginConnectAsync, outstanding: 0, last-read: 0s ago, last-write: 0s ago, keep-alive: 60s, state: Connecting, mgr: 10 of 10 available, last-heartbeat: never, global: 0s ago, v: 2.1.30.38891",
"duration": "00:00:10.0141671",
"exception": "It was not possible to connect to the redis server(s). UnableToConnect on 192.168.66.66:6666/Interactive, Initializing/NotStarted, last: NONE, origin: BeginConnectAsync, outstanding: 0, last-read: 0s ago, last-write: 0s ago, keep-alive: 60s, state: Connecting, mgr: 10 of 10 available, last-heartbeat: never, global: 0s ago, v: 2.1.30.38891",
"status": "Unhealthy"
}
}
}
增加统一健康检查Dashboard
public void ConfigureServices(IServiceCollection services)
{
services.AddHealthChecksUI();//添加健康检查UI dashboard
}
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
application.UseHealthChecksUI(s => s.UIPath = "/hc-ui");//健康检查UI地址
application.UseCheck(envPath:"/env",infoPath:"/info");//envPath:应用环境地址;infoPath:应用自身信息地址
}
"HealthChecksUI": {
"HealthChecks": [
{
"Name": "HealthList",
"Uri": "/health"
},
{
"Name": "HTTP-Api-Basic",
"Uri": "http://localhost:6457/healthz"
}
],//通过HealthChecks可统一检测对所有符合`HealthChecks.UI`规范的组件健康程度,支持本地和远程
"Webhooks": [],
"EvaluationTimeOnSeconds": 3600, //检查周期,单位秒
"MinimumSecondsBetweenFailureNotifications": 60
},
可视化查看健康状况
会将所有配置在HealthChecksUI:HealthChecks节点下各地址的健康信息统一显示
访问 /hc-ui
<p align="center"> <img src="https://github.com/LeonKou/NetPro/blob/master/docs/images/checkhealth.jpg"> </p>
访问 /env
将得到应用所在系统的环境参数值,可快速定位问题
"ProcessId": 11232,
"ProcessStartTime": "2020-05-25T03:55:55.9760077Z",
"Hostname": "Leon",
"EnvironmentVariables": {
"MSBuildLoadMicrosoftTargetsReadOnly": "true",
"JAVA_HOME": "C:\\Program Files (x86)\\jdk-14",
"ThreadedWaitDialogDpiContext": "-4",
"COMPUTERNAME": "Leon",
"FPS_BROWSER_APP_PROFILE_STRING": "Internet Explorer",
"CommonProgramW6432": "C:\\Program Files\\Common Files",
"HOMEPATH": "\\Users\\Administrator",
"LOGONSERVER": "\\\\Leon",
"SESSIONNAME": "Console",
"ProgramFiles(x86)": "C:\\Program Files (x86)",
"VSLANG": "2052",
"USERNAME": "Administrator",
"ASPNETCORE_URLS": "http://localhost:5001",
"SystemDrive": "C:",
"ProgramFiles": "C:\\Program Files",
"PROCESSOR_LEVEL": "6",
"OS": "Windows_NT",
"VisualStudioVersion": "16.0",
"USERDOMAIN_ROAMINGPROFILE": "Leon",
"PATHEXT": ".COM;.EXE;.BAT;.CMD;.VBS;.VBE;.JS;.JSE;.WSF;.WSH;.MSC;.PY;.PYW",
"Path": "C:\\Program Files\\Python38\\Scripts\\;C:\\Program Files\\Python38\\;C:\\Windows\\system32;C:\\Windows;C:\\Windows\\System32\\Wbem;C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\;C:\\Windows\\System32\\OpenSSH\\;C:\\Program Files (x86)\\NVIDIA Corporation\\PhysX\\Common;C:\\Program Files\\NVIDIA Corporation\\NVIDIA NvDLISR;C:\\Program Files\\TortoiseSVN\\bin;C:\\Program Files\\Microsoft SQL Server\\130\\Tools\\Binn\\;C:\\Program Files\\Microsoft SQL Server\\Client SDK\\ODBC\\170\\Tools\\Binn\\;C:\\Program Files (x86)\\Microsoft SQL Server\\150\\DTS\\Binn\\;C:\\Program Files\\Microsoft VS Code\\bin;C:\\Program Files\\TortoiseGit\\bin;C:\\Program Files\\dotnet\\;C:\\ProgramData\\chocolatey\\bin;C:\\Program Files (x86)\\jdk-14\\bin;C:\\Program Files (x86)\\jdk-14\\jre\\bin;C:\\Program Files\\Git\\cmd;F:\\工作代码库\\Alarm\\src\\AlarmProcess\\bin\\Debug\\netcoreapp3.1;D:\\Program Files\\nodejs\\;C:\\Users\\Administrator\\AppData\\Local\\Microsoft\\WindowsApps;C:\\Users\\Administrator\\.dotnet\\tools;C:\\Users\\Administrator\\AppData\\Local\\Programs\\Fiddler;C:\\Users\\Administrator\\Documents\\WindowsPowerShell\\Scripts;C:\\kube;C:\\Users\\Administrator\\AppData\\Roaming\\npm",//所有环境变量值
"SystemRoot": "C:\\Windows",
"CommonProgramFiles(x86)": "C:\\Program Files (x86)\\Common Files",
"ComSpec": "C:\\Windows\\system32\\cmd.exe",
"OneDrive": "C:\\Users\\Administrator\\OneDrive",
"ALLUSERSPROFILE": "C:\\ProgramData",
"HOMEDRIVE": "C:",
"PROCESSOR_REVISION": "9e0d",
"PSModulePath": "C:\\Program Files\\WindowsPowerShell\\Modules;C:\\Windows\\system32\\WindowsPowerShell\\v1.0\\Modules",
"VisualStudioDir": "C:\\Users\\Administrator\\Documents\\Visual Studio 2019",
"VisualStudioEdition": "Microsoft Visual Studio Enterprise 2019",
"JMETER_HOME": "D:\\apache-jmeter-5.2.1",
"PROCESSOR_ARCHITECTURE": "AMD64",
"ProgramData": "C:\\ProgramData",
"USERDOMAIN": "Leon",
"CommonProgramFiles": "C:\\Program Files\\Common Files",
"LOCALAPPDATA": "C:\\Users\\Administrator\\AppData\\Local",
"VSSKUEDITION": "Enterprise",
"OneDriveConsumer": "C:\\Users\\Administrator\\OneDrive",
"DriverData": "C:\\Windows\\System32\\Drivers\\DriverData",
"ServiceHubLogSessionKey": "E66AF406",
"windir": "C:\\Windows",
"FPS_BROWSER_USER_PROFILE_STRING": "Default",
"ChocolateyInstall": "C:\\ProgramData\\chocolatey",
"TMP": "C:\\Users\\AppData\\Local\\Temp",
"CLASS_PATH": "C:\\Program Files (x86)\\jdk-14\\bin;C:\\Program Files (x86)\\jdk-14\\lib\\dt.jar;C:\\Program Files (x86)\\jdk-14\\lib\\tools.jar;D:\\apache-jmeter-5.2.1\\lib\\ext\\ApacheJMeter_core.jar;D:\\apache-jmeter-5.2.1\\lib\\jorphan.jar;D:\\apache-jmeter-5.2.1\\lib\\logkit-2.0.jar;",
"TEMP": "C:\\Users\\ADMINI~1\\AppData\\Local\\Temp",
"USERPROFILE": "C:\\Users\\Administrator",
"ASPNETCORE_ENVIRONMENT": "Development",
"VSAPPIDDIR": "C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\Enterprise\\Common7\\IDE\\",
"NUMBER_OF_PROCESSORS": "6",
"ProgramW6432": "C:\\Program Files",
"PUBLIC": "C:\\Users\\Public",
"ChocolateyLastPathUpdate": "1615616511616458546",
"APPDATA": "C:\\Users\\Administrator\\AppData\\Roaming",
"PkgDefApplicationConfigFile": "C:\\Users\\Administrator\\AppData\\Local\\Microsoft\\VisualStudio\\16.0_258a1b31\\devenv.exe.config",
"VSAPPIDNAME": "devenv.exe"
}
}
访问 /info
可得到.netcore应用本身的环境信息,例如appsetting.json;系统环境变量;配置文件所有驱动,主机地址等等
{
"RequestHeaders": {
"Connection": "keep-alive",
"Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9",
"Accept-Encoding": "gzip, deflate, br",
"Accept-Language": "zh-CN,zh;q=0.9,en;q=0.8,en-GB;q=0.7,en-US;q=0.6",
"Host": "localhost:5001",
"User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4178.0 Safari/537.36 Edg/85.0.558.0",
"Upgrade-Insecure-Requests": "1",
"sec-ch-ua": "\"Chromium\";v=\"85\", \"\\\\Not;A\\\"Brand\";v=\"99\", \"Microsoft Edge\";v=\"85\"",
"sec-ch-ua-mobile": "?0",
"Sec-Fetch-Site": "none",
"Sec-Fetch-Mode": "navigate",
"Sec-Fetch-User": "?1",
"Sec-Fetch-Dest": "document"
},
"ConfigProviders": [
"Microsoft.Extensions.Configuration.ChainedConfigurationProvider",
"JsonConfigurationProvider for 'appsettings.json' (Optional)",
"JsonConfigurationProvider for 'appsettings.Development.json' (Optional)",
"EnvironmentVariablesConfigurationProvider",
"CommandLineConfigurationProvider",
"JsonConfigurationProvider for 'appsettings.json' (Optional)",
"JsonConfigurationProvider for 'appsettings.Development.json' (Optional)",
"EnvironmentVariablesConfigurationProvider",
"CommandLineConfigurationProvider"
],
"Configs": [
{
"Key": "windir",
"Value": "C:\\Windows"
},
{
"Key": "VSSKUEDITION",
"Value": "Enterprise"
},
{
"Key": "VSLANG",
"Value": "2052"
},
{
"Key": "VSAPPIDNAME",
"Value": "devenv.exe"
},
{
"Key": "VSAPPIDDIR",
"Value": "C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\Enterprise\\Common7\\IDE\\"
},
{
"Key": "VisualStudioVersion",
"Value": "16.0"
},
{
"Key": "VisualStudioEdition",
"Value": "Microsoft Visual Studio Enterprise 2019"
},
{
"Key": "VisualStudioDir",
"Value": "C:\\Users\\Administrator\\Documents\\Visual Studio 2019"
},
{
"Key": "VerifySignOption",
"Value": null
}]
}
"NetProCheckerOption": {
"Enabled": true,
"HealthPath": "/health",
"InfoPath": "/info",
"EnvPath": "/Env"
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp3.1 is compatible. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETCoreApp 3.1
- IPAddressRange (>= 4.2.0)
- Microsoft.AspNetCore.Http.Abstractions (>= 2.2.0)
- Microsoft.Extensions.Configuration (>= 6.0.0)
- MongoDB.Driver (>= 2.14.1)
- NetPro.Core (>= 6.0.5-beta.4)
- Newtonsoft.Json (>= 13.0.1)
- StackExchange.Redis (>= 2.2.88)
-
net6.0
- IPAddressRange (>= 4.2.0)
- Microsoft.AspNetCore.Http.Abstractions (>= 2.2.0)
- Microsoft.Extensions.Configuration (>= 6.0.0)
- MongoDB.Driver (>= 2.14.1)
- NetPro.Core (>= 6.0.5-beta.4)
- Newtonsoft.Json (>= 13.0.1)
- StackExchange.Redis (>= 2.2.88)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on NetPro.Checker:
Package | Downloads |
---|---|
NetPro.Web.Core
Package Description |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
6.0.16 | 194 | 7/24/2023 |
6.0.15 | 481 | 7/19/2022 |
6.0.14 | 482 | 7/10/2022 |
6.0.13 | 495 | 6/15/2022 |
6.0.12 | 485 | 6/15/2022 |
6.0.11 | 469 | 6/15/2022 |
6.0.10 | 475 | 6/11/2022 |
6.0.9 | 479 | 6/8/2022 |
6.0.8 | 486 | 5/26/2022 |
6.0.8-beta.3 | 141 | 5/24/2022 |
6.0.8-beta.2 | 113 | 5/24/2022 |
6.0.7 | 477 | 5/18/2022 |
6.0.6 | 517 | 4/28/2022 |
6.0.5 | 533 | 3/30/2022 |
6.0.5-beta.20 | 127 | 4/27/2022 |
6.0.5-beta.19 | 125 | 4/25/2022 |
6.0.5-beta.18 | 119 | 4/22/2022 |
6.0.5-beta.17 | 113 | 4/16/2022 |
6.0.5-beta.16 | 120 | 4/8/2022 |
6.0.5-beta.15 | 122 | 4/8/2022 |
6.0.5-beta.14 | 126 | 4/7/2022 |
6.0.5-beta.13 | 136 | 4/7/2022 |
6.0.5-beta.12 | 124 | 4/6/2022 |
6.0.5-beta.11 | 117 | 4/6/2022 |
6.0.5-beta.10 | 121 | 3/31/2022 |
6.0.5-beta.9 | 132 | 3/26/2022 |
6.0.5-beta.8 | 127 | 3/22/2022 |
6.0.5-beta.7 | 117 | 3/21/2022 |
6.0.5-beta.6 | 127 | 3/14/2022 |
6.0.5-beta.5 | 117 | 3/2/2022 |
6.0.5-beta.4 | 123 | 2/22/2022 |
6.0.5-beta.3 | 134 | 2/18/2022 |
6.0.5-beta.2 | 121 | 2/18/2022 |
6.0.5-beta.1 | 122 | 2/16/2022 |
6.0.4 | 573 | 2/10/2022 |
6.0.3 | 582 | 2/9/2022 |
6.0.3-beta.9 | 124 | 2/10/2022 |
6.0.3-beta.8 | 132 | 1/27/2022 |
6.0.3-beta.7 | 132 | 1/19/2022 |
6.0.3-beta.6 | 132 | 1/17/2022 |
6.0.3-beta.5 | 139 | 1/16/2022 |
6.0.3-beta.4 | 140 | 1/14/2022 |
6.0.3-beta.3 | 139 | 1/13/2022 |
6.0.3-beta.2 | 162 | 1/11/2022 |
6.0.3-beta.1 | 155 | 1/11/2022 |
6.0.2 | 327 | 1/6/2022 |
6.0.1 | 1,025 | 12/3/2021 |
3.1.11 | 437 | 11/17/2021 |
3.1.10 | 1,800 | 7/29/2021 |
3.1.9 | 1,620 | 7/1/2021 |
3.1.8 | 1,652 | 12/15/2020 |
3.1.6 | 1,794 | 9/16/2020 |
3.1.5 | 1,679 | 9/8/2020 |
3.1.2 | 1,856 | 6/30/2020 |
3.1.1 | 1,863 | 6/23/2020 |
3.1.0 | 4,316 | 5/24/2020 |
1.0.1 | 1,984 | 5/4/2020 |
1.0.0 | 1,820 | 4/27/2020 |