-
Notifications
You must be signed in to change notification settings - Fork 95
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
It's a FAQ #238
Merged
Merged
It's a FAQ #238
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
# FAQ | ||
|
||
## Just how fast is Quilkin? What sort of performance can I expect? | ||
|
||
Our current testing shows that on Quilkin shows that it process packets _quite fast_! | ||
|
||
We won't be publishing performance benchmarks, as performance will always | ||
change depending on the underlying hardware, number of filters, configurations and more. | ||
|
||
We highly recommend you run your own load tests on your platform and configuration, matching your production | ||
workload and configuration as close as possible. | ||
|
||
Our [iperf3](https://iperf.fr/) based performance test in the [examples' folder](../examples/iperf3) is a good | ||
starting point. | ||
|
||
Since this is still an alpha project, we have plans on investigating further performance improvements in upcoming | ||
releases, both from an optimisation and observability perspective as well. | ||
|
||
## Can I integrate Quilkin with C++ code? | ||
|
||
Quilkin is also released as a [library](https://crates.io/crates/quilkin), so it can be integrated with an external | ||
codebase as necessary. | ||
|
||
Using Rust code inside a C or C++ project mostly consists of two parts. | ||
|
||
* Creating a C-friendly API in Rust | ||
* Embedding your Rust project into an external build system | ||
|
||
See [A little Rust with your C](https://docs.rust-embedded.org/book/interoperability/rust-with-c.html) for more | ||
information. | ||
|
||
Over time, we will be expanding documentation on how to integrate with specific engines if running Quilkin as a | ||
separate binary is not an option. | ||
|
||
## I would like to run Quilkin as a client side proxy on a console? Can I do that? | ||
|
||
This is an ongoing discussion, and since console development is protected by non-disclosure agreements, we can't | ||
comment on this directly. | ||
|
||
That being said, we are having discussions on how we can release lean versions of certain filters that would work | ||
with known supported game engines and languages for circumstances where compiling Rust or providing a separate | ||
Quilkin binary as an executable is not an option. | ||
|
||
## Any reason you didn't contribute this into/extend Envoy? | ||
|
||
This is an excellent question! [Envoy](https://www.envoyproxy.io/) is an amazing project, and has set many of the | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @luna-duclos what did you think of this answer? |
||
standards for how [proxies are written and orchestrated](./xds.md), and was an inspiration for many of | ||
the decisions made on Quilkin. | ||
|
||
However, we decided to build this project separately: | ||
|
||
* Envoy seems primarily focused on web/mobile network workloads (which makes total sense), whereas we wanted | ||
something specialised on gaming UDP communication, so having a leaner, more focused codebase would allow us to move | ||
faster. | ||
* We found the Rust and Cargo ecosystem easier to work with than Bazel and C++, and figured our users would as well. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@luna-duclos what did you think of this answer?