Skip to content

add performance section to dev guide#10132

Merged
scolapasta merged 3 commits into
developfrom
9919-perf-doc
Dec 12, 2023
Merged

add performance section to dev guide#10132
scolapasta merged 3 commits into
developfrom
9919-perf-doc

Conversation

@pdurbin
Copy link
Copy Markdown
Member

@pdurbin pdurbin commented Nov 20, 2023

What this PR does / why we need it:

As explained in the issue, we'd like to capture our desired strategies in a document that we can review and revise for future use.

Which issue(s) this PR closes:

Special notes for your reviewer:

None. We went over the original doc at tech hours. This is mostly formatting it at rst.

Suggestions on how to test this:

Make sure the docs build.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

No.

Is there a release notes update needed for this change?:

Hmm, I don't think so. Maybe an email to the mailing list.

Additional documentation:

It is documentation.

Also cross-link related content.
@pdurbin pdurbin assigned pdurbin and unassigned pdurbin Nov 20, 2023
@cmbz cmbz added the Size: 3 A percentage of a sprint. 2.1 hours. label Nov 27, 2023
@sekmiller sekmiller self-assigned this Dec 11, 2023
Solr
~~~~

While in the past Solr performance hasn't been much of a concern, in recent years we've noticed performance problems when Harvard Dataverse is under load. We are investigating in `#9635 <https://github.com/IQSS/dataverse/issues/9635>`_.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This issue is marked Closed as Completed

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.

Thanks in 80634c7 I linked to the PR.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

We'd like to scale Dataverse to better handle large number of files or versions (`#9763 <https://github.com/IQSS/dataverse/issues/9763>`_).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Also closed

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.

Good catch, in 80634c7 I linked to the PR as an example.

Learn from the Community How They Monitor Performance
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Some members of the Dataverse community are likely users of newish tools like the ELK stack (Elasticsearch, Logstash, and Kibana), the TICK stack (Telegraph InfluxDB Chronograph and Kapacitor), GoAccess, Prometheus, Graphite, and more we haven't even heard of. In the :doc:`/admin/monitoring` section of the Admin Guide, we already encourage the community to share findings (, but we could dedicate time to this topic at our annual meeting or community calls.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Close parens here?

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.

Whoops. I removed the stray ( in 80634c7. Thanks.

Copy link
Copy Markdown
Contributor

@sekmiller sekmiller left a comment

Choose a reason for hiding this comment

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

Looks Ok. A couple of the issues referred to are already closed as completed

@coveralls
Copy link
Copy Markdown

Coverage Status

coverage: 20.176%. remained the same
when pulling 80634c7 on 9919-perf-doc
into b2c37af on develop.

Copy link
Copy Markdown
Contributor

@sekmiller sekmiller left a comment

Choose a reason for hiding this comment

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

Thanks for the updates

@sekmiller sekmiller removed their assignment Dec 12, 2023
@scolapasta scolapasta merged commit c1754ee into develop Dec 12, 2023
@scolapasta scolapasta deleted the 9919-perf-doc branch December 12, 2023 18:17
@pdurbin pdurbin added this to the 6.1 milestone Dec 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Size: 3 A percentage of a sprint. 2.1 hours.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Develop a performance strategy document describing our preferred approaches and tools

5 participants