Page Comparison

Summary

Basically, once you have 50.000 requirements in the database, expect 20ms per requirement on the page when you save a page, and 20ms per requirement on view.

Performance improvements in v1.11.5

• For pages with no requirements, we've improved the speed by skipping our indexation:
  • We skip the parsing if the storage format hasn't changed,
  • We skip the parsing if the rendered format hasn't changed, in case it contains an "Include" or "Scaffolding" macro.
  • We skip the parsing if there is no requirement in the old or new version.
• For pages with requirements:
  • We've added indexes on database columns. On our instance we get 5x faster results when saving a page, but we may be in special circumstances.
  • When we index a page (=when a user saves a page), we've batched the lookups of requirements, so we don't do 1 database request for each requirement on the page. On our instance, we get again 4x faster times depending on database latency (most LANs are on 1ms latency, but we've measured with 5ms).
  • We'd be thrilled if you have 20x better response times than in 1.11.4, but we'll check back with customers before asserting that.

For users with Confluence 6.0.2 or 5.10

Indexes on database columns were not available for add-ons in those versions. The best is to upgrade to Confluence 6.0.3 or above, and you will get indexes automatically, which greatly improve databsae performance. Alternatively, you (or your DBA) can create indexes manually:

• AORequirement.SPACEKEY and REQKEY (the index spans on those 2 columns)
• AODependency.SPACEKEY and KEY and BASELINE (the index spans on those 3 columns).
• AOIntegrationQueue.SERVICEID
• AOIntegrationQueue.STATUS

...

This is not a commitment, as it depends on the machine, the set up, the configuration, the latency of the DB, the version of Confluence and Requirement Yogi.

Bottlenecks

We recommend:

• 150 requirements per page, with a maximum of 400 (Confluence doesn't support infinite pages anyway).

• The default Global Limit is 12,000 and it should be the optimum for most people. If administrators notice that the Confluence is running slow, this might be where you need to check first.

• The expected number of dependencies, as explained on Limitations, is about 20. We don't have a hard limit, but please don't design a model with 1000-to-1 relationships, whether on requirements or on Jira issues.

• The size limit for baselines depends on the Global Limit and it is 12,000 requirements by default.

Processes to monitor:

• For administrators, the process to monitor is baseline creation. If baselines take more than 30s to create, they load very important amounts of data in memory, such as requirements and the associated pages, and hold on to the transaction until the baseline is created.

  • Symptom: If baselines are too big, they will cause a memory error, which symptom is to slow the instance down until it doesn't process anything anymore (the phase where the JVM tries to garbage-collect forever) until, at one point, it throws a HeapSpaceException or OutOfMemoryError.

  • Resolution: Administrators can reduce the baseline size by reducing the Global Limit.

  • Our plans: In RY-965, we will ensure we communicate it to users in the UI, and in RY-966 we will make it a background task chopped in smaller transactions.

• The disk space usage in Jira. Delete history in the administration if the AO_42D05A_RY_AUDIT_TRAIL table becomes too large. See Maintenance guide.

• The queue. See Queue performance.

Performance in 3.0

Changes in 3.0:

• When saving a page, we've gone from 3500 requests to 1356 (Don't assume we just had to switch a flag, it instead required heavy optimizations for each request).

• We have reworked the data model around dependencies, it shouldn't change the performance very much.

We have evaluated on a personal machine with the following setup:

• Macbook 2013
• 2,

  iMac 2013 – 3.4 GHz Intel Core

  i7-3635QM (3rd generation–2013, not the 8th generation from 2017)

  i5,

• RAM 8GB.

• Database latency: 5 to 10ms (random) per query.

• Network latency to the database: 2ms (simulated) per query,

• Database prefilled with 80.000 requirements.

We have simply instrumented the code and created massive pages:

Performance in 2.6.9

Same conditions:

Performance in 2.0

Same conditions:

Performance changes in 2.0:

• We've deeply modified the indexing algorithm in 2.0, because we are now importing Excel files.

• This algo generally reads first and checks whether it needs to change the data, instead of deleting all and writing blindly.

• We did not notice much change in speed. Some speeds are improved, other are worse, depending on the number of modified requirements and properties.

Performance in 1.11.5

• For pages with no requirements, we've improved the speed by skipping our indexation:

  • We skip the parsing if the storage format hasn't changed,

  • We skip the parsing if the rendered format hasn't changed, in case it contains an "Include" or "Scaffolding" macro.

  • We skip the parsing if there is no requirement in the old or new version.

• For pages with requirements:

  • We've added indexes on database columns. On our instance we get 5x faster results when saving a page, but we may be in special circumstances.

  • When we index a page (=when a user saves a page), we've batched the lookups of requirements, so we don't do 1 database request for each requirement on the page. On our instance, we get again 4x faster times depending on database latency (most LANs are on 1ms latency, but we've measured with 5ms).

  • We'd be thrilled if you have 20x better response times than in 1.11.4, but we'll check back with customers before asserting that.

Errors in the logs?

If your server meets problems like "OutOfMemoryException", "Java Heap Space" or "SiteMesh" exceptions, it could be related to building the Traceability matrix. One important thing to note is that the Requirement Yogi add-on may not be mentioned in those exceptions. If you are in this situation:

• Use queries that return fewer requirements, in the search, but more importantly in the dependency, traceability and coverage matrix.

• The dependency matrix and the coverage report can only be built by users who can export the space (This permission will change in version 2.0, see Release Notes 2.0).

• Therefore, inform a subset of your users about the server limits and the tips to prevent a memory overflow; and restrict the export permissions to this group only.

• As a last resort, don't use the coverage and dependency matrixes. You can always explore Confluence's database schema and run the queries using an SQL tool. Tables related to Requirement Yogi start with "AO_32F7CE_AOREQUIREMENT".

Also, please notify us if you're meeting performance issues. We've obtained Data Center certification with several performance tests, but real-life environment can be different than prepared tests and we want to keep improving.

Performance of upgrade tasks

Upgrade tasks are executed once, when the addon is upgraded to the provided version.