clydeio-simple-access-log

Simple Access Log Filter

Access log filter implementation for Clyde API gateway, which allows to store request information into files.

Implementation is based in morgan module.

• Simple Access Log Filter
  • Installation
  • Configuration
  • Examples
    • Configured as global prefilter
    • Configured as provider prefilter
  • Notes
• License

Installation

npm install clydeio-simple-access-log --save

Configuration

Filter accepts the next configuration properties (most of them wrapping morgan properties):

• directory: The folder where to store log files. Default ./.
• file: The file where to store log information. Default access-%DATE%.log.
• format: Log format to store information. See available morgan values. Default combined.
• frequency: Rotating log files are stored with the specified frequency value. See available morgan values. Default daily.
• verbose: Log to STDOUT when it rotates files and name of log file. Default false.
• date_format: Format used to attach dates to file names. Default YYYY-MM-DD.

Examples

Configured as global prefilter

All request to any provider will be stored:

{
  "prefilters" : [
    {
      "id" : "global-log",
      "path" : "clydeio-simple-access-log",
      "config" : {
        "directory" : "./tmp/log",
        "file" : "global-access-%DATE%.log"
      }
    }
    ...
  ]
}

Configured as provider prefilter

Only the requests addresses to the provider will be stored

{
  "providers" : [
    {
      "id" : "some_provider",
      "context" : "/some_provider",
      "target" : "http://some_server",
      "prefilters" : [
        {
          "id" : "provider-logger",
          "path" : "clydeio-simple-access-log",
          "config" : {
            "directory" : "./tmp/log",
            "file" : "provider-access-%DATE%.log"
          }
        }
    },
    ...
  ]
}

Notes

• Note if you configure as a postfilter it is only invoked for success responses.

License

The MIT License (MIT)

Copyright (c) 2015 Antonio Santiago (@acanimal)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.