https://github.com/apitally/apitally-dotnet
Simple, privacy-focused API monitoring & analytics for ASP.NET Core web apps
https://github.com/apitally/apitally-dotnet
api api-analytics api-logging api-monitoring api-observability asp-net-core monitoring rest-api
Last synced: 14 days ago
JSON representation
Simple, privacy-focused API monitoring & analytics for ASP.NET Core web apps
- Host: GitHub
- URL: https://github.com/apitally/apitally-dotnet
- Owner: apitally
- License: mit
- Created: 2025-02-24T11:38:30.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-04-09T23:05:47.000Z (20 days ago)
- Last Synced: 2025-04-11T22:17:45.858Z (18 days ago)
- Topics: api, api-analytics, api-logging, api-monitoring, api-observability, asp-net-core, monitoring, rest-api
- Language: C#
- Homepage: https://apitally.io
- Size: 21.5 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Simple, privacy-focused API monitoring & analytics
Apitally helps you understand how your APIs are being used and alerts you when things go wrong.
Just add two lines of code to your project to get started.
---
# Apitally SDK for .NET
[](https://github.com/apitally/apitally-dotnet/actions)
[](https://codecov.io/gh/apitally/apitally-dotnet)
This SDK for Apitally currently supports the following .NET web frameworks:
- [ASP.NET Core](https://docs.apitally.io/frameworks/aspnet-core) (≥ 6.0)
Learn more about Apitally on our 🌎 [website](https://apitally.io) or check out
the 📚 [documentation](https://docs.apitally.io).
## Key features
### API analytics
Track traffic, error and performance metrics for your API, each endpoint and
individual API consumers, allowing you to make informed, data-driven engineering
and product decisions.
### Error tracking
Understand which validation rules in your endpoints cause client errors. Capture
error details and stack traces for 500 error responses, and have them linked to
Sentry issues automatically.
### Request logging
Drill down from insights to individual requests or use powerful filtering to
understand how consumers have interacted with your API. Configure exactly what
is included in the logs to meet your requirements.
### API monitoring & alerting
Get notified immediately if something isn't right using custom alerts, synthetic
uptime checks and heartbeat monitoring. Notifications can be delivered via
email, Slack or Microsoft Teams.
## Install
Install the NuGet package:
```shell
dotnet add package Apitally
```
## Usage
Add Apitally to your ASP.NET Core application by registering the required
services and middleware in your `Program.cs` file:
```csharp
using Apitally;
var builder = WebApplication.CreateBuilder(args);
// Add Apitally services
builder.Services.AddApitally(options =>
{
options.ClientId = "your-client-id";
options.Env = "dev"; // or "prod" etc.
});
var app = builder.Build();
// Add Apitally middleware
app.UseApitally();
// ... rest of your middleware configuration
```
For further instructions, see our
[setup guide for ASP.NET Core](https://docs.apitally.io/frameworks/aspnet-core).
## Getting help
If you need help please
[create a new discussion](https://github.com/orgs/apitally/discussions/categories/q-a)
on GitHub or
[join our Slack workspace](https://join.slack.com/t/apitally-community/shared_invite/zt-2b3xxqhdu-9RMq2HyZbR79wtzNLoGHrg).
## License
This library is licensed under the terms of the MIT license.