AspNetCore.HealthChecks.MySql
8.0.1
dotnet add package AspNetCore.HealthChecks.MySql --version 8.0.1
NuGet\Install-Package AspNetCore.HealthChecks.MySql -Version 8.0.1
<PackageReference Include="AspNetCore.HealthChecks.MySql" Version="8.0.1" />
paket add AspNetCore.HealthChecks.MySql --version 8.0.1
#r "nuget: AspNetCore.HealthChecks.MySql, 8.0.1"
// Install AspNetCore.HealthChecks.MySql as a Cake Addin #addin nuget:?package=AspNetCore.HealthChecks.MySql&version=8.0.1 // Install AspNetCore.HealthChecks.MySql as a Cake Tool #tool nuget:?package=AspNetCore.HealthChecks.MySql&version=8.0.1
MySQL Health Check
This health check verifies the ability to communicate with a MySQL Server. It uses the provided MySqlDataSource or a connection string to connect to the server.
Defaults
By default, the MySqlDataSource
instance is resolved from service provider.
(This should be the same as the instance being used by the application; do not create a new MySqlDataSource
just for the health check.)
The health check will send a MySQL "ping" packet to the server to verify connectivity.
builder.Services
.AddMySqlDataSource(builder.Configuration.GetConnectionString("mysql")) // using the MySqlConnector.DependencyInjection package
.AddHealthChecks().AddMySql();
Connection String
You can also specify a connection string directly:
builder.Services.AddHealthChecks().AddMySql(connectionString: "Server=...;User Id=...;Password=...");
This can be useful if you're not using MySqlDataSource
in your application.
Customization
You can additionally add the following parameters:
healthQuery
: A query to run against the server. Ifnull
(the default), the health check will send a MySQL "ping" packet to the server.configure
: An action to configure theMySqlConnection
object. This is called after theMySqlConnection
is created but before the connection is opened.name
: The health check name. The default ismysql
.failureStatus
: TheHealthStatus
that should be reported when the health check fails. Default isHealthStatus.Unhealthy
.tags
: A list of tags that can be used to filter sets of health checks.timeout
: ASystem.TimeSpan
representing the timeout of the check.
builder.Services
.AddMySqlDataSource(builder.Configuration.GetConnectionString("mysql"))
.AddHealthChecks().AddMySql(
healthQuery: "SELECT 1;",
configure: conn => conn.ConnectTimeout = 3,
name: "MySQL"
);
Breaking changes
In previous versions, MySqlHealthCheck
defaulted to testing connectivity by sending a SELECT 1;
query to the server.
It has been changed to send a more efficient "ping" packet instead.
To restore the previous behavior, specify healthQuery: "SELECT 1;"
when registering the health check.
While not a breaking change, it's now preferred to use MySqlDataSource
instead of a connection string.
This allows the health check to use the same connection pool as the rest of the application.
This can be achieved by calling the .AddMySql()
overload that has no required parameters.
The health check assumes that a MySqlDataSource
instance has been registered with the service provider and will retrieve it automatically.
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 | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.0)
- MySqlConnector (>= 2.3.1)
-
net6.0
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.0)
- MySqlConnector (>= 2.3.1)
NuGet packages (40)
Showing the top 5 NuGet packages that depend on AspNetCore.HealthChecks.MySql:
Package | Downloads |
---|---|
NanoCore
The project is inspired by years of tedious repetitions, continuously re-writing similar code-snippets and libraries, to handle common functionality, not related to the business domain, such as logging, data persistence, message queuing, documentation, validation and similar. |
|
FenixAlliance.ACL.Dependencies
Application Component for the Alliance Business Suite. |
|
EachShow.Host
主机启动程序 |
|
GeeksCoreLibrary
Geeks Core Library |
|
Marvel.Web.Framework
Marvel.Web.Framework |
GitHub repositories (13)
Showing the top 5 popular GitHub repositories that depend on AspNetCore.HealthChecks.MySql:
Repository | Stars |
---|---|
dotnet/aspire
An opinionated, cloud ready stack for building observable, production ready, distributed applications in .NET
|
|
Ombi-app/Ombi
Want a Movie or TV Show on Plex/Emby/Jellyfin? Use Ombi!
|
|
skoruba/IdentityServer4.Admin
The administration for the IdentityServer4 and Asp.Net Core Identity
|
|
dotnetcore/osharp
OSharp是一个基于.Net6.0的快速开发框架,框架对 AspNetCore 的配置、依赖注入、日志、缓存、实体框架、Mvc(WebApi)、身份认证、功能权限、数据权限等模块进行更高一级的自动化封装,并规范了一套业务实现的代码结构与操作流程,使 .Net 框架更易于应用到实际项目开发中。
|
|
AlphaYu/adnc
.NET微服务/分布式开发框架,同时也适用于单体架构系统的开发。
|
Version | Downloads | Last updated |
---|---|---|
8.0.1 | 280,980 | 4/2/2024 |
8.0.0 | 213,099 | 12/15/2023 |
7.0.0 | 193,301 | 7/30/2023 |
7.0.0-rc2.5 | 33,090 | 3/13/2023 |
7.0.0-rc2.4 | 15,325 | 1/14/2023 |
7.0.0-rc2.3 | 207 | 12/27/2022 |
7.0.0-rc2.2 | 161 | 12/27/2022 |
6.0.2 | 2,101,639 | 2/28/2022 |
6.0.1 | 280,023 | 12/29/2021 |
6.0.1-rc1.1 | 31,902 | 11/5/2021 |
6.0.0 | 14,285 | 12/29/2021 |
5.0.1 | 698,187 | 1/5/2021 |
5.0.0 | 10,725 | 12/29/2020 |
5.0.0-preview1 | 4,027 | 11/22/2020 |
3.2.0 | 275,964 | 9/3/2020 |
3.1.1 | 645,357 | 4/17/2020 |
3.1.0 | 36,197 | 4/9/2020 |
3.0.0 | 405,630 | 9/24/2019 |
2.2.0 | 617,208 | 11/14/2018 |