Skip to content

Conversation

@Josipmrden
Copy link
Contributor

Description

New parameter has been added in the show storage info command that shows the peak memory in the system during the whole run

Pull request type

Please check what kind of PR this is:

  • Fix or improvement of an existing page
  • New documentation page, release related

Related PRs and issues

PR this doc page is related to:
(especially necessary if the PR is related to a release)

Closes:
x

Checklist:

  • Check all content with Grammarly
  • Perform a self-review of my code
  • Make corresponding changes to the rest of the documentation (consult with the DX team)
  • The build passes locally
  • My changes generate no new warnings or errors
  • Add a corresponding label
  • If release-related, add a product and version label
  • If release-related, add release note on product PR

@Josipmrden Josipmrden added the priority: low (improvements) An idea how the representation of knowledge on a certain page could be improved label May 22, 2024
@Josipmrden Josipmrden self-assigned this May 22, 2024
@Josipmrden Josipmrden requested a review from kgolubic as a code owner May 22, 2024 10:28
@vercel
Copy link

vercel bot commented May 22, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 17, 2024 1:01pm

@kgolubic kgolubic changed the base branch from main to memgraph-2-18 May 28, 2024 14:11
@kgolubic kgolubic added the future release For one of the next versions label May 28, 2024
@kgolubic kgolubic requested a review from hal-eisen-MG June 10, 2024 08:20
@kgolubic kgolubic added status: ready PR is ready for review Docs Ready - Pending Dev Merge Documentation reviewed and ready; awaiting corresponding dev merge. labels Jun 14, 2024
query execution happens. They are approximately of 56 bytes in size, but large-update transactions
can make the number of delta objects be huge - therefore resulting in Memgraph getting out of memory.

We have exposed the `peak_memory_res` variable in the `SHOW STORAGE INFO;` command, with which you
Copy link
Contributor

Choose a reason for hiding this comment

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

Explain that res is an abbreviation for "resident"

can make the number of delta objects be huge - therefore resulting in Memgraph getting out of memory.

We have exposed the `peak_memory_res` variable in the `SHOW STORAGE INFO;` command, with which you
can monitor when the peak memory rises in the system. It will help you diagnose bottlenecks, and queries
Copy link
Contributor

Choose a reason for hiding this comment

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

Awkward. Too many comma. Try something like:
It will help you diagnose bottlenecks and high-memory queries which can be optimized.

Copy link
Contributor

@hal-eisen-MG hal-eisen-MG left a comment

Choose a reason for hiding this comment

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

LGTM

@kgolubic kgolubic added the status: ship it PR can be merged label Jun 17, 2024
Copy link
Contributor

@kgolubic kgolubic left a comment

Choose a reason for hiding this comment

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

Everything looks OK. Can be merged once the memgraph dev PR is merged.

@hal-eisen-MG
Copy link
Contributor

Please link to the blocking PR in the other repo

