Improves monitoring Neo4j standalone container docs #175

ravikiran-sulikeri · 2023-12-11T14:17:47Z

If you open a PR that needs to go into a current version, you need to cherry-pick your commit from dev over to the current version branch. Only then will the proper builds that generate html/pdf be run. But beware: Docs will be generated but not published automatically!

N/A - or - I have added the appropriate "cherry-pick-to" labels to this PR so I don't forget to do this later!

Trello

netlify · 2023-12-11T14:17:53Z

✅ Deploy Preview for priceless-fermi-5883f3 ready!

Name	Link
🔨 Latest commit	`c0ac9ac`
🔍 Latest deploy log	https://app.netlify.com/sites/priceless-fermi-5883f3/deploys/6582f1717ecaf1000861b480
😎 Deploy Preview	https://deploy-preview-175--priceless-fermi-5883f3.netlify.app/ops-manager/1.8/addition/docker/container
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

neo-technology-commit-status-publisher · 2023-12-11T14:19:36Z

Thanks for the documentation updates.

The preview documentation has now been torn down - reopening this PR will republish it.

AlexicaWright

Editorial and formatting comments and suggestions.

modules/ROOT/pages/addition/docker/container.adoc

Co-authored-by: Jessica Wright <[email protected]>

modules/ROOT/pages/addition/docker/container.adoc

alexnb · 2023-12-18T07:47:35Z

modules/ROOT/pages/addition/docker/container.adoc

+    NEO4J_server_metrics_prometheus_endpoint="localhost:2004" \
+    NEO4J_server_metrics_filter="*" \
+    agent console -s'
+


I think security configuration variables are also needed, ex.

CONFIG_TLS_TRUSTED_CERTS: "/certificates/server.cer"

EDIT: but maybe this one is not important since it is optional.

These properties are not needed for an agent (afaik):

NEO4J_ACCEPT_LICENSE_AGREEMENT="yes" NEO4J_EDITION="enterprise" NEO4J_server_metrics_prometheus_enabled="true" NEO4J_server_metrics_prometheus_endpoint="localhost:2004" NEO4J_server_metrics_filter="*"

This would also apply to the other env variable blocks on this page.

will update, thanks for introducing callouts

alexnb · 2023-12-18T08:35:04Z

Ravi, I changed some shell formatting, hope that is okay!

lidiazuin

Left some editorial suggestions. Could you please take a look too @AlexicaWright ?

modules/ROOT/pages/addition/docker/container.adoc

lidiazuin · 2023-12-18T10:57:11Z

modules/ROOT/pages/addition/docker/container.adoc

+       neo4j/neo4j:latest
+----
+
+<1> Neo4j home directory needs to be mounted back on the Docker host to enable access to agent.


Suggested change

<1> Neo4j home directory needs to be mounted back on the Docker host to enable access to agent.

Note that:

. The Neo4j home directory needs to be mounted back on the Docker host to enable access to agent.

I think callouts make more sense in this section than a note. WDYT @AlexicaWright ?

@ravikiran-sulikeri Ravi, fyi, there is currently an issue with callouts but I added them in anticipation that it gets fixed.

Waiting for word on whether it's getting fixed in the near future. If so, I'd say keep the annotation.

lidiazuin · 2023-12-18T10:57:23Z

modules/ROOT/pages/addition/docker/container.adoc

+----
+
+<1> Neo4j home directory needs to be mounted back on the Docker host to enable access to agent.
+<2> Neo4j prometheus endpoint port (2004) needs to be exposed via port mapping.


Suggested change

<2> Neo4j prometheus endpoint port (2004) needs to be exposed via port mapping.

. Neo4j Prometheus endpoint port (2004) needs to be exposed via port mapping.

lidiazuin · 2023-12-18T10:57:37Z

modules/ROOT/pages/addition/docker/container.adoc

+
+<1> Neo4j home directory needs to be mounted back on the Docker host to enable access to agent.
+<2> Neo4j prometheus endpoint port (2004) needs to be exposed via port mapping.
+<3> Query log port (9500) needs to be mapped for log appender to forward query logs.


Suggested change

<3> Query log port (9500) needs to be mapped for log appender to forward query logs.

. Query log port (9500) needs to be mapped for log appender to forward query logs.

Co-authored-by: Lidia Zuin <[email protected]>

modules/ROOT/pages/addition/docker/container.adoc

Co-authored-by: Alexander Bouriakov <[email protected]>

alexnb

LGTM!

modules/ROOT/pages/addition/docker/container.adoc

AlexicaWright · 2023-12-19T13:42:10Z

modules/ROOT/pages/addition/docker/container.adoc

+       neo4j/neo4j:latest
+----
+
+<1> Neo4j home directory needs to be mounted back on the Docker host to enable access to agent.


Waiting for word on whether it's getting fixed in the near future. If so, I'd say keep the annotation.

modules/ROOT/pages/addition/docker/container.adoc

Co-authored-by: Jessica Wright <[email protected]> Co-authored-by: Lidia Zuin <[email protected]>

AlexicaWright

LGTM 👍

