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

Add health state and management server for coordinators #908

Merged
merged 10 commits into from
Jul 24, 2024

Conversation

antoniofilipovic
Copy link
Contributor

Description

This diff adds docs for PR: memgraph/memgraph#2138.

In the given PR management server coordinators is introduced, as well as health output is now the same for leaders and followers.

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)
memgraph/memgraph#2138

Closes:
(paste the link to the issue it closes)

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

@antoniofilipovic antoniofilipovic added the future release For one of the next versions label Jul 12, 2024
@antoniofilipovic antoniofilipovic self-assigned this Jul 12, 2024
Copy link

vercel bot commented Jul 12, 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 22, 2024 8:05am

@kgolubic kgolubic changed the base branch from memgraph-2-19 to memgraph-2-18-1 July 17, 2024 13:49
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.

It all looks ok to me.

health status of other instances and the time of last response since only the leader is pinging instances for their status.
perspective, their role (are they MAIN, REPLICA, LEADER, FOLLOWER or unknown if not alive) and the response time
from instances to the leader's ping. This query can be run both on the leader and followers. Followers will try contacting the leader to get the state of the cluster.
If contacting the leader fails, followers will return time since the last successful response and health state set to 0 and unknown, respectfully.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think you mean "respectively". However, I'm still having trouble understanding what happens when contacting the leader fails. Perhaps make an ordered list to clearly separate the results?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can you explain which part is problematic, I have trouble fixing it if I am not sure what the exact issue is with understanding 😄
I will rewrite what is happening, but I think a better way on commenting a sentence would be to say which part exactly is not understood

Copy link
Contributor

Choose a reason for hiding this comment

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

Note: the development PR is marked as breaking. Due to that, if all comments are not resolved until the moment we release 2.18.1, I'll create new issues to resolve the remainder of the open issues after the release.

@kgolubic kgolubic merged commit 63e9dff into memgraph-2-18-1 Jul 24, 2024
2 checks passed
@kgolubic kgolubic deleted the add-health-output branch July 24, 2024 11:05
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
future release For one of the next versions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants