Moesif.Middleware 0.2.2

Middleware to capture incoming API calls from .NET apps and send to the Moesif API Analytics platform.

Source Code on GitHub

How to install

Install the Nuget Package:

Install-Package Moesif.Middleware

How to use

In Startup.cs file in your project directory, please add app.UseMiddleware<MoesifMiddleware>(moesifOptions); to the pipeline.

Because of middleware execution order, it is best to add middleware below SessionMiddleware and AuthenticationMiddleware, because they add useful session data that enables deeper error analysis. On the other hand, if you have other middleware that modified response before going out, you may choose to place Moesif middleware above the middleware modifying response. This allows Moesif to see the modifications to the response data and see closer to what is going over the wire.

Add the middleware to your application:

app.UseMiddleware<MoesifMiddleware>(moesifOptions);

Also, add moesifOptions to your settings file,

// moesifOptions is an object of type Dictionary<string, object> which holds configuration options for your application.
Dictionary<string, object> moesifOptions = new Dictionary<string, object>
{
    {"ApplicationId", "Your Application ID Found in Settings on Moesif"},
    {"LogBody", true},
    ...
    # For other options see below.
};

You can find your Application Id from Moesif Dashboard → Top Right Menu → App Setup

Configuration options

ApplicationId

(required), string, is obtained via your Moesif Account, this is required.

Skip

(optional) (HttpRequest, HttpResponse) ⇒ boolean, a function that takes a request and a response, and returns true if you want to skip this particular event.

IdentifyUser

(optional) (HttpRequest, HttpResponse) ⇒ string, a function that takes a request and a response, and returns a string that is the user id used by your system. While Moesif identify users automatically, if your set up is very different from the standard implementations, it would be helpful to provide this function.

IdentifyCompany

(optional) (HttpRequest, HttpResponse) ⇒ string, a function that takes a request and a response, and returns a string that is the company id for this event.

GetSessionToken

(optional) (HttpRequest, HttpResponse) ⇒ string, a function that takes a request and a response, and returns a string that is the session token for this event. Again, Moesif tries to get the session token automatically, but if you setup is very different from standard, this function will be very help for tying events together, and help you replay the events.

GetMetadata

(optional) (HttpRequest, HttpResponse) ⇒ dictionary, getMetadata is a function that returns an object that allows you to add custom metadata that will be associated with the event. The metadata must be a dictionary that can be converted to JSON. For example, you may want to save a VM instance_id, a trace_id, or a tenant_id with the request.

MaskEventModel

(optional) (EventModel) ⇒ EventModel, a function that takes an EventModel and returns an EventModel with desired data removed. Use this if you prefer to write your own mask function. The return value must be a valid EventModel required by Moesif data ingestion API. For details regarding EventModel please see the Moesif CSharp API Documentation.

ApiVersion

(optional), string, api version associated with this particular event.

LocalDebug

boolean, set to true to print internal log messages for debugging SDK integration issues.

LogBody

boolean, default true. Set to false to not log the request and response body to Moesif.

Capture_Outgoing_Requests

(optional), Set to capture all outgoing API calls from your app to third parties like Stripe or to your own dependencies while using System.Net.Http package. The options below is applied to outgoing API calls. When the request is outgoing, for options functions that take request and response as input arguments, the request and response objects passed in are HttpRequestMessage request and HttpResponseMessage response objects.

How to configure your application to start capturing outgoing API calls.

using System.Net.Http;
using Moesif.Middleware.Helpers;

// moesifOptions is an object of type Dictionary<string, object> which holds configuration options for your application.
MoesifCaptureOutgoingRequestHandler handler = new MoesifCaptureOutgoingRequestHandler(new HttpClientHandler(), moesifOptions);
HttpClient client = new HttpClient(handler);

GetMetadataOutgoing

(optional) (HttpRequestMessage, HttpResponseMessage) ⇒ dictionary, getMetadata is a function that returns an object that allows you to add custom metadata that will be associated with the event. The metadata must be a dictionary that can be converted to JSON. For example, you may want to save a VM instance_id, a trace_id, or a tenant_id with the request.

GetSessionTokenOutgoing

(optional) (HttpRequestMessage, HttpResponseMessage) ⇒ string, a function that takes a HttpRequestMessage and a HttpResponseMessage, and returns a string that is the session token for this event. Again, Moesif tries to get the session token automatically, but if you setup is very different from standard, this function will be very help for tying events together, and help you replay the events.

IdentifyUserOutgoing

(optional) (HttpRequestMessage, HttpResponseMessage) ⇒ string, a function that takes a HttpRequestMessage and a HttpResponseMessage, and returns a string that is the user id used by your system. While Moesif identify users automatically, if your set up is very different from the standard implementations, it would be helpful to provide this function.

IdentifyCompanyOutgoing

(optional) (HttpRequestMessage, HttpResponseMessage) ⇒ string, a function that takes a HttpRequestMessage and a HttpResponseMessage, and returns a string that is the company id for this event.

SkipOutgoing

(optional) (HttpRequestMessage, HttpResponseMessage) ⇒ boolean, a function that takes a HttpRequestMessage and a HttpResponseMessage, and returns true if you want to skip this particular event.

MaskEventModelOutgoing

(optional) (EventModel) ⇒ EventModel, a function that takes an EventModel and returns an EventModel with desired data removed. Use this if you prefer to write your own mask function. The return value must be a valid EventModel required by Moesif data ingestion API. For details regarding EventModel please see the Moesif CSharp API Documentation.

LogBodyOutgoing

boolean, default true. Set to false to not log the request and response body to Moesif.