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

Update guide on how to analyze & solve performance problems #11467

Closed
5 tasks done
MartinWahnschaffe opened this issue Feb 9, 2023 · 0 comments · Fixed by #11508
Closed
5 tasks done

Update guide on how to analyze & solve performance problems #11467

MartinWahnschaffe opened this issue Feb 9, 2023 · 0 comments · Fixed by #11508
Assignees
@MartinWahnschaffe
Labels
documentation Guides or documentation to help users, developers or other contributors performance Issues that are meant to increase the performance of the application task Something to be done that does not directly affect the software
Milestone
Iteration 2023-02...

Comments

@MartinWahnschaffe
Copy link
Contributor

MartinWahnschaffe commented Feb 9, 2023 •
edited
Loading

Problem Description

While improving the performance of the duplicate merge process (#9054), we identified a few good practices that should be reflected in our existing guide: https://github.com/hzi-braunschweig/SORMAS-Project/blob/development/docs/TROUBLESHOOTING.md#run-analysis-of-a-sql-query-sormas-docker

Proposed Solution

  • Either extend the TROUBLESHOOTING guide or extract a dedicated guide for performance topics
  • Add how to best get executed SQL on dev environment (unit test + show_sql properties)
  • Mention manually optimizing the SQL query to experiment
  • Explain how to use postgres explain analyze and explain.dalibo.com
  • Mention optimizing the query in the code and quickly evaluating the results based on unit tests

Possible Alternatives

Additional Information
@MartinWahnschaffe MartinWahnschaffe added documentation Guides or documentation to help users, developers or other contributors performance Issues that are meant to increase the performance of the application task Something to be done that does not directly affect the software labels Feb 9, 2023
@MartinWahnschaffe MartinWahnschaffe mentioned this issue Feb 9, 2023
Closed
10 tasks
@MartinWahnschaffe MartinWahnschaffe self-assigned this Feb 15, 2023
MartinWahnschaffe added a commit that referenced this issue Feb 15, 2023
@MartinWahnschaffe
#11467 updated performance section of troubleshooting guide
0f239ea 
* clean separation of production and development aspects
* better differentation between SQL performance and java code performance
* guide on how to create sql analysis on dev system
* tips on how to interpret analysis
* tips on how to speed of iteration time when improving a query
* table of contents
@MartinWahnschaffe MartinWahnschaffe mentioned this issue Feb 15, 2023
Merged
MartinWahnschaffe added a commit that referenced this issue Feb 20, 2023
@MartinWahnschaffe
#11467 added methods on how to improve the query
e79f0e4
MartinWahnschaffe added a commit that referenced this issue Feb 20, 2023
@MartinWahnschaffe
Merge pull request #11508 from hzi-braunschweig/task-11467-update-per…
a04a755 
…formance-troubleshooting

#11467 updated performance section of troubleshooting guide
@StefanKock StefanKock added this to the Iteration 2023-02 - 1.81.0 milestone Feb 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MartinWahnschaffe MartinWahnschaffe

Labels
documentation Guides or documentation to help users, developers or other contributors performance Issues that are meant to increase the performance of the application task Something to be done that does not directly affect the software
Projects
None yet
Milestone
Iteration 2023-02 - 1.81.0
Development

Successfully merging a pull request may close this issue.

#11467 updated performance section of troubleshooting guide SORMAS-Foundation/SORMAS-Project
2 participants
@MartinWahnschaffe @StefanKock