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.

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

Observe allocated deltas in system docs #808

Merged
merged 48 commits into from
Jul 17, 2024

Conversation

Josipmrden
Copy link
Contributor

Description

A new parameter has been added in the SHOW STORAGE INFO that tracks the total unreleased amount of Delta objects in the system.

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 priority: high (error) A mistake in the documentation, or information that is crucial for a correct flow status: ready PR is ready for review customer labels May 29, 2024
@Josipmrden Josipmrden self-assigned this May 29, 2024
@Josipmrden Josipmrden requested a review from kgolubic as a code owner May 29, 2024 11:47
Copy link

vercel bot commented May 29, 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 Jul 17, 2024 1:37pm

@Josipmrden Josipmrden changed the base branch from main to observe-peak-memory-docs May 29, 2024 11:48
@kgolubic kgolubic requested a review from hal-eisen-MG June 10, 2024 08:19
@@ -36,6 +36,7 @@ The result will contain the following fields:
| vm_max_map_count | The number of memory-mapped areas that the kernel allows a process to have. If it is unknown, returns -1. </br> For more info, check out [virtual memory section of the docs](/fundamentals/storage-memory-usage#virtual-memory). |
| memory_res | The non-swapped physical RAM memory a task has used, reported by the OS (in B, KiB, MiB, GiB or TiB). |
| peak_memory_res | Peak RAM memory usage in the system during the whole run. |
| unreleased_delta_objects | Total unreleased number of `Delta` objects in the system. |
Copy link
Contributor

Choose a reason for hiding this comment

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

Avoid using a term to define itself. Rather, explain what it means to be "released" vs "not released" and explain what a "delta object" is

@kgolubic kgolubic added the Docs Ready - Pending Dev Merge Documentation reviewed and ready; awaiting corresponding dev merge. label Jun 14, 2024
@Josipmrden Josipmrden requested a review from hal-eisen-MG June 17, 2024 12:53
Base automatically changed from observe-peak-memory-docs to memgraph-2-18 July 1, 2024 05:06
andrejtonev and others added 10 commits July 1, 2024 07:07
* 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 instance to be alive on force reset

* Update high-availability.mdx
* 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>
* wip oidc docs

* oidc sso docs

* PR changes and update

* update package info

* add startup info
* 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>
@Josipmrden
Copy link
Contributor Author

@kgolubic Please don't merge into memgraph-2-18, we'll wait for 2.19 for this.

hal-eisen-MG
hal-eisen-MG previously approved these changes Jul 2, 2024
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

Base automatically changed from memgraph-2-18 to main July 3, 2024 17:11
@kgolubic kgolubic dismissed hal-eisen-MG’s stale review July 3, 2024 17:11

The base branch was changed.

@kgolubic kgolubic changed the base branch from main to memgraph-2-19 July 8, 2024 07:01
@kgolubic kgolubic added future release For one of the next versions and removed Docs Ready - Pending Dev Merge Documentation reviewed and ready; awaiting corresponding dev merge. labels Jul 8, 2024
@kgolubic kgolubic changed the base branch from memgraph-2-19 to memgraph-2-18-1 July 17, 2024 13:27
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 to me.

@kgolubic kgolubic merged commit e458555 into memgraph-2-18-1 Jul 17, 2024
2 checks passed
@kgolubic kgolubic deleted the observe-allocated-deltas-in-system-docs branch July 17, 2024 13:46
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
customer future release For one of the next versions priority: high (error) A mistake in the documentation, or information that is crucial for a correct flow status: ready PR is ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants