Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[14.0.x] Add a statement why we provide no performance numbers #10424

Merged
merged 1 commit into from
Nov 3, 2022
Merged

[14.0.x] Add a statement why we provide no performance numbers #10424

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions documentation/src/main/asciidoc/stories/assembly_deployment_planning.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ To get the best performance for your {brandname} deployment, you should do the f
* Determine what type of clustered cache mode best suits your use case and requirements.
* Understand performance trade-offs and considerations for {brandname} capabilities that provide fault tolerance and consistency guarantees.

include::{topics}/con_performance_metric_considerations.adoc[leveloffset=+1]
include::{topics}/con_calculate_size_data_set.adoc[leveloffset=+1]
include::{topics}/con_memory_overhead.adoc[leveloffset=+2]
include::{topics}/con_jvm_heap_memory_allocation.adoc[leveloffset=+2]
Expand Down
5 changes: 5 additions & 0 deletions documentation/src/main/asciidoc/topics/attributes/community-attributes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,11 @@
:jgroups_schema: http://www.jgroups.org/schema/jgroups-5.2.xsd
:jgroups_extras: https://github.com/jgroups-extras

//
// Infinispan titles
//
:sizing_title: {brandname} performance considerations and tuning guidelines

//
// Include topic-specific attributes
//
Expand Down
25 changes: 25 additions & 0 deletions documentation/src/main/asciidoc/topics/con_performance_metrics_considerations.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
[id='performance-metric-considerations_{context}']
= Performance metric considerations
{brandname} includes so many configurable combinations that determining a single formula for performance metrics that covers all use cases is not possible.

The purpose of the _{sizing_title}_ document is to provide details about use cases and architectures that can help you determine requirements for your {brandname} deployment.

Additionally, consider the following inter-related factors that apply to {brandname}:

* Available CPU and memory resources in cloud environments
* Caches used in parallel
* Get, put, query balancing
* Peak load and throughput limitations
* Querying limitations with data set
* Number of entries per cache
* Size of cache entries

Given the number of different combinations and unknown external factors, providing a performance calculation that meets all {brandname} use cases is not possible.
You cannot compare one performance test to another test if any of the previously listed factors are different.

You can run basic performance tests with the {brandname} CLI that collects limited performance metrics.
You can customize the performance test so that the test outputs results that might meet your needs.
Test results provide baseline metrics that can help you determine settings and resources for your {brandname} caching requirements.

Measure the performance of your current settings and check if they meet your requirements.
If your needs are not met, optimize the settings and then re-measure their performance.