Consumption history

Content Type: Module
Categories: Communication

Overview

This module stores and displays the restcalls made by this application to published services, including the request- and response-content. This is a very powerful tool for managing and troubleshooting the application's api calls.

Also it provides an overview of the number of calls made per api. Also its average response time and the max. Each day.

Since potentially many calls will be made, it is important to only enable this history, especially in production, when there is reason to do so and to keep this information to a very limited extent.

Documentation

Typical usage scenario

Any app consuming an external service, where more control over the rest calls is helpful for development, testing and usage.

Features and limitations

- Get an overview showing the recent rest calls made

- Sort&filter the calls by tag, user or date-period

- View call-details like request-content, response-content, response's status code, etc.

- Remove the call-history per set period.

Dependencies

Widget JSON Editor

Installation

  • Download and install this module from the Mendix Marketplace
  • Assign the module roles to the project roles of your choice.
  • Add Snip_Request_Overview to a page of your choice.
  • Now run your app locally and set the configuration.
  • Modify each rest call in your app (do a search on "call rest") and add RequestHistory_Create, RequestHistory_AddResponse, and RequestHistory_AddError around the call like in Demo_RestCall.

Configuration

  • Set the retention-period of the call history. Do this in the configuration-block in the overviewpage.

 

Releases

Version: 1.2.0
Framework Version: 9.24.16
Release Notes: Version 1.2.0 - Due to popular demand: downgraded to Mx9.24.16 Still todo: - Complete the implementation of the switch Enum_KeepHistory - Separate 'allowed on prod' for Content versus Count-statistics.
Version: 1.1.0
Framework Version: 10.6.9
Release Notes: Version 1.1.0 - Added a daily count per api-tag, - Added a graph for the daily calls per api-tag - Added the daily call-responsetimes per api-tag. Average and max.
Version: 1.0.0
Framework Version: 10.6.9
Release Notes: First release in Mendix 10.6.9