DOC-695: rewrite support topic (WIP) #2009
Conversation
✅ Deploy Preview for hardcore-allen-f5257d ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Rob-Hazelcast
left a comment
Rob-Hazelcast
left a comment
There was a problem hiding this comment.
Looks good. A smattering of suggestions in-line.
| == Community support | ||
|
|
||
| Community support is for every Hazelcast user. You can use the following channels to get community support: | ||
| Community support is available to every Hazelcast user. You can use the following channels to get community support: |
There was a problem hiding this comment.
This makes it sound more formal / guaranteed than it is - we don't have any kind of SLA for community support. Maybe:
| Community support is available to every Hazelcast user. You can use the following channels to get community support: | |
| Community support is available to every Hazelcast user. You can use the following channels to ask for help: |
Not convinced this framing is right though. Do we want CE users submitting GitHub issues asking for help or is that just for reporting bugs? I suspect we want to direct users to Slack. If we treat GitHub issues as support requests that we'll respond to, that's basically the same as the EE experience. @wyohm ?
|
|
||
| ==== Hazelcast logs | ||
|
|
||
| The Hazelcast logs contain useful information when debugging an issue in a Hazelcast cluster. Each member has its own Hazelcast log, which typically includes: |
There was a problem hiding this comment.
Per the style guide, bullets should end in full stops unless they're single words/phrases or links
| - Stack traces | ||
| - Other log messages regarding cluster health and performance | ||
|
|
||
| We recommend you configure Hazelcast to use log4j, log4j2 or logback via slf4j. For more information about how to do this, see xref:maintain-cluster:logging.adoc[]. |
There was a problem hiding this comment.
| We recommend you configure Hazelcast to use log4j, log4j2 or logback via slf4j. For more information about how to do this, see xref:maintain-cluster:logging.adoc[]. | |
| We recommend you configure Hazelcast to use log4j, log4j2 or logback via slf4j. For more information, see xref:maintain-cluster:logging.adoc[]. |
| - Details about the type and volume of operations run on the member | ||
| - WAN Replication diagnostic information | ||
|
|
||
| The Hazelcast configuration provides settings for the rotation and retention of these diagnostic log files. For more information about the diagnostic plugins and how to configure them, see xref:maintain-cluster:monitoring.adoc#diagnostics[Diagnostics]. |
There was a problem hiding this comment.
| The Hazelcast configuration provides settings for the rotation and retention of these diagnostic log files. For more information about the diagnostic plugins and how to configure them, see xref:maintain-cluster:monitoring.adoc#diagnostics[Diagnostics]. | |
| The Hazelcast configuration provides settings for the rotation and retention of these diagnostic log files. For more information, see xref:maintain-cluster:monitoring.adoc#diagnostics[Diagnostics]. |
|
|
||
| This section describes the configuration parameters to enable JVM garbage collection logging, along with parameters for rotation and retention. | ||
|
|
||
| In Java 8 and below, the output file path is set with the `-Xloggc` parameter; in Java 9 and above, with the `file=` parameter. |
There was a problem hiding this comment.
From Hazelcast 5.4, our minimum supported Java version is 17. We last supported Java 8 in 5.2 (and I assume you're not planning to backport that far).
Where do you set this config?
|
|
||
| The JVM's garbage collection logs are often valuable in diagnosing performance problems in Hazelcast. Garbage collection (GC) logging is not enabled by default. We recommend you enable GC logging in production environments for performance analysis. | ||
|
|
||
| This section describes the configuration parameters to enable JVM garbage collection logging, along with parameters for rotation and retention. |
There was a problem hiding this comment.
| This section describes the configuration parameters to enable JVM garbage collection logging, along with parameters for rotation and retention. |
Generally avoid this kind of thing, it's a distracting context switch (reading about the docs structure instead of just absorbing the content). Maybe OK at a higher level but not for short child sections.
|
|
||
| The Hazelcast configuration provides settings for the rotation and retention of these diagnostic log files. For more information about the diagnostic plugins and how to configure them, see xref:maintain-cluster:monitoring.adoc#diagnostics[Diagnostics]. | ||
|
|
||
| TIP: Do not truncate diagnostics logs. If you must truncate a log, ensure the startup section—containing environment and system details—is included. |
There was a problem hiding this comment.
| TIP: Do not truncate diagnostics logs. If you must truncate a log, ensure the startup section—containing environment and system details—is included. | |
| NOTE: Do not truncate diagnostics logs. If you must truncate a log, ensure the startup section—containing environment and system details—is included. |
| A support subscription from Hazelcast provides rapid response times to technical | ||
| support inquiries, access to critical software patches, and other services which | ||
| will help you achieve increased productivity and quality. Learn more about Hazelcast support subscriptions: | ||
| https://hazelcast.com/pricing/?utm_source=docs-website[https://hazelcast.com/pricing/] |
There was a problem hiding this comment.
| https://hazelcast.com/pricing/?utm_source=docs-website[https://hazelcast.com/pricing/] | |
| https://hazelcast.com/pricing/?utm_source=docs-website[https://hazelcast.com/pricing/]. |
| -Xlog:safepoint,gc+age=debug,gc*=debug:file=gc.log:uptime,level,tags:filesize=10m,filecount=10 | ||
| ---- | ||
|
|
||
| // Author's note - the docs include a slightly different command (below) - which one should we use, or should we just xref this topic? |
There was a problem hiding this comment.
Suggest xrefing as that's what we've done with the other sections.
|
comments applied |
Rob-Hazelcast
left a comment
Rob-Hazelcast
left a comment
There was a problem hiding this comment.
Looks great, thanks!
amandalindsay
added
the
backport to all versions
|
❌ Failed to backport, change must be manually backported. |
1 similar comment
|
❌ Failed to backport, change must be manually backported. |
4 participants
Improve the Get support topic, consolidating info from the Support site with existing info in this topic