Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 2.27 KB

README.md

File metadata and controls

54 lines (36 loc) · 2.27 KB
Raw

Zoic logo


Developer Tool


Table of Contents

  1. Description
  2. Installation
  3. Usage and Configuration
  4. Authors

Description

The Zoic Developer Tool is a Chrome Developer Tools extension for monitoring metrics in a ZoicCache instance. With the Zoic Developer Tool, you can monitor and inspect memory usage, reads processed, writes processed, latency, and more.

Installation

The Zoic Developer Tool is currently available as a Chrome Developer Tools extension. The easiest to get it is to add it from the Chrome Web Store.

The Zoic Developer Tool's latest build can be also be added manually as a Chrome extension. In the Chrome Extensions Page (chrome://extensions/), click on "Load unpacked" and navigate to .../zoic/zoic_dev_tool/ and click "Select". (You may need to toggle on "Developer mode" to do this.) The extension should now be loaded and available in the Chrome Developer Tools.

The Zoic Developer Tool will also be available for download via the Chrome Web Store soon.

Usage and Configuration

To configure the dev tools, you must first link your server address via the input field on the dev tool panel.

  • First: Specify your server address, and endpoint at which you will serve the cache metrics from. (Ex: http://localhost:3000/zoicMetrics)
  • Second: In your server routes, create a new route matching the endpoint specified in the dev tool. In this route add middleware Zoic.getMetrics.

NOTE: This route WILL have CORS enabled.

Example configuration:

const cache = new Zoic();
 
router.get('/zoicMetrics', cache.getMetrics);

Authors