Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 4.44 KB

README.md

File metadata and controls

70 lines (50 loc) · 4.44 KB
Raw

Docker Images Maven Central NPM

WireQuery

WireQuery is a full-stack session replay tool. Using WireQuery, you can see how a user experiences an issue through a video-like frontend recording. Combined with an overview of the network calls to the backend (including network calls further upstream and their actual payload), you get a holistic overview of how an issue came into existence.

Some issues, however, can only be found on the backend, before users have reported them with a video-like recording. Through a specialized “network query language” called WQL, you can easily start your investigation from the backend as well. Like before, this includes all the network calls up- and downstream of your query result.

Since the video-like recordings and network calls may contain sensitive information, WireQuery’s SDKs are designed with privacy in mind. In most cases, minimum effort is required to strip all sensitive data from your frontend and backend systems.

⭐ If you like WireQuery, please consider giving it a star. Your support can help the project grow and deliver exciting features.

Getting Started

If you want to try out WireQuery on your local machine:

  1. Make sure Docker is installed and run the following commands in your terminal: 
    mkdir wirequery
cd wirequery
curl -O https://raw.githubusercontent.com/wirequery/wirequery/main/docker-compose.yml
curl -O https://raw.githubusercontent.com/wirequery/wirequery/main/nginx.conf
docker-compose up
  2. Wait until both the backend and frontend are initialized and navigate to localhost:8090. Log in with admin / admin and update your password in the Settings.
  3. Start using WireQuery by creating an application and connecting to WireQuery using one of the SDKs below.

If you wish to install WireQuery on a server, please follow the Server Installation instructions.

SDKs

WireQuery's SDKs are offered in the following variants:

Technology Description Notes Resources
JVM Library for vanilla Java, Spring Boot 2 and 3 Docs
JS (Browser) Integration with Javascript in the Browser for frontend recording Not a library, but integration guide and examples Docs
Go Library for Go. Highly experimental and masking not built-in yet Docs
Universal Universal SDK for every other programming language. Highly experimental and masking should be done by the client Docs

More SDKs will be added over time.

Links

Contributing

See CONTRIBUTING.md

License

Unless otherwise specified, WireQuery is licensed under AGPLv3 and the SDK is licensed under MIT. For more information, see LICENSE.md.