@kgolubic kgolubic merged commit 075a967 into memgraph-2-18 Jul 1, 2024
@kgolubic kgolubic deleted the observe-peak-memory-docs branch July 1, 2024 05:06
kgolubic added a commit that referenced this pull request Jul 3, 2024
* Docs improvements (#799)

* Add NuRaft log file flag (#816)

* Add health checks docs (#833)

* Update HA examples

* Add NuRaft log file env (#848)

* Add leader/follower role (#857)

Co-authored-by: Antonio Filipovic <61245998+antoniofilipovic@users.noreply.github.com>

* Add coordinator hostname HA configuration option (#860)

* First leader

* Update pages/clustering/high-availability.mdx

Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>
Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>

* Add monitoring at runtime docs (#806)

* database-less connections update (#853)

* Update HA docs

* Add durability for coordinator (#859)

* add durability docs

* Update high-availability.mdx

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* Edge type property index (#855)

* Add hops limit docs (#881)

* add docs for hops limit

* revert accidentally changed part of the docs

* fix grammar mistakes

* implement suggestions

* Peak memory observation in the system (#788)

* Peak memory observation in the system

* Update storage info where needed

* Update best practics

* Add information from PR review

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* removed flags (#854)

* Update envs for HA (#878)

* fix envs

* add 3 missing envs

* Update configuration.mdx

* Update configuration.mdx

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* Add callout for important force reset  notice (#877)

* add callout for instance to be alive on force reset

* Update high-availability.mdx

* Enum datatype (v1) (#852)

* Add information around enums

* Add ALTER to the list of clauses

* Add ALTER to the list of Memgraph's Cypher extension

* Fix incorrect ALTER command

* Update pages/querying/clauses/create.mdx

* Update pages/querying/clauses/alter.mdx

* Update pages/querying/clauses/alter.mdx

* Update graph-modeling.md

* Address PR comments

---------

Co-authored-by: kgolubic <kgolubic@gmail.com>
Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* SSO Core - OIDC + OAuth2.0 docs (#876)

* wip oidc docs

* oidc sso docs

* PR changes and update

* update package info

* add startup info

* Update v2.18 experimental feature statuses (#871)

* Update v2.18 experimental feature statuses

* Join the sentances into paragraphs

* Update language and formatting

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>
Co-authored-by: kgolubic <kgolubic@gmail.com>

* Add postgresql migration docs (#867)

* Add postgresql migration docs

* Fix from PR review

* Single-sign on: general and SAML documentation (#884)

* Update the existing auth flags for v2.18

* Add a usage note for streams and triggers created by SSO users

* Update general (other than the SAML modules) auth functionalities

* Reorganize auth documentation to accommodate SSO

* Add SAML SSO docs (partial)

* Complete SAML docs

* Apply review suggestions

* Add remaining review suggestions

* Move OIDC docs next to SAML (since both are SSO)

* Fix trigger/stream × SSO usage note placement

* Remove duplicate entry and fix section tag

* Move section to the right place

* Apply suggestions

* Update direct download paths (#885)

* Migration tutorial from `RDBMS` using `MAGE` modules (#770)

* Memgraph 2.17 docs

* Docs

* Zoned datetime data type (#723)

* Document how zoned datetime is supported

* Fix formatting

* Update the Differences in Cypher implementation page

* Update min/max functions

* Revert "Zoned datetime data type (#723)" (#763)

This reverts commit 16c8157.

* Add migration tutorial from rdbms to memgraph

* Add fixes

* Fix from PR review

---------

Co-authored-by: kgolubic <kgolubic@gmail.com>
Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>
Co-authored-by: Ante Pušić <ante.pusic@memgraph.io>

* new: Add query sharing docs and update ENV variables for Lab (#865)

* new: Add a complete list of ENV variables

* new: Add query-sharing feature page

* Fix styling issues

* Update query-sharing.mdx

* new: Add more details for the query sharing

* Add images

* Insert images

* Insert images

* Fix paths

---------

Co-authored-by: kgolubic <kgolubic@gmail.com>
Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* Added description how each user can change its own password (#819)

* Added description how each user can change its own password

* Update users.mdx

* Update users.mdx

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* Add SSO docs (#797)

* Add docs for OAuth setup (WIP)

* Add docs for Okta OAuth

* Replace references to OAuth with OIDC

* Update single-sign-on.mdx

* new: Add SAML for Entra and Okta

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>
Co-authored-by: Toni Lastre <toni.lastre@memgraph.io>

* Create release notes for Memgraph 2.18 (#795)

* Update release notes

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update PR

* Update RN

* new: Add Lab 2.15 release notes (#866)

* new: Add Lab 2.15 release notes

* Update pages/release-notes.mdx

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* Update RN

* Update RN

---------

Co-authored-by: Toni <toni.lastre@memgraph.io>

* Remove support for Amazon Linux 2, CentOS 7 and RedHat 8

* Linked MAGE docs

* Update release notes

* Add callout for Breaking changes

* Add PR link

* Update Release notes

* Update pages/database-management/authentication-and-authorization/auth-system-integrations.mdx

Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>

* Fix indentation

---------

Co-authored-by: Andi <andi8647@gmail.com>
Co-authored-by: Antonio Filipovic <61245998+antoniofilipovic@users.noreply.github.com>
Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>
Co-authored-by: Josipmrden <josip.mrden@memgraph.io>
Co-authored-by: andrejtonev <29177572+andrejtonev@users.noreply.github.com>
Co-authored-by: Aidar Samerkhanov <aidar.samerkhanov@memgraph.io>
Co-authored-by: David Ivekovic <david.ivekovic@memgraph.io>
Co-authored-by: Gareth Andrew Lloyd <gareth@ignition-web.co.uk>
Co-authored-by: Ivan Milinović <44698587+imilinovic@users.noreply.github.com>
Co-authored-by: Marko Budiselić <marko.budiselic@memgraph.com>
Co-authored-by: Ante Pušić <ante.pusic@memgraph.io>
Co-authored-by: Toni <toni.lastre@memgraph.io>
Co-authored-by: tonijurjevic96 <168409767+tonijurjevic96@users.noreply.github.com>
Co-authored-by: David <davidlozic@gmail.com>
kgolubic added a commit that referenced this pull request Jul 17, 2024
* Peak memory observation in the system

* Docs improvements (#799)

* Update storage info where needed

* Update best practics

* Add total unreleased amount of deltas to show storage info

* Add best practice for delta allocation

* Add additional info

* Add NuRaft log file flag (#816)

* Add health checks docs (#833)

* Update HA examples

* Add information

* Add NuRaft log file env (#848)

* Add leader/follower role (#857)

Co-authored-by: Antonio Filipovic <61245998+antoniofilipovic@users.noreply.github.com>

* Add fix

* Add coordinator hostname HA configuration option (#860)

* First leader

* Update pages/clustering/high-availability.mdx

Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>
Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>

* Add monitoring at runtime docs (#806)

* database-less connections update (#853)

* Update HA docs

* Add durability for coordinator (#859)

* add durability docs

* Update high-availability.mdx

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* Edge type property index (#855)

* Add hops limit docs (#881)

* add docs for hops limit

* revert accidentally changed part of the docs

* fix grammar mistakes

* implement suggestions

* Peak memory observation in the system (#788)

* Peak memory observation in the system

* Update storage info where needed

* Update best practics

* Add information from PR review

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* removed flags (#854)

* Update envs for HA (#878)

* fix envs

* add 3 missing envs

* Update configuration.mdx

* Update configuration.mdx

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* Add callout for important force reset  notice (#877)

* add callout for instance to be alive on force reset

* Update high-availability.mdx

* Enum datatype (v1) (#852)

* Add information around enums

* Add ALTER to the list of clauses

* Add ALTER to the list of Memgraph's Cypher extension

* Fix incorrect ALTER command

* Update pages/querying/clauses/create.mdx

* Update pages/querying/clauses/alter.mdx

* Update pages/querying/clauses/alter.mdx

* Update graph-modeling.md

* Address PR comments

---------

Co-authored-by: kgolubic <kgolubic@gmail.com>
Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* SSO Core - OIDC + OAuth2.0 docs (#876)

* wip oidc docs

* oidc sso docs

* PR changes and update

* update package info

* add startup info

* Update v2.18 experimental feature statuses (#871)

* Update v2.18 experimental feature statuses

* Join the sentances into paragraphs

* Update language and formatting

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>
Co-authored-by: kgolubic <kgolubic@gmail.com>

* Fix from PR

* Update README.md

* Add metrics info docs (#809)

---------

Co-authored-by: Andi <andi8647@gmail.com>
Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>
Co-authored-by: kgolubic <kgolubic@gmail.com>
Co-authored-by: Antonio Filipovic <61245998+antoniofilipovic@users.noreply.github.com>
Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>
Co-authored-by: andrejtonev <29177572+andrejtonev@users.noreply.github.com>
Co-authored-by: Aidar Samerkhanov <aidar.samerkhanov@memgraph.io>
Co-authored-by: David Ivekovic <david.ivekovic@memgraph.io>
Co-authored-by: Gareth Andrew Lloyd <gareth@ignition-web.co.uk>
Co-authored-by: Ivan Milinović <44698587+imilinovic@users.noreply.github.com>
Co-authored-by: Marko Budiselić <marko.budiselic@memgraph.com>
kgolubic added a commit that referenced this pull request Jul 24, 2024
* Update docs

* Observe allocated deltas in system docs (#808)

* Peak memory observation in the system

* Docs improvements (#799)

* Update storage info where needed

* Update best practics

* Add total unreleased amount of deltas to show storage info

* Add best practice for delta allocation

* Add additional info

* Add NuRaft log file flag (#816)

* Add health checks docs (#833)

* Update HA examples

* Add information

* Add NuRaft log file env (#848)

* Add leader/follower role (#857)

Co-authored-by: Antonio Filipovic <61245998+antoniofilipovic@users.noreply.github.com>

* Add fix

* Add coordinator hostname HA configuration option (#860)

* First leader

* Update pages/clustering/high-availability.mdx

Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>
Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>

* Add monitoring at runtime docs (#806)

* database-less connections update (#853)

* Update HA docs

* Add durability for coordinator (#859)

* add durability docs

* Update high-availability.mdx

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* Edge type property index (#855)

* Add hops limit docs (#881)

* add docs for hops limit

* revert accidentally changed part of the docs

* fix grammar mistakes

* implement suggestions

* Peak memory observation in the system (#788)

* Peak memory observation in the system

* Update storage info where needed

* Update best practics

* Add information from PR review

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* removed flags (#854)

* Update envs for HA (#878)

* fix envs

* add 3 missing envs

* Update configuration.mdx

* Update configuration.mdx

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* Add callout for important force reset  notice (#877)

* add callout for instance to be alive on force reset

* Update high-availability.mdx

* Enum datatype (v1) (#852)

* Add information around enums

* Add ALTER to the list of clauses

* Add ALTER to the list of Memgraph's Cypher extension

* Fix incorrect ALTER command

* Update pages/querying/clauses/create.mdx

* Update pages/querying/clauses/alter.mdx

* Update pages/querying/clauses/alter.mdx

* Update graph-modeling.md

* Address PR comments

---------

Co-authored-by: kgolubic <kgolubic@gmail.com>
Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* SSO Core - OIDC + OAuth2.0 docs (#876)

* wip oidc docs

* oidc sso docs

* PR changes and update

* update package info

* add startup info

* Update v2.18 experimental feature statuses (#871)

* Update v2.18 experimental feature statuses

* Join the sentances into paragraphs

* Update language and formatting

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>
Co-authored-by: kgolubic <kgolubic@gmail.com>

* Fix from PR

* Update README.md

* Add metrics info docs (#809)

---------

Co-authored-by: Andi <andi8647@gmail.com>
Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>
Co-authored-by: kgolubic <kgolubic@gmail.com>
Co-authored-by: Antonio Filipovic <61245998+antoniofilipovic@users.noreply.github.com>
Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>
Co-authored-by: andrejtonev <29177572+andrejtonev@users.noreply.github.com>
Co-authored-by: Aidar Samerkhanov <aidar.samerkhanov@memgraph.io>
Co-authored-by: David Ivekovic <david.ivekovic@memgraph.io>
Co-authored-by: Gareth Andrew Lloyd <gareth@ignition-web.co.uk>
Co-authored-by: Ivan Milinović <44698587+imilinovic@users.noreply.github.com>
Co-authored-by: Marko Budiselić <marko.budiselic@memgraph.com>

* Add params section

* Update high-availability.mdx

* Added config (#931)

* Added config

* Update pages/clustering/high-availability.mdx

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* Update pages/clustering/high-availability.mdx

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* Reloading query modules docs (#916)

* QM improvements docs

* Expand on reloading query modules docs

* Add health state and management server for coordinators (#908)

* Update README.md

* add health output docs

* change sentence

* address PR comments

* add example of correct approach

* rewrite show instances follower part

* add suggestion to use dns

---------

Co-authored-by: kgolubic <kgolubic@gmail.com>
Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* Update direct download link (#939)

* [memgraph-2-18-1 < memgraph-2-18-1-relase-notes] Release notes for Memgraph 2.18-1 (#911)

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* update RN

* Update RN

* Update RN

* Update release notes

* Update release notes

* Add documentation links to the release notes

---------

Co-authored-by: Josipmrden <josip.mrden@memgraph.io>
Co-authored-by: Andi <andi8647@gmail.com>
Co-authored-by: Antonio Filipovic <61245998+antoniofilipovic@users.noreply.github.com>
Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>
Co-authored-by: andrejtonev <29177572+andrejtonev@users.noreply.github.com>
Co-authored-by: Aidar Samerkhanov <aidar.samerkhanov@memgraph.io>
Co-authored-by: David Ivekovic <david.ivekovic@memgraph.io>
Co-authored-by: Gareth Andrew Lloyd <gareth@ignition-web.co.uk>
Co-authored-by: Ivan Milinović <44698587+imilinovic@users.noreply.github.com>
Co-authored-by: Marko Budiselić <marko.budiselic@memgraph.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Docs Ready - Pending Dev Merge Documentation reviewed and ready; awaiting corresponding dev merge. future release For one of the next versions priority: low (improvements) An idea how the representation of knowledge on a certain page could be improved status: ready PR is ready for review status: ship it PR can be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants