ApiGaze.AspNetCore 0.0.1-alpha2

ApiGaze.AspNetCore

ApiGaze is a powerful API monitoring and telemetry middleware for ASP.NET Core applications. It helps you capture, analyze, and monitor your API traffic with ease.

Features

• 🔍 Capture HTTP request and response data
• 🔒 Built-in sensitive data redaction
• ⚡ Efficient buffering and batching
• 🛡️ Configurable path exclusions
• 📊 Rich telemetry data collection
• 🔄 Background processing
• 🎯 Flexible configuration options

Installation

dotnet add package ApiGaze.AspNetCore --version 0.1.0-beta1

Quick Start

1. Create an application in the ApiGaze dashboard and get your Application ID

2. Add ApiGaze to your application:

var builder = WebApplication.CreateBuilder(args);

builder.AddApiGaze(options => 
{
    options.ApplicationId = "your-application-id";
    options.Enabled = true;
});

var app = builder.Build();
app.UseApiGaze();

3. Configure the middleware options:

builder.AddApiGaze(options => 
{
    // Basic configuration
    options.ApplicationId = "your-application-id";
    options.Enabled = true;

    // HTTP capture options
    options.HttpCapture.CaptureRequestBody = true;
    options.HttpCapture.CaptureResponseBody = true;
    options.HttpCapture.CaptureQueryParameters = true;
    options.HttpCapture.CaptureRequestHeaders = true;
    options.HttpCapture.CaptureResponseHeaders = true;
    options.HttpCapture.CaptureExceptionInfo = true;

    // Exclude paths
    options.ExcludedPathPatterns.Add("/health");
    options.ExcludedPathPatterns.Add("/metrics");
    options.ExcludedPathPatterns.Add("/swagger/*");

    // Redaction rules
    options.HttpCapture.RedactionRules.QueryParameterRedactionPatterns.Add("apiKey");
    options.HttpCapture.RedactionRules.HeaderRedactionPatterns.Add("authorization");
    options.HttpCapture.RedactionRules.BodyRedactionPatterns.Add(@"\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}\b");
});

Beta Status

This is a beta release of ApiGaze. Some features and behaviors may change before the final release. We're particularly interested in feedback on:

• Configuration options and defaults
• Performance impact
• Memory usage
• Error handling
• Documentation clarity

Please report any issues or suggestions on our GitHub repository.

Known Limitations

• Memory usage may be high when capturing large request/response bodies
• No built-in persistence for telemetry data
• Limited error handling for external API failures
• No built-in rate limiting

Configuration Options

ApiGazeOptions

HttpCaptureOptions

Best Practices

1. Security

   • Always configure redaction rules for sensitive data
   • Exclude health check and metrics endpoints
   • Use appropriate capture settings based on your needs

2. Performance

   • Enable only the capture options you need
   • Use path exclusions for high-traffic endpoints
   • Monitor memory usage with body capture enabled

3. Configuration

   • Store sensitive configuration in secure configuration providers
   • Use environment-specific settings
   • Validate configuration in development

License

This project is licensed under the MIT License - see the LICENSE file for details.