diff --git a/src/current/_includes/v20.2/orchestration/kubernetes-prometheus-alertmanager.md b/src/current/_includes/v20.2/orchestration/kubernetes-prometheus-alertmanager.md index 9f7fbd4136e..a0974949fd9 100644 --- a/src/current/_includes/v20.2/orchestration/kubernetes-prometheus-alertmanager.md +++ b/src/current/_includes/v20.2/orchestration/kubernetes-prometheus-alertmanager.md @@ -54,7 +54,7 @@ If you're on Hosted GKE, before starting, make sure the email address associated 2. Install [CoreOS's Prometheus Operator](https://raw.githubusercontent.com/prometheus-operator/prometheus-operator/release-0.43/bundle.yaml): {{site.data.alerts.callout_info}} - If you run into an error when installing the Prometheus Operator, first try updating the [release version](https://github.com/prometheus-operator/prometheus-operator/blob/master/RELEASE.md) specified in the below command and reapplying the manifest. If this doesn't work, please [file an issue](file-an-issue.html). + If you run into an error when installing the Prometheus Operator, first try updating the [release version](https://github.com/prometheus-operator/prometheus-operator/blob/master/RELEASE.md) specified in the below command and reapplying the manifest. If this doesn't work, please [contact Support](support-resources.html). {{site.data.alerts.end}} {% include copy-clipboard.html %} diff --git a/src/current/_includes/v23.1/misc/beta-warning.md b/src/current/_includes/v23.1/misc/beta-warning.md index 4a5b9e3c6ae..b5660551c41 100644 --- a/src/current/_includes/v23.1/misc/beta-warning.md +++ b/src/current/_includes/v23.1/misc/beta-warning.md @@ -1,3 +1,3 @@ {{site.data.alerts.callout_danger}} -**This is a beta feature.** It is currently undergoing continued testing. Please [file a Github issue]({% link {{ page.version.version }}/file-an-issue.md %}) with us if you identify a bug. +**This is a beta feature.** It is currently undergoing continued testing. Please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) if you identify a bug. {{site.data.alerts.end}} diff --git a/src/current/_includes/v23.1/sidebar-data/troubleshooting.json b/src/current/_includes/v23.1/sidebar-data/troubleshooting.json index 4715ed9b672..6a8a3a03d0d 100644 --- a/src/current/_includes/v23.1/sidebar-data/troubleshooting.json +++ b/src/current/_includes/v23.1/sidebar-data/troubleshooting.json @@ -1,99 +1,93 @@ { - "title": "Troubleshooting", - "is_top_level": true, - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/troubleshooting-overview.html" - ] - }, - { - "title": "Common Errors and Solutions", - "urls": [ - "/${VERSION}/common-errors.html" - ] - }, - { - "title": "Troubleshoot Cloud Setup", - "urls": [ - "/cockroachcloud/troubleshooting-page.html" - ] - }, - { - "title": "Troubleshoot Self-Hosted Setup", - "urls": [ - "/${VERSION}/cluster-setup-troubleshooting.html" - ] - }, - { - "title": "Troubleshoot SQL Statements", - "urls": [ - "/${VERSION}/query-behavior-troubleshooting.html" - ] - }, - { - "title": "Transaction Retry Error Reference", - "urls": [ - "/${VERSION}/transaction-retry-error-reference.html" - ] - }, - { - "title": "Transaction Retry Error Example", - "urls": [ - "/${VERSION}/transaction-retry-error-example.html" - ] - }, - { - "title": "Differences in Metrics between Third-Party Monitoring Integrations and DB Console", - "urls": [ - "/${VERSION}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.html" - ] - }, - { - "title": "Troubleshoot Replication Zones", - "urls": [ - "/${VERSION}/troubleshoot-replication-zones.html" - ] - }, - { - "title": "Benchmarking", - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/performance.html" - ] - }, - { - "title": "Benchmarking with TPC-C", - "urls": [ - "/${VERSION}/performance-benchmarking-with-tpcc-local.html", - "/${VERSION}/performance-benchmarking-with-tpcc-local-multiregion.html", - "/${VERSION}/performance-benchmarking-with-tpcc-small.html", - "/${VERSION}/performance-benchmarking-with-tpcc-medium.html", - "/${VERSION}/performance-benchmarking-with-tpcc-large.html" - ] - } - ] - }, - { - "title": "Support Resources", - "urls": [ - "/${VERSION}/support-resources.html" - ] - }, - { - "title": "File an Issue", - "urls": [ - "/${VERSION}/file-an-issue.html" - ] - }, - { - "title": "Automatic CPU Profiler", - "urls": [ - "/${VERSION}/automatic-cpu-profiler.html" - ] - } - ] - } + "title": "Troubleshooting", + "is_top_level": true, + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/troubleshooting-overview.html" + ] + }, + { + "title": "Common Errors and Solutions", + "urls": [ + "/${VERSION}/common-errors.html" + ] + }, + { + "title": "Troubleshoot Cloud Setup", + "urls": [ + "/cockroachcloud/troubleshooting-page.html" + ] + }, + { + "title": "Troubleshoot Self-Hosted Setup", + "urls": [ + "/${VERSION}/cluster-setup-troubleshooting.html" + ] + }, + { + "title": "Troubleshoot SQL Statements", + "urls": [ + "/${VERSION}/query-behavior-troubleshooting.html" + ] + }, + { + "title": "Transaction Retry Error Reference", + "urls": [ + "/${VERSION}/transaction-retry-error-reference.html" + ] + }, + { + "title": "Transaction Retry Error Example", + "urls": [ + "/${VERSION}/transaction-retry-error-example.html" + ] + }, + { + "title": "Differences in Metrics between Third-Party Monitoring Integrations and DB Console", + "urls": [ + "/${VERSION}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.html" + ] + }, + { + "title": "Troubleshoot Replication Zones", + "urls": [ + "/${VERSION}/troubleshoot-replication-zones.html" + ] + }, + { + "title": "Benchmarking", + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/performance.html" + ] + }, + { + "title": "Benchmarking with TPC-C", + "urls": [ + "/${VERSION}/performance-benchmarking-with-tpcc-local.html", + "/${VERSION}/performance-benchmarking-with-tpcc-local-multiregion.html", + "/${VERSION}/performance-benchmarking-with-tpcc-small.html", + "/${VERSION}/performance-benchmarking-with-tpcc-medium.html", + "/${VERSION}/performance-benchmarking-with-tpcc-large.html" + ] + } + ] + }, + { + "title": "Support Resources", + "urls": [ + "/${VERSION}/support-resources.html" + ] + }, + { + "title": "Automatic CPU Profiler", + "urls": [ + "/${VERSION}/automatic-cpu-profiler.html" + ] + } + ] +} diff --git a/src/current/_includes/v23.2/misc/beta-warning.md b/src/current/_includes/v23.2/misc/beta-warning.md index 4a5b9e3c6ae..b5660551c41 100644 --- a/src/current/_includes/v23.2/misc/beta-warning.md +++ b/src/current/_includes/v23.2/misc/beta-warning.md @@ -1,3 +1,3 @@ {{site.data.alerts.callout_danger}} -**This is a beta feature.** It is currently undergoing continued testing. Please [file a Github issue]({% link {{ page.version.version }}/file-an-issue.md %}) with us if you identify a bug. +**This is a beta feature.** It is currently undergoing continued testing. Please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) if you identify a bug. {{site.data.alerts.end}} diff --git a/src/current/_includes/v23.2/sidebar-data/troubleshooting.json b/src/current/_includes/v23.2/sidebar-data/troubleshooting.json index 4715ed9b672..6a8a3a03d0d 100644 --- a/src/current/_includes/v23.2/sidebar-data/troubleshooting.json +++ b/src/current/_includes/v23.2/sidebar-data/troubleshooting.json @@ -1,99 +1,93 @@ { - "title": "Troubleshooting", - "is_top_level": true, - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/troubleshooting-overview.html" - ] - }, - { - "title": "Common Errors and Solutions", - "urls": [ - "/${VERSION}/common-errors.html" - ] - }, - { - "title": "Troubleshoot Cloud Setup", - "urls": [ - "/cockroachcloud/troubleshooting-page.html" - ] - }, - { - "title": "Troubleshoot Self-Hosted Setup", - "urls": [ - "/${VERSION}/cluster-setup-troubleshooting.html" - ] - }, - { - "title": "Troubleshoot SQL Statements", - "urls": [ - "/${VERSION}/query-behavior-troubleshooting.html" - ] - }, - { - "title": "Transaction Retry Error Reference", - "urls": [ - "/${VERSION}/transaction-retry-error-reference.html" - ] - }, - { - "title": "Transaction Retry Error Example", - "urls": [ - "/${VERSION}/transaction-retry-error-example.html" - ] - }, - { - "title": "Differences in Metrics between Third-Party Monitoring Integrations and DB Console", - "urls": [ - "/${VERSION}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.html" - ] - }, - { - "title": "Troubleshoot Replication Zones", - "urls": [ - "/${VERSION}/troubleshoot-replication-zones.html" - ] - }, - { - "title": "Benchmarking", - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/performance.html" - ] - }, - { - "title": "Benchmarking with TPC-C", - "urls": [ - "/${VERSION}/performance-benchmarking-with-tpcc-local.html", - "/${VERSION}/performance-benchmarking-with-tpcc-local-multiregion.html", - "/${VERSION}/performance-benchmarking-with-tpcc-small.html", - "/${VERSION}/performance-benchmarking-with-tpcc-medium.html", - "/${VERSION}/performance-benchmarking-with-tpcc-large.html" - ] - } - ] - }, - { - "title": "Support Resources", - "urls": [ - "/${VERSION}/support-resources.html" - ] - }, - { - "title": "File an Issue", - "urls": [ - "/${VERSION}/file-an-issue.html" - ] - }, - { - "title": "Automatic CPU Profiler", - "urls": [ - "/${VERSION}/automatic-cpu-profiler.html" - ] - } - ] - } + "title": "Troubleshooting", + "is_top_level": true, + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/troubleshooting-overview.html" + ] + }, + { + "title": "Common Errors and Solutions", + "urls": [ + "/${VERSION}/common-errors.html" + ] + }, + { + "title": "Troubleshoot Cloud Setup", + "urls": [ + "/cockroachcloud/troubleshooting-page.html" + ] + }, + { + "title": "Troubleshoot Self-Hosted Setup", + "urls": [ + "/${VERSION}/cluster-setup-troubleshooting.html" + ] + }, + { + "title": "Troubleshoot SQL Statements", + "urls": [ + "/${VERSION}/query-behavior-troubleshooting.html" + ] + }, + { + "title": "Transaction Retry Error Reference", + "urls": [ + "/${VERSION}/transaction-retry-error-reference.html" + ] + }, + { + "title": "Transaction Retry Error Example", + "urls": [ + "/${VERSION}/transaction-retry-error-example.html" + ] + }, + { + "title": "Differences in Metrics between Third-Party Monitoring Integrations and DB Console", + "urls": [ + "/${VERSION}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.html" + ] + }, + { + "title": "Troubleshoot Replication Zones", + "urls": [ + "/${VERSION}/troubleshoot-replication-zones.html" + ] + }, + { + "title": "Benchmarking", + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/performance.html" + ] + }, + { + "title": "Benchmarking with TPC-C", + "urls": [ + "/${VERSION}/performance-benchmarking-with-tpcc-local.html", + "/${VERSION}/performance-benchmarking-with-tpcc-local-multiregion.html", + "/${VERSION}/performance-benchmarking-with-tpcc-small.html", + "/${VERSION}/performance-benchmarking-with-tpcc-medium.html", + "/${VERSION}/performance-benchmarking-with-tpcc-large.html" + ] + } + ] + }, + { + "title": "Support Resources", + "urls": [ + "/${VERSION}/support-resources.html" + ] + }, + { + "title": "Automatic CPU Profiler", + "urls": [ + "/${VERSION}/automatic-cpu-profiler.html" + ] + } + ] +} diff --git a/src/current/_includes/v24.1/misc/beta-warning.md b/src/current/_includes/v24.1/misc/beta-warning.md index 4a5b9e3c6ae..b5660551c41 100644 --- a/src/current/_includes/v24.1/misc/beta-warning.md +++ b/src/current/_includes/v24.1/misc/beta-warning.md @@ -1,3 +1,3 @@ {{site.data.alerts.callout_danger}} -**This is a beta feature.** It is currently undergoing continued testing. Please [file a Github issue]({% link {{ page.version.version }}/file-an-issue.md %}) with us if you identify a bug. +**This is a beta feature.** It is currently undergoing continued testing. Please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) if you identify a bug. {{site.data.alerts.end}} diff --git a/src/current/_includes/v24.1/sidebar-data/troubleshooting.json b/src/current/_includes/v24.1/sidebar-data/troubleshooting.json index 4715ed9b672..6a8a3a03d0d 100644 --- a/src/current/_includes/v24.1/sidebar-data/troubleshooting.json +++ b/src/current/_includes/v24.1/sidebar-data/troubleshooting.json @@ -1,99 +1,93 @@ { - "title": "Troubleshooting", - "is_top_level": true, - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/troubleshooting-overview.html" - ] - }, - { - "title": "Common Errors and Solutions", - "urls": [ - "/${VERSION}/common-errors.html" - ] - }, - { - "title": "Troubleshoot Cloud Setup", - "urls": [ - "/cockroachcloud/troubleshooting-page.html" - ] - }, - { - "title": "Troubleshoot Self-Hosted Setup", - "urls": [ - "/${VERSION}/cluster-setup-troubleshooting.html" - ] - }, - { - "title": "Troubleshoot SQL Statements", - "urls": [ - "/${VERSION}/query-behavior-troubleshooting.html" - ] - }, - { - "title": "Transaction Retry Error Reference", - "urls": [ - "/${VERSION}/transaction-retry-error-reference.html" - ] - }, - { - "title": "Transaction Retry Error Example", - "urls": [ - "/${VERSION}/transaction-retry-error-example.html" - ] - }, - { - "title": "Differences in Metrics between Third-Party Monitoring Integrations and DB Console", - "urls": [ - "/${VERSION}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.html" - ] - }, - { - "title": "Troubleshoot Replication Zones", - "urls": [ - "/${VERSION}/troubleshoot-replication-zones.html" - ] - }, - { - "title": "Benchmarking", - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/performance.html" - ] - }, - { - "title": "Benchmarking with TPC-C", - "urls": [ - "/${VERSION}/performance-benchmarking-with-tpcc-local.html", - "/${VERSION}/performance-benchmarking-with-tpcc-local-multiregion.html", - "/${VERSION}/performance-benchmarking-with-tpcc-small.html", - "/${VERSION}/performance-benchmarking-with-tpcc-medium.html", - "/${VERSION}/performance-benchmarking-with-tpcc-large.html" - ] - } - ] - }, - { - "title": "Support Resources", - "urls": [ - "/${VERSION}/support-resources.html" - ] - }, - { - "title": "File an Issue", - "urls": [ - "/${VERSION}/file-an-issue.html" - ] - }, - { - "title": "Automatic CPU Profiler", - "urls": [ - "/${VERSION}/automatic-cpu-profiler.html" - ] - } - ] - } + "title": "Troubleshooting", + "is_top_level": true, + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/troubleshooting-overview.html" + ] + }, + { + "title": "Common Errors and Solutions", + "urls": [ + "/${VERSION}/common-errors.html" + ] + }, + { + "title": "Troubleshoot Cloud Setup", + "urls": [ + "/cockroachcloud/troubleshooting-page.html" + ] + }, + { + "title": "Troubleshoot Self-Hosted Setup", + "urls": [ + "/${VERSION}/cluster-setup-troubleshooting.html" + ] + }, + { + "title": "Troubleshoot SQL Statements", + "urls": [ + "/${VERSION}/query-behavior-troubleshooting.html" + ] + }, + { + "title": "Transaction Retry Error Reference", + "urls": [ + "/${VERSION}/transaction-retry-error-reference.html" + ] + }, + { + "title": "Transaction Retry Error Example", + "urls": [ + "/${VERSION}/transaction-retry-error-example.html" + ] + }, + { + "title": "Differences in Metrics between Third-Party Monitoring Integrations and DB Console", + "urls": [ + "/${VERSION}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.html" + ] + }, + { + "title": "Troubleshoot Replication Zones", + "urls": [ + "/${VERSION}/troubleshoot-replication-zones.html" + ] + }, + { + "title": "Benchmarking", + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/performance.html" + ] + }, + { + "title": "Benchmarking with TPC-C", + "urls": [ + "/${VERSION}/performance-benchmarking-with-tpcc-local.html", + "/${VERSION}/performance-benchmarking-with-tpcc-local-multiregion.html", + "/${VERSION}/performance-benchmarking-with-tpcc-small.html", + "/${VERSION}/performance-benchmarking-with-tpcc-medium.html", + "/${VERSION}/performance-benchmarking-with-tpcc-large.html" + ] + } + ] + }, + { + "title": "Support Resources", + "urls": [ + "/${VERSION}/support-resources.html" + ] + }, + { + "title": "Automatic CPU Profiler", + "urls": [ + "/${VERSION}/automatic-cpu-profiler.html" + ] + } + ] +} diff --git a/src/current/_includes/v24.2/misc/beta-warning.md b/src/current/_includes/v24.2/misc/beta-warning.md index 4a5b9e3c6ae..b5660551c41 100644 --- a/src/current/_includes/v24.2/misc/beta-warning.md +++ b/src/current/_includes/v24.2/misc/beta-warning.md @@ -1,3 +1,3 @@ {{site.data.alerts.callout_danger}} -**This is a beta feature.** It is currently undergoing continued testing. Please [file a Github issue]({% link {{ page.version.version }}/file-an-issue.md %}) with us if you identify a bug. +**This is a beta feature.** It is currently undergoing continued testing. Please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) if you identify a bug. {{site.data.alerts.end}} diff --git a/src/current/_includes/v24.2/sidebar-data/troubleshooting.json b/src/current/_includes/v24.2/sidebar-data/troubleshooting.json index 4715ed9b672..6a8a3a03d0d 100644 --- a/src/current/_includes/v24.2/sidebar-data/troubleshooting.json +++ b/src/current/_includes/v24.2/sidebar-data/troubleshooting.json @@ -1,99 +1,93 @@ { - "title": "Troubleshooting", - "is_top_level": true, - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/troubleshooting-overview.html" - ] - }, - { - "title": "Common Errors and Solutions", - "urls": [ - "/${VERSION}/common-errors.html" - ] - }, - { - "title": "Troubleshoot Cloud Setup", - "urls": [ - "/cockroachcloud/troubleshooting-page.html" - ] - }, - { - "title": "Troubleshoot Self-Hosted Setup", - "urls": [ - "/${VERSION}/cluster-setup-troubleshooting.html" - ] - }, - { - "title": "Troubleshoot SQL Statements", - "urls": [ - "/${VERSION}/query-behavior-troubleshooting.html" - ] - }, - { - "title": "Transaction Retry Error Reference", - "urls": [ - "/${VERSION}/transaction-retry-error-reference.html" - ] - }, - { - "title": "Transaction Retry Error Example", - "urls": [ - "/${VERSION}/transaction-retry-error-example.html" - ] - }, - { - "title": "Differences in Metrics between Third-Party Monitoring Integrations and DB Console", - "urls": [ - "/${VERSION}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.html" - ] - }, - { - "title": "Troubleshoot Replication Zones", - "urls": [ - "/${VERSION}/troubleshoot-replication-zones.html" - ] - }, - { - "title": "Benchmarking", - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/performance.html" - ] - }, - { - "title": "Benchmarking with TPC-C", - "urls": [ - "/${VERSION}/performance-benchmarking-with-tpcc-local.html", - "/${VERSION}/performance-benchmarking-with-tpcc-local-multiregion.html", - "/${VERSION}/performance-benchmarking-with-tpcc-small.html", - "/${VERSION}/performance-benchmarking-with-tpcc-medium.html", - "/${VERSION}/performance-benchmarking-with-tpcc-large.html" - ] - } - ] - }, - { - "title": "Support Resources", - "urls": [ - "/${VERSION}/support-resources.html" - ] - }, - { - "title": "File an Issue", - "urls": [ - "/${VERSION}/file-an-issue.html" - ] - }, - { - "title": "Automatic CPU Profiler", - "urls": [ - "/${VERSION}/automatic-cpu-profiler.html" - ] - } - ] - } + "title": "Troubleshooting", + "is_top_level": true, + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/troubleshooting-overview.html" + ] + }, + { + "title": "Common Errors and Solutions", + "urls": [ + "/${VERSION}/common-errors.html" + ] + }, + { + "title": "Troubleshoot Cloud Setup", + "urls": [ + "/cockroachcloud/troubleshooting-page.html" + ] + }, + { + "title": "Troubleshoot Self-Hosted Setup", + "urls": [ + "/${VERSION}/cluster-setup-troubleshooting.html" + ] + }, + { + "title": "Troubleshoot SQL Statements", + "urls": [ + "/${VERSION}/query-behavior-troubleshooting.html" + ] + }, + { + "title": "Transaction Retry Error Reference", + "urls": [ + "/${VERSION}/transaction-retry-error-reference.html" + ] + }, + { + "title": "Transaction Retry Error Example", + "urls": [ + "/${VERSION}/transaction-retry-error-example.html" + ] + }, + { + "title": "Differences in Metrics between Third-Party Monitoring Integrations and DB Console", + "urls": [ + "/${VERSION}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.html" + ] + }, + { + "title": "Troubleshoot Replication Zones", + "urls": [ + "/${VERSION}/troubleshoot-replication-zones.html" + ] + }, + { + "title": "Benchmarking", + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/performance.html" + ] + }, + { + "title": "Benchmarking with TPC-C", + "urls": [ + "/${VERSION}/performance-benchmarking-with-tpcc-local.html", + "/${VERSION}/performance-benchmarking-with-tpcc-local-multiregion.html", + "/${VERSION}/performance-benchmarking-with-tpcc-small.html", + "/${VERSION}/performance-benchmarking-with-tpcc-medium.html", + "/${VERSION}/performance-benchmarking-with-tpcc-large.html" + ] + } + ] + }, + { + "title": "Support Resources", + "urls": [ + "/${VERSION}/support-resources.html" + ] + }, + { + "title": "Automatic CPU Profiler", + "urls": [ + "/${VERSION}/automatic-cpu-profiler.html" + ] + } + ] +} diff --git a/src/current/_includes/v24.3/misc/beta-warning.md b/src/current/_includes/v24.3/misc/beta-warning.md index 4a5b9e3c6ae..b5660551c41 100644 --- a/src/current/_includes/v24.3/misc/beta-warning.md +++ b/src/current/_includes/v24.3/misc/beta-warning.md @@ -1,3 +1,3 @@ {{site.data.alerts.callout_danger}} -**This is a beta feature.** It is currently undergoing continued testing. Please [file a Github issue]({% link {{ page.version.version }}/file-an-issue.md %}) with us if you identify a bug. +**This is a beta feature.** It is currently undergoing continued testing. Please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) if you identify a bug. {{site.data.alerts.end}} diff --git a/src/current/_includes/v24.3/sidebar-data/troubleshooting.json b/src/current/_includes/v24.3/sidebar-data/troubleshooting.json index 4715ed9b672..6a8a3a03d0d 100644 --- a/src/current/_includes/v24.3/sidebar-data/troubleshooting.json +++ b/src/current/_includes/v24.3/sidebar-data/troubleshooting.json @@ -1,99 +1,93 @@ { - "title": "Troubleshooting", - "is_top_level": true, - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/troubleshooting-overview.html" - ] - }, - { - "title": "Common Errors and Solutions", - "urls": [ - "/${VERSION}/common-errors.html" - ] - }, - { - "title": "Troubleshoot Cloud Setup", - "urls": [ - "/cockroachcloud/troubleshooting-page.html" - ] - }, - { - "title": "Troubleshoot Self-Hosted Setup", - "urls": [ - "/${VERSION}/cluster-setup-troubleshooting.html" - ] - }, - { - "title": "Troubleshoot SQL Statements", - "urls": [ - "/${VERSION}/query-behavior-troubleshooting.html" - ] - }, - { - "title": "Transaction Retry Error Reference", - "urls": [ - "/${VERSION}/transaction-retry-error-reference.html" - ] - }, - { - "title": "Transaction Retry Error Example", - "urls": [ - "/${VERSION}/transaction-retry-error-example.html" - ] - }, - { - "title": "Differences in Metrics between Third-Party Monitoring Integrations and DB Console", - "urls": [ - "/${VERSION}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.html" - ] - }, - { - "title": "Troubleshoot Replication Zones", - "urls": [ - "/${VERSION}/troubleshoot-replication-zones.html" - ] - }, - { - "title": "Benchmarking", - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/performance.html" - ] - }, - { - "title": "Benchmarking with TPC-C", - "urls": [ - "/${VERSION}/performance-benchmarking-with-tpcc-local.html", - "/${VERSION}/performance-benchmarking-with-tpcc-local-multiregion.html", - "/${VERSION}/performance-benchmarking-with-tpcc-small.html", - "/${VERSION}/performance-benchmarking-with-tpcc-medium.html", - "/${VERSION}/performance-benchmarking-with-tpcc-large.html" - ] - } - ] - }, - { - "title": "Support Resources", - "urls": [ - "/${VERSION}/support-resources.html" - ] - }, - { - "title": "File an Issue", - "urls": [ - "/${VERSION}/file-an-issue.html" - ] - }, - { - "title": "Automatic CPU Profiler", - "urls": [ - "/${VERSION}/automatic-cpu-profiler.html" - ] - } - ] - } + "title": "Troubleshooting", + "is_top_level": true, + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/troubleshooting-overview.html" + ] + }, + { + "title": "Common Errors and Solutions", + "urls": [ + "/${VERSION}/common-errors.html" + ] + }, + { + "title": "Troubleshoot Cloud Setup", + "urls": [ + "/cockroachcloud/troubleshooting-page.html" + ] + }, + { + "title": "Troubleshoot Self-Hosted Setup", + "urls": [ + "/${VERSION}/cluster-setup-troubleshooting.html" + ] + }, + { + "title": "Troubleshoot SQL Statements", + "urls": [ + "/${VERSION}/query-behavior-troubleshooting.html" + ] + }, + { + "title": "Transaction Retry Error Reference", + "urls": [ + "/${VERSION}/transaction-retry-error-reference.html" + ] + }, + { + "title": "Transaction Retry Error Example", + "urls": [ + "/${VERSION}/transaction-retry-error-example.html" + ] + }, + { + "title": "Differences in Metrics between Third-Party Monitoring Integrations and DB Console", + "urls": [ + "/${VERSION}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.html" + ] + }, + { + "title": "Troubleshoot Replication Zones", + "urls": [ + "/${VERSION}/troubleshoot-replication-zones.html" + ] + }, + { + "title": "Benchmarking", + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/performance.html" + ] + }, + { + "title": "Benchmarking with TPC-C", + "urls": [ + "/${VERSION}/performance-benchmarking-with-tpcc-local.html", + "/${VERSION}/performance-benchmarking-with-tpcc-local-multiregion.html", + "/${VERSION}/performance-benchmarking-with-tpcc-small.html", + "/${VERSION}/performance-benchmarking-with-tpcc-medium.html", + "/${VERSION}/performance-benchmarking-with-tpcc-large.html" + ] + } + ] + }, + { + "title": "Support Resources", + "urls": [ + "/${VERSION}/support-resources.html" + ] + }, + { + "title": "Automatic CPU Profiler", + "urls": [ + "/${VERSION}/automatic-cpu-profiler.html" + ] + } + ] +} diff --git a/src/current/_includes/v25.1/misc/beta-warning.md b/src/current/_includes/v25.1/misc/beta-warning.md index 4a5b9e3c6ae..b5660551c41 100644 --- a/src/current/_includes/v25.1/misc/beta-warning.md +++ b/src/current/_includes/v25.1/misc/beta-warning.md @@ -1,3 +1,3 @@ {{site.data.alerts.callout_danger}} -**This is a beta feature.** It is currently undergoing continued testing. Please [file a Github issue]({% link {{ page.version.version }}/file-an-issue.md %}) with us if you identify a bug. +**This is a beta feature.** It is currently undergoing continued testing. Please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) if you identify a bug. {{site.data.alerts.end}} diff --git a/src/current/_includes/v25.1/sidebar-data/troubleshooting.json b/src/current/_includes/v25.1/sidebar-data/troubleshooting.json index fb57092a188..079dfd8024a 100644 --- a/src/current/_includes/v25.1/sidebar-data/troubleshooting.json +++ b/src/current/_includes/v25.1/sidebar-data/troubleshooting.json @@ -1,105 +1,99 @@ { - "title": "Troubleshooting", - "is_top_level": true, - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/troubleshooting-overview.html" - ] - }, - { - "title": "Common Errors and Solutions", - "urls": [ - "/${VERSION}/common-errors.html" - ] - }, - { - "title": "Troubleshoot Cloud Setup", - "urls": [ - "/cockroachcloud/troubleshooting-page.html" - ] - }, - { - "title": "Troubleshoot Self-Hosted Setup", - "urls": [ - "/${VERSION}/cluster-setup-troubleshooting.html" - ] - }, - { - "title": "Troubleshoot SQL Statements", - "urls": [ - "/${VERSION}/query-behavior-troubleshooting.html" - ] - }, - { - "title": "Transaction Retry Error Reference", - "urls": [ - "/${VERSION}/transaction-retry-error-reference.html" - ] - }, - { - "title": "Transaction Retry Error Example", - "urls": [ - "/${VERSION}/transaction-retry-error-example.html" - ] - }, - { - "title": "Differences in Metrics between Third-Party Monitoring Integrations and DB Console", - "urls": [ - "/${VERSION}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.html" - ] - }, - { - "title": "Understand Hotspots", - "urls": [ - "/${VERSION}/understand-hotspots.html" - ] - }, - { - "title": "Troubleshoot Replication Zones", - "urls": [ - "/${VERSION}/troubleshoot-replication-zones.html" - ] - }, - { - "title": "Benchmarking", - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/performance.html" - ] - }, - { - "title": "Benchmarking with TPC-C", - "urls": [ - "/${VERSION}/performance-benchmarking-with-tpcc-local.html", - "/${VERSION}/performance-benchmarking-with-tpcc-local-multiregion.html", - "/${VERSION}/performance-benchmarking-with-tpcc-small.html", - "/${VERSION}/performance-benchmarking-with-tpcc-medium.html", - "/${VERSION}/performance-benchmarking-with-tpcc-large.html" - ] - } - ] - }, - { - "title": "Support Resources", - "urls": [ - "/${VERSION}/support-resources.html" - ] - }, - { - "title": "File an Issue", - "urls": [ - "/${VERSION}/file-an-issue.html" - ] - }, - { - "title": "Automatic CPU Profiler", - "urls": [ - "/${VERSION}/automatic-cpu-profiler.html" - ] - } - ] - } + "title": "Troubleshooting", + "is_top_level": true, + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/troubleshooting-overview.html" + ] + }, + { + "title": "Common Errors and Solutions", + "urls": [ + "/${VERSION}/common-errors.html" + ] + }, + { + "title": "Troubleshoot Cloud Setup", + "urls": [ + "/cockroachcloud/troubleshooting-page.html" + ] + }, + { + "title": "Troubleshoot Self-Hosted Setup", + "urls": [ + "/${VERSION}/cluster-setup-troubleshooting.html" + ] + }, + { + "title": "Troubleshoot SQL Statements", + "urls": [ + "/${VERSION}/query-behavior-troubleshooting.html" + ] + }, + { + "title": "Transaction Retry Error Reference", + "urls": [ + "/${VERSION}/transaction-retry-error-reference.html" + ] + }, + { + "title": "Transaction Retry Error Example", + "urls": [ + "/${VERSION}/transaction-retry-error-example.html" + ] + }, + { + "title": "Differences in Metrics between Third-Party Monitoring Integrations and DB Console", + "urls": [ + "/${VERSION}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.html" + ] + }, + { + "title": "Understand Hotspots", + "urls": [ + "/${VERSION}/understand-hotspots.html" + ] + }, + { + "title": "Troubleshoot Replication Zones", + "urls": [ + "/${VERSION}/troubleshoot-replication-zones.html" + ] + }, + { + "title": "Benchmarking", + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/performance.html" + ] + }, + { + "title": "Benchmarking with TPC-C", + "urls": [ + "/${VERSION}/performance-benchmarking-with-tpcc-local.html", + "/${VERSION}/performance-benchmarking-with-tpcc-local-multiregion.html", + "/${VERSION}/performance-benchmarking-with-tpcc-small.html", + "/${VERSION}/performance-benchmarking-with-tpcc-medium.html", + "/${VERSION}/performance-benchmarking-with-tpcc-large.html" + ] + } + ] + }, + { + "title": "Support Resources", + "urls": [ + "/${VERSION}/support-resources.html" + ] + }, + { + "title": "Automatic CPU Profiler", + "urls": [ + "/${VERSION}/automatic-cpu-profiler.html" + ] + } + ] +} diff --git a/src/current/_includes/v25.2/misc/beta-warning.md b/src/current/_includes/v25.2/misc/beta-warning.md index 4a5b9e3c6ae..b5660551c41 100644 --- a/src/current/_includes/v25.2/misc/beta-warning.md +++ b/src/current/_includes/v25.2/misc/beta-warning.md @@ -1,3 +1,3 @@ {{site.data.alerts.callout_danger}} -**This is a beta feature.** It is currently undergoing continued testing. Please [file a Github issue]({% link {{ page.version.version }}/file-an-issue.md %}) with us if you identify a bug. +**This is a beta feature.** It is currently undergoing continued testing. Please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) if you identify a bug. {{site.data.alerts.end}} diff --git a/src/current/_includes/v25.2/sidebar-data/troubleshooting.json b/src/current/_includes/v25.2/sidebar-data/troubleshooting.json index c862533bd63..5cbee0aafa7 100644 --- a/src/current/_includes/v25.2/sidebar-data/troubleshooting.json +++ b/src/current/_includes/v25.2/sidebar-data/troubleshooting.json @@ -1,111 +1,105 @@ { - "title": "Troubleshooting", - "is_top_level": true, - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/troubleshooting-overview.html" - ] - }, - { - "title": "Common Errors and Solutions", - "urls": [ - "/${VERSION}/common-errors.html" - ] - }, - { - "title": "Troubleshoot Cloud Setup", - "urls": [ - "/cockroachcloud/troubleshooting-page.html" - ] - }, - { - "title": "Troubleshoot Self-Hosted Setup", - "urls": [ - "/${VERSION}/cluster-setup-troubleshooting.html" - ] - }, - { - "title": "Troubleshoot SQL Statements", - "urls": [ - "/${VERSION}/query-behavior-troubleshooting.html" - ] - }, - { - "title": "Transaction Retry Error Reference", - "urls": [ - "/${VERSION}/transaction-retry-error-reference.html" - ] - }, - { - "title": "Transaction Retry Error Example", - "urls": [ - "/${VERSION}/transaction-retry-error-example.html" - ] - }, - { - "title": "Differences in Metrics between Third-Party Monitoring Integrations and DB Console", - "urls": [ - "/${VERSION}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.html" - ] - }, - { - "title": "Understand Hotspots", - "urls": [ - "/${VERSION}/understand-hotspots.html" - ] - }, - { - "title": "Detect Hotspots", - "urls": [ - "/${VERSION}/detect-hotspots.html" - ] - }, - { - "title": "Troubleshoot Replication Zones", - "urls": [ - "/${VERSION}/troubleshoot-replication-zones.html" - ] - }, - { - "title": "Benchmarking", - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/performance.html" - ] - }, - { - "title": "Benchmarking with TPC-C", - "urls": [ - "/${VERSION}/performance-benchmarking-with-tpcc-local.html", - "/${VERSION}/performance-benchmarking-with-tpcc-local-multiregion.html", - "/${VERSION}/performance-benchmarking-with-tpcc-small.html", - "/${VERSION}/performance-benchmarking-with-tpcc-medium.html", - "/${VERSION}/performance-benchmarking-with-tpcc-large.html" - ] - } - ] - }, - { - "title": "Support Resources", - "urls": [ - "/${VERSION}/support-resources.html" - ] - }, - { - "title": "File an Issue", - "urls": [ - "/${VERSION}/file-an-issue.html" - ] - }, - { - "title": "Automatic CPU Profiler", - "urls": [ - "/${VERSION}/automatic-cpu-profiler.html" - ] - } - ] - } + "title": "Troubleshooting", + "is_top_level": true, + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/troubleshooting-overview.html" + ] + }, + { + "title": "Common Errors and Solutions", + "urls": [ + "/${VERSION}/common-errors.html" + ] + }, + { + "title": "Troubleshoot Cloud Setup", + "urls": [ + "/cockroachcloud/troubleshooting-page.html" + ] + }, + { + "title": "Troubleshoot Self-Hosted Setup", + "urls": [ + "/${VERSION}/cluster-setup-troubleshooting.html" + ] + }, + { + "title": "Troubleshoot SQL Statements", + "urls": [ + "/${VERSION}/query-behavior-troubleshooting.html" + ] + }, + { + "title": "Transaction Retry Error Reference", + "urls": [ + "/${VERSION}/transaction-retry-error-reference.html" + ] + }, + { + "title": "Transaction Retry Error Example", + "urls": [ + "/${VERSION}/transaction-retry-error-example.html" + ] + }, + { + "title": "Differences in Metrics between Third-Party Monitoring Integrations and DB Console", + "urls": [ + "/${VERSION}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.html" + ] + }, + { + "title": "Understand Hotspots", + "urls": [ + "/${VERSION}/understand-hotspots.html" + ] + }, + { + "title": "Detect Hotspots", + "urls": [ + "/${VERSION}/detect-hotspots.html" + ] + }, + { + "title": "Troubleshoot Replication Zones", + "urls": [ + "/${VERSION}/troubleshoot-replication-zones.html" + ] + }, + { + "title": "Benchmarking", + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/performance.html" + ] + }, + { + "title": "Benchmarking with TPC-C", + "urls": [ + "/${VERSION}/performance-benchmarking-with-tpcc-local.html", + "/${VERSION}/performance-benchmarking-with-tpcc-local-multiregion.html", + "/${VERSION}/performance-benchmarking-with-tpcc-small.html", + "/${VERSION}/performance-benchmarking-with-tpcc-medium.html", + "/${VERSION}/performance-benchmarking-with-tpcc-large.html" + ] + } + ] + }, + { + "title": "Support Resources", + "urls": [ + "/${VERSION}/support-resources.html" + ] + }, + { + "title": "Automatic CPU Profiler", + "urls": [ + "/${VERSION}/automatic-cpu-profiler.html" + ] + } + ] +} diff --git a/src/current/_includes/v25.3/misc/beta-warning.md b/src/current/_includes/v25.3/misc/beta-warning.md index 4a5b9e3c6ae..b5660551c41 100644 --- a/src/current/_includes/v25.3/misc/beta-warning.md +++ b/src/current/_includes/v25.3/misc/beta-warning.md @@ -1,3 +1,3 @@ {{site.data.alerts.callout_danger}} -**This is a beta feature.** It is currently undergoing continued testing. Please [file a Github issue]({% link {{ page.version.version }}/file-an-issue.md %}) with us if you identify a bug. +**This is a beta feature.** It is currently undergoing continued testing. Please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) if you identify a bug. {{site.data.alerts.end}} diff --git a/src/current/_includes/v25.3/sidebar-data/troubleshooting.json b/src/current/_includes/v25.3/sidebar-data/troubleshooting.json index 886d5297ac6..c14fdedcd6b 100644 --- a/src/current/_includes/v25.3/sidebar-data/troubleshooting.json +++ b/src/current/_includes/v25.3/sidebar-data/troubleshooting.json @@ -1,117 +1,111 @@ { - "title": "Troubleshooting", - "is_top_level": true, - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/troubleshooting-overview.html" - ] - }, - { - "title": "Common Errors and Solutions", - "urls": [ - "/${VERSION}/common-errors.html" - ] - }, - { - "title": "Troubleshoot Cloud Setup", - "urls": [ - "/cockroachcloud/troubleshooting-page.html" - ] - }, - { - "title": "Troubleshoot Self-Hosted Setup", - "urls": [ - "/${VERSION}/cluster-setup-troubleshooting.html" - ] - }, - { - "title": "Troubleshoot SQL Statements", - "urls": [ - "/${VERSION}/query-behavior-troubleshooting.html" - ] - }, - { - "title": "Transaction Retry Error Reference", - "urls": [ - "/${VERSION}/transaction-retry-error-reference.html" - ] - }, - { - "title": "Transaction Retry Error Example", - "urls": [ - "/${VERSION}/transaction-retry-error-example.html" - ] - }, - { - "title": "Differences in Metrics between Third-Party Monitoring Integrations and DB Console", - "urls": [ - "/${VERSION}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.html" - ] - }, - { - "title": "Understand Hotspots", - "urls": [ - "/${VERSION}/understand-hotspots.html" - ] - }, - { - "title": "Detect Hotspots", - "urls": [ - "/${VERSION}/detect-hotspots.html" - ] - }, - { - "title": "Troubleshoot Replication Zones", - "urls": [ - "/${VERSION}/troubleshoot-replication-zones.html" - ] - }, - { - "title": "Benchmarking", - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/performance.html" - ] - }, - { - "title": "Benchmarking with TPC-C", - "urls": [ - "/${VERSION}/performance-benchmarking-with-tpcc-local.html", - "/${VERSION}/performance-benchmarking-with-tpcc-local-multiregion.html", - "/${VERSION}/performance-benchmarking-with-tpcc-small.html", - "/${VERSION}/performance-benchmarking-with-tpcc-medium.html", - "/${VERSION}/performance-benchmarking-with-tpcc-large.html" - ] - } - ] - }, - { - "title": "Support Resources", - "urls": [ - "/${VERSION}/support-resources.html" - ] - }, - { - "title": "File an Issue", - "urls": [ - "/${VERSION}/file-an-issue.html" - ] - }, - { - "title": "Automatic CPU Profiler", - "urls": [ - "/${VERSION}/automatic-cpu-profiler.html" - ] - }, - { - "title": "Automatic Go Execution Tracer", - "urls": [ - "/${VERSION}/automatic-go-execution-tracer.html" - ] - } - ] - } + "title": "Troubleshooting", + "is_top_level": true, + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/troubleshooting-overview.html" + ] + }, + { + "title": "Common Errors and Solutions", + "urls": [ + "/${VERSION}/common-errors.html" + ] + }, + { + "title": "Troubleshoot Cloud Setup", + "urls": [ + "/cockroachcloud/troubleshooting-page.html" + ] + }, + { + "title": "Troubleshoot Self-Hosted Setup", + "urls": [ + "/${VERSION}/cluster-setup-troubleshooting.html" + ] + }, + { + "title": "Troubleshoot SQL Statements", + "urls": [ + "/${VERSION}/query-behavior-troubleshooting.html" + ] + }, + { + "title": "Transaction Retry Error Reference", + "urls": [ + "/${VERSION}/transaction-retry-error-reference.html" + ] + }, + { + "title": "Transaction Retry Error Example", + "urls": [ + "/${VERSION}/transaction-retry-error-example.html" + ] + }, + { + "title": "Differences in Metrics between Third-Party Monitoring Integrations and DB Console", + "urls": [ + "/${VERSION}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.html" + ] + }, + { + "title": "Understand Hotspots", + "urls": [ + "/${VERSION}/understand-hotspots.html" + ] + }, + { + "title": "Detect Hotspots", + "urls": [ + "/${VERSION}/detect-hotspots.html" + ] + }, + { + "title": "Troubleshoot Replication Zones", + "urls": [ + "/${VERSION}/troubleshoot-replication-zones.html" + ] + }, + { + "title": "Benchmarking", + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/performance.html" + ] + }, + { + "title": "Benchmarking with TPC-C", + "urls": [ + "/${VERSION}/performance-benchmarking-with-tpcc-local.html", + "/${VERSION}/performance-benchmarking-with-tpcc-local-multiregion.html", + "/${VERSION}/performance-benchmarking-with-tpcc-small.html", + "/${VERSION}/performance-benchmarking-with-tpcc-medium.html", + "/${VERSION}/performance-benchmarking-with-tpcc-large.html" + ] + } + ] + }, + { + "title": "Support Resources", + "urls": [ + "/${VERSION}/support-resources.html" + ] + }, + { + "title": "Automatic CPU Profiler", + "urls": [ + "/${VERSION}/automatic-cpu-profiler.html" + ] + }, + { + "title": "Automatic Go Execution Tracer", + "urls": [ + "/${VERSION}/automatic-go-execution-tracer.html" + ] + } + ] +} diff --git a/src/current/_includes/v25.4/misc/beta-warning.md b/src/current/_includes/v25.4/misc/beta-warning.md index 4a5b9e3c6ae..b5660551c41 100644 --- a/src/current/_includes/v25.4/misc/beta-warning.md +++ b/src/current/_includes/v25.4/misc/beta-warning.md @@ -1,3 +1,3 @@ {{site.data.alerts.callout_danger}} -**This is a beta feature.** It is currently undergoing continued testing. Please [file a Github issue]({% link {{ page.version.version }}/file-an-issue.md %}) with us if you identify a bug. +**This is a beta feature.** It is currently undergoing continued testing. Please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) if you identify a bug. {{site.data.alerts.end}} diff --git a/src/current/_includes/v25.4/sidebar-data/troubleshooting.json b/src/current/_includes/v25.4/sidebar-data/troubleshooting.json index f9e11c5ab36..e1f186eee69 100644 --- a/src/current/_includes/v25.4/sidebar-data/troubleshooting.json +++ b/src/current/_includes/v25.4/sidebar-data/troubleshooting.json @@ -1,129 +1,123 @@ { - "title": "Troubleshooting", - "is_top_level": true, - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/troubleshooting-overview.html" - ] - }, - { - "title": "Common Errors and Solutions", - "urls": [ - "/${VERSION}/common-errors.html" - ] - }, - { - "title": "Troubleshoot Cloud Setup", - "urls": [ - "/cockroachcloud/troubleshooting-page.html" - ] - }, - { - "title": "Troubleshoot Self-Hosted Setup", - "urls": [ - "/${VERSION}/cluster-setup-troubleshooting.html" - ] - }, - { - "title": "Troubleshoot SQL Statements", - "urls": [ - "/${VERSION}/query-behavior-troubleshooting.html" - ] - }, - { - "title": "Transaction Retry Error Reference", - "urls": [ - "/${VERSION}/transaction-retry-error-reference.html" - ] - }, - { - "title": "Transaction Retry Error Example", - "urls": [ - "/${VERSION}/transaction-retry-error-example.html" - ] - }, - { - "title": "Differences in Metrics between Third-Party Monitoring Integrations and DB Console", - "urls": [ - "/${VERSION}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.html" - ] - }, - { - "title": "Understand Hotspots", - "urls": [ - "/${VERSION}/understand-hotspots.html" - ] - }, - { - "title": "Detect Hotspots", - "urls": [ - "/${VERSION}/detect-hotspots.html" - ] - }, - { - "title": "Troubleshoot Query Plan Regressions", - "urls": [ - "/${VERSION}/troubleshoot-query-plan-regressions.html" - ] - }, - { - "title": "Troubleshoot Replication Zones", - "urls": [ - "/${VERSION}/troubleshoot-replication-zones.html" - ] - }, - { - "title": "Benchmarking", - "items": [ - { - "title": "Overview", - "urls": [ - "/${VERSION}/performance.html" - ] - }, - { - "title": "Benchmarking with TPC-C", - "urls": [ - "/${VERSION}/performance-benchmarking-with-tpcc-local.html", - "/${VERSION}/performance-benchmarking-with-tpcc-local-multiregion.html", - "/${VERSION}/performance-benchmarking-with-tpcc-small.html", - "/${VERSION}/performance-benchmarking-with-tpcc-medium.html", - "/${VERSION}/performance-benchmarking-with-tpcc-large.html" - ] - } - ] - }, - { - "title": "Support Resources", - "urls": [ - "/${VERSION}/support-resources.html" - ] - }, - { - "title": "File an Issue", - "urls": [ - "/${VERSION}/file-an-issue.html" - ] - }, - { - "title": "Automatic CPU Profiler", - "urls": [ - "/${VERSION}/automatic-cpu-profiler.html" - ] - }, - { - "title": "Automatic Go Execution Tracer", - "urls": [ - "/${VERSION}/automatic-go-execution-tracer.html" - ] - }, - { - "title": "Transaction Diagnostics", - "urls": [ - "/${VERSION}/transaction-diagnostics.html" - ] - } - ] - } + "title": "Troubleshooting", + "is_top_level": true, + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/troubleshooting-overview.html" + ] + }, + { + "title": "Common Errors and Solutions", + "urls": [ + "/${VERSION}/common-errors.html" + ] + }, + { + "title": "Troubleshoot Cloud Setup", + "urls": [ + "/cockroachcloud/troubleshooting-page.html" + ] + }, + { + "title": "Troubleshoot Self-Hosted Setup", + "urls": [ + "/${VERSION}/cluster-setup-troubleshooting.html" + ] + }, + { + "title": "Troubleshoot SQL Statements", + "urls": [ + "/${VERSION}/query-behavior-troubleshooting.html" + ] + }, + { + "title": "Transaction Retry Error Reference", + "urls": [ + "/${VERSION}/transaction-retry-error-reference.html" + ] + }, + { + "title": "Transaction Retry Error Example", + "urls": [ + "/${VERSION}/transaction-retry-error-example.html" + ] + }, + { + "title": "Differences in Metrics between Third-Party Monitoring Integrations and DB Console", + "urls": [ + "/${VERSION}/differences-in-metrics-between-third-party-monitoring-integrations-and-db-console.html" + ] + }, + { + "title": "Understand Hotspots", + "urls": [ + "/${VERSION}/understand-hotspots.html" + ] + }, + { + "title": "Detect Hotspots", + "urls": [ + "/${VERSION}/detect-hotspots.html" + ] + }, + { + "title": "Troubleshoot Query Plan Regressions", + "urls": [ + "/${VERSION}/troubleshoot-query-plan-regressions.html" + ] + }, + { + "title": "Troubleshoot Replication Zones", + "urls": [ + "/${VERSION}/troubleshoot-replication-zones.html" + ] + }, + { + "title": "Benchmarking", + "items": [ + { + "title": "Overview", + "urls": [ + "/${VERSION}/performance.html" + ] + }, + { + "title": "Benchmarking with TPC-C", + "urls": [ + "/${VERSION}/performance-benchmarking-with-tpcc-local.html", + "/${VERSION}/performance-benchmarking-with-tpcc-local-multiregion.html", + "/${VERSION}/performance-benchmarking-with-tpcc-small.html", + "/${VERSION}/performance-benchmarking-with-tpcc-medium.html", + "/${VERSION}/performance-benchmarking-with-tpcc-large.html" + ] + } + ] + }, + { + "title": "Support Resources", + "urls": [ + "/${VERSION}/support-resources.html" + ] + }, + { + "title": "Automatic CPU Profiler", + "urls": [ + "/${VERSION}/automatic-cpu-profiler.html" + ] + }, + { + "title": "Automatic Go Execution Tracer", + "urls": [ + "/${VERSION}/automatic-go-execution-tracer.html" + ] + }, + { + "title": "Transaction Diagnostics", + "urls": [ + "/${VERSION}/transaction-diagnostics.html" + ] + } + ] +} diff --git a/src/current/_includes/v26.1/misc/beta-warning.md b/src/current/_includes/v26.1/misc/beta-warning.md index 4a5b9e3c6ae..b5660551c41 100644 --- a/src/current/_includes/v26.1/misc/beta-warning.md +++ b/src/current/_includes/v26.1/misc/beta-warning.md @@ -1,3 +1,3 @@ {{site.data.alerts.callout_danger}} -**This is a beta feature.** It is currently undergoing continued testing. Please [file a Github issue]({% link {{ page.version.version }}/file-an-issue.md %}) with us if you identify a bug. +**This is a beta feature.** It is currently undergoing continued testing. Please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) if you identify a bug. {{site.data.alerts.end}} diff --git a/src/current/_includes/v26.2/misc/beta-warning.md b/src/current/_includes/v26.2/misc/beta-warning.md index 4a5b9e3c6ae..b5660551c41 100644 --- a/src/current/_includes/v26.2/misc/beta-warning.md +++ b/src/current/_includes/v26.2/misc/beta-warning.md @@ -1,3 +1,3 @@ {{site.data.alerts.callout_danger}} -**This is a beta feature.** It is currently undergoing continued testing. Please [file a Github issue]({% link {{ page.version.version }}/file-an-issue.md %}) with us if you identify a bug. +**This is a beta feature.** It is currently undergoing continued testing. Please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) if you identify a bug. {{site.data.alerts.end}} diff --git a/src/current/v23.1/cluster-setup-troubleshooting.md b/src/current/v23.1/cluster-setup-troubleshooting.md index 79d98251f18..bcb4dcb0828 100644 --- a/src/current/v23.1/cluster-setup-troubleshooting.md +++ b/src/current/v23.1/cluster-setup-troubleshooting.md @@ -91,7 +91,7 @@ You should see a list of the built-in databases: If you’re not seeing the output above, check for the following: - `connection refused` error, which indicates you have not included some flag that you used to start the node. We have additional troubleshooting steps for this error [here]({% link {{ page.version.version }}/common-errors.md %}#connection-refused). -- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. +- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [contact Support]({% link {{ page.version.version }}/support-resources.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. ## Cannot run a multi-node CockroachDB cluster on the same machine @@ -508,7 +508,7 @@ CockroachDB memory usage has the following components: {% include {{ page.version.version }}/prod-deployment/healthy-crdb-memory.md %} - If you observe values not within the expected range for a healthy cluster, [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). + If you observe values not within the expected range for a healthy cluster, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). #### Out-of-memory (OOM) crash @@ -564,7 +564,7 @@ To identify under-replicated/unavailable ranges: 1. On the **Cluster Overview** page, check the **Replication Status**. If the **Under-replicated ranges** or **Unavailable ranges** count is non-zero, then you have under-replicated or unavailable ranges in your cluster. -1. Check for a network partition: Click the gear icon on the left-hand navigation bar to access the **Advanced Debugging** page. On the Advanced Debugging page, click **Network Latency**. In the **Latencies** table, check if any cells are marked as "X". If yes, it indicates that the nodes cannot communicate with those nodes, and might indicate a network partition. If there's no partition, and there's still no upreplication after 5 mins, then [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). +1. Check for a network partition: Click the gear icon on the left-hand navigation bar to access the **Advanced Debugging** page. On the Advanced Debugging page, click **Network Latency**. In the **Latencies** table, check if any cells are marked as "X". If yes, it indicates that the nodes cannot communicate with those nodes, and might indicate a network partition. If there's no partition, and there's still no upreplication after 5 mins, then [contact Support]({% link {{ page.version.version }}/support-resources.md %}). **Add nodes to the cluster:** @@ -577,7 +577,7 @@ If you still see under-replicated/unavailable ranges on the Cluster Overview pag 1. Click **Problem Ranges**. 1. In the **Connections** table, identify the node with the under-replicated/unavailable ranges and click the node ID in the Node column. 1. To view the **Range Report** for a range, click on the range number in the **Under-replicated (or slow)** table or **Unavailable** table. -1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). Please be sure to include the full Range Report and error message when you submit the issue. +1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Please be sure to include the full Range Report and error message when you submit the issue. #### Check for under-replicated or unavailable data diff --git a/src/current/v23.1/cockroach-debug-encryption-active-key.md b/src/current/v23.1/cockroach-debug-encryption-active-key.md index 7c1ddf7988e..aca9814104b 100644 --- a/src/current/v23.1/cockroach-debug-encryption-active-key.md +++ b/src/current/v23.1/cockroach-debug-encryption-active-key.md @@ -40,6 +40,6 @@ AES128_CTR:be235c29239aa84a48e5e1874d76aebf7fb3c1bdc438cec2eb98de82f06a57a0 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v23.1/cockroach-debug-encryption-decrypt.md b/src/current/v23.1/cockroach-debug-encryption-decrypt.md index 94b88d85ba0..87a69627d49 100644 --- a/src/current/v23.1/cockroach-debug-encryption-decrypt.md +++ b/src/current/v23.1/cockroach-debug-encryption-decrypt.md @@ -57,7 +57,7 @@ The `cockroach debug encryption-decrypt` command will output the decrypted store ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v23.1/cockroach-debug-job-trace.md b/src/current/v23.1/cockroach-debug-job-trace.md index 0684f385172..406f235696d 100644 --- a/src/current/v23.1/cockroach-debug-job-trace.md +++ b/src/current/v23.1/cockroach-debug-job-trace.md @@ -70,7 +70,7 @@ You will find the zip file in the directory you ran the command from: ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v23.1/cockroach-debug-merge-logs.md b/src/current/v23.1/cockroach-debug-merge-logs.md index 44f5e9af312..80a2f4d16df 100644 --- a/src/current/v23.1/cockroach-debug-merge-logs.md +++ b/src/current/v23.1/cockroach-debug-merge-logs.md @@ -79,6 +79,6 @@ cockroach debug merge-logs --redact debug/nodes/*/logs/* ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v23.1/cockroach-debug-tsdump.md b/src/current/v23.1/cockroach-debug-tsdump.md index dce0d7a277e..5a2d51582e2 100644 --- a/src/current/v23.1/cockroach-debug-tsdump.md +++ b/src/current/v23.1/cockroach-debug-tsdump.md @@ -106,6 +106,6 @@ $ cockroach debug tsdump --format=raw --from='2023-01-10 01:00:00' --to='2023-01 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v23.1/cockroach-debug-zip.md b/src/current/v23.1/cockroach-debug-zip.md index fb53065a835..df91b18508c 100644 --- a/src/current/v23.1/cockroach-debug-zip.md +++ b/src/current/v23.1/cockroach-debug-zip.md @@ -195,6 +195,6 @@ server/server.go:1423 ⋮ password of user ‹×› was set to ‹×› ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v23.1/example-apps.md b/src/current/v23.1/example-apps.md index bea3cfd1876..7737474b620 100644 --- a/src/current/v23.1/example-apps.md +++ b/src/current/v23.1/example-apps.md @@ -14,7 +14,7 @@ Click the links in the tables below to see simple but complete example applicati If you are looking to do a specific task such as connect to the database, insert data, or run multi-statement transactions, see [this list of tasks](#tasks). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Note that tools with [**community-level** support]({% link {{ page.version.version }}/community-tooling.md %}) have been tested or developed by the CockroachDB community, but are not officially supported by Cockroach Labs. If you encounter problems with using these tools, please contact the maintainer of the tool with details. {{site.data.alerts.end}} diff --git a/src/current/v23.1/file-an-issue.md b/src/current/v23.1/file-an-issue.md deleted file mode 100644 index 9255e2c08b2..00000000000 --- a/src/current/v23.1/file-an-issue.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: File an Issue -summary: Learn how to file a GitHub issue with CockroachDB. -toc: false -docs_area: manage ---- - -If you've tried to [troubleshoot]({% link {{ page.version.version }}/troubleshooting-overview.md %}) an issue yourself, have [reached out for help]({% link {{ page.version.version }}/support-resources.md %}), and are still stumped, you can file an issue in GitHub. - -To file an issue in GitHub, we need the following information: - -1. A summary of the issue. - -1. The steps to reproduce the issue. - -1. The result you expected. - -1. The result that actually occurred. - -1. The first few lines of the log file from each node in the cluster in a timeframe as close as possible to reproducing the issue. On most Unix-based systems running with defaults, you can get this information using the following command: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ grep -F '[config]' cockroach-data/logs/cockroach.log - ~~~ - {{site.data.alerts.callout_info}}You might need to replace cockroach-data/logs with the location of your logs.{{site.data.alerts.end}} - If the logs are not available, include the output of `cockroach version` for each node in the cluster. - -### Template - -You can use this as a template for [filing an issue in GitHub](https://github.com/cockroachdb/cockroach/issues/new): - -~~~ - -## Summary - - - -## Steps to reproduce - -1. -2. -3. - -## Expected Result - - - -## Actual Result - - - -## Log files/version - -### Node 1 - - - -### Node 2 - - - -### Node 3 - - - -~~~ diff --git a/src/current/v23.1/install-client-drivers.md b/src/current/v23.1/install-client-drivers.md index 984671a0dfc..cdb1ab19223 100644 --- a/src/current/v23.1/install-client-drivers.md +++ b/src/current/v23.1/install-client-drivers.md @@ -8,7 +8,7 @@ docs_area: develop CockroachDB supports both native drivers and the PostgreSQL wire protocol, so most available PostgreSQL client drivers and ORM frameworks should work with CockroachDB. Choose a language for supported clients, and follow the installation steps. After you install a client library, you can [connect to the database]({% link {{ page.version.version }}/connect-to-the-database.md %}). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). {{site.data.alerts.end}}
diff --git a/src/current/v23.1/intellij-idea.md b/src/current/v23.1/intellij-idea.md index de46249320f..70a74f0ca2b 100644 --- a/src/current/v23.1/intellij-idea.md +++ b/src/current/v23.1/intellij-idea.md @@ -81,7 +81,7 @@ You can now use IntelliJ's [database tool window](https://www.jetbrains.com/help ## Report issues with IntelliJ IDEA & CockroachDB -If you encounter issues other than those outlined above, please [file an issue on the `cockroachdb/cockroach` GitHub repo](https://github.com/cockroachdb/cockroach/issues/new?template=bug_report.md), including the following details about the environment where you encountered the issue: +If you encounter issues other than those outlined above, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) with the following details about the environment where you encountered the issue: - CockroachDB version ([`cockroach version`]({% link {{ page.version.version }}/cockroach-version.md %})) - IntelliJ IDEA version diff --git a/src/current/v23.1/postgresql-compatibility.md b/src/current/v23.1/postgresql-compatibility.md index 319e81338f0..e77ab6c2168 100644 --- a/src/current/v23.1/postgresql-compatibility.md +++ b/src/current/v23.1/postgresql-compatibility.md @@ -34,11 +34,11 @@ When set to `true`, multiple portals can be open at the same time, with their ex This feature has the following limitations: - Only read-only [`SELECT` queries]({% link {{ page.version.version }}/selection-queries.md %}) without [subqueries]({% link {{ page.version.version }}/subqueries.md %}) are supported. -- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported - [cockroachdb/cockroach#96398](https://github.com/cockroachdb/cockroach/issues/96398) -- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only - [cockroachdb/cockroach#100822](https://github.com/cockroachdb/cockroach/issues/100822) -- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}) - [cockroachdb/cockroach#99404](https://github.com/cockroachdb/cockroach/issues/99404) +- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported. +- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only. +- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}). -In addition to the known issues, additional performance testing is needed. The current list of known issues can be viewed [on GitHub using the `A-pausable-portals` label](https://github.com/cockroachdb/cockroach/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc++label%3AA-pausable-portals+), and we welcome bug reports. +In addition to the known issues, additional performance testing is needed. ## Features that differ from PostgreSQL @@ -181,7 +181,6 @@ An `x` value less than `1` would result in the following error: pq: check constraint violated ~~~ -[Tracking GitHub Issue](https://github.com/cockroachdb/cockroach/issues/35370) ### Column name from an outer column inside a subquery @@ -207,7 +206,6 @@ PostgreSQL: 1 ~~~ -[Tracking GitHub Issue](https://github.com/cockroachdb/cockroach/issues/46563) ### SQL Compatibility diff --git a/src/current/v23.1/query-behavior-troubleshooting.md b/src/current/v23.1/query-behavior-troubleshooting.md index b7e203ea761..5b5d037d5e2 100644 --- a/src/current/v23.1/query-behavior-troubleshooting.md +++ b/src/current/v23.1/query-behavior-troubleshooting.md @@ -324,7 +324,7 @@ A response of `bad connection` or `closed` normally indicates that the node to w Once you find the node, you can check its [logs]({% link {{ page.version.version }}/logging.md %}) (stored in `cockroach-data/logs` by [default]({% link {{ page.version.version }}/configure-logs.md %}#default-logging-configuration)). -Because this kind of behavior is unexpected, you should [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). +Because this kind of behavior is unexpected, you should [contact Support]({% link {{ page.version.version }}/support-resources.md %}). ### Log queries executed by a specific node diff --git a/src/current/v23.1/support-resources.md b/src/current/v23.1/support-resources.md index d4ac13b822f..0474ef39a6c 100644 --- a/src/current/v23.1/support-resources.md +++ b/src/current/v23.1/support-resources.md @@ -13,6 +13,5 @@ If you're having an issue with CockroachDB, you can reach out for support from C - [CockroachDB Community Forum](https://forum.cockroachlabs.com) - [CockroachDB Community Slack](https://cockroachdb.slack.com) - [CockroachDB in StackOverflow](http://stackoverflow.com/questions/tagged/cockroachdb) -- [File an issue in GitHub]({% link {{ page.version.version }}/file-an-issue.md %}) We also rely on contributions from users like you. If you know how to help users who might be struggling with a problem, we hope you will! diff --git a/src/current/v23.1/troubleshooting-overview.md b/src/current/v23.1/troubleshooting-overview.md index 1ada8bdc479..33e5ec5b2d3 100644 --- a/src/current/v23.1/troubleshooting-overview.md +++ b/src/current/v23.1/troubleshooting-overview.md @@ -26,7 +26,6 @@ If you experience an issue when using CockroachDB, try these steps to resolve th - If you cannot resolve the issue yourself, the following tools can help you move forward: - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) identify ways you can get help with troubleshooting. - - [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) provides details on how to file an issue that you're unable to resolve. - In a support escalation, you may be directed to use the following features by the [Cockroach Labs support team]({% link {{ page.version.version }}/support-resources.md %}): diff --git a/src/current/v23.2/cluster-setup-troubleshooting.md b/src/current/v23.2/cluster-setup-troubleshooting.md index ad7c820493e..e184b085a1d 100644 --- a/src/current/v23.2/cluster-setup-troubleshooting.md +++ b/src/current/v23.2/cluster-setup-troubleshooting.md @@ -91,7 +91,7 @@ You should see a list of the built-in databases: If you’re not seeing the output above, check for the following: - `connection refused` error, which indicates you have not included some flag that you used to start the node. We have additional troubleshooting steps for this error [here]({% link {{ page.version.version }}/common-errors.md %}#connection-refused). -- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. +- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [contact Support]({% link {{ page.version.version }}/support-resources.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. ## Cannot run a multi-node CockroachDB cluster on the same machine @@ -515,7 +515,7 @@ CockroachDB memory usage has the following components: {% include {{ page.version.version }}/prod-deployment/healthy-crdb-memory.md %} - If you observe values not within the expected range for a healthy cluster, [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). + If you observe values not within the expected range for a healthy cluster, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). #### Out-of-memory (OOM) crash @@ -571,7 +571,7 @@ To identify under-replicated/unavailable ranges: 1. On the **Cluster Overview** page, check the **Replication Status**. If the **Under-replicated ranges** or **Unavailable ranges** count is non-zero, then you have under-replicated or unavailable ranges in your cluster. -1. Check for a network partition: Click the gear icon on the left-hand navigation bar to access the **Advanced Debugging** page. On the Advanced Debugging page, click **Network Latency**. In the **Latencies** table, check if any cells are marked as "X". If yes, it indicates that the nodes cannot communicate with those nodes, and might indicate a network partition. If there's no partition, and there's still no upreplication after 5 mins, then [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). +1. Check for a network partition: Click the gear icon on the left-hand navigation bar to access the **Advanced Debugging** page. On the Advanced Debugging page, click **Network Latency**. In the **Latencies** table, check if any cells are marked as "X". If yes, it indicates that the nodes cannot communicate with those nodes, and might indicate a network partition. If there's no partition, and there's still no upreplication after 5 mins, then [contact Support]({% link {{ page.version.version }}/support-resources.md %}). **Add nodes to the cluster:** @@ -584,7 +584,7 @@ If you still see under-replicated/unavailable ranges on the Cluster Overview pag 1. Click **Problem Ranges**. 1. In the **Connections** table, identify the node with the under-replicated/unavailable ranges and click the node ID in the Node column. 1. To view the **Range Report** for a range, click on the range number in the **Under-replicated (or slow)** table or **Unavailable** table. -1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). Please be sure to include the full Range Report and error message when you submit the issue. +1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Please be sure to include the full Range Report and error message when you submit the issue. #### Check for under-replicated or unavailable data diff --git a/src/current/v23.2/cockroach-debug-encryption-active-key.md b/src/current/v23.2/cockroach-debug-encryption-active-key.md index 7c1ddf7988e..aca9814104b 100644 --- a/src/current/v23.2/cockroach-debug-encryption-active-key.md +++ b/src/current/v23.2/cockroach-debug-encryption-active-key.md @@ -40,6 +40,6 @@ AES128_CTR:be235c29239aa84a48e5e1874d76aebf7fb3c1bdc438cec2eb98de82f06a57a0 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v23.2/cockroach-debug-encryption-decrypt.md b/src/current/v23.2/cockroach-debug-encryption-decrypt.md index 94b88d85ba0..87a69627d49 100644 --- a/src/current/v23.2/cockroach-debug-encryption-decrypt.md +++ b/src/current/v23.2/cockroach-debug-encryption-decrypt.md @@ -57,7 +57,7 @@ The `cockroach debug encryption-decrypt` command will output the decrypted store ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v23.2/cockroach-debug-job-trace.md b/src/current/v23.2/cockroach-debug-job-trace.md index 0684f385172..406f235696d 100644 --- a/src/current/v23.2/cockroach-debug-job-trace.md +++ b/src/current/v23.2/cockroach-debug-job-trace.md @@ -70,7 +70,7 @@ You will find the zip file in the directory you ran the command from: ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v23.2/cockroach-debug-merge-logs.md b/src/current/v23.2/cockroach-debug-merge-logs.md index 4ebed81dd51..2d54b2c9e14 100644 --- a/src/current/v23.2/cockroach-debug-merge-logs.md +++ b/src/current/v23.2/cockroach-debug-merge-logs.md @@ -84,6 +84,6 @@ As of v23.2, logs can be configured to use a [timezone with formats `crdb-v1` or ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v23.2/cockroach-debug-tsdump.md b/src/current/v23.2/cockroach-debug-tsdump.md index dce0d7a277e..5a2d51582e2 100644 --- a/src/current/v23.2/cockroach-debug-tsdump.md +++ b/src/current/v23.2/cockroach-debug-tsdump.md @@ -106,6 +106,6 @@ $ cockroach debug tsdump --format=raw --from='2023-01-10 01:00:00' --to='2023-01 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v23.2/cockroach-debug-zip.md b/src/current/v23.2/cockroach-debug-zip.md index 7655d3ff8fd..b5fde8186db 100644 --- a/src/current/v23.2/cockroach-debug-zip.md +++ b/src/current/v23.2/cockroach-debug-zip.md @@ -196,6 +196,6 @@ server/server.go:1423 ⋮ password of user ‹×› was set to ‹×› ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v23.2/example-apps.md b/src/current/v23.2/example-apps.md index bea3cfd1876..7737474b620 100644 --- a/src/current/v23.2/example-apps.md +++ b/src/current/v23.2/example-apps.md @@ -14,7 +14,7 @@ Click the links in the tables below to see simple but complete example applicati If you are looking to do a specific task such as connect to the database, insert data, or run multi-statement transactions, see [this list of tasks](#tasks). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Note that tools with [**community-level** support]({% link {{ page.version.version }}/community-tooling.md %}) have been tested or developed by the CockroachDB community, but are not officially supported by Cockroach Labs. If you encounter problems with using these tools, please contact the maintainer of the tool with details. {{site.data.alerts.end}} diff --git a/src/current/v23.2/file-an-issue.md b/src/current/v23.2/file-an-issue.md deleted file mode 100644 index 9255e2c08b2..00000000000 --- a/src/current/v23.2/file-an-issue.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: File an Issue -summary: Learn how to file a GitHub issue with CockroachDB. -toc: false -docs_area: manage ---- - -If you've tried to [troubleshoot]({% link {{ page.version.version }}/troubleshooting-overview.md %}) an issue yourself, have [reached out for help]({% link {{ page.version.version }}/support-resources.md %}), and are still stumped, you can file an issue in GitHub. - -To file an issue in GitHub, we need the following information: - -1. A summary of the issue. - -1. The steps to reproduce the issue. - -1. The result you expected. - -1. The result that actually occurred. - -1. The first few lines of the log file from each node in the cluster in a timeframe as close as possible to reproducing the issue. On most Unix-based systems running with defaults, you can get this information using the following command: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ grep -F '[config]' cockroach-data/logs/cockroach.log - ~~~ - {{site.data.alerts.callout_info}}You might need to replace cockroach-data/logs with the location of your logs.{{site.data.alerts.end}} - If the logs are not available, include the output of `cockroach version` for each node in the cluster. - -### Template - -You can use this as a template for [filing an issue in GitHub](https://github.com/cockroachdb/cockroach/issues/new): - -~~~ - -## Summary - - - -## Steps to reproduce - -1. -2. -3. - -## Expected Result - - - -## Actual Result - - - -## Log files/version - -### Node 1 - - - -### Node 2 - - - -### Node 3 - - - -~~~ diff --git a/src/current/v23.2/install-client-drivers.md b/src/current/v23.2/install-client-drivers.md index 984671a0dfc..cdb1ab19223 100644 --- a/src/current/v23.2/install-client-drivers.md +++ b/src/current/v23.2/install-client-drivers.md @@ -8,7 +8,7 @@ docs_area: develop CockroachDB supports both native drivers and the PostgreSQL wire protocol, so most available PostgreSQL client drivers and ORM frameworks should work with CockroachDB. Choose a language for supported clients, and follow the installation steps. After you install a client library, you can [connect to the database]({% link {{ page.version.version }}/connect-to-the-database.md %}). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). {{site.data.alerts.end}}
diff --git a/src/current/v23.2/intellij-idea.md b/src/current/v23.2/intellij-idea.md index de46249320f..70a74f0ca2b 100644 --- a/src/current/v23.2/intellij-idea.md +++ b/src/current/v23.2/intellij-idea.md @@ -81,7 +81,7 @@ You can now use IntelliJ's [database tool window](https://www.jetbrains.com/help ## Report issues with IntelliJ IDEA & CockroachDB -If you encounter issues other than those outlined above, please [file an issue on the `cockroachdb/cockroach` GitHub repo](https://github.com/cockroachdb/cockroach/issues/new?template=bug_report.md), including the following details about the environment where you encountered the issue: +If you encounter issues other than those outlined above, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) with the following details about the environment where you encountered the issue: - CockroachDB version ([`cockroach version`]({% link {{ page.version.version }}/cockroach-version.md %})) - IntelliJ IDEA version diff --git a/src/current/v23.2/postgresql-compatibility.md b/src/current/v23.2/postgresql-compatibility.md index 319e81338f0..e77ab6c2168 100644 --- a/src/current/v23.2/postgresql-compatibility.md +++ b/src/current/v23.2/postgresql-compatibility.md @@ -34,11 +34,11 @@ When set to `true`, multiple portals can be open at the same time, with their ex This feature has the following limitations: - Only read-only [`SELECT` queries]({% link {{ page.version.version }}/selection-queries.md %}) without [subqueries]({% link {{ page.version.version }}/subqueries.md %}) are supported. -- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported - [cockroachdb/cockroach#96398](https://github.com/cockroachdb/cockroach/issues/96398) -- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only - [cockroachdb/cockroach#100822](https://github.com/cockroachdb/cockroach/issues/100822) -- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}) - [cockroachdb/cockroach#99404](https://github.com/cockroachdb/cockroach/issues/99404) +- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported. +- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only. +- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}). -In addition to the known issues, additional performance testing is needed. The current list of known issues can be viewed [on GitHub using the `A-pausable-portals` label](https://github.com/cockroachdb/cockroach/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc++label%3AA-pausable-portals+), and we welcome bug reports. +In addition to the known issues, additional performance testing is needed. ## Features that differ from PostgreSQL @@ -181,7 +181,6 @@ An `x` value less than `1` would result in the following error: pq: check constraint violated ~~~ -[Tracking GitHub Issue](https://github.com/cockroachdb/cockroach/issues/35370) ### Column name from an outer column inside a subquery @@ -207,7 +206,6 @@ PostgreSQL: 1 ~~~ -[Tracking GitHub Issue](https://github.com/cockroachdb/cockroach/issues/46563) ### SQL Compatibility diff --git a/src/current/v23.2/query-behavior-troubleshooting.md b/src/current/v23.2/query-behavior-troubleshooting.md index 511a93117d7..5565e0281b5 100644 --- a/src/current/v23.2/query-behavior-troubleshooting.md +++ b/src/current/v23.2/query-behavior-troubleshooting.md @@ -324,7 +324,7 @@ A response of `bad connection` or `closed` normally indicates that the node to w Once you find the node, you can check its [logs]({% link {{ page.version.version }}/logging.md %}) (stored in `cockroach-data/logs` by [default]({% link {{ page.version.version }}/configure-logs.md %}#default-logging-configuration)). -Because this kind of behavior is unexpected, you should [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). +Because this kind of behavior is unexpected, you should [contact Support]({% link {{ page.version.version }}/support-resources.md %}). ### Log queries executed by a specific node diff --git a/src/current/v23.2/support-resources.md b/src/current/v23.2/support-resources.md index d4ac13b822f..0474ef39a6c 100644 --- a/src/current/v23.2/support-resources.md +++ b/src/current/v23.2/support-resources.md @@ -13,6 +13,5 @@ If you're having an issue with CockroachDB, you can reach out for support from C - [CockroachDB Community Forum](https://forum.cockroachlabs.com) - [CockroachDB Community Slack](https://cockroachdb.slack.com) - [CockroachDB in StackOverflow](http://stackoverflow.com/questions/tagged/cockroachdb) -- [File an issue in GitHub]({% link {{ page.version.version }}/file-an-issue.md %}) We also rely on contributions from users like you. If you know how to help users who might be struggling with a problem, we hope you will! diff --git a/src/current/v23.2/troubleshooting-overview.md b/src/current/v23.2/troubleshooting-overview.md index 1ada8bdc479..33e5ec5b2d3 100644 --- a/src/current/v23.2/troubleshooting-overview.md +++ b/src/current/v23.2/troubleshooting-overview.md @@ -26,7 +26,6 @@ If you experience an issue when using CockroachDB, try these steps to resolve th - If you cannot resolve the issue yourself, the following tools can help you move forward: - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) identify ways you can get help with troubleshooting. - - [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) provides details on how to file an issue that you're unable to resolve. - In a support escalation, you may be directed to use the following features by the [Cockroach Labs support team]({% link {{ page.version.version }}/support-resources.md %}): diff --git a/src/current/v24.1/cluster-setup-troubleshooting.md b/src/current/v24.1/cluster-setup-troubleshooting.md index 8e4c67bf8fc..a884a8cc384 100644 --- a/src/current/v24.1/cluster-setup-troubleshooting.md +++ b/src/current/v24.1/cluster-setup-troubleshooting.md @@ -91,7 +91,7 @@ You should see a list of the built-in databases: If you’re not seeing the output above, check for the following: - `connection refused` error, which indicates you have not included some flag that you used to start the node. We have additional troubleshooting steps for this error [here]({% link {{ page.version.version }}/common-errors.md %}#connection-refused). -- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. +- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [contact Support]({% link {{ page.version.version }}/support-resources.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. ## Cannot run a multi-node CockroachDB cluster on the same machine @@ -528,7 +528,7 @@ CockroachDB memory usage has the following components: {% include {{ page.version.version }}/prod-deployment/healthy-crdb-memory.md %} - If you observe values not within the expected range for a healthy cluster, [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). + If you observe values not within the expected range for a healthy cluster, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). #### Out-of-memory (OOM) crash @@ -584,7 +584,7 @@ To identify under-replicated/unavailable ranges: 1. On the [**Cluster Overview** page]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}), check the **Replication Status**. If the **Under-replicated ranges** or **Unavailable ranges** count is non-zero, then you have under-replicated or unavailable ranges in your cluster. -1. Check for a network partition: On the [**Network** page]({% link {{ page.version.version }}/ui-network-latency-page.md %}), if there are nodes in the network matrix with [no connections]({% link {{ page.version.version }}/ui-network-latency-page.md %}#no-connections), this may indicate a network partition. If there is no partition and still no upreplication after 5 minutes, then [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). +1. Check for a network partition: On the [**Network** page]({% link {{ page.version.version }}/ui-network-latency-page.md %}), if there are nodes in the network matrix with [no connections]({% link {{ page.version.version }}/ui-network-latency-page.md %}#no-connections), this may indicate a network partition. If there is no partition and still no upreplication after 5 minutes, then [contact Support]({% link {{ page.version.version }}/support-resources.md %}). **Add nodes to the cluster:** @@ -596,7 +596,7 @@ If you still see under-replicated/unavailable ranges on the Cluster Overview pag 1. On the [**Advanced Debug** page]({% link {{ page.version.version }}/ui-debug-pages.md %}), click **Problem Ranges**. 1. In the **Connections** table, identify the node with the under-replicated/unavailable ranges and click the node ID in the Node column. 1. To view the **Range Report** for a range, click on the range number in the **Under-replicated (or slow)** table or **Unavailable** table. -1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). Please be sure to include the full Range Report and error message when you submit the issue. +1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Please be sure to include the full Range Report and error message when you submit the issue. #### Check for under-replicated or unavailable data diff --git a/src/current/v24.1/cockroach-debug-encryption-active-key.md b/src/current/v24.1/cockroach-debug-encryption-active-key.md index 7c1ddf7988e..aca9814104b 100644 --- a/src/current/v24.1/cockroach-debug-encryption-active-key.md +++ b/src/current/v24.1/cockroach-debug-encryption-active-key.md @@ -40,6 +40,6 @@ AES128_CTR:be235c29239aa84a48e5e1874d76aebf7fb3c1bdc438cec2eb98de82f06a57a0 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v24.1/cockroach-debug-encryption-decrypt.md b/src/current/v24.1/cockroach-debug-encryption-decrypt.md index 94b88d85ba0..87a69627d49 100644 --- a/src/current/v24.1/cockroach-debug-encryption-decrypt.md +++ b/src/current/v24.1/cockroach-debug-encryption-decrypt.md @@ -57,7 +57,7 @@ The `cockroach debug encryption-decrypt` command will output the decrypted store ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v24.1/cockroach-debug-job-trace.md b/src/current/v24.1/cockroach-debug-job-trace.md index 0684f385172..406f235696d 100644 --- a/src/current/v24.1/cockroach-debug-job-trace.md +++ b/src/current/v24.1/cockroach-debug-job-trace.md @@ -70,7 +70,7 @@ You will find the zip file in the directory you ran the command from: ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v24.1/cockroach-debug-merge-logs.md b/src/current/v24.1/cockroach-debug-merge-logs.md index 4ebed81dd51..2d54b2c9e14 100644 --- a/src/current/v24.1/cockroach-debug-merge-logs.md +++ b/src/current/v24.1/cockroach-debug-merge-logs.md @@ -84,6 +84,6 @@ As of v23.2, logs can be configured to use a [timezone with formats `crdb-v1` or ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v24.1/cockroach-debug-tsdump.md b/src/current/v24.1/cockroach-debug-tsdump.md index dce0d7a277e..5a2d51582e2 100644 --- a/src/current/v24.1/cockroach-debug-tsdump.md +++ b/src/current/v24.1/cockroach-debug-tsdump.md @@ -106,6 +106,6 @@ $ cockroach debug tsdump --format=raw --from='2023-01-10 01:00:00' --to='2023-01 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v24.1/cockroach-debug-zip.md b/src/current/v24.1/cockroach-debug-zip.md index b6898c61d33..cc09646d9f7 100644 --- a/src/current/v24.1/cockroach-debug-zip.md +++ b/src/current/v24.1/cockroach-debug-zip.md @@ -196,6 +196,6 @@ server/server.go:1423 ⋮ password of user ‹×› was set to ‹×› ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v24.1/example-apps.md b/src/current/v24.1/example-apps.md index bea3cfd1876..7737474b620 100644 --- a/src/current/v24.1/example-apps.md +++ b/src/current/v24.1/example-apps.md @@ -14,7 +14,7 @@ Click the links in the tables below to see simple but complete example applicati If you are looking to do a specific task such as connect to the database, insert data, or run multi-statement transactions, see [this list of tasks](#tasks). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Note that tools with [**community-level** support]({% link {{ page.version.version }}/community-tooling.md %}) have been tested or developed by the CockroachDB community, but are not officially supported by Cockroach Labs. If you encounter problems with using these tools, please contact the maintainer of the tool with details. {{site.data.alerts.end}} diff --git a/src/current/v24.1/file-an-issue.md b/src/current/v24.1/file-an-issue.md deleted file mode 100644 index 9255e2c08b2..00000000000 --- a/src/current/v24.1/file-an-issue.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: File an Issue -summary: Learn how to file a GitHub issue with CockroachDB. -toc: false -docs_area: manage ---- - -If you've tried to [troubleshoot]({% link {{ page.version.version }}/troubleshooting-overview.md %}) an issue yourself, have [reached out for help]({% link {{ page.version.version }}/support-resources.md %}), and are still stumped, you can file an issue in GitHub. - -To file an issue in GitHub, we need the following information: - -1. A summary of the issue. - -1. The steps to reproduce the issue. - -1. The result you expected. - -1. The result that actually occurred. - -1. The first few lines of the log file from each node in the cluster in a timeframe as close as possible to reproducing the issue. On most Unix-based systems running with defaults, you can get this information using the following command: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ grep -F '[config]' cockroach-data/logs/cockroach.log - ~~~ - {{site.data.alerts.callout_info}}You might need to replace cockroach-data/logs with the location of your logs.{{site.data.alerts.end}} - If the logs are not available, include the output of `cockroach version` for each node in the cluster. - -### Template - -You can use this as a template for [filing an issue in GitHub](https://github.com/cockroachdb/cockroach/issues/new): - -~~~ - -## Summary - - - -## Steps to reproduce - -1. -2. -3. - -## Expected Result - - - -## Actual Result - - - -## Log files/version - -### Node 1 - - - -### Node 2 - - - -### Node 3 - - - -~~~ diff --git a/src/current/v24.1/install-client-drivers.md b/src/current/v24.1/install-client-drivers.md index 984671a0dfc..cdb1ab19223 100644 --- a/src/current/v24.1/install-client-drivers.md +++ b/src/current/v24.1/install-client-drivers.md @@ -8,7 +8,7 @@ docs_area: develop CockroachDB supports both native drivers and the PostgreSQL wire protocol, so most available PostgreSQL client drivers and ORM frameworks should work with CockroachDB. Choose a language for supported clients, and follow the installation steps. After you install a client library, you can [connect to the database]({% link {{ page.version.version }}/connect-to-the-database.md %}). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). {{site.data.alerts.end}}
diff --git a/src/current/v24.1/intellij-idea.md b/src/current/v24.1/intellij-idea.md index de46249320f..70a74f0ca2b 100644 --- a/src/current/v24.1/intellij-idea.md +++ b/src/current/v24.1/intellij-idea.md @@ -81,7 +81,7 @@ You can now use IntelliJ's [database tool window](https://www.jetbrains.com/help ## Report issues with IntelliJ IDEA & CockroachDB -If you encounter issues other than those outlined above, please [file an issue on the `cockroachdb/cockroach` GitHub repo](https://github.com/cockroachdb/cockroach/issues/new?template=bug_report.md), including the following details about the environment where you encountered the issue: +If you encounter issues other than those outlined above, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) with the following details about the environment where you encountered the issue: - CockroachDB version ([`cockroach version`]({% link {{ page.version.version }}/cockroach-version.md %})) - IntelliJ IDEA version diff --git a/src/current/v24.1/postgresql-compatibility.md b/src/current/v24.1/postgresql-compatibility.md index 15eff6fdc35..e77ab6c2168 100644 --- a/src/current/v24.1/postgresql-compatibility.md +++ b/src/current/v24.1/postgresql-compatibility.md @@ -34,11 +34,11 @@ When set to `true`, multiple portals can be open at the same time, with their ex This feature has the following limitations: - Only read-only [`SELECT` queries]({% link {{ page.version.version }}/selection-queries.md %}) without [subqueries]({% link {{ page.version.version }}/subqueries.md %}) are supported. -- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported - [cockroachdb/cockroach#96398](https://github.com/cockroachdb/cockroach/issues/96398) -- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only - [cockroachdb/cockroach#100822](https://github.com/cockroachdb/cockroach/issues/100822) -- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}) - [cockroachdb/cockroach#99404](https://github.com/cockroachdb/cockroach/issues/99404) +- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported. +- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only. +- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}). -In addition to the known issues, additional performance testing is needed. The current list of known issues can be viewed [on GitHub using the `A-pausable-portals` label](https://github.com/cockroachdb/cockroach/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc++label%3AA-pausable-portals+), and we welcome bug reports. +In addition to the known issues, additional performance testing is needed. ## Features that differ from PostgreSQL @@ -181,7 +181,6 @@ An `x` value less than `1` would result in the following error: pq: check constraint violated ~~~ -[#35370](https://github.com/cockroachdb/cockroach/issues/35370) ### Column name from an outer column inside a subquery @@ -207,7 +206,6 @@ PostgreSQL: 1 ~~~ -[#46563](https://github.com/cockroachdb/cockroach/issues/46563) ### SQL Compatibility diff --git a/src/current/v24.1/query-behavior-troubleshooting.md b/src/current/v24.1/query-behavior-troubleshooting.md index 7ac7b3840c3..8587959b740 100644 --- a/src/current/v24.1/query-behavior-troubleshooting.md +++ b/src/current/v24.1/query-behavior-troubleshooting.md @@ -324,7 +324,7 @@ A response of `bad connection` or `closed` normally indicates that the node to w Once you find the node, you can check its [logs]({% link {{ page.version.version }}/logging.md %}) (stored in `cockroach-data/logs` by [default]({% link {{ page.version.version }}/configure-logs.md %}#default-logging-configuration)). -Because this kind of behavior is unexpected, you should [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). +Because this kind of behavior is unexpected, you should [contact Support]({% link {{ page.version.version }}/support-resources.md %}). ### Log queries executed by a specific node diff --git a/src/current/v24.1/support-resources.md b/src/current/v24.1/support-resources.md index d4ac13b822f..0474ef39a6c 100644 --- a/src/current/v24.1/support-resources.md +++ b/src/current/v24.1/support-resources.md @@ -13,6 +13,5 @@ If you're having an issue with CockroachDB, you can reach out for support from C - [CockroachDB Community Forum](https://forum.cockroachlabs.com) - [CockroachDB Community Slack](https://cockroachdb.slack.com) - [CockroachDB in StackOverflow](http://stackoverflow.com/questions/tagged/cockroachdb) -- [File an issue in GitHub]({% link {{ page.version.version }}/file-an-issue.md %}) We also rely on contributions from users like you. If you know how to help users who might be struggling with a problem, we hope you will! diff --git a/src/current/v24.1/troubleshooting-overview.md b/src/current/v24.1/troubleshooting-overview.md index 1ada8bdc479..33e5ec5b2d3 100644 --- a/src/current/v24.1/troubleshooting-overview.md +++ b/src/current/v24.1/troubleshooting-overview.md @@ -26,7 +26,6 @@ If you experience an issue when using CockroachDB, try these steps to resolve th - If you cannot resolve the issue yourself, the following tools can help you move forward: - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) identify ways you can get help with troubleshooting. - - [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) provides details on how to file an issue that you're unable to resolve. - In a support escalation, you may be directed to use the following features by the [Cockroach Labs support team]({% link {{ page.version.version }}/support-resources.md %}): diff --git a/src/current/v24.2/cluster-setup-troubleshooting.md b/src/current/v24.2/cluster-setup-troubleshooting.md index 997923e9f03..42365ecec0e 100644 --- a/src/current/v24.2/cluster-setup-troubleshooting.md +++ b/src/current/v24.2/cluster-setup-troubleshooting.md @@ -91,7 +91,7 @@ You should see a list of the built-in databases: If you’re not seeing the output above, check for the following: - `connection refused` error, which indicates you have not included some flag that you used to start the node. We have additional troubleshooting steps for this error [here]({% link {{ page.version.version }}/common-errors.md %}#connection-refused). -- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. +- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [contact Support]({% link {{ page.version.version }}/support-resources.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. ## Cannot run a multi-node CockroachDB cluster on the same machine @@ -513,7 +513,7 @@ CockroachDB memory usage has the following components: {% include {{ page.version.version }}/prod-deployment/healthy-crdb-memory.md %} - If you observe values not within the expected range for a healthy cluster, [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). + If you observe values not within the expected range for a healthy cluster, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). #### Out-of-memory (OOM) crash @@ -569,7 +569,7 @@ To identify under-replicated/unavailable ranges: 1. On the [**Cluster Overview** page]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}), check the **Replication Status**. If the **Under-replicated ranges** or **Unavailable ranges** count is non-zero, then you have under-replicated or unavailable ranges in your cluster. -1. Check for a network partition: On the [**Network** page]({% link {{ page.version.version }}/ui-network-latency-page.md %}), if there are nodes in the network matrix with [no connections]({% link {{ page.version.version }}/ui-network-latency-page.md %}#no-connections), this may indicate a network partition. If there is no partition and still no upreplication after 5 minutes, then [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). +1. Check for a network partition: On the [**Network** page]({% link {{ page.version.version }}/ui-network-latency-page.md %}), if there are nodes in the network matrix with [no connections]({% link {{ page.version.version }}/ui-network-latency-page.md %}#no-connections), this may indicate a network partition. If there is no partition and still no upreplication after 5 minutes, then [contact Support]({% link {{ page.version.version }}/support-resources.md %}). **Add nodes to the cluster:** @@ -581,7 +581,7 @@ If you still see under-replicated/unavailable ranges on the Cluster Overview pag 1. On the [**Advanced Debug** page]({% link {{ page.version.version }}/ui-debug-pages.md %}), click **Problem Ranges**. 1. In the **Connections** table, identify the node with the under-replicated/unavailable ranges and click the node ID in the Node column. 1. To view the **Range Report** for a range, click on the range number in the **Under-replicated (or slow)** table or **Unavailable** table. -1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). Please be sure to include the full Range Report and error message when you submit the issue. +1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Please be sure to include the full Range Report and error message when you submit the issue. #### Check for under-replicated or unavailable data diff --git a/src/current/v24.2/cockroach-debug-encryption-active-key.md b/src/current/v24.2/cockroach-debug-encryption-active-key.md index 7c1ddf7988e..aca9814104b 100644 --- a/src/current/v24.2/cockroach-debug-encryption-active-key.md +++ b/src/current/v24.2/cockroach-debug-encryption-active-key.md @@ -40,6 +40,6 @@ AES128_CTR:be235c29239aa84a48e5e1874d76aebf7fb3c1bdc438cec2eb98de82f06a57a0 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v24.2/cockroach-debug-encryption-decrypt.md b/src/current/v24.2/cockroach-debug-encryption-decrypt.md index 94b88d85ba0..87a69627d49 100644 --- a/src/current/v24.2/cockroach-debug-encryption-decrypt.md +++ b/src/current/v24.2/cockroach-debug-encryption-decrypt.md @@ -57,7 +57,7 @@ The `cockroach debug encryption-decrypt` command will output the decrypted store ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v24.2/cockroach-debug-job-trace.md b/src/current/v24.2/cockroach-debug-job-trace.md index 0684f385172..406f235696d 100644 --- a/src/current/v24.2/cockroach-debug-job-trace.md +++ b/src/current/v24.2/cockroach-debug-job-trace.md @@ -70,7 +70,7 @@ You will find the zip file in the directory you ran the command from: ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v24.2/cockroach-debug-merge-logs.md b/src/current/v24.2/cockroach-debug-merge-logs.md index 4ebed81dd51..2d54b2c9e14 100644 --- a/src/current/v24.2/cockroach-debug-merge-logs.md +++ b/src/current/v24.2/cockroach-debug-merge-logs.md @@ -84,6 +84,6 @@ As of v23.2, logs can be configured to use a [timezone with formats `crdb-v1` or ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v24.2/cockroach-debug-tsdump.md b/src/current/v24.2/cockroach-debug-tsdump.md index dce0d7a277e..5a2d51582e2 100644 --- a/src/current/v24.2/cockroach-debug-tsdump.md +++ b/src/current/v24.2/cockroach-debug-tsdump.md @@ -106,6 +106,6 @@ $ cockroach debug tsdump --format=raw --from='2023-01-10 01:00:00' --to='2023-01 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v24.2/cockroach-debug-zip.md b/src/current/v24.2/cockroach-debug-zip.md index b9819ab3c67..92d5e3d7a88 100644 --- a/src/current/v24.2/cockroach-debug-zip.md +++ b/src/current/v24.2/cockroach-debug-zip.md @@ -250,6 +250,6 @@ cockroach debug zip ./cockroach-data/logs/debug.zip --redact --insecure --host=2 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v24.2/example-apps.md b/src/current/v24.2/example-apps.md index bea3cfd1876..7737474b620 100644 --- a/src/current/v24.2/example-apps.md +++ b/src/current/v24.2/example-apps.md @@ -14,7 +14,7 @@ Click the links in the tables below to see simple but complete example applicati If you are looking to do a specific task such as connect to the database, insert data, or run multi-statement transactions, see [this list of tasks](#tasks). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Note that tools with [**community-level** support]({% link {{ page.version.version }}/community-tooling.md %}) have been tested or developed by the CockroachDB community, but are not officially supported by Cockroach Labs. If you encounter problems with using these tools, please contact the maintainer of the tool with details. {{site.data.alerts.end}} diff --git a/src/current/v24.2/file-an-issue.md b/src/current/v24.2/file-an-issue.md deleted file mode 100644 index 9255e2c08b2..00000000000 --- a/src/current/v24.2/file-an-issue.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: File an Issue -summary: Learn how to file a GitHub issue with CockroachDB. -toc: false -docs_area: manage ---- - -If you've tried to [troubleshoot]({% link {{ page.version.version }}/troubleshooting-overview.md %}) an issue yourself, have [reached out for help]({% link {{ page.version.version }}/support-resources.md %}), and are still stumped, you can file an issue in GitHub. - -To file an issue in GitHub, we need the following information: - -1. A summary of the issue. - -1. The steps to reproduce the issue. - -1. The result you expected. - -1. The result that actually occurred. - -1. The first few lines of the log file from each node in the cluster in a timeframe as close as possible to reproducing the issue. On most Unix-based systems running with defaults, you can get this information using the following command: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ grep -F '[config]' cockroach-data/logs/cockroach.log - ~~~ - {{site.data.alerts.callout_info}}You might need to replace cockroach-data/logs with the location of your logs.{{site.data.alerts.end}} - If the logs are not available, include the output of `cockroach version` for each node in the cluster. - -### Template - -You can use this as a template for [filing an issue in GitHub](https://github.com/cockroachdb/cockroach/issues/new): - -~~~ - -## Summary - - - -## Steps to reproduce - -1. -2. -3. - -## Expected Result - - - -## Actual Result - - - -## Log files/version - -### Node 1 - - - -### Node 2 - - - -### Node 3 - - - -~~~ diff --git a/src/current/v24.2/install-client-drivers.md b/src/current/v24.2/install-client-drivers.md index 984671a0dfc..cdb1ab19223 100644 --- a/src/current/v24.2/install-client-drivers.md +++ b/src/current/v24.2/install-client-drivers.md @@ -8,7 +8,7 @@ docs_area: develop CockroachDB supports both native drivers and the PostgreSQL wire protocol, so most available PostgreSQL client drivers and ORM frameworks should work with CockroachDB. Choose a language for supported clients, and follow the installation steps. After you install a client library, you can [connect to the database]({% link {{ page.version.version }}/connect-to-the-database.md %}). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). {{site.data.alerts.end}}
diff --git a/src/current/v24.2/intellij-idea.md b/src/current/v24.2/intellij-idea.md index de46249320f..70a74f0ca2b 100644 --- a/src/current/v24.2/intellij-idea.md +++ b/src/current/v24.2/intellij-idea.md @@ -81,7 +81,7 @@ You can now use IntelliJ's [database tool window](https://www.jetbrains.com/help ## Report issues with IntelliJ IDEA & CockroachDB -If you encounter issues other than those outlined above, please [file an issue on the `cockroachdb/cockroach` GitHub repo](https://github.com/cockroachdb/cockroach/issues/new?template=bug_report.md), including the following details about the environment where you encountered the issue: +If you encounter issues other than those outlined above, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) with the following details about the environment where you encountered the issue: - CockroachDB version ([`cockroach version`]({% link {{ page.version.version }}/cockroach-version.md %})) - IntelliJ IDEA version diff --git a/src/current/v24.2/postgresql-compatibility.md b/src/current/v24.2/postgresql-compatibility.md index 15eff6fdc35..e77ab6c2168 100644 --- a/src/current/v24.2/postgresql-compatibility.md +++ b/src/current/v24.2/postgresql-compatibility.md @@ -34,11 +34,11 @@ When set to `true`, multiple portals can be open at the same time, with their ex This feature has the following limitations: - Only read-only [`SELECT` queries]({% link {{ page.version.version }}/selection-queries.md %}) without [subqueries]({% link {{ page.version.version }}/subqueries.md %}) are supported. -- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported - [cockroachdb/cockroach#96398](https://github.com/cockroachdb/cockroach/issues/96398) -- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only - [cockroachdb/cockroach#100822](https://github.com/cockroachdb/cockroach/issues/100822) -- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}) - [cockroachdb/cockroach#99404](https://github.com/cockroachdb/cockroach/issues/99404) +- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported. +- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only. +- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}). -In addition to the known issues, additional performance testing is needed. The current list of known issues can be viewed [on GitHub using the `A-pausable-portals` label](https://github.com/cockroachdb/cockroach/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc++label%3AA-pausable-portals+), and we welcome bug reports. +In addition to the known issues, additional performance testing is needed. ## Features that differ from PostgreSQL @@ -181,7 +181,6 @@ An `x` value less than `1` would result in the following error: pq: check constraint violated ~~~ -[#35370](https://github.com/cockroachdb/cockroach/issues/35370) ### Column name from an outer column inside a subquery @@ -207,7 +206,6 @@ PostgreSQL: 1 ~~~ -[#46563](https://github.com/cockroachdb/cockroach/issues/46563) ### SQL Compatibility diff --git a/src/current/v24.2/query-behavior-troubleshooting.md b/src/current/v24.2/query-behavior-troubleshooting.md index 0a0fa9b69a6..5428ce7f870 100644 --- a/src/current/v24.2/query-behavior-troubleshooting.md +++ b/src/current/v24.2/query-behavior-troubleshooting.md @@ -324,7 +324,7 @@ A response of `bad connection` or `closed` normally indicates that the node to w Once you find the node, you can check its [logs]({% link {{ page.version.version }}/logging.md %}) (stored in `cockroach-data/logs` by [default]({% link {{ page.version.version }}/configure-logs.md %}#default-logging-configuration)). -Because this kind of behavior is unexpected, you should [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). +Because this kind of behavior is unexpected, you should [contact Support]({% link {{ page.version.version }}/support-resources.md %}). ### Log queries executed by a specific node diff --git a/src/current/v24.2/support-resources.md b/src/current/v24.2/support-resources.md index d4ac13b822f..0474ef39a6c 100644 --- a/src/current/v24.2/support-resources.md +++ b/src/current/v24.2/support-resources.md @@ -13,6 +13,5 @@ If you're having an issue with CockroachDB, you can reach out for support from C - [CockroachDB Community Forum](https://forum.cockroachlabs.com) - [CockroachDB Community Slack](https://cockroachdb.slack.com) - [CockroachDB in StackOverflow](http://stackoverflow.com/questions/tagged/cockroachdb) -- [File an issue in GitHub]({% link {{ page.version.version }}/file-an-issue.md %}) We also rely on contributions from users like you. If you know how to help users who might be struggling with a problem, we hope you will! diff --git a/src/current/v24.2/troubleshooting-overview.md b/src/current/v24.2/troubleshooting-overview.md index 1ada8bdc479..33e5ec5b2d3 100644 --- a/src/current/v24.2/troubleshooting-overview.md +++ b/src/current/v24.2/troubleshooting-overview.md @@ -26,7 +26,6 @@ If you experience an issue when using CockroachDB, try these steps to resolve th - If you cannot resolve the issue yourself, the following tools can help you move forward: - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) identify ways you can get help with troubleshooting. - - [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) provides details on how to file an issue that you're unable to resolve. - In a support escalation, you may be directed to use the following features by the [Cockroach Labs support team]({% link {{ page.version.version }}/support-resources.md %}): diff --git a/src/current/v24.3/cluster-setup-troubleshooting.md b/src/current/v24.3/cluster-setup-troubleshooting.md index f013cdd8bc8..c7c4541ba08 100644 --- a/src/current/v24.3/cluster-setup-troubleshooting.md +++ b/src/current/v24.3/cluster-setup-troubleshooting.md @@ -91,7 +91,7 @@ You should see a list of the built-in databases: If you’re not seeing the output above, check for the following: - `connection refused` error, which indicates you have not included some flag that you used to start the node. We have additional troubleshooting steps for this error [here]({% link {{ page.version.version }}/common-errors.md %}#connection-refused). -- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. +- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [contact Support]({% link {{ page.version.version }}/support-resources.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. ## Cannot run a multi-node CockroachDB cluster on the same machine @@ -528,7 +528,7 @@ CockroachDB memory usage has the following components: {% include {{ page.version.version }}/prod-deployment/healthy-crdb-memory.md %} - If you observe values not within the expected range for a healthy cluster, [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). + If you observe values not within the expected range for a healthy cluster, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). #### Out-of-memory (OOM) crash @@ -584,7 +584,7 @@ To identify under-replicated/unavailable ranges: 1. On the [**Cluster Overview** page]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}), check the **Replication Status**. If the **Under-replicated ranges** or **Unavailable ranges** count is non-zero, then you have under-replicated or unavailable ranges in your cluster. -1. Check for a network partition: On the [**Network** page]({% link {{ page.version.version }}/ui-network-latency-page.md %}), if there are nodes in the network matrix with [no connections]({% link {{ page.version.version }}/ui-network-latency-page.md %}#no-connections), this may indicate a network partition. If there is no partition and still no upreplication after 5 minutes, then [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). +1. Check for a network partition: On the [**Network** page]({% link {{ page.version.version }}/ui-network-latency-page.md %}), if there are nodes in the network matrix with [no connections]({% link {{ page.version.version }}/ui-network-latency-page.md %}#no-connections), this may indicate a network partition. If there is no partition and still no upreplication after 5 minutes, then [contact Support]({% link {{ page.version.version }}/support-resources.md %}). **Add nodes to the cluster:** @@ -596,7 +596,7 @@ If you still see under-replicated/unavailable ranges on the Cluster Overview pag 1. On the [**Advanced Debug** page]({% link {{ page.version.version }}/ui-debug-pages.md %}), click **Problem Ranges**. 1. In the **Connections** table, identify the node with the under-replicated/unavailable ranges and click the node ID in the Node column. 1. To view the **Range Report** for a range, click on the range number in the **Under-replicated (or slow)** table or **Unavailable** table. -1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). Please be sure to include the full Range Report and error message when you submit the issue. +1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Please be sure to include the full Range Report and error message when you submit the issue. #### Check for under-replicated or unavailable data diff --git a/src/current/v24.3/cockroach-debug-encryption-active-key.md b/src/current/v24.3/cockroach-debug-encryption-active-key.md index 7c1ddf7988e..aca9814104b 100644 --- a/src/current/v24.3/cockroach-debug-encryption-active-key.md +++ b/src/current/v24.3/cockroach-debug-encryption-active-key.md @@ -40,6 +40,6 @@ AES128_CTR:be235c29239aa84a48e5e1874d76aebf7fb3c1bdc438cec2eb98de82f06a57a0 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v24.3/cockroach-debug-encryption-decrypt.md b/src/current/v24.3/cockroach-debug-encryption-decrypt.md index 94b88d85ba0..87a69627d49 100644 --- a/src/current/v24.3/cockroach-debug-encryption-decrypt.md +++ b/src/current/v24.3/cockroach-debug-encryption-decrypt.md @@ -57,7 +57,7 @@ The `cockroach debug encryption-decrypt` command will output the decrypted store ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v24.3/cockroach-debug-job-trace.md b/src/current/v24.3/cockroach-debug-job-trace.md index 0684f385172..406f235696d 100644 --- a/src/current/v24.3/cockroach-debug-job-trace.md +++ b/src/current/v24.3/cockroach-debug-job-trace.md @@ -70,7 +70,7 @@ You will find the zip file in the directory you ran the command from: ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v24.3/cockroach-debug-merge-logs.md b/src/current/v24.3/cockroach-debug-merge-logs.md index 4ebed81dd51..2d54b2c9e14 100644 --- a/src/current/v24.3/cockroach-debug-merge-logs.md +++ b/src/current/v24.3/cockroach-debug-merge-logs.md @@ -84,6 +84,6 @@ As of v23.2, logs can be configured to use a [timezone with formats `crdb-v1` or ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v24.3/cockroach-debug-tsdump.md b/src/current/v24.3/cockroach-debug-tsdump.md index bbf82372255..ecef99c67d5 100644 --- a/src/current/v24.3/cockroach-debug-tsdump.md +++ b/src/current/v24.3/cockroach-debug-tsdump.md @@ -118,6 +118,6 @@ $ cockroach debug tsdump --format=raw --from='2023-01-10 01:00:00' --to='2023-01 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v24.3/cockroach-debug-zip.md b/src/current/v24.3/cockroach-debug-zip.md index b9819ab3c67..92d5e3d7a88 100644 --- a/src/current/v24.3/cockroach-debug-zip.md +++ b/src/current/v24.3/cockroach-debug-zip.md @@ -250,6 +250,6 @@ cockroach debug zip ./cockroach-data/logs/debug.zip --redact --insecure --host=2 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v24.3/example-apps.md b/src/current/v24.3/example-apps.md index bea3cfd1876..7737474b620 100644 --- a/src/current/v24.3/example-apps.md +++ b/src/current/v24.3/example-apps.md @@ -14,7 +14,7 @@ Click the links in the tables below to see simple but complete example applicati If you are looking to do a specific task such as connect to the database, insert data, or run multi-statement transactions, see [this list of tasks](#tasks). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Note that tools with [**community-level** support]({% link {{ page.version.version }}/community-tooling.md %}) have been tested or developed by the CockroachDB community, but are not officially supported by Cockroach Labs. If you encounter problems with using these tools, please contact the maintainer of the tool with details. {{site.data.alerts.end}} diff --git a/src/current/v24.3/file-an-issue.md b/src/current/v24.3/file-an-issue.md deleted file mode 100644 index 9255e2c08b2..00000000000 --- a/src/current/v24.3/file-an-issue.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: File an Issue -summary: Learn how to file a GitHub issue with CockroachDB. -toc: false -docs_area: manage ---- - -If you've tried to [troubleshoot]({% link {{ page.version.version }}/troubleshooting-overview.md %}) an issue yourself, have [reached out for help]({% link {{ page.version.version }}/support-resources.md %}), and are still stumped, you can file an issue in GitHub. - -To file an issue in GitHub, we need the following information: - -1. A summary of the issue. - -1. The steps to reproduce the issue. - -1. The result you expected. - -1. The result that actually occurred. - -1. The first few lines of the log file from each node in the cluster in a timeframe as close as possible to reproducing the issue. On most Unix-based systems running with defaults, you can get this information using the following command: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ grep -F '[config]' cockroach-data/logs/cockroach.log - ~~~ - {{site.data.alerts.callout_info}}You might need to replace cockroach-data/logs with the location of your logs.{{site.data.alerts.end}} - If the logs are not available, include the output of `cockroach version` for each node in the cluster. - -### Template - -You can use this as a template for [filing an issue in GitHub](https://github.com/cockroachdb/cockroach/issues/new): - -~~~ - -## Summary - - - -## Steps to reproduce - -1. -2. -3. - -## Expected Result - - - -## Actual Result - - - -## Log files/version - -### Node 1 - - - -### Node 2 - - - -### Node 3 - - - -~~~ diff --git a/src/current/v24.3/install-client-drivers.md b/src/current/v24.3/install-client-drivers.md index 984671a0dfc..cdb1ab19223 100644 --- a/src/current/v24.3/install-client-drivers.md +++ b/src/current/v24.3/install-client-drivers.md @@ -8,7 +8,7 @@ docs_area: develop CockroachDB supports both native drivers and the PostgreSQL wire protocol, so most available PostgreSQL client drivers and ORM frameworks should work with CockroachDB. Choose a language for supported clients, and follow the installation steps. After you install a client library, you can [connect to the database]({% link {{ page.version.version }}/connect-to-the-database.md %}). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). {{site.data.alerts.end}}
diff --git a/src/current/v24.3/intellij-idea.md b/src/current/v24.3/intellij-idea.md index de46249320f..70a74f0ca2b 100644 --- a/src/current/v24.3/intellij-idea.md +++ b/src/current/v24.3/intellij-idea.md @@ -81,7 +81,7 @@ You can now use IntelliJ's [database tool window](https://www.jetbrains.com/help ## Report issues with IntelliJ IDEA & CockroachDB -If you encounter issues other than those outlined above, please [file an issue on the `cockroachdb/cockroach` GitHub repo](https://github.com/cockroachdb/cockroach/issues/new?template=bug_report.md), including the following details about the environment where you encountered the issue: +If you encounter issues other than those outlined above, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) with the following details about the environment where you encountered the issue: - CockroachDB version ([`cockroach version`]({% link {{ page.version.version }}/cockroach-version.md %})) - IntelliJ IDEA version diff --git a/src/current/v24.3/postgresql-compatibility.md b/src/current/v24.3/postgresql-compatibility.md index 15eff6fdc35..e77ab6c2168 100644 --- a/src/current/v24.3/postgresql-compatibility.md +++ b/src/current/v24.3/postgresql-compatibility.md @@ -34,11 +34,11 @@ When set to `true`, multiple portals can be open at the same time, with their ex This feature has the following limitations: - Only read-only [`SELECT` queries]({% link {{ page.version.version }}/selection-queries.md %}) without [subqueries]({% link {{ page.version.version }}/subqueries.md %}) are supported. -- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported - [cockroachdb/cockroach#96398](https://github.com/cockroachdb/cockroach/issues/96398) -- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only - [cockroachdb/cockroach#100822](https://github.com/cockroachdb/cockroach/issues/100822) -- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}) - [cockroachdb/cockroach#99404](https://github.com/cockroachdb/cockroach/issues/99404) +- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported. +- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only. +- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}). -In addition to the known issues, additional performance testing is needed. The current list of known issues can be viewed [on GitHub using the `A-pausable-portals` label](https://github.com/cockroachdb/cockroach/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc++label%3AA-pausable-portals+), and we welcome bug reports. +In addition to the known issues, additional performance testing is needed. ## Features that differ from PostgreSQL @@ -181,7 +181,6 @@ An `x` value less than `1` would result in the following error: pq: check constraint violated ~~~ -[#35370](https://github.com/cockroachdb/cockroach/issues/35370) ### Column name from an outer column inside a subquery @@ -207,7 +206,6 @@ PostgreSQL: 1 ~~~ -[#46563](https://github.com/cockroachdb/cockroach/issues/46563) ### SQL Compatibility diff --git a/src/current/v24.3/query-behavior-troubleshooting.md b/src/current/v24.3/query-behavior-troubleshooting.md index f9c99c18587..2cb5e5c35de 100644 --- a/src/current/v24.3/query-behavior-troubleshooting.md +++ b/src/current/v24.3/query-behavior-troubleshooting.md @@ -324,7 +324,7 @@ A response of `bad connection` or `closed` normally indicates that the node to w Once you find the node, you can check its [logs]({% link {{ page.version.version }}/logging.md %}) (stored in `cockroach-data/logs` by [default]({% link {{ page.version.version }}/configure-logs.md %}#default-logging-configuration)). -Because this kind of behavior is unexpected, you should [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). +Because this kind of behavior is unexpected, you should [contact Support]({% link {{ page.version.version }}/support-resources.md %}). ### Log queries executed by a specific node diff --git a/src/current/v24.3/support-resources.md b/src/current/v24.3/support-resources.md index d4ac13b822f..0474ef39a6c 100644 --- a/src/current/v24.3/support-resources.md +++ b/src/current/v24.3/support-resources.md @@ -13,6 +13,5 @@ If you're having an issue with CockroachDB, you can reach out for support from C - [CockroachDB Community Forum](https://forum.cockroachlabs.com) - [CockroachDB Community Slack](https://cockroachdb.slack.com) - [CockroachDB in StackOverflow](http://stackoverflow.com/questions/tagged/cockroachdb) -- [File an issue in GitHub]({% link {{ page.version.version }}/file-an-issue.md %}) We also rely on contributions from users like you. If you know how to help users who might be struggling with a problem, we hope you will! diff --git a/src/current/v24.3/troubleshooting-overview.md b/src/current/v24.3/troubleshooting-overview.md index 1ada8bdc479..33e5ec5b2d3 100644 --- a/src/current/v24.3/troubleshooting-overview.md +++ b/src/current/v24.3/troubleshooting-overview.md @@ -26,7 +26,6 @@ If you experience an issue when using CockroachDB, try these steps to resolve th - If you cannot resolve the issue yourself, the following tools can help you move forward: - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) identify ways you can get help with troubleshooting. - - [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) provides details on how to file an issue that you're unable to resolve. - In a support escalation, you may be directed to use the following features by the [Cockroach Labs support team]({% link {{ page.version.version }}/support-resources.md %}): diff --git a/src/current/v25.1/cluster-setup-troubleshooting.md b/src/current/v25.1/cluster-setup-troubleshooting.md index 35dfd522e9f..1d1e0b8e013 100644 --- a/src/current/v25.1/cluster-setup-troubleshooting.md +++ b/src/current/v25.1/cluster-setup-troubleshooting.md @@ -91,7 +91,7 @@ You should see a list of the built-in databases: If you’re not seeing the output above, check for the following: - `connection refused` error, which indicates you have not included some flag that you used to start the node. We have additional troubleshooting steps for this error [here]({% link {{ page.version.version }}/common-errors.md %}#connection-refused). -- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. +- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [contact Support]({% link {{ page.version.version }}/support-resources.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. ## Cannot run a multi-node CockroachDB cluster on the same machine @@ -517,7 +517,7 @@ CockroachDB memory usage has the following components: {% include {{ page.version.version }}/prod-deployment/healthy-crdb-memory.md %} - If you observe values not within the expected range for a healthy cluster, [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). + If you observe values not within the expected range for a healthy cluster, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). #### Out-of-memory (OOM) crash @@ -573,7 +573,7 @@ To identify under-replicated/unavailable ranges: 1. On the [**Cluster Overview** page]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}), check the **Replication Status**. If the **Under-replicated ranges** or **Unavailable ranges** count is non-zero, then you have under-replicated or unavailable ranges in your cluster. -1. Check for a network partition: On the [**Network** page]({% link {{ page.version.version }}/ui-network-latency-page.md %}), if there are nodes in the network matrix with [no connections]({% link {{ page.version.version }}/ui-network-latency-page.md %}#no-connections), this may indicate a network partition. If there is no partition and still no upreplication after 5 minutes, then [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). +1. Check for a network partition: On the [**Network** page]({% link {{ page.version.version }}/ui-network-latency-page.md %}), if there are nodes in the network matrix with [no connections]({% link {{ page.version.version }}/ui-network-latency-page.md %}#no-connections), this may indicate a network partition. If there is no partition and still no upreplication after 5 minutes, then [contact Support]({% link {{ page.version.version }}/support-resources.md %}). **Add nodes to the cluster:** @@ -585,7 +585,7 @@ If you still see under-replicated/unavailable ranges on the Cluster Overview pag 1. On the [**Advanced Debug** page]({% link {{ page.version.version }}/ui-debug-pages.md %}), click **Problem Ranges**. 1. In the **Connections** table, identify the node with the under-replicated/unavailable ranges and click the node ID in the Node column. 1. To view the **Range Report** for a range, click on the range number in the **Under-replicated (or slow)** table or **Unavailable** table. -1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). Please be sure to include the full Range Report and error message when you submit the issue. +1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Please be sure to include the full Range Report and error message when you submit the issue. #### Check for under-replicated or unavailable data diff --git a/src/current/v25.1/cockroach-debug-encryption-active-key.md b/src/current/v25.1/cockroach-debug-encryption-active-key.md index 7c1ddf7988e..aca9814104b 100644 --- a/src/current/v25.1/cockroach-debug-encryption-active-key.md +++ b/src/current/v25.1/cockroach-debug-encryption-active-key.md @@ -40,6 +40,6 @@ AES128_CTR:be235c29239aa84a48e5e1874d76aebf7fb3c1bdc438cec2eb98de82f06a57a0 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v25.1/cockroach-debug-encryption-decrypt.md b/src/current/v25.1/cockroach-debug-encryption-decrypt.md index 94b88d85ba0..87a69627d49 100644 --- a/src/current/v25.1/cockroach-debug-encryption-decrypt.md +++ b/src/current/v25.1/cockroach-debug-encryption-decrypt.md @@ -57,7 +57,7 @@ The `cockroach debug encryption-decrypt` command will output the decrypted store ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v25.1/cockroach-debug-job-trace.md b/src/current/v25.1/cockroach-debug-job-trace.md index 0684f385172..406f235696d 100644 --- a/src/current/v25.1/cockroach-debug-job-trace.md +++ b/src/current/v25.1/cockroach-debug-job-trace.md @@ -70,7 +70,7 @@ You will find the zip file in the directory you ran the command from: ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v25.1/cockroach-debug-merge-logs.md b/src/current/v25.1/cockroach-debug-merge-logs.md index 4ebed81dd51..2d54b2c9e14 100644 --- a/src/current/v25.1/cockroach-debug-merge-logs.md +++ b/src/current/v25.1/cockroach-debug-merge-logs.md @@ -84,6 +84,6 @@ As of v23.2, logs can be configured to use a [timezone with formats `crdb-v1` or ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v25.1/cockroach-debug-tsdump.md b/src/current/v25.1/cockroach-debug-tsdump.md index bbf82372255..ecef99c67d5 100644 --- a/src/current/v25.1/cockroach-debug-tsdump.md +++ b/src/current/v25.1/cockroach-debug-tsdump.md @@ -118,6 +118,6 @@ $ cockroach debug tsdump --format=raw --from='2023-01-10 01:00:00' --to='2023-01 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v25.1/cockroach-debug-zip.md b/src/current/v25.1/cockroach-debug-zip.md index cfdaf4dc2f4..e3b9fd65a14 100644 --- a/src/current/v25.1/cockroach-debug-zip.md +++ b/src/current/v25.1/cockroach-debug-zip.md @@ -250,6 +250,6 @@ cockroach debug zip ./cockroach-data/logs/debug.zip --redact --insecure --host=2 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v25.1/example-apps.md b/src/current/v25.1/example-apps.md index bea3cfd1876..7737474b620 100644 --- a/src/current/v25.1/example-apps.md +++ b/src/current/v25.1/example-apps.md @@ -14,7 +14,7 @@ Click the links in the tables below to see simple but complete example applicati If you are looking to do a specific task such as connect to the database, insert data, or run multi-statement transactions, see [this list of tasks](#tasks). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Note that tools with [**community-level** support]({% link {{ page.version.version }}/community-tooling.md %}) have been tested or developed by the CockroachDB community, but are not officially supported by Cockroach Labs. If you encounter problems with using these tools, please contact the maintainer of the tool with details. {{site.data.alerts.end}} diff --git a/src/current/v25.1/file-an-issue.md b/src/current/v25.1/file-an-issue.md deleted file mode 100644 index 9255e2c08b2..00000000000 --- a/src/current/v25.1/file-an-issue.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: File an Issue -summary: Learn how to file a GitHub issue with CockroachDB. -toc: false -docs_area: manage ---- - -If you've tried to [troubleshoot]({% link {{ page.version.version }}/troubleshooting-overview.md %}) an issue yourself, have [reached out for help]({% link {{ page.version.version }}/support-resources.md %}), and are still stumped, you can file an issue in GitHub. - -To file an issue in GitHub, we need the following information: - -1. A summary of the issue. - -1. The steps to reproduce the issue. - -1. The result you expected. - -1. The result that actually occurred. - -1. The first few lines of the log file from each node in the cluster in a timeframe as close as possible to reproducing the issue. On most Unix-based systems running with defaults, you can get this information using the following command: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ grep -F '[config]' cockroach-data/logs/cockroach.log - ~~~ - {{site.data.alerts.callout_info}}You might need to replace cockroach-data/logs with the location of your logs.{{site.data.alerts.end}} - If the logs are not available, include the output of `cockroach version` for each node in the cluster. - -### Template - -You can use this as a template for [filing an issue in GitHub](https://github.com/cockroachdb/cockroach/issues/new): - -~~~ - -## Summary - - - -## Steps to reproduce - -1. -2. -3. - -## Expected Result - - - -## Actual Result - - - -## Log files/version - -### Node 1 - - - -### Node 2 - - - -### Node 3 - - - -~~~ diff --git a/src/current/v25.1/install-client-drivers.md b/src/current/v25.1/install-client-drivers.md index 984671a0dfc..cdb1ab19223 100644 --- a/src/current/v25.1/install-client-drivers.md +++ b/src/current/v25.1/install-client-drivers.md @@ -8,7 +8,7 @@ docs_area: develop CockroachDB supports both native drivers and the PostgreSQL wire protocol, so most available PostgreSQL client drivers and ORM frameworks should work with CockroachDB. Choose a language for supported clients, and follow the installation steps. After you install a client library, you can [connect to the database]({% link {{ page.version.version }}/connect-to-the-database.md %}). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). {{site.data.alerts.end}}
diff --git a/src/current/v25.1/intellij-idea.md b/src/current/v25.1/intellij-idea.md index de46249320f..70a74f0ca2b 100644 --- a/src/current/v25.1/intellij-idea.md +++ b/src/current/v25.1/intellij-idea.md @@ -81,7 +81,7 @@ You can now use IntelliJ's [database tool window](https://www.jetbrains.com/help ## Report issues with IntelliJ IDEA & CockroachDB -If you encounter issues other than those outlined above, please [file an issue on the `cockroachdb/cockroach` GitHub repo](https://github.com/cockroachdb/cockroach/issues/new?template=bug_report.md), including the following details about the environment where you encountered the issue: +If you encounter issues other than those outlined above, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) with the following details about the environment where you encountered the issue: - CockroachDB version ([`cockroach version`]({% link {{ page.version.version }}/cockroach-version.md %})) - IntelliJ IDEA version diff --git a/src/current/v25.1/postgresql-compatibility.md b/src/current/v25.1/postgresql-compatibility.md index 15eff6fdc35..e77ab6c2168 100644 --- a/src/current/v25.1/postgresql-compatibility.md +++ b/src/current/v25.1/postgresql-compatibility.md @@ -34,11 +34,11 @@ When set to `true`, multiple portals can be open at the same time, with their ex This feature has the following limitations: - Only read-only [`SELECT` queries]({% link {{ page.version.version }}/selection-queries.md %}) without [subqueries]({% link {{ page.version.version }}/subqueries.md %}) are supported. -- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported - [cockroachdb/cockroach#96398](https://github.com/cockroachdb/cockroach/issues/96398) -- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only - [cockroachdb/cockroach#100822](https://github.com/cockroachdb/cockroach/issues/100822) -- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}) - [cockroachdb/cockroach#99404](https://github.com/cockroachdb/cockroach/issues/99404) +- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported. +- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only. +- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}). -In addition to the known issues, additional performance testing is needed. The current list of known issues can be viewed [on GitHub using the `A-pausable-portals` label](https://github.com/cockroachdb/cockroach/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc++label%3AA-pausable-portals+), and we welcome bug reports. +In addition to the known issues, additional performance testing is needed. ## Features that differ from PostgreSQL @@ -181,7 +181,6 @@ An `x` value less than `1` would result in the following error: pq: check constraint violated ~~~ -[#35370](https://github.com/cockroachdb/cockroach/issues/35370) ### Column name from an outer column inside a subquery @@ -207,7 +206,6 @@ PostgreSQL: 1 ~~~ -[#46563](https://github.com/cockroachdb/cockroach/issues/46563) ### SQL Compatibility diff --git a/src/current/v25.1/query-behavior-troubleshooting.md b/src/current/v25.1/query-behavior-troubleshooting.md index a06bb233110..d139559810c 100644 --- a/src/current/v25.1/query-behavior-troubleshooting.md +++ b/src/current/v25.1/query-behavior-troubleshooting.md @@ -58,23 +58,23 @@ You can look more closely at the behavior of a statement by visualizing a [state 1. Click **JSON File** in the Jaeger UI and upload `trace-jaeger.json` from the diagnostics bundle. The trace will appear in the list on the right. - Jaeger Trace Upload JSON + Jaeger Trace Upload JSON 1. Click the trace to view its details. It is visualized as a collection of spans with timestamps. These may include operations executed by different nodes. - Jaeger Trace Spans + Jaeger Trace Spans The full timeline displays the execution time and [execution phases]({% link {{ page.version.version }}/architecture/sql-layer.md %}#sql-parser-planner-executor) for the statement. 1. Click a span to view details for that span and log messages. - Jaeger Trace Log Messages + Jaeger Trace Log Messages 1. You can troubleshoot [transaction contention]({% link {{ page.version.version }}/performance-best-practices-overview.md %}#transaction-contention), for example, by gathering [diagnostics]({% link {{ page.version.version }}/ui-statements-page.md %}#diagnostics) on statements with high latency and looking through the log messages in `trace-jaeger.json` for jumps in latency. In the following example, the trace shows that there is significant latency between a push attempt on a transaction that is holding a [lock]({% link {{ page.version.version }}/architecture/transaction-layer.md %}#writing) (56.85ms) and that transaction being committed (131.37ms). - Jaeger Trace Log Messages + Jaeger Trace Log Messages #### Visualize traces sent directly from CockroachDB @@ -93,7 +93,7 @@ Enabling full tracing is expensive both in terms of CPU usage and memory footpri 1. Go to [`http://localhost:16686`](http://localhost:16686). 1. In the Service field, select **CockroachDB**. - Jaeger Trace Log Messages + Jaeger Trace Log Messages 1. Click **Find Traces**. @@ -324,7 +324,7 @@ A response of `bad connection` or `closed` normally indicates that the node to w Once you find the node, you can check its [logs]({% link {{ page.version.version }}/logging.md %}) (stored in `cockroach-data/logs` by [default]({% link {{ page.version.version }}/configure-logs.md %}#default-logging-configuration)). -Because this kind of behavior is unexpected, you should [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). +Because this kind of behavior is unexpected, you should [contact Support]({% link {{ page.version.version }}/support-resources.md %}). ### Log queries executed by a specific node diff --git a/src/current/v25.1/support-resources.md b/src/current/v25.1/support-resources.md index d4ac13b822f..0474ef39a6c 100644 --- a/src/current/v25.1/support-resources.md +++ b/src/current/v25.1/support-resources.md @@ -13,6 +13,5 @@ If you're having an issue with CockroachDB, you can reach out for support from C - [CockroachDB Community Forum](https://forum.cockroachlabs.com) - [CockroachDB Community Slack](https://cockroachdb.slack.com) - [CockroachDB in StackOverflow](http://stackoverflow.com/questions/tagged/cockroachdb) -- [File an issue in GitHub]({% link {{ page.version.version }}/file-an-issue.md %}) We also rely on contributions from users like you. If you know how to help users who might be struggling with a problem, we hope you will! diff --git a/src/current/v25.1/troubleshooting-overview.md b/src/current/v25.1/troubleshooting-overview.md index 1ada8bdc479..33e5ec5b2d3 100644 --- a/src/current/v25.1/troubleshooting-overview.md +++ b/src/current/v25.1/troubleshooting-overview.md @@ -26,7 +26,6 @@ If you experience an issue when using CockroachDB, try these steps to resolve th - If you cannot resolve the issue yourself, the following tools can help you move forward: - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) identify ways you can get help with troubleshooting. - - [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) provides details on how to file an issue that you're unable to resolve. - In a support escalation, you may be directed to use the following features by the [Cockroach Labs support team]({% link {{ page.version.version }}/support-resources.md %}): diff --git a/src/current/v25.2/cluster-setup-troubleshooting.md b/src/current/v25.2/cluster-setup-troubleshooting.md index 00decb5a647..936d68938ee 100644 --- a/src/current/v25.2/cluster-setup-troubleshooting.md +++ b/src/current/v25.2/cluster-setup-troubleshooting.md @@ -91,7 +91,7 @@ You should see a list of the built-in databases: If you’re not seeing the output above, check for the following: - `connection refused` error, which indicates you have not included some flag that you used to start the node. We have additional troubleshooting steps for this error [here]({% link {{ page.version.version }}/common-errors.md %}#connection-refused). -- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. +- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [contact Support]({% link {{ page.version.version }}/support-resources.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. ## Cannot run a multi-node CockroachDB cluster on the same machine @@ -514,7 +514,7 @@ CockroachDB memory usage has the following components: {% include {{ page.version.version }}/prod-deployment/healthy-crdb-memory.md %} - If you observe values not within the expected range for a healthy cluster, [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). + If you observe values not within the expected range for a healthy cluster, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). #### Out-of-memory (OOM) crash @@ -570,7 +570,7 @@ To identify under-replicated/unavailable ranges: 1. On the [**Cluster Overview** page]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}), check the **Replication Status**. If the **Under-replicated ranges** or **Unavailable ranges** count is non-zero, then you have under-replicated or unavailable ranges in your cluster. -1. Check for a network partition: On the [**Network** page]({% link {{ page.version.version }}/ui-network-latency-page.md %}), if there are nodes in the network matrix with [no connections]({% link {{ page.version.version }}/ui-network-latency-page.md %}#no-connections), this may indicate a network partition. If there is no partition and still no upreplication after 5 minutes, then [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). +1. Check for a network partition: On the [**Network** page]({% link {{ page.version.version }}/ui-network-latency-page.md %}), if there are nodes in the network matrix with [no connections]({% link {{ page.version.version }}/ui-network-latency-page.md %}#no-connections), this may indicate a network partition. If there is no partition and still no upreplication after 5 minutes, then [contact Support]({% link {{ page.version.version }}/support-resources.md %}). **Add nodes to the cluster:** @@ -582,7 +582,7 @@ If you still see under-replicated/unavailable ranges on the Cluster Overview pag 1. On the [**Advanced Debug** page]({% link {{ page.version.version }}/ui-debug-pages.md %}), click **Problem Ranges**. 1. In the **Connections** table, identify the node with the under-replicated/unavailable ranges and click the node ID in the Node column. 1. To view the **Range Report** for a range, click on the range number in the **Under-replicated (or slow)** table or **Unavailable** table. -1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). Please be sure to include the full Range Report and error message when you submit the issue. +1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Please be sure to include the full Range Report and error message when you submit the issue. #### Check for under-replicated or unavailable data diff --git a/src/current/v25.2/cockroach-debug-encryption-active-key.md b/src/current/v25.2/cockroach-debug-encryption-active-key.md index 7c1ddf7988e..aca9814104b 100644 --- a/src/current/v25.2/cockroach-debug-encryption-active-key.md +++ b/src/current/v25.2/cockroach-debug-encryption-active-key.md @@ -40,6 +40,6 @@ AES128_CTR:be235c29239aa84a48e5e1874d76aebf7fb3c1bdc438cec2eb98de82f06a57a0 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v25.2/cockroach-debug-encryption-decrypt.md b/src/current/v25.2/cockroach-debug-encryption-decrypt.md index 94b88d85ba0..87a69627d49 100644 --- a/src/current/v25.2/cockroach-debug-encryption-decrypt.md +++ b/src/current/v25.2/cockroach-debug-encryption-decrypt.md @@ -57,7 +57,7 @@ The `cockroach debug encryption-decrypt` command will output the decrypted store ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v25.2/cockroach-debug-job-trace.md b/src/current/v25.2/cockroach-debug-job-trace.md index 0684f385172..406f235696d 100644 --- a/src/current/v25.2/cockroach-debug-job-trace.md +++ b/src/current/v25.2/cockroach-debug-job-trace.md @@ -70,7 +70,7 @@ You will find the zip file in the directory you ran the command from: ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v25.2/cockroach-debug-merge-logs.md b/src/current/v25.2/cockroach-debug-merge-logs.md index 4ebed81dd51..2d54b2c9e14 100644 --- a/src/current/v25.2/cockroach-debug-merge-logs.md +++ b/src/current/v25.2/cockroach-debug-merge-logs.md @@ -84,6 +84,6 @@ As of v23.2, logs can be configured to use a [timezone with formats `crdb-v1` or ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v25.2/cockroach-debug-tsdump.md b/src/current/v25.2/cockroach-debug-tsdump.md index bbf82372255..ecef99c67d5 100644 --- a/src/current/v25.2/cockroach-debug-tsdump.md +++ b/src/current/v25.2/cockroach-debug-tsdump.md @@ -118,6 +118,6 @@ $ cockroach debug tsdump --format=raw --from='2023-01-10 01:00:00' --to='2023-01 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v25.2/cockroach-debug-zip.md b/src/current/v25.2/cockroach-debug-zip.md index cfdaf4dc2f4..e3b9fd65a14 100644 --- a/src/current/v25.2/cockroach-debug-zip.md +++ b/src/current/v25.2/cockroach-debug-zip.md @@ -250,6 +250,6 @@ cockroach debug zip ./cockroach-data/logs/debug.zip --redact --insecure --host=2 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v25.2/example-apps.md b/src/current/v25.2/example-apps.md index bea3cfd1876..7737474b620 100644 --- a/src/current/v25.2/example-apps.md +++ b/src/current/v25.2/example-apps.md @@ -14,7 +14,7 @@ Click the links in the tables below to see simple but complete example applicati If you are looking to do a specific task such as connect to the database, insert data, or run multi-statement transactions, see [this list of tasks](#tasks). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Note that tools with [**community-level** support]({% link {{ page.version.version }}/community-tooling.md %}) have been tested or developed by the CockroachDB community, but are not officially supported by Cockroach Labs. If you encounter problems with using these tools, please contact the maintainer of the tool with details. {{site.data.alerts.end}} diff --git a/src/current/v25.2/file-an-issue.md b/src/current/v25.2/file-an-issue.md deleted file mode 100644 index 9255e2c08b2..00000000000 --- a/src/current/v25.2/file-an-issue.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: File an Issue -summary: Learn how to file a GitHub issue with CockroachDB. -toc: false -docs_area: manage ---- - -If you've tried to [troubleshoot]({% link {{ page.version.version }}/troubleshooting-overview.md %}) an issue yourself, have [reached out for help]({% link {{ page.version.version }}/support-resources.md %}), and are still stumped, you can file an issue in GitHub. - -To file an issue in GitHub, we need the following information: - -1. A summary of the issue. - -1. The steps to reproduce the issue. - -1. The result you expected. - -1. The result that actually occurred. - -1. The first few lines of the log file from each node in the cluster in a timeframe as close as possible to reproducing the issue. On most Unix-based systems running with defaults, you can get this information using the following command: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ grep -F '[config]' cockroach-data/logs/cockroach.log - ~~~ - {{site.data.alerts.callout_info}}You might need to replace cockroach-data/logs with the location of your logs.{{site.data.alerts.end}} - If the logs are not available, include the output of `cockroach version` for each node in the cluster. - -### Template - -You can use this as a template for [filing an issue in GitHub](https://github.com/cockroachdb/cockroach/issues/new): - -~~~ - -## Summary - - - -## Steps to reproduce - -1. -2. -3. - -## Expected Result - - - -## Actual Result - - - -## Log files/version - -### Node 1 - - - -### Node 2 - - - -### Node 3 - - - -~~~ diff --git a/src/current/v25.2/install-client-drivers.md b/src/current/v25.2/install-client-drivers.md index 984671a0dfc..cdb1ab19223 100644 --- a/src/current/v25.2/install-client-drivers.md +++ b/src/current/v25.2/install-client-drivers.md @@ -8,7 +8,7 @@ docs_area: develop CockroachDB supports both native drivers and the PostgreSQL wire protocol, so most available PostgreSQL client drivers and ORM frameworks should work with CockroachDB. Choose a language for supported clients, and follow the installation steps. After you install a client library, you can [connect to the database]({% link {{ page.version.version }}/connect-to-the-database.md %}). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). {{site.data.alerts.end}}
diff --git a/src/current/v25.2/intellij-idea.md b/src/current/v25.2/intellij-idea.md index de46249320f..70a74f0ca2b 100644 --- a/src/current/v25.2/intellij-idea.md +++ b/src/current/v25.2/intellij-idea.md @@ -81,7 +81,7 @@ You can now use IntelliJ's [database tool window](https://www.jetbrains.com/help ## Report issues with IntelliJ IDEA & CockroachDB -If you encounter issues other than those outlined above, please [file an issue on the `cockroachdb/cockroach` GitHub repo](https://github.com/cockroachdb/cockroach/issues/new?template=bug_report.md), including the following details about the environment where you encountered the issue: +If you encounter issues other than those outlined above, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) with the following details about the environment where you encountered the issue: - CockroachDB version ([`cockroach version`]({% link {{ page.version.version }}/cockroach-version.md %})) - IntelliJ IDEA version diff --git a/src/current/v25.2/postgresql-compatibility.md b/src/current/v25.2/postgresql-compatibility.md index 15eff6fdc35..e77ab6c2168 100644 --- a/src/current/v25.2/postgresql-compatibility.md +++ b/src/current/v25.2/postgresql-compatibility.md @@ -34,11 +34,11 @@ When set to `true`, multiple portals can be open at the same time, with their ex This feature has the following limitations: - Only read-only [`SELECT` queries]({% link {{ page.version.version }}/selection-queries.md %}) without [subqueries]({% link {{ page.version.version }}/subqueries.md %}) are supported. -- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported - [cockroachdb/cockroach#96398](https://github.com/cockroachdb/cockroach/issues/96398) -- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only - [cockroachdb/cockroach#100822](https://github.com/cockroachdb/cockroach/issues/100822) -- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}) - [cockroachdb/cockroach#99404](https://github.com/cockroachdb/cockroach/issues/99404) +- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported. +- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only. +- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}). -In addition to the known issues, additional performance testing is needed. The current list of known issues can be viewed [on GitHub using the `A-pausable-portals` label](https://github.com/cockroachdb/cockroach/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc++label%3AA-pausable-portals+), and we welcome bug reports. +In addition to the known issues, additional performance testing is needed. ## Features that differ from PostgreSQL @@ -181,7 +181,6 @@ An `x` value less than `1` would result in the following error: pq: check constraint violated ~~~ -[#35370](https://github.com/cockroachdb/cockroach/issues/35370) ### Column name from an outer column inside a subquery @@ -207,7 +206,6 @@ PostgreSQL: 1 ~~~ -[#46563](https://github.com/cockroachdb/cockroach/issues/46563) ### SQL Compatibility diff --git a/src/current/v25.2/query-behavior-troubleshooting.md b/src/current/v25.2/query-behavior-troubleshooting.md index c810f6dfc8d..b885a8ba26b 100644 --- a/src/current/v25.2/query-behavior-troubleshooting.md +++ b/src/current/v25.2/query-behavior-troubleshooting.md @@ -58,23 +58,23 @@ You can look more closely at the behavior of a statement by visualizing a [state 1. Click **JSON File** in the Jaeger UI and upload `trace-jaeger.json` from the diagnostics bundle. The trace will appear in the list on the right. - Jaeger Trace Upload JSON + Jaeger Trace Upload JSON 1. Click the trace to view its details. It is visualized as a collection of spans with timestamps. These may include operations executed by different nodes. - Jaeger Trace Spans + Jaeger Trace Spans The full timeline displays the execution time and [execution phases]({% link {{ page.version.version }}/architecture/sql-layer.md %}#sql-parser-planner-executor) for the statement. 1. Click a span to view details for that span and log messages. - Jaeger Trace Log Messages + Jaeger Trace Log Messages 1. You can troubleshoot [transaction contention]({% link {{ page.version.version }}/performance-best-practices-overview.md %}#transaction-contention), for example, by gathering [diagnostics]({% link {{ page.version.version }}/ui-statements-page.md %}#diagnostics) on statements with high latency and looking through the log messages in `trace-jaeger.json` for jumps in latency. In the following example, the trace shows that there is significant latency between a push attempt on a transaction that is holding a [lock]({% link {{ page.version.version }}/architecture/transaction-layer.md %}#writing) (56.85ms) and that transaction being committed (131.37ms). - Jaeger Trace Log Messages + Jaeger Trace Log Messages #### Visualize traces sent directly from CockroachDB @@ -93,7 +93,7 @@ Enabling full tracing is expensive both in terms of CPU usage and memory footpri 1. Go to [`http://localhost:16686`](http://localhost:16686). 1. In the Service field, select **CockroachDB**. - Jaeger Trace Log Messages + Jaeger Trace Log Messages 1. Click **Find Traces**. @@ -361,7 +361,7 @@ A response of `bad connection` or `closed` normally indicates that the node to w Once you find the node, you can check its [logs]({% link {{ page.version.version }}/logging.md %}) (stored in `cockroach-data/logs` by [default]({% link {{ page.version.version }}/configure-logs.md %}#default-logging-configuration)). -Because this kind of behavior is unexpected, you should [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). +Because this kind of behavior is unexpected, you should [contact Support]({% link {{ page.version.version }}/support-resources.md %}). ### Log queries executed by a specific node diff --git a/src/current/v25.2/support-resources.md b/src/current/v25.2/support-resources.md index d4ac13b822f..0474ef39a6c 100644 --- a/src/current/v25.2/support-resources.md +++ b/src/current/v25.2/support-resources.md @@ -13,6 +13,5 @@ If you're having an issue with CockroachDB, you can reach out for support from C - [CockroachDB Community Forum](https://forum.cockroachlabs.com) - [CockroachDB Community Slack](https://cockroachdb.slack.com) - [CockroachDB in StackOverflow](http://stackoverflow.com/questions/tagged/cockroachdb) -- [File an issue in GitHub]({% link {{ page.version.version }}/file-an-issue.md %}) We also rely on contributions from users like you. If you know how to help users who might be struggling with a problem, we hope you will! diff --git a/src/current/v25.2/troubleshooting-overview.md b/src/current/v25.2/troubleshooting-overview.md index 1ada8bdc479..33e5ec5b2d3 100644 --- a/src/current/v25.2/troubleshooting-overview.md +++ b/src/current/v25.2/troubleshooting-overview.md @@ -26,7 +26,6 @@ If you experience an issue when using CockroachDB, try these steps to resolve th - If you cannot resolve the issue yourself, the following tools can help you move forward: - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) identify ways you can get help with troubleshooting. - - [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) provides details on how to file an issue that you're unable to resolve. - In a support escalation, you may be directed to use the following features by the [Cockroach Labs support team]({% link {{ page.version.version }}/support-resources.md %}): diff --git a/src/current/v25.3/cluster-setup-troubleshooting.md b/src/current/v25.3/cluster-setup-troubleshooting.md index 9972c334d98..8b75c204bd9 100644 --- a/src/current/v25.3/cluster-setup-troubleshooting.md +++ b/src/current/v25.3/cluster-setup-troubleshooting.md @@ -91,7 +91,7 @@ You should see a list of the built-in databases: If you’re not seeing the output above, check for the following: - `connection refused` error, which indicates you have not included some flag that you used to start the node. We have additional troubleshooting steps for this error [here]({% link {{ page.version.version }}/common-errors.md %}#connection-refused). -- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. +- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [contact Support]({% link {{ page.version.version }}/support-resources.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. ## Cannot run a multi-node CockroachDB cluster on the same machine @@ -512,7 +512,7 @@ CockroachDB memory usage has the following components: {% include {{ page.version.version }}/prod-deployment/healthy-crdb-memory.md %} - If you observe values not within the expected range for a healthy cluster, [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). + If you observe values not within the expected range for a healthy cluster, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). #### Out-of-memory (OOM) crash @@ -568,7 +568,7 @@ To identify under-replicated/unavailable ranges: 1. On the [**Cluster Overview** page]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}), check the **Replication Status**. If the **Under-replicated ranges** or **Unavailable ranges** count is non-zero, then you have under-replicated or unavailable ranges in your cluster. -1. Check for a network partition: On the [**Network** page]({% link {{ page.version.version }}/ui-network-latency-page.md %}), if there are nodes in the network matrix with [no connections]({% link {{ page.version.version }}/ui-network-latency-page.md %}#no-connections), this may indicate a network partition. If there is no partition and still no upreplication after 5 minutes, then [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). +1. Check for a network partition: On the [**Network** page]({% link {{ page.version.version }}/ui-network-latency-page.md %}), if there are nodes in the network matrix with [no connections]({% link {{ page.version.version }}/ui-network-latency-page.md %}#no-connections), this may indicate a network partition. If there is no partition and still no upreplication after 5 minutes, then [contact Support]({% link {{ page.version.version }}/support-resources.md %}). **Add nodes to the cluster:** @@ -580,7 +580,7 @@ If you still see under-replicated/unavailable ranges on the Cluster Overview pag 1. On the [**Advanced Debug** page]({% link {{ page.version.version }}/ui-debug-pages.md %}), click **Problem Ranges**. 1. In the **Connections** table, identify the node with the under-replicated/unavailable ranges and click the node ID in the Node column. 1. To view the **Range Report** for a range, click on the range number in the **Under-replicated (or slow)** table or **Unavailable** table. -1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). Please be sure to include the full Range Report and error message when you submit the issue. +1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Please be sure to include the full Range Report and error message when you submit the issue. #### Check for under-replicated or unavailable data diff --git a/src/current/v25.3/cockroach-debug-encryption-active-key.md b/src/current/v25.3/cockroach-debug-encryption-active-key.md index 7c1ddf7988e..aca9814104b 100644 --- a/src/current/v25.3/cockroach-debug-encryption-active-key.md +++ b/src/current/v25.3/cockroach-debug-encryption-active-key.md @@ -40,6 +40,6 @@ AES128_CTR:be235c29239aa84a48e5e1874d76aebf7fb3c1bdc438cec2eb98de82f06a57a0 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v25.3/cockroach-debug-encryption-decrypt.md b/src/current/v25.3/cockroach-debug-encryption-decrypt.md index 94b88d85ba0..87a69627d49 100644 --- a/src/current/v25.3/cockroach-debug-encryption-decrypt.md +++ b/src/current/v25.3/cockroach-debug-encryption-decrypt.md @@ -57,7 +57,7 @@ The `cockroach debug encryption-decrypt` command will output the decrypted store ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v25.3/cockroach-debug-job-trace.md b/src/current/v25.3/cockroach-debug-job-trace.md index 0684f385172..406f235696d 100644 --- a/src/current/v25.3/cockroach-debug-job-trace.md +++ b/src/current/v25.3/cockroach-debug-job-trace.md @@ -70,7 +70,7 @@ You will find the zip file in the directory you ran the command from: ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v25.3/cockroach-debug-merge-logs.md b/src/current/v25.3/cockroach-debug-merge-logs.md index 4ebed81dd51..2d54b2c9e14 100644 --- a/src/current/v25.3/cockroach-debug-merge-logs.md +++ b/src/current/v25.3/cockroach-debug-merge-logs.md @@ -84,6 +84,6 @@ As of v23.2, logs can be configured to use a [timezone with formats `crdb-v1` or ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v25.3/cockroach-debug-tsdump.md b/src/current/v25.3/cockroach-debug-tsdump.md index bbf82372255..ecef99c67d5 100644 --- a/src/current/v25.3/cockroach-debug-tsdump.md +++ b/src/current/v25.3/cockroach-debug-tsdump.md @@ -118,6 +118,6 @@ $ cockroach debug tsdump --format=raw --from='2023-01-10 01:00:00' --to='2023-01 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v25.3/cockroach-debug-zip.md b/src/current/v25.3/cockroach-debug-zip.md index 3390d7f0e61..fd79c867ecf 100644 --- a/src/current/v25.3/cockroach-debug-zip.md +++ b/src/current/v25.3/cockroach-debug-zip.md @@ -251,6 +251,6 @@ cockroach debug zip ./cockroach-data/logs/debug.zip --redact --insecure --host=2 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v25.3/example-apps.md b/src/current/v25.3/example-apps.md index bea3cfd1876..7737474b620 100644 --- a/src/current/v25.3/example-apps.md +++ b/src/current/v25.3/example-apps.md @@ -14,7 +14,7 @@ Click the links in the tables below to see simple but complete example applicati If you are looking to do a specific task such as connect to the database, insert data, or run multi-statement transactions, see [this list of tasks](#tasks). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Note that tools with [**community-level** support]({% link {{ page.version.version }}/community-tooling.md %}) have been tested or developed by the CockroachDB community, but are not officially supported by Cockroach Labs. If you encounter problems with using these tools, please contact the maintainer of the tool with details. {{site.data.alerts.end}} diff --git a/src/current/v25.3/file-an-issue.md b/src/current/v25.3/file-an-issue.md deleted file mode 100644 index 9255e2c08b2..00000000000 --- a/src/current/v25.3/file-an-issue.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: File an Issue -summary: Learn how to file a GitHub issue with CockroachDB. -toc: false -docs_area: manage ---- - -If you've tried to [troubleshoot]({% link {{ page.version.version }}/troubleshooting-overview.md %}) an issue yourself, have [reached out for help]({% link {{ page.version.version }}/support-resources.md %}), and are still stumped, you can file an issue in GitHub. - -To file an issue in GitHub, we need the following information: - -1. A summary of the issue. - -1. The steps to reproduce the issue. - -1. The result you expected. - -1. The result that actually occurred. - -1. The first few lines of the log file from each node in the cluster in a timeframe as close as possible to reproducing the issue. On most Unix-based systems running with defaults, you can get this information using the following command: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ grep -F '[config]' cockroach-data/logs/cockroach.log - ~~~ - {{site.data.alerts.callout_info}}You might need to replace cockroach-data/logs with the location of your logs.{{site.data.alerts.end}} - If the logs are not available, include the output of `cockroach version` for each node in the cluster. - -### Template - -You can use this as a template for [filing an issue in GitHub](https://github.com/cockroachdb/cockroach/issues/new): - -~~~ - -## Summary - - - -## Steps to reproduce - -1. -2. -3. - -## Expected Result - - - -## Actual Result - - - -## Log files/version - -### Node 1 - - - -### Node 2 - - - -### Node 3 - - - -~~~ diff --git a/src/current/v25.3/install-client-drivers.md b/src/current/v25.3/install-client-drivers.md index 984671a0dfc..cdb1ab19223 100644 --- a/src/current/v25.3/install-client-drivers.md +++ b/src/current/v25.3/install-client-drivers.md @@ -8,7 +8,7 @@ docs_area: develop CockroachDB supports both native drivers and the PostgreSQL wire protocol, so most available PostgreSQL client drivers and ORM frameworks should work with CockroachDB. Choose a language for supported clients, and follow the installation steps. After you install a client library, you can [connect to the database]({% link {{ page.version.version }}/connect-to-the-database.md %}). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). {{site.data.alerts.end}}
diff --git a/src/current/v25.3/intellij-idea.md b/src/current/v25.3/intellij-idea.md index de46249320f..70a74f0ca2b 100644 --- a/src/current/v25.3/intellij-idea.md +++ b/src/current/v25.3/intellij-idea.md @@ -81,7 +81,7 @@ You can now use IntelliJ's [database tool window](https://www.jetbrains.com/help ## Report issues with IntelliJ IDEA & CockroachDB -If you encounter issues other than those outlined above, please [file an issue on the `cockroachdb/cockroach` GitHub repo](https://github.com/cockroachdb/cockroach/issues/new?template=bug_report.md), including the following details about the environment where you encountered the issue: +If you encounter issues other than those outlined above, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) with the following details about the environment where you encountered the issue: - CockroachDB version ([`cockroach version`]({% link {{ page.version.version }}/cockroach-version.md %})) - IntelliJ IDEA version diff --git a/src/current/v25.3/postgresql-compatibility.md b/src/current/v25.3/postgresql-compatibility.md index 15eff6fdc35..e77ab6c2168 100644 --- a/src/current/v25.3/postgresql-compatibility.md +++ b/src/current/v25.3/postgresql-compatibility.md @@ -34,11 +34,11 @@ When set to `true`, multiple portals can be open at the same time, with their ex This feature has the following limitations: - Only read-only [`SELECT` queries]({% link {{ page.version.version }}/selection-queries.md %}) without [subqueries]({% link {{ page.version.version }}/subqueries.md %}) are supported. -- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported - [cockroachdb/cockroach#96398](https://github.com/cockroachdb/cockroach/issues/96398) -- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only - [cockroachdb/cockroach#100822](https://github.com/cockroachdb/cockroach/issues/100822) -- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}) - [cockroachdb/cockroach#99404](https://github.com/cockroachdb/cockroach/issues/99404) +- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported. +- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only. +- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}). -In addition to the known issues, additional performance testing is needed. The current list of known issues can be viewed [on GitHub using the `A-pausable-portals` label](https://github.com/cockroachdb/cockroach/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc++label%3AA-pausable-portals+), and we welcome bug reports. +In addition to the known issues, additional performance testing is needed. ## Features that differ from PostgreSQL @@ -181,7 +181,6 @@ An `x` value less than `1` would result in the following error: pq: check constraint violated ~~~ -[#35370](https://github.com/cockroachdb/cockroach/issues/35370) ### Column name from an outer column inside a subquery @@ -207,7 +206,6 @@ PostgreSQL: 1 ~~~ -[#46563](https://github.com/cockroachdb/cockroach/issues/46563) ### SQL Compatibility diff --git a/src/current/v25.3/query-behavior-troubleshooting.md b/src/current/v25.3/query-behavior-troubleshooting.md index d13106413fc..eedb52f0763 100644 --- a/src/current/v25.3/query-behavior-troubleshooting.md +++ b/src/current/v25.3/query-behavior-troubleshooting.md @@ -58,23 +58,23 @@ You can look more closely at the behavior of a statement by visualizing a [state 1. Click **JSON File** in the Jaeger UI and upload `trace-jaeger.json` from the diagnostics bundle. The trace will appear in the list on the right. - Jaeger Trace Upload JSON + Jaeger Trace Upload JSON 1. Click the trace to view its details. It is visualized as a collection of spans with timestamps. These may include operations executed by different nodes. - Jaeger Trace Spans + Jaeger Trace Spans The full timeline displays the execution time and [execution phases]({% link {{ page.version.version }}/architecture/sql-layer.md %}#sql-parser-planner-executor) for the statement. 1. Click a span to view details for that span and log messages. - Jaeger Trace Log Messages + Jaeger Trace Log Messages 1. You can troubleshoot [transaction contention]({% link {{ page.version.version }}/performance-best-practices-overview.md %}#transaction-contention), for example, by gathering [diagnostics]({% link {{ page.version.version }}/ui-statements-page.md %}#diagnostics) on statements with high latency and looking through the log messages in `trace-jaeger.json` for jumps in latency. In the following example, the trace shows that there is significant latency between a push attempt on a transaction that is holding a [lock]({% link {{ page.version.version }}/architecture/transaction-layer.md %}#writing) (56.85ms) and that transaction being committed (131.37ms). - Jaeger Trace Log Messages + Jaeger Trace Log Messages #### Visualize traces sent directly from CockroachDB @@ -93,7 +93,7 @@ Enabling full tracing is expensive both in terms of CPU usage and memory footpri 1. Go to [`http://localhost:16686`](http://localhost:16686). 1. In the Service field, select **CockroachDB**. - Jaeger Trace Log Messages + Jaeger Trace Log Messages 1. Click **Find Traces**. @@ -361,7 +361,7 @@ A response of `bad connection` or `closed` normally indicates that the node to w Once you find the node, you can check its [logs]({% link {{ page.version.version }}/logging.md %}) (stored in `cockroach-data/logs` by [default]({% link {{ page.version.version }}/configure-logs.md %}#default-logging-configuration)). -Because this kind of behavior is unexpected, you should [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). +Because this kind of behavior is unexpected, you should [contact Support]({% link {{ page.version.version }}/support-resources.md %}). ### Log queries executed by a specific node diff --git a/src/current/v25.3/support-resources.md b/src/current/v25.3/support-resources.md index d4ac13b822f..0474ef39a6c 100644 --- a/src/current/v25.3/support-resources.md +++ b/src/current/v25.3/support-resources.md @@ -13,6 +13,5 @@ If you're having an issue with CockroachDB, you can reach out for support from C - [CockroachDB Community Forum](https://forum.cockroachlabs.com) - [CockroachDB Community Slack](https://cockroachdb.slack.com) - [CockroachDB in StackOverflow](http://stackoverflow.com/questions/tagged/cockroachdb) -- [File an issue in GitHub]({% link {{ page.version.version }}/file-an-issue.md %}) We also rely on contributions from users like you. If you know how to help users who might be struggling with a problem, we hope you will! diff --git a/src/current/v25.3/troubleshooting-overview.md b/src/current/v25.3/troubleshooting-overview.md index e4152c431ad..4dbf6e93686 100644 --- a/src/current/v25.3/troubleshooting-overview.md +++ b/src/current/v25.3/troubleshooting-overview.md @@ -26,7 +26,6 @@ If you experience an issue when using CockroachDB, try these steps to resolve th - If you cannot resolve the issue yourself, the following tools can help you move forward: - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) identify ways you can get help with troubleshooting. - - [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) provides details on how to file an issue that you're unable to resolve. - In a support escalation, you may be directed to use the following features by the [Cockroach Labs support team]({% link {{ page.version.version }}/support-resources.md %}): diff --git a/src/current/v25.4/cluster-setup-troubleshooting.md b/src/current/v25.4/cluster-setup-troubleshooting.md index e7c16577c14..b8aabecd89a 100644 --- a/src/current/v25.4/cluster-setup-troubleshooting.md +++ b/src/current/v25.4/cluster-setup-troubleshooting.md @@ -91,7 +91,7 @@ You should see a list of the built-in databases: If you’re not seeing the output above, check for the following: - `connection refused` error, which indicates you have not included some flag that you used to start the node. We have additional troubleshooting steps for this error [here]({% link {{ page.version.version }}/common-errors.md %}#connection-refused). -- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. +- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [contact Support]({% link {{ page.version.version }}/support-resources.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. ## Cannot run a multi-node CockroachDB cluster on the same machine @@ -526,7 +526,7 @@ CockroachDB memory usage has the following components: {% include {{ page.version.version }}/prod-deployment/healthy-crdb-memory.md %} - If you observe values not within the expected range for a healthy cluster, [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). + If you observe values not within the expected range for a healthy cluster, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). #### Out-of-memory (OOM) crash @@ -582,7 +582,7 @@ To identify under-replicated/unavailable ranges: 1. On the [**Cluster Overview** page]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}), check the **Replication Status**. If the **Under-replicated ranges** or **Unavailable ranges** count is non-zero, then you have under-replicated or unavailable ranges in your cluster. -1. Check for a network partition: On the [**Network** page]({% link {{ page.version.version }}/ui-network-latency-page.md %}), if there are nodes in the network matrix with [no connections]({% link {{ page.version.version }}/ui-network-latency-page.md %}#no-connections), this may indicate a network partition. If there is no partition and still no upreplication after 5 minutes, then [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). +1. Check for a network partition: On the [**Network** page]({% link {{ page.version.version }}/ui-network-latency-page.md %}), if there are nodes in the network matrix with [no connections]({% link {{ page.version.version }}/ui-network-latency-page.md %}#no-connections), this may indicate a network partition. If there is no partition and still no upreplication after 5 minutes, then [contact Support]({% link {{ page.version.version }}/support-resources.md %}). **Add nodes to the cluster:** @@ -594,7 +594,7 @@ If you still see under-replicated/unavailable ranges on the Cluster Overview pag 1. On the [**Advanced Debug** page]({% link {{ page.version.version }}/ui-debug-pages.md %}), click **Problem Ranges**. 1. In the **Connections** table, identify the node with the under-replicated/unavailable ranges and click the node ID in the Node column. 1. To view the **Range Report** for a range, click on the range number in the **Under-replicated (or slow)** table or **Unavailable** table. -1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). Please be sure to include the full Range Report and error message when you submit the issue. +1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Please be sure to include the full Range Report and error message when you submit the issue. #### Check for under-replicated or unavailable data diff --git a/src/current/v25.4/cockroach-debug-encryption-active-key.md b/src/current/v25.4/cockroach-debug-encryption-active-key.md index 7c1ddf7988e..aca9814104b 100644 --- a/src/current/v25.4/cockroach-debug-encryption-active-key.md +++ b/src/current/v25.4/cockroach-debug-encryption-active-key.md @@ -40,6 +40,6 @@ AES128_CTR:be235c29239aa84a48e5e1874d76aebf7fb3c1bdc438cec2eb98de82f06a57a0 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v25.4/cockroach-debug-encryption-decrypt.md b/src/current/v25.4/cockroach-debug-encryption-decrypt.md index 94b88d85ba0..87a69627d49 100644 --- a/src/current/v25.4/cockroach-debug-encryption-decrypt.md +++ b/src/current/v25.4/cockroach-debug-encryption-decrypt.md @@ -57,7 +57,7 @@ The `cockroach debug encryption-decrypt` command will output the decrypted store ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v25.4/cockroach-debug-job-trace.md b/src/current/v25.4/cockroach-debug-job-trace.md index 0684f385172..406f235696d 100644 --- a/src/current/v25.4/cockroach-debug-job-trace.md +++ b/src/current/v25.4/cockroach-debug-job-trace.md @@ -70,7 +70,7 @@ You will find the zip file in the directory you ran the command from: ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v25.4/cockroach-debug-merge-logs.md b/src/current/v25.4/cockroach-debug-merge-logs.md index 4ebed81dd51..2d54b2c9e14 100644 --- a/src/current/v25.4/cockroach-debug-merge-logs.md +++ b/src/current/v25.4/cockroach-debug-merge-logs.md @@ -84,6 +84,6 @@ As of v23.2, logs can be configured to use a [timezone with formats `crdb-v1` or ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v25.4/cockroach-debug-tsdump.md b/src/current/v25.4/cockroach-debug-tsdump.md index bbf82372255..ecef99c67d5 100644 --- a/src/current/v25.4/cockroach-debug-tsdump.md +++ b/src/current/v25.4/cockroach-debug-tsdump.md @@ -118,6 +118,6 @@ $ cockroach debug tsdump --format=raw --from='2023-01-10 01:00:00' --to='2023-01 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v25.4/cockroach-debug-zip.md b/src/current/v25.4/cockroach-debug-zip.md index 6bdf18b4627..0e21b62a5d7 100644 --- a/src/current/v25.4/cockroach-debug-zip.md +++ b/src/current/v25.4/cockroach-debug-zip.md @@ -284,6 +284,6 @@ cockroach debug zip ./cockroach-data/logs/debug.zip --redact --insecure --host=2 ## See also -- [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v25.4/example-apps.md b/src/current/v25.4/example-apps.md index bea3cfd1876..7737474b620 100644 --- a/src/current/v25.4/example-apps.md +++ b/src/current/v25.4/example-apps.md @@ -14,7 +14,7 @@ Click the links in the tables below to see simple but complete example applicati If you are looking to do a specific task such as connect to the database, insert data, or run multi-statement transactions, see [this list of tasks](#tasks). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Note that tools with [**community-level** support]({% link {{ page.version.version }}/community-tooling.md %}) have been tested or developed by the CockroachDB community, but are not officially supported by Cockroach Labs. If you encounter problems with using these tools, please contact the maintainer of the tool with details. {{site.data.alerts.end}} diff --git a/src/current/v25.4/file-an-issue.md b/src/current/v25.4/file-an-issue.md deleted file mode 100644 index 9255e2c08b2..00000000000 --- a/src/current/v25.4/file-an-issue.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: File an Issue -summary: Learn how to file a GitHub issue with CockroachDB. -toc: false -docs_area: manage ---- - -If you've tried to [troubleshoot]({% link {{ page.version.version }}/troubleshooting-overview.md %}) an issue yourself, have [reached out for help]({% link {{ page.version.version }}/support-resources.md %}), and are still stumped, you can file an issue in GitHub. - -To file an issue in GitHub, we need the following information: - -1. A summary of the issue. - -1. The steps to reproduce the issue. - -1. The result you expected. - -1. The result that actually occurred. - -1. The first few lines of the log file from each node in the cluster in a timeframe as close as possible to reproducing the issue. On most Unix-based systems running with defaults, you can get this information using the following command: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ grep -F '[config]' cockroach-data/logs/cockroach.log - ~~~ - {{site.data.alerts.callout_info}}You might need to replace cockroach-data/logs with the location of your logs.{{site.data.alerts.end}} - If the logs are not available, include the output of `cockroach version` for each node in the cluster. - -### Template - -You can use this as a template for [filing an issue in GitHub](https://github.com/cockroachdb/cockroach/issues/new): - -~~~ - -## Summary - - - -## Steps to reproduce - -1. -2. -3. - -## Expected Result - - - -## Actual Result - - - -## Log files/version - -### Node 1 - - - -### Node 2 - - - -### Node 3 - - - -~~~ diff --git a/src/current/v25.4/install-client-drivers.md b/src/current/v25.4/install-client-drivers.md index 984671a0dfc..cdb1ab19223 100644 --- a/src/current/v25.4/install-client-drivers.md +++ b/src/current/v25.4/install-client-drivers.md @@ -8,7 +8,7 @@ docs_area: develop CockroachDB supports both native drivers and the PostgreSQL wire protocol, so most available PostgreSQL client drivers and ORM frameworks should work with CockroachDB. Choose a language for supported clients, and follow the installation steps. After you install a client library, you can [connect to the database]({% link {{ page.version.version }}/connect-to-the-database.md %}). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). {{site.data.alerts.end}}
diff --git a/src/current/v25.4/intellij-idea.md b/src/current/v25.4/intellij-idea.md index de46249320f..70a74f0ca2b 100644 --- a/src/current/v25.4/intellij-idea.md +++ b/src/current/v25.4/intellij-idea.md @@ -81,7 +81,7 @@ You can now use IntelliJ's [database tool window](https://www.jetbrains.com/help ## Report issues with IntelliJ IDEA & CockroachDB -If you encounter issues other than those outlined above, please [file an issue on the `cockroachdb/cockroach` GitHub repo](https://github.com/cockroachdb/cockroach/issues/new?template=bug_report.md), including the following details about the environment where you encountered the issue: +If you encounter issues other than those outlined above, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) with the following details about the environment where you encountered the issue: - CockroachDB version ([`cockroach version`]({% link {{ page.version.version }}/cockroach-version.md %})) - IntelliJ IDEA version diff --git a/src/current/v25.4/postgresql-compatibility.md b/src/current/v25.4/postgresql-compatibility.md index 15eff6fdc35..e77ab6c2168 100644 --- a/src/current/v25.4/postgresql-compatibility.md +++ b/src/current/v25.4/postgresql-compatibility.md @@ -34,11 +34,11 @@ When set to `true`, multiple portals can be open at the same time, with their ex This feature has the following limitations: - Only read-only [`SELECT` queries]({% link {{ page.version.version }}/selection-queries.md %}) without [subqueries]({% link {{ page.version.version }}/subqueries.md %}) are supported. -- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported - [cockroachdb/cockroach#96398](https://github.com/cockroachdb/cockroach/issues/96398) -- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only - [cockroachdb/cockroach#100822](https://github.com/cockroachdb/cockroach/issues/100822) -- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}) - [cockroachdb/cockroach#99404](https://github.com/cockroachdb/cockroach/issues/99404) +- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported. +- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only. +- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}). -In addition to the known issues, additional performance testing is needed. The current list of known issues can be viewed [on GitHub using the `A-pausable-portals` label](https://github.com/cockroachdb/cockroach/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc++label%3AA-pausable-portals+), and we welcome bug reports. +In addition to the known issues, additional performance testing is needed. ## Features that differ from PostgreSQL @@ -181,7 +181,6 @@ An `x` value less than `1` would result in the following error: pq: check constraint violated ~~~ -[#35370](https://github.com/cockroachdb/cockroach/issues/35370) ### Column name from an outer column inside a subquery @@ -207,7 +206,6 @@ PostgreSQL: 1 ~~~ -[#46563](https://github.com/cockroachdb/cockroach/issues/46563) ### SQL Compatibility diff --git a/src/current/v25.4/query-behavior-troubleshooting.md b/src/current/v25.4/query-behavior-troubleshooting.md index e1bba668303..a14de50bdc8 100644 --- a/src/current/v25.4/query-behavior-troubleshooting.md +++ b/src/current/v25.4/query-behavior-troubleshooting.md @@ -366,7 +366,7 @@ A response of `bad connection` or `closed` normally indicates that the node to w Once you find the node, you can check its [logs]({% link {{ page.version.version }}/logging.md %}) (stored in `cockroach-data/logs` by [default]({% link {{ page.version.version }}/configure-logs.md %}#default-logging-configuration)). -Because this kind of behavior is unexpected, you should [file an issue]({% link {{ page.version.version }}/file-an-issue.md %}). +Because this kind of behavior is unexpected, you should [contact Support]({% link {{ page.version.version }}/support-resources.md %}). ### Log queries executed by a specific node diff --git a/src/current/v25.4/support-resources.md b/src/current/v25.4/support-resources.md index d4ac13b822f..0474ef39a6c 100644 --- a/src/current/v25.4/support-resources.md +++ b/src/current/v25.4/support-resources.md @@ -13,6 +13,5 @@ If you're having an issue with CockroachDB, you can reach out for support from C - [CockroachDB Community Forum](https://forum.cockroachlabs.com) - [CockroachDB Community Slack](https://cockroachdb.slack.com) - [CockroachDB in StackOverflow](http://stackoverflow.com/questions/tagged/cockroachdb) -- [File an issue in GitHub]({% link {{ page.version.version }}/file-an-issue.md %}) We also rely on contributions from users like you. If you know how to help users who might be struggling with a problem, we hope you will! diff --git a/src/current/v25.4/troubleshooting-overview.md b/src/current/v25.4/troubleshooting-overview.md index e4b911aadbd..ed015771ef2 100644 --- a/src/current/v25.4/troubleshooting-overview.md +++ b/src/current/v25.4/troubleshooting-overview.md @@ -26,7 +26,6 @@ If you experience an issue when using CockroachDB, try these steps to resolve th - If you cannot resolve the issue yourself, the following tools can help you move forward: - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) identify ways you can get help with troubleshooting. - - [File an Issue]({% link {{ page.version.version }}/file-an-issue.md %}) provides details on how to file an issue that you're unable to resolve. - In a support escalation, you may be directed to use the following features by the [Cockroach Labs support team]({% link {{ page.version.version }}/support-resources.md %}): diff --git a/src/current/v26.1/cluster-setup-troubleshooting.md b/src/current/v26.1/cluster-setup-troubleshooting.md index d952f1af609..b8aabecd89a 100644 --- a/src/current/v26.1/cluster-setup-troubleshooting.md +++ b/src/current/v26.1/cluster-setup-troubleshooting.md @@ -91,7 +91,7 @@ You should see a list of the built-in databases: If you’re not seeing the output above, check for the following: - `connection refused` error, which indicates you have not included some flag that you used to start the node. We have additional troubleshooting steps for this error [here]({% link {{ page.version.version }}/common-errors.md %}#connection-refused). -- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), file an issue in Github, including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. +- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [contact Support]({% link {{ page.version.version }}/support-resources.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. ## Cannot run a multi-node CockroachDB cluster on the same machine @@ -526,7 +526,7 @@ CockroachDB memory usage has the following components: {% include {{ page.version.version }}/prod-deployment/healthy-crdb-memory.md %} - If you observe values not within the expected range for a healthy cluster, file an issue in Github. + If you observe values not within the expected range for a healthy cluster, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). #### Out-of-memory (OOM) crash @@ -582,7 +582,7 @@ To identify under-replicated/unavailable ranges: 1. On the [**Cluster Overview** page]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}), check the **Replication Status**. If the **Under-replicated ranges** or **Unavailable ranges** count is non-zero, then you have under-replicated or unavailable ranges in your cluster. -1. Check for a network partition: On the [**Network** page]({% link {{ page.version.version }}/ui-network-latency-page.md %}), if there are nodes in the network matrix with [no connections]({% link {{ page.version.version }}/ui-network-latency-page.md %}#no-connections), this may indicate a network partition. If there is no partition and still no upreplication after 5 minutes, then file an issue in Github. +1. Check for a network partition: On the [**Network** page]({% link {{ page.version.version }}/ui-network-latency-page.md %}), if there are nodes in the network matrix with [no connections]({% link {{ page.version.version }}/ui-network-latency-page.md %}#no-connections), this may indicate a network partition. If there is no partition and still no upreplication after 5 minutes, then [contact Support]({% link {{ page.version.version }}/support-resources.md %}). **Add nodes to the cluster:** @@ -594,7 +594,7 @@ If you still see under-replicated/unavailable ranges on the Cluster Overview pag 1. On the [**Advanced Debug** page]({% link {{ page.version.version }}/ui-debug-pages.md %}), click **Problem Ranges**. 1. In the **Connections** table, identify the node with the under-replicated/unavailable ranges and click the node ID in the Node column. 1. To view the **Range Report** for a range, click on the range number in the **Under-replicated (or slow)** table or **Unavailable** table. -1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, file an issue in Github. Please be sure to include the full Range Report and error message when you submit the issue. +1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Please be sure to include the full Range Report and error message when you submit the issue. #### Check for under-replicated or unavailable data diff --git a/src/current/v26.1/cockroach-debug-encryption-active-key.md b/src/current/v26.1/cockroach-debug-encryption-active-key.md index 80f43344ed9..aca9814104b 100644 --- a/src/current/v26.1/cockroach-debug-encryption-active-key.md +++ b/src/current/v26.1/cockroach-debug-encryption-active-key.md @@ -40,5 +40,6 @@ AES128_CTR:be235c29239aa84a48e5e1874d76aebf7fb3c1bdc438cec2eb98de82f06a57a0 ## See also +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v26.1/cockroach-debug-encryption-decrypt.md b/src/current/v26.1/cockroach-debug-encryption-decrypt.md index 10b10c90ec2..87a69627d49 100644 --- a/src/current/v26.1/cockroach-debug-encryption-decrypt.md +++ b/src/current/v26.1/cockroach-debug-encryption-decrypt.md @@ -57,6 +57,7 @@ The `cockroach debug encryption-decrypt` command will output the decrypted store ## See also +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v26.1/cockroach-debug-job-trace.md b/src/current/v26.1/cockroach-debug-job-trace.md index eb0047826b6..406f235696d 100644 --- a/src/current/v26.1/cockroach-debug-job-trace.md +++ b/src/current/v26.1/cockroach-debug-job-trace.md @@ -70,6 +70,7 @@ You will find the zip file in the directory you ran the command from: ## See also +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v26.1/cockroach-debug-merge-logs.md b/src/current/v26.1/cockroach-debug-merge-logs.md index 8dd6c4ecd23..2d54b2c9e14 100644 --- a/src/current/v26.1/cockroach-debug-merge-logs.md +++ b/src/current/v26.1/cockroach-debug-merge-logs.md @@ -84,5 +84,6 @@ As of v23.2, logs can be configured to use a [timezone with formats `crdb-v1` or ## See also +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v26.1/cockroach-debug-tsdump.md b/src/current/v26.1/cockroach-debug-tsdump.md index 4a96b75a0a4..8553c44b568 100644 --- a/src/current/v26.1/cockroach-debug-tsdump.md +++ b/src/current/v26.1/cockroach-debug-tsdump.md @@ -184,5 +184,6 @@ $ cockroach debug tsdump --format=raw --metrics-list-file=metrics.txt --certs-di ## See also +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v26.1/cockroach-debug-zip.md b/src/current/v26.1/cockroach-debug-zip.md index 9a387069d48..ef706bdd49e 100644 --- a/src/current/v26.1/cockroach-debug-zip.md +++ b/src/current/v26.1/cockroach-debug-zip.md @@ -285,5 +285,6 @@ cockroach debug zip ./cockroach-data/logs/debug.zip --redact --insecure --host=2 ## See also +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v26.1/install-client-drivers.md b/src/current/v26.1/install-client-drivers.md index 75b39685574..4d489dd7449 100644 --- a/src/current/v26.1/install-client-drivers.md +++ b/src/current/v26.1/install-client-drivers.md @@ -8,7 +8,7 @@ docs_area: develop CockroachDB supports both native drivers and the PostgreSQL wire protocol, so most available PostgreSQL client drivers and ORM frameworks should work with CockroachDB. Choose a language for supported clients, and follow the installation steps. After you install a client library, you can [connect to the database]({% link {{ page.version.version }}/connect-to-the-database.md %}). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). {{site.data.alerts.end}}
diff --git a/src/current/v26.1/intellij-idea.md b/src/current/v26.1/intellij-idea.md index 1ce61a25e53..ebc01ef18ea 100644 --- a/src/current/v26.1/intellij-idea.md +++ b/src/current/v26.1/intellij-idea.md @@ -81,7 +81,7 @@ You can now use IntelliJ's [database tool window](https://www.jetbrains.com/help ## Report issues with IntelliJ IDEA & CockroachDB -If you encounter issues other than those outlined above, please [file an issue on the `cockroachdb/cockroach` GitHub repo](https://github.com/cockroachdb/cockroach/issues/new?template=bug_report.md), including the following details about the environment where you encountered the issue: +If you encounter issues other than those outlined above, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) with the following details about the environment where you encountered the issue: - CockroachDB version ([`cockroach version`]({% link {{ page.version.version }}/cockroach-version.md %})) - IntelliJ IDEA version diff --git a/src/current/v26.1/postgresql-compatibility.md b/src/current/v26.1/postgresql-compatibility.md index ad110c9e4ef..b7b377c8326 100644 --- a/src/current/v26.1/postgresql-compatibility.md +++ b/src/current/v26.1/postgresql-compatibility.md @@ -34,11 +34,11 @@ When set to `true`, multiple portals can be open at the same time, with their ex This feature has the following limitations: - Only read-only [`SELECT` queries]({% link {{ page.version.version }}/selection-queries.md %}) without [subqueries]({% link {{ page.version.version }}/subqueries.md %}) are supported. -- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported - [cockroachdb/cockroach#96398](https://github.com/cockroachdb/cockroach/issues/96398) -- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only - [cockroachdb/cockroach#100822](https://github.com/cockroachdb/cockroach/issues/100822) -- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}) - [cockroachdb/cockroach#99404](https://github.com/cockroachdb/cockroach/issues/99404) +- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported. +- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only. +- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}). -In addition to the known issues, additional performance testing is needed. The current list of known issues can be viewed [on GitHub using the `A-pausable-portals` label](https://github.com/cockroachdb/cockroach/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc++label%3AA-pausable-portals+), and we welcome bug reports. +In addition to the known issues, additional performance testing is needed. ## Features that differ from PostgreSQL @@ -181,7 +181,6 @@ An `x` value less than `1` would result in the following error: pq: check constraint violated ~~~ -[#35370](https://github.com/cockroachdb/cockroach/issues/35370) ### Column name from an outer column inside a subquery @@ -207,7 +206,6 @@ PostgreSQL: 1 ~~~ -[#46563](https://github.com/cockroachdb/cockroach/issues/46563) ### SQL Compatibility diff --git a/src/current/v26.1/query-behavior-troubleshooting.md b/src/current/v26.1/query-behavior-troubleshooting.md index 292a4f96b04..85580d50681 100644 --- a/src/current/v26.1/query-behavior-troubleshooting.md +++ b/src/current/v26.1/query-behavior-troubleshooting.md @@ -366,7 +366,7 @@ A response of `bad connection` or `closed` normally indicates that the node to w Once you find the node, you can check its [logs]({% link {{ page.version.version }}/logging.md %}) (stored in `cockroach-data/logs` by [default]({% link {{ page.version.version }}/configure-logs.md %}#default-logging-configuration)). -Because this kind of behavior is unexpected, you should file an issue on Github. +Because this kind of behavior is unexpected, you should [contact Support]({% link {{ page.version.version }}/support-resources.md %}). ### Log queries executed by a specific node diff --git a/src/current/v26.2/active-session-history.md b/src/current/v26.2/active-session-history.md index f2ca8113919..7b341f11182 100644 --- a/src/current/v26.2/active-session-history.md +++ b/src/current/v26.2/active-session-history.md @@ -89,7 +89,7 @@ Each sample is attributed to a workload via the `workload_type` and `workload_id | `STATEMENT` | Hex-encoded [statement fingerprint]({% link {{ page.version.version }}/ui-statements-page.md %}#sql-statement-fingerprints) ID | | `JOB` | Decimal [job ID]({% link {{ page.version.version }}/show-jobs.md %}) | | `SYSTEM` | One of the following system task names:
`LDR`, `RAFT`, `STORELIVENESS`, `RPC_HEARTBEAT`, `NODE_LIVENESS`, `SQL_LIVENESS`, `TIMESERIES`, `RAFT_LOG_TRUNCATION`, `TXN_HEARTBEAT`, `INTENT_RESOLUTION`, `LEASE_ACQUISITION`, `MERGE_QUEUE`, `CIRCUIT_BREAKER_PROBE`, `GC`, `RANGEFEED`, `REPLICATE_QUEUE`, `SPLIT_QUEUE`, `DESCRIPTOR_LEASE` | -| `UNKNOWN` | Unidentified. If you're seeing many unattributed samples for your workload, you may want to [file an issue](https://github.com/cockroachdb/cockroach/issues/new?template=bug_report.md). | +| `UNKNOWN` | Unidentified. If you're seeing many unattributed samples for your workload, you may want to [contact Support]({% link {{ page.version.version }}/support-resources.md %}). | ### `work_event` columns diff --git a/src/current/v26.2/cluster-setup-troubleshooting.md b/src/current/v26.2/cluster-setup-troubleshooting.md index d952f1af609..b8aabecd89a 100644 --- a/src/current/v26.2/cluster-setup-troubleshooting.md +++ b/src/current/v26.2/cluster-setup-troubleshooting.md @@ -91,7 +91,7 @@ You should see a list of the built-in databases: If you’re not seeing the output above, check for the following: - `connection refused` error, which indicates you have not included some flag that you used to start the node. We have additional troubleshooting steps for this error [here]({% link {{ page.version.version }}/common-errors.md %}#connection-refused). -- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), file an issue in Github, including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. +- The node crashed. To ascertain if the node crashed, run `ps | grep cockroach` to look for the `cockroach` process. If you cannot locate the `cockroach` process (i.e., it crashed), [contact Support]({% link {{ page.version.version }}/support-resources.md %}), including the [logs from your node]({% link {{ page.version.version }}/configure-logs.md %}#logging-directory) and any errors you received. ## Cannot run a multi-node CockroachDB cluster on the same machine @@ -526,7 +526,7 @@ CockroachDB memory usage has the following components: {% include {{ page.version.version }}/prod-deployment/healthy-crdb-memory.md %} - If you observe values not within the expected range for a healthy cluster, file an issue in Github. + If you observe values not within the expected range for a healthy cluster, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). #### Out-of-memory (OOM) crash @@ -582,7 +582,7 @@ To identify under-replicated/unavailable ranges: 1. On the [**Cluster Overview** page]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}), check the **Replication Status**. If the **Under-replicated ranges** or **Unavailable ranges** count is non-zero, then you have under-replicated or unavailable ranges in your cluster. -1. Check for a network partition: On the [**Network** page]({% link {{ page.version.version }}/ui-network-latency-page.md %}), if there are nodes in the network matrix with [no connections]({% link {{ page.version.version }}/ui-network-latency-page.md %}#no-connections), this may indicate a network partition. If there is no partition and still no upreplication after 5 minutes, then file an issue in Github. +1. Check for a network partition: On the [**Network** page]({% link {{ page.version.version }}/ui-network-latency-page.md %}), if there are nodes in the network matrix with [no connections]({% link {{ page.version.version }}/ui-network-latency-page.md %}#no-connections), this may indicate a network partition. If there is no partition and still no upreplication after 5 minutes, then [contact Support]({% link {{ page.version.version }}/support-resources.md %}). **Add nodes to the cluster:** @@ -594,7 +594,7 @@ If you still see under-replicated/unavailable ranges on the Cluster Overview pag 1. On the [**Advanced Debug** page]({% link {{ page.version.version }}/ui-debug-pages.md %}), click **Problem Ranges**. 1. In the **Connections** table, identify the node with the under-replicated/unavailable ranges and click the node ID in the Node column. 1. To view the **Range Report** for a range, click on the range number in the **Under-replicated (or slow)** table or **Unavailable** table. -1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, file an issue in Github. Please be sure to include the full Range Report and error message when you submit the issue. +1. On the Range Report page, scroll down to the **Simulated Allocator Output** section. The table contains an error message which explains the reason for the under-replicated range. Follow the guidance in the message to resolve the issue. If you need help understanding the error or the guidance, [contact Support]({% link {{ page.version.version }}/support-resources.md %}). Please be sure to include the full Range Report and error message when you submit the issue. #### Check for under-replicated or unavailable data diff --git a/src/current/v26.2/cockroach-debug-encryption-active-key.md b/src/current/v26.2/cockroach-debug-encryption-active-key.md index 80f43344ed9..aca9814104b 100644 --- a/src/current/v26.2/cockroach-debug-encryption-active-key.md +++ b/src/current/v26.2/cockroach-debug-encryption-active-key.md @@ -40,5 +40,6 @@ AES128_CTR:be235c29239aa84a48e5e1874d76aebf7fb3c1bdc438cec2eb98de82f06a57a0 ## See also +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v26.2/cockroach-debug-encryption-decrypt.md b/src/current/v26.2/cockroach-debug-encryption-decrypt.md index 10b10c90ec2..87a69627d49 100644 --- a/src/current/v26.2/cockroach-debug-encryption-decrypt.md +++ b/src/current/v26.2/cockroach-debug-encryption-decrypt.md @@ -57,6 +57,7 @@ The `cockroach debug encryption-decrypt` command will output the decrypted store ## See also +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v26.2/cockroach-debug-job-trace.md b/src/current/v26.2/cockroach-debug-job-trace.md index eb0047826b6..406f235696d 100644 --- a/src/current/v26.2/cockroach-debug-job-trace.md +++ b/src/current/v26.2/cockroach-debug-job-trace.md @@ -70,6 +70,7 @@ You will find the zip file in the directory you ran the command from: ## See also +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) - [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) diff --git a/src/current/v26.2/cockroach-debug-merge-logs.md b/src/current/v26.2/cockroach-debug-merge-logs.md index 8dd6c4ecd23..2d54b2c9e14 100644 --- a/src/current/v26.2/cockroach-debug-merge-logs.md +++ b/src/current/v26.2/cockroach-debug-merge-logs.md @@ -84,5 +84,6 @@ As of v23.2, logs can be configured to use a [timezone with formats `crdb-v1` or ## See also +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v26.2/cockroach-debug-tsdump.md b/src/current/v26.2/cockroach-debug-tsdump.md index 271855498e8..fd04ee3141c 100644 --- a/src/current/v26.2/cockroach-debug-tsdump.md +++ b/src/current/v26.2/cockroach-debug-tsdump.md @@ -183,5 +183,6 @@ $ cockroach debug tsdump --format=raw --metrics-list-file=metrics.txt --certs-di ## See also +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v26.2/cockroach-debug-zip.md b/src/current/v26.2/cockroach-debug-zip.md index 7c86e0071bb..3f8ca0bacbf 100644 --- a/src/current/v26.2/cockroach-debug-zip.md +++ b/src/current/v26.2/cockroach-debug-zip.md @@ -286,5 +286,6 @@ cockroach debug zip ./cockroach-data/logs/debug.zip --redact --insecure --host=2 ## See also +- [Support Resources]({% link {{ page.version.version }}/support-resources.md %}) - [`cockroach` Commands Overview]({% link {{ page.version.version }}/cockroach-commands.md %}) - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v26.2/install-client-drivers.md b/src/current/v26.2/install-client-drivers.md index 75b39685574..4d489dd7449 100644 --- a/src/current/v26.2/install-client-drivers.md +++ b/src/current/v26.2/install-client-drivers.md @@ -8,7 +8,7 @@ docs_area: develop CockroachDB supports both native drivers and the PostgreSQL wire protocol, so most available PostgreSQL client drivers and ORM frameworks should work with CockroachDB. Choose a language for supported clients, and follow the installation steps. After you install a client library, you can [connect to the database]({% link {{ page.version.version }}/connect-to-the-database.md %}). {{site.data.alerts.callout_info}} -Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [open an issue](https://github.com/cockroachdb/cockroach/issues/new) with details to help us make progress toward full support. +Applications may encounter incompatibilities when using advanced or obscure features of a driver or ORM framework with **partial** support. If you encounter problems, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}). {{site.data.alerts.end}}
diff --git a/src/current/v26.2/intellij-idea.md b/src/current/v26.2/intellij-idea.md index 7a5b5adcb6e..b59d37e6dcf 100644 --- a/src/current/v26.2/intellij-idea.md +++ b/src/current/v26.2/intellij-idea.md @@ -81,7 +81,7 @@ You can now use IntelliJ's [database tool window](https://www.jetbrains.com/help ## Report issues with IntelliJ IDEA & CockroachDB -If you encounter issues other than those outlined above, please [file an issue on the `cockroachdb/cockroach` GitHub repo](https://github.com/cockroachdb/cockroach/issues/new?template=bug_report.md), including the following details about the environment where you encountered the issue: +If you encounter issues other than those outlined above, please [contact Support]({% link {{ page.version.version }}/support-resources.md %}) with the following details about the environment where you encountered the issue: - CockroachDB version ([`cockroach version`]({% link {{ page.version.version }}/cockroach-version.md %})) - IntelliJ IDEA version diff --git a/src/current/v26.2/postgresql-compatibility.md b/src/current/v26.2/postgresql-compatibility.md index ad110c9e4ef..b7b377c8326 100644 --- a/src/current/v26.2/postgresql-compatibility.md +++ b/src/current/v26.2/postgresql-compatibility.md @@ -34,11 +34,11 @@ When set to `true`, multiple portals can be open at the same time, with their ex This feature has the following limitations: - Only read-only [`SELECT` queries]({% link {{ page.version.version }}/selection-queries.md %}) without [subqueries]({% link {{ page.version.version }}/subqueries.md %}) are supported. -- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported - [cockroachdb/cockroach#96398](https://github.com/cockroachdb/cockroach/issues/96398) -- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only - [cockroachdb/cockroach#100822](https://github.com/cockroachdb/cockroach/issues/100822) -- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}) - [cockroachdb/cockroach#99404](https://github.com/cockroachdb/cockroach/issues/99404) +- Postqueries (which are how CockroachDB executes [foreign key checks]({% link {{ page.version.version }}/foreign-key.md %}), for example) are not supported. +- [Distributed SQL execution]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql) is not supported for multiple active portals; instead queries execute on the [gateway node]({% link {{ page.version.version }}/architecture/life-of-a-distributed-transaction.md %}#gateway) only. +- Only the latest execution of a statement from a pausable portal is recorded by the [trace infrastructure]({% link {{ page.version.version }}/show-trace.md %}). -In addition to the known issues, additional performance testing is needed. The current list of known issues can be viewed [on GitHub using the `A-pausable-portals` label](https://github.com/cockroachdb/cockroach/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc++label%3AA-pausable-portals+), and we welcome bug reports. +In addition to the known issues, additional performance testing is needed. ## Features that differ from PostgreSQL @@ -181,7 +181,6 @@ An `x` value less than `1` would result in the following error: pq: check constraint violated ~~~ -[#35370](https://github.com/cockroachdb/cockroach/issues/35370) ### Column name from an outer column inside a subquery @@ -207,7 +206,6 @@ PostgreSQL: 1 ~~~ -[#46563](https://github.com/cockroachdb/cockroach/issues/46563) ### SQL Compatibility diff --git a/src/current/v26.2/query-behavior-troubleshooting.md b/src/current/v26.2/query-behavior-troubleshooting.md index 938ca0f382e..aaf1af8b727 100644 --- a/src/current/v26.2/query-behavior-troubleshooting.md +++ b/src/current/v26.2/query-behavior-troubleshooting.md @@ -366,7 +366,7 @@ A response of `bad connection` or `closed` normally indicates that the node to w Once you find the node, you can check its [logs]({% link {{ page.version.version }}/logging.md %}) (stored in `cockroach-data/logs` by [default]({% link {{ page.version.version }}/configure-logs.md %}#default-logging-configuration)). -Because this kind of behavior is unexpected, you should file an issue on Github. +Because this kind of behavior is unexpected, you should [contact Support]({% link {{ page.version.version }}/support-resources.md %}). ### Log queries executed by a specific node