* Improves monitoring Neo4j standalone container docs * minor edits * Update modules/ROOT/pages/addition/docker/container.adoc Co-authored-by: Jessica Wright <[email protected]> * Update modules/ROOT/pages/addition/docker/container.adoc Co-authored-by: Jessica Wright <[email protected]> * Apply suggestions from code review Co-authored-by: Jessica Wright <[email protected]> * correct the doc formmating * formatted shell commands * combined 3 shell blocks into one with callouts * fix agent env config scripts * Apply suggestions from code review Co-authored-by: Lidia Zuin <[email protected]> * Update modules/ROOT/pages/addition/docker/container.adoc Co-authored-by: Alexander Bouriakov <[email protected]> * Apply suggestions from code review Co-authored-by: Jessica Wright <[email protected]> Co-authored-by: Lidia Zuin <[email protected]> --------- Co-authored-by: Jessica Wright <[email protected]> Co-authored-by: Alexander Bouriakov <[email protected]> Co-authored-by: Lidia Zuin <[email protected]>

… (#181) Improves monitoring Neo4j standalone container docs (#175) * Improves monitoring Neo4j standalone container docs * minor edits * Update modules/ROOT/pages/addition/docker/container.adoc * Update modules/ROOT/pages/addition/docker/container.adoc * Apply suggestions from code review * correct the doc formmating * formatted shell commands * combined 3 shell blocks into one with callouts * fix agent env config scripts * Apply suggestions from code review * Update modules/ROOT/pages/addition/docker/container.adoc * Apply suggestions from code review --------- Co-authored-by: Jessica Wright <[email protected]> Co-authored-by: Alexander Bouriakov <[email protected]> Co-authored-by: Lidia Zuin <[email protected]>

Improves monitoring Neo4j standalone container docs

9dfc5d7

ravikiran-sulikeri requested review from alexnb and eve-bright December 11, 2023 14:17

ravikiran-sulikeri added the cherry-pick-to-1.8 label Dec 11, 2023

minor edits

99c7614

AlexicaWright reviewed Dec 15, 2023

View reviewed changes

ravikiran-sulikeri requested a review from lidiazuin December 15, 2023 11:56

ravikiran-sulikeri and others added 4 commits December 15, 2023 11:57

Update modules/ROOT/pages/addition/docker/container.adoc

dffa4fe

Co-authored-by: Jessica Wright <[email protected]>

Update modules/ROOT/pages/addition/docker/container.adoc

52cb62d

Co-authored-by: Jessica Wright <[email protected]>

Apply suggestions from code review

23fe7ea

Co-authored-by: Jessica Wright <[email protected]>

correct the doc formmating

0a46fc8

ravikiran-sulikeri requested a review from AlexicaWright December 15, 2023 12:54

AlexicaWright reviewed Dec 15, 2023

View reviewed changes

modules/ROOT/pages/addition/docker/container.adoc Show resolved Hide resolved

alexnb added 2 commits December 18, 2023 09:33

formatted shell commands

aa0bd0f

combined 3 shell blocks into one with callouts

eb43c91

alexnb requested changes Dec 18, 2023

View reviewed changes

lidiazuin reviewed Dec 18, 2023

View reviewed changes

ravikiran-sulikeri and others added 2 commits December 18, 2023 13:49

fix agent env config scripts

39a3238

Apply suggestions from code review

7eff316

Co-authored-by: Lidia Zuin <[email protected]>

ravikiran-sulikeri requested review from AlexicaWright, alexnb and lidiazuin December 18, 2023 13:59

alexnb requested changes Dec 18, 2023

View reviewed changes

modules/ROOT/pages/addition/docker/container.adoc Outdated Show resolved Hide resolved

Update modules/ROOT/pages/addition/docker/container.adoc

27f5997

Co-authored-by: Alexander Bouriakov <[email protected]>

alexnb approved these changes Dec 18, 2023

View reviewed changes

AlexicaWright reviewed Dec 19, 2023

View reviewed changes

AlexicaWright reviewed Dec 20, 2023

View reviewed changes

modules/ROOT/pages/addition/docker/container.adoc Outdated Show resolved Hide resolved

Apply suggestions from code review

c0ac9ac

Co-authored-by: Jessica Wright <[email protected]> Co-authored-by: Lidia Zuin <[email protected]>

AlexicaWright approved these changes Dec 20, 2023

View reviewed changes

ravikiran-sulikeri merged commit 2b349b6 into neo4j:dev Dec 20, 2023

	<1> Neo4j home directory needs to be mounted back on the Docker host to enable access to agent.
	Note that:
	. The Neo4j home directory needs to be mounted back on the Docker host to enable access to agent.

	<2> Neo4j prometheus endpoint port (2004) needs to be exposed via port mapping.
	. Neo4j Prometheus endpoint port (2004) needs to be exposed via port mapping.

	<3> Query log port (9500) needs to be mapped for log appender to forward query logs.
	. Query log port (9500) needs to be mapped for log appender to forward query logs.

Improves monitoring Neo4j standalone container docs #175

Improves monitoring Neo4j standalone container docs #175

Uh oh!

Conversation

ravikiran-sulikeri commented Dec 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Dec 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for priceless-fermi-5883f3 ready!

Uh oh!

neo-technology-commit-status-publisher commented Dec 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AlexicaWright left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alexnb Dec 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexnb commented Dec 18, 2023

Uh oh!

lidiazuin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

alexnb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

AlexicaWright left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

ravikiran-sulikeri commented Dec 11, 2023 •

edited

Loading

netlify bot commented Dec 11, 2023 •

edited

Loading

neo-technology-commit-status-publisher commented Dec 11, 2023 •

edited

Loading

alexnb Dec 18, 2023 •

edited

Loading