LiteX.HealthChecks.AmazonS3
3.0.0
Install-Package LiteX.HealthChecks.AmazonS3 -Version 3.0.0
dotnet add package LiteX.HealthChecks.AmazonS3 --version 3.0.0
<PackageReference Include="LiteX.HealthChecks.AmazonS3" Version="3.0.0" />
paket add LiteX.HealthChecks.AmazonS3 --version 3.0.0
#r "nuget: LiteX.HealthChecks.AmazonS3, 3.0.0"
// Install LiteX.HealthChecks.AmazonS3 as a Cake Addin
#addin nuget:?package=LiteX.HealthChecks.AmazonS3&version=3.0.0
// Install LiteX.HealthChecks.AmazonS3 as a Cake Tool
#tool nuget:?package=LiteX.HealthChecks.AmazonS3&version=3.0.0
LiteX HealthChecks AmazonS3
AmazonS3 health checks package used to check the status of a Amazon S3 service in ASP.NET Core applications.
LiteXHealthChecks is very small yet powerful and high-performance library used to check the status of a component in the application, such as a backend service, database or some internal state.
Basic Usage
Install the package
Install via Nuget.
PM> Install-Package LiteX.HealthChecks.AmazonS3
AppSettings
{
"AmazonS3": {
"AccessKey": "--REPLACE WITH YOUR AccessKey--",
"SecretKey": "--REPLACE WITH YOUR SecretKey--",
"BucketName": "--REPLACE WITH YOUR BucketName--"
}
}
Configure Startup Class
public class Startup
{
public IConfiguration Configuration { get; }
public Startup(IConfiguration configuration)
{
Configuration = configuration;
}
public void ConfigureServices(IServiceCollection services)
{
// 1: Use default configuration
services.AddHealthChecks()
.AddAmazonS3(options =>
{
options.AccessKey = Configuration["AmazonS3:AccessKey"];
options.SecretKey = Configuration["AmazonS3:SecretKey"];
options.BucketName = Configuration["AmazonS3:BucketName"];
}, name: "amazon-s3");
// OR
// 2: With all optional configuration
services.AddHealthChecks()
.AddAmazonS3(options =>
{
options.AccessKey = Configuration["AmazonS3:AccessKey"];
options.SecretKey = Configuration["AmazonS3:SecretKey"];
options.BucketName = Configuration["AmazonS3:BucketName"];
},
name: "amazon-s3",
failureStatus: HealthStatus.Degraded,
tags: new string[] { "amazon-s3", "aws-s3", "s3", "amazon-s3" });
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
app.UseHealthChecks("/health");
}
}
Sample Usage Example
Sample for other services.
For more helpful information about LiteX HealthChecks, Please click here.
Product | Versions |
---|---|
.NET | net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows |
.NET Core | netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1 |
.NET Standard | netstandard2.0 netstandard2.1 |
.NET Framework | net461 net462 net463 net47 net471 net472 net48 |
MonoAndroid | monoandroid |
MonoMac | monomac |
MonoTouch | monotouch |
Tizen | tizen40 tizen60 |
Xamarin.iOS | xamarinios |
Xamarin.Mac | xamarinmac |
Xamarin.TVOS | xamarintvos |
Xamarin.WatchOS | xamarinwatchos |
-
.NETCoreApp 3.1
- AWSSDK.S3 (>= 3.5.7.4)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 3.1.10)
-
.NETStandard 2.0
- AWSSDK.S3 (>= 3.5.7.4)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 3.1.10)
-
.NETStandard 2.1
- AWSSDK.S3 (>= 3.5.7.4)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 3.1.10)
-
net5.0
- AWSSDK.S3 (>= 3.5.7.4)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 5.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Upgrade to .NET 5.x.
Added multi-framework target support - .NET 5, .NET Core 3.1, .NET Standard 2.1 and .NET Standard 2.0
Update libraries and SDKs to latest version.