Giter Club home page Giter Club logo

brakecode-node's Introduction

BrakeCODE

Brakecode is software that runs on your hosts. It manages Node.js debugging and other V8 Inspector Protocol sessions as well as diagnostic reports. The Brakecode NPM package is open-source.

Current Features

  • PADS Secure (certificate based SSH tunnel) Remote V8 Protocol Debugging

    • Fully managed SSH tunnels
    • Multiple tunnels per host
    • Multiple hosts per user
    • Easily share debugging sessions with other developers.
    • Support for Node.js and Deno
  • Node.js Diagnostic Reports

    Delivers a JSON-formatted diagnostic summary, written to a file anywhere.

PADS

Installation for PADS usage...

npm install -g brakecode or run with npx npx brakecode

Running BrakeCODE agent You will then be able to access your V8 debugger sessions from your dashboard. Further if you are logged into the NiM client, you can access remote sessions there as well. To open remote sessions, you must be logged into the BrakeCODE dashboard, otherwise NiM will simply show session data.

BrakeCODE PADS panel

Login to BrakeCODE dashboard from NiM

Login to BrakeCODE dashboard from NiM


Node.js Diagnostic Reports

Installation as an application dependency for Node.js diagnostic reports usage...

Install the dependencies and devDependencies and start the server.

$ npm install brakecode

Usage

Example helloworld usage just requires the inclusion of the brakecode package. And very similar to native report handling process.report.writeReport(), you instead use brakecode.sendReport().

brakecode = require('./brakecode')();
let report = brakecode.sendReport();

Reports can then be easily accessed from Chromium DevTools as shown:

Redacted by default

Sensitive data is now redacted by default thanks to rtk. To send unredacted reports set the BRAKECODE_NOREDACT env var to true.

redacted

Environment Vars

  • BRAKECODE_NOREDACT - Set to true to disable redaction.
  • BRAKECODE_API_KEY - An API Key is required to send reports to Brakecode.
  • BRAKECODE_SERVER - Change which server reports are sent to.
  • BRAKECODE_SOURCE_HOST - The source host of the reports can be changed using this var.

brakecode-node's People

Contributors

dependabot[bot] avatar june07 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.