Skip to content

Latest commit

 

History

History
87 lines (55 loc) · 2.9 KB

README.md

File metadata and controls

87 lines (55 loc) · 2.9 KB
Raw

performance-log-middleware

This is simple piece of asp.net core middleware that adds a performance times the duration to each incoming request and logs it to the configured Logger (ILoggerFactory)

CircleCI #

Getting started

Install the package

Install the nuget package from nuget

Either add it with the PM-Console:

    Install-Package performance-log-middleware

Or add it to project.json "dependencies": { ... "performance-log-middleware": "XXX" }

Set your api up

Edit your Startup.cs ->

    Configure(){
        ...

        app.UsePerformanceLog(new PerformanceLogOptions());
        
        ...
    }

Thats it. Now you application logs all request durations to your configured logger.

Options

PerformanceLogOptions

  • LogLevel (optional): Log level the performance logger should UsePerformanceLog. Default: Information
  • Format (optional): Default: "request to {Operation} took {Duration}ms" possible params: 0: operation 1: duration in ms 2: correlationId (the correlationId is equal to Context.TraceIdentifier)

Be aware that asp.net core logging is semantic/structured so the order matters and you cant address a paramter by {1}. It will always use the paramters in the same order => asp.net core log formatting

Look at the unit tests (category: usage) if you want more examples on how to set up logging, e.g. with serilog

###Contributions

Contributors are very welcome. Missing a feature? Have some hints about what can be done better?

Please follow this guideline if you want to contribute:

  • Fork the repository.
  • Create a branch to work in.
  • Make your feature addition or bug fix.
  • Don't forget the unit tests.
  • Send a pull request.

Build and Publish

The package is build in docker so you will need to install docker to build and publish the package. (Of course you could just build it on the machine you are running on and publish it from there. I prefer to build and publish from docker images to have a reliable environment, plus makes it easier to build this on circleci).

build

run: docker-compose -f docker-compose-build.yml up

this will build & test the code. The testresult will be in folder ./testresults and the package in ./package

publish

run (fill in the api key):

    docker run --rm -v ${PWD}/package:/data/package schwamster/nuget-docker push /data/package/*.nupkg <your nuget api key> -Source nuget.org

this will take the package from ./package and push it to nuget.org