Skip to content

Commit

Permalink
Fix some rendering bugs and improve common-issues-to-monitor content
Browse files Browse the repository at this point in the history
  • Loading branch information
@mdlinville
mdlinville committed Apr 3, 2024
1 parent 3550f2a commit ff16686
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 24 deletions.
17 changes: 9 additions & 8 deletions src/current/v23.1/common-issues-to-monitor.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,19 +128,20 @@ CockroachDB is [resilient]({% link {{ page.version.version }}/demo-fault-toleran

Provision enough memory and allocate an appropriate portion for data caching:

| Category | Recommendations |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Memory | <ul><li>Provision at least {% include {{ page.version.version }}/prod-deployment/provision-memory.md %}.</li><li>{% include {{ page.version.version }}/prod-deployment/prod-guidance-cache-max-sql-memory.md %} For more details, see the [Recommended Production Settings]({% link {{ page.version.version }}/recommended-production-settings.md %}#cache-and-sql-memory-size).</li><li>{% include {{ page.version.version }}/prod-deployment/prod-guidance-disable-swap.md %}</li><li>See additional memory recommendations in the [Recommended Production Settings]({% link {{ page.version.version }}/recommended-production-settings.md %}#memory).</li> |
- Provision at least {% include {{ page.version.version }}/prod-deployment/provision-memory.md %}.
- {% include {{ page.version.version }}/prod-deployment/prod-guidance-cache-max-sql-memory.md %} For more details, see the [Recommended Production Settings]({% link {{ page.version.version }}/recommended-production-settings.md %}#cache-and-sql-memory-size).
- {% include {{ page.version.version }}/prod-deployment/prod-guidance-disable-swap.md %}
- For additional memory recommendations, refer to [Recommended Production Settings]({% link {{ page.version.version }}/recommended-production-settings.md %}#memory).

### Memory monitoring

Monitor memory usage and node behavior for [OOM errors]({% link {{ page.version.version }}/cluster-setup-troubleshooting.md %}#out-of-memory-oom-crash):

| Metric or event | Description |
|-------------------------------------------------|---------------------------------------------|
| [Node process restarts](#node-process-restarts) | Nodes restarting after crashes. |
| [SQL memory usage](#sql-memory-usage) | The memory allocated to the SQL layer. |
| [Database memory usage](#database-memory-usage) | The memory in use by CockroachDB processes. |
Metric or event | Description
----------------------------------------------------|--------------------------------------
[Node process restarts](#node-process-restarts) | Nodes restarting after crashes
[SQL memory usage](#sql-memory-usage) | The memory allocated to the SQL layer
[Database memory usage](#database-memory-usage) | The memory in use by CockroachDB processes

#### Node process restarts

Expand Down
17 changes: 9 additions & 8 deletions src/current/v23.2/common-issues-to-monitor.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,19 +132,20 @@ CockroachDB is [resilient]({% link {{ page.version.version }}/demo-fault-toleran

Provision enough memory and allocate an appropriate portion for data caching:

| Category | Recommendations |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Memory | <ul><li>Provision at least {% include {{ page.version.version }}/prod-deployment/provision-memory.md %}.</li><li>{% include {{ page.version.version }}/prod-deployment/prod-guidance-cache-max-sql-memory.md %} For more details, see the [Recommended Production Settings]({% link {{ page.version.version }}/recommended-production-settings.md %}#cache-and-sql-memory-size).</li><li>{% include {{ page.version.version }}/prod-deployment/prod-guidance-disable-swap.md %}</li><li>See additional memory recommendations in the [Recommended Production Settings]({% link {{ page.version.version }}/recommended-production-settings.md %}#memory).</li> |
- Provision at least {% include {{ page.version.version }}/prod-deployment/provision-memory.md %}.
- {% include {{ page.version.version }}/prod-deployment/prod-guidance-cache-max-sql-memory.md %} For more details, see the [Recommended Production Settings]({% link {{ page.version.version }}/recommended-production-settings.md %}#cache-and-sql-memory-size).
- {% include {{ page.version.version }}/prod-deployment/prod-guidance-disable-swap.md %}
- For additional memory recommendations, refer to [Recommended Production Settings]({% link {{ page.version.version }}/recommended-production-settings.md %}#memory).

### Memory monitoring

Monitor memory usage and node behavior for [OOM errors]({% link {{ page.version.version }}/cluster-setup-troubleshooting.md %}#out-of-memory-oom-crash):

| Metric or event | Description |
|-------------------------------------------------|---------------------------------------------|
| [Node process restarts](#node-process-restarts) | Nodes restarting after crashes. |
| [SQL memory usage](#sql-memory-usage) | The memory allocated to the SQL layer. |
| [Database memory usage](#database-memory-usage) | The memory in use by CockroachDB processes. |
Metric or event | Description
----------------------------------------------------|--------------------------------------
[Node process restarts](#node-process-restarts) | Nodes restarting after crashes
[SQL memory usage](#sql-memory-usage) | The memory allocated to the SQL layer
[Database memory usage](#database-memory-usage) | The memory in use by CockroachDB processes

#### Node process restarts

Expand Down
17 changes: 9 additions & 8 deletions src/current/v24.1/common-issues-to-monitor.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,19 +132,20 @@ CockroachDB is [resilient]({% link {{ page.version.version }}/demo-fault-toleran

Provision enough memory and allocate an appropriate portion for data caching:

| Category | Recommendations |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Memory | <ul><li>Provision at least {% include {{ page.version.version }}/prod-deployment/provision-memory.md %}.</li><li>{% include {{ page.version.version }}/prod-deployment/prod-guidance-cache-max-sql-memory.md %} For more details, see the [Recommended Production Settings]({% link {{ page.version.version }}/recommended-production-settings.md %}#cache-and-sql-memory-size).</li><li>{% include {{ page.version.version }}/prod-deployment/prod-guidance-disable-swap.md %}</li><li>See additional memory recommendations in the [Recommended Production Settings]({% link {{ page.version.version }}/recommended-production-settings.md %}#memory).</li> |
- Provision at least {% include {{ page.version.version }}/prod-deployment/provision-memory.md %}.
- {% include {{ page.version.version }}/prod-deployment/prod-guidance-cache-max-sql-memory.md %} For more details, see the [Recommended Production Settings]({% link {{ page.version.version }}/recommended-production-settings.md %}#cache-and-sql-memory-size).
- {% include {{ page.version.version }}/prod-deployment/prod-guidance-disable-swap.md %}
- For additional memory recommendations, refer to [Recommended Production Settings]({% link {{ page.version.version }}/recommended-production-settings.md %}#memory).

### Memory monitoring

Monitor memory usage and node behavior for [OOM errors]({% link {{ page.version.version }}/cluster-setup-troubleshooting.md %}#out-of-memory-oom-crash):

| Metric or event | Description |
|-------------------------------------------------|---------------------------------------------|
| [Node process restarts](#node-process-restarts) | Nodes restarting after crashes. |
| [SQL memory usage](#sql-memory-usage) | The memory allocated to the SQL layer. |
| [Database memory usage](#database-memory-usage) | The memory in use by CockroachDB processes. |
Metric or event | Description
----------------------------------------------------|--------------------------------------
[Node process restarts](#node-process-restarts) | Nodes restarting after crashes
[SQL memory usage](#sql-memory-usage) | The memory allocated to the SQL layer
[Database memory usage](#database-memory-usage) | The memory in use by CockroachDB processes

#### Node process restarts

Expand Down

0 comments on commit ff16686

Please sign in to comment.