Skip to content

Add documentation about system requirements and suggestions#4937

Merged
optionsome merged 6 commits into
opentripplanner:dev-2.xfrom
HSLdevcom:system-requirements
Mar 9, 2023
Merged

Add documentation about system requirements and suggestions#4937
optionsome merged 6 commits into
opentripplanner:dev-2.xfrom
HSLdevcom:system-requirements

Conversation

@optionsome

Copy link
Copy Markdown
Member

Summary

Adds documentation page for the system requirements and suggestions.

Issue

No issue

Documentation

Updated documentation

Changelog

From title.

@optionsome optionsome added the !Documentation Improve documentation targeting users and/or developers. label Mar 6, 2023
@optionsome
optionsome requested a review from a team as a code owner March 6, 2023 16:37
@leonardehrenfried

Copy link
Copy Markdown
Member

I think CI is affected by #4929

Comment thread docs/System-Requirements.md Outdated
@codecov

codecov Bot commented Mar 6, 2023

Copy link
Copy Markdown

Codecov Report

Patch coverage has no change and project coverage change: +0.12 🎉

Comparison is base (00aad08) 63.02% compared to head (36d0a3c) 63.15%.

Additional details and impacted files
@@              Coverage Diff              @@
##             dev-2.x    #4937      +/-   ##
=============================================
+ Coverage      63.02%   63.15%   +0.12%     
- Complexity     13370    13406      +36     
=============================================
  Files           1669     1669              
  Lines          66505    66519      +14     
  Branches        7253     7250       -3     
=============================================
+ Hits           41917    42009      +92     
+ Misses         22192    22111      -81     
- Partials        2396     2399       +3     
Impacted Files Coverage Δ
...ner/standalone/configure/ConstructApplication.java 10.52% <0.00%> (-0.29%) ⬇️
...entripplanner/routing/algorithm/RoutingWorker.java 81.67% <0.00%> (-0.14%) ⬇️
...n/java/org/opentripplanner/standalone/OTPMain.java 0.00% <0.00%> (ø)
...rg/opentripplanner/graph_builder/GraphBuilder.java 0.00% <0.00%> (ø)
...ntripplanner/standalone/server/MetricsLogging.java 0.00% <0.00%> (ø)
...pplanner/standalone/configure/LoadApplication.java 0.00% <0.00%> (ø)
..._builder/module/configure/GraphBuilderModules.java 0.00% <0.00%> (ø)
...r/api/request/DynamicSearchWindowCoefficients.java 100.00% <0.00%> (ø)
...lone/config/routerconfig/TransitRoutingConfig.java 96.19% <0.00%> (ø)
...geraptor/transit/RaptorSearchWindowCalculator.java 100.00% <0.00%> (ø)
... and 11 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@leonardehrenfried
leonardehrenfried requested a review from t2gran March 7, 2023 10:24
Comment thread docs/System-Requirements.md Outdated
Comment thread docs/System-Requirements.md Outdated
Comment on lines +13 to +15
OTP's performance scales with the number of available CPU cores. OTP processes each request in a separate thread and depending on the configuration, a single request can use multiple threads. Realtime updates also run in a separate thread. Therefore, to have a good performance, it makes sense to have multiple cores available. How OTP uses parallel processing also depends on the available cores (<= 2 cores vs >2 cores) in some cases. Therefore, load testing should be done against a machine that doesn't differ too much from production machines.

Entur and the Digitransit project have found that the 3rd generation AMD processors have a slightly better performance for OTP2 than the Intel 3rd generation CPUs (and especially better than the 2nd generation CPUs).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe emphasize that one OTP http request runs for most parts in one thread. There are small operations
part of an request that can be configured to run in parallel, but in general we do not utilize more than
one core per request. However, this is something we continuously evaluate and may change.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Legacy GraphQL API allows batch queries (and queries containing multiple queries) to be processed totally in parallel if the queries are plan/nearest queries, If configured to do so. But you are correct that almost always we only use singly thread (at least for the most part of the query) so I'll change the wording.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed in 36d0a3c

@t2gran t2gran left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only one comment about threading.

optionsome and others added 2 commits March 7, 2023 17:03
@optionsome
optionsome merged commit f2702ee into opentripplanner:dev-2.x Mar 9, 2023
@optionsome
optionsome deleted the system-requirements branch March 9, 2023 14:52
t2gran pushed a commit that referenced this pull request Mar 9, 2023
@t2gran t2gran added this to the 2.3 milestone Mar 14, 2023
loj-hbt pushed a commit to HBTGmbH/OpenTripPlanner that referenced this pull request Mar 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

!Documentation Improve documentation targeting users and/or developers.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants