Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Ark Detective Plugin

This plugin logs all incoming requests made to P2P and API plugins.

⚠️ This plugin logs a lot of messages ⚠️

Due to logging a lot of things we suggest you modify the settings for the winston logger otherwise you might not have logs that will be few days old.

❤️ Support maintenance and development of plugins

If you find this or other plugins useful please consider

  • voting for deadlock delegate
  • donating to AWtgFYbvtLDYccJvC5MChk4dpiUy2Krt2U

to support development new plugins and tools for Ark's Ecosystem and maintenance of existing ones. Full list of contributions can be found on https://arkdelegatesio/delegate/deadlock/. 🖖

Installation

For production:

yarn global add @deadlock-delegate/detective

For development:

cd ~/ark-core/plugins
git clone https://github.com/deadlock-delegate/detective
lerna bootstrap

Registration

Open ~/.config/ark-core/{mainnet|devnet|testnet}/plugins.js and add the following at the end (it has to be bellow p2p and api).

'@deadlock-delegate/detective': {}

like so:

module.exports = {
  '@arkecosystem/core-event-emitter': {},
  '@arkecosystem/core-config': {},
  ...
  '@deadlock-delegate/detective': {},  // this is the newly added line
}

Configuration

module.exports = {
  '@arkecosystem/core-event-emitter': {},
  '@arkecosystem/core-config': {},
  ...
  '@deadlock-delegate/detective': {
    enabled: true, // disable/enable the plugin (default: true)
    api: false, // include api request logs (default: true)
    excludeIPs: ['127.0.0.1'], // exclude requests from these IPs (default: [])
    headers: false, // log the headers (default: true)
    p2p: false, // include p2p request logs (default: true)
    payload: false, // log the POST/PUT/PATCH payloads (default: true)
    requestID: true, // show the requestID (default: false)
  },
}

Credits

License

MIT © roks0n

About

Logs all requests made to p2p and api endpoints

Resources

License

Releases

No releases published

Packages

No packages published