Skip to content

Commit 8a839a7

Browse files
rmlovelandrmloveland
committed
Update critical nodes endpoint to make curl POST more prominent / clearer
Fixes DOC-17121
1 parent d16db72 commit 8a839a7

7 files changed

Lines changed: 133 additions & 0 deletions

File tree

‎src/current/v23.2/monitoring-and-alerting.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,25 @@ The critical nodes status endpoint is used to:
207207

208208
If you find under-replicated ranges or constraint violations, you will need to [Troubleshoot your replication zones]({% link {{ page.version.version }}/troubleshoot-replication-zones.md %}).
209209

210+
#### Request the endpoint
211+
212+
To return the JSON response, send a `POST` request to `/_status/critical_nodes`.
213+
214+
For an insecure or local testing cluster, use HTTP:
215+
216+
{% include_cached copy-clipboard.html %}
217+
~~~ shell
218+
curl -X POST http://<host>:<http-port>/_status/critical_nodes
219+
~~~
220+
221+
For a secure cluster, authenticate to the HTTPS endpoint with [`cockroach auth-session login`]({% link {{ page.version.version }}/cockroach-auth-session.md %}#log-in-to-the-http-interface), then pass the authentication cookie to `curl`.
222+
223+
{% include_cached copy-clipboard.html %}
224+
~~~ shell
225+
cockroach auth-session login <user> --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key
226+
curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://<host>:<http-port>/_status/critical_nodes
227+
~~~
228+
210229
#### Fields
211230

212231
The JSON object returned by the critical nodes status endpoint contains the following top-level fields.

‎src/current/v24.1/monitoring-and-alerting.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,25 @@ The critical nodes status endpoint is used to:
205205

206206
If you find under-replicated ranges or constraint violations, you will need to [Troubleshoot your replication zones]({% link {{ page.version.version }}/troubleshoot-replication-zones.md %}).
207207

208+
#### Request the endpoint
209+
210+
To return the JSON response, send a `POST` request to `/_status/critical_nodes`.
211+
212+
For an insecure or local testing cluster, use HTTP:
213+
214+
{% include_cached copy-clipboard.html %}
215+
~~~ shell
216+
curl -X POST http://<host>:<http-port>/_status/critical_nodes
217+
~~~
218+
219+
For a secure cluster, authenticate to the HTTPS endpoint with [`cockroach auth-session login`]({% link {{ page.version.version }}/cockroach-auth-session.md %}#log-in-to-the-http-interface), then pass the authentication cookie to `curl`.
220+
221+
{% include_cached copy-clipboard.html %}
222+
~~~ shell
223+
cockroach auth-session login <user> --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key
224+
curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://<host>:<http-port>/_status/critical_nodes
225+
~~~
226+
208227
#### Fields
209228

210229
The JSON object returned by the critical nodes status endpoint contains the following top-level fields.

‎src/current/v24.3/monitoring-and-alerting.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,25 @@ The critical nodes status endpoint is used to:
205205

206206
If you find under-replicated ranges or constraint violations, you will need to [Troubleshoot your replication zones]({% link {{ page.version.version }}/troubleshoot-replication-zones.md %}).
207207

208+
#### Request the endpoint
209+
210+
To return the JSON response, send a `POST` request to `/_status/critical_nodes`.
211+
212+
For an insecure or local testing cluster, use HTTP:
213+
214+
{% include_cached copy-clipboard.html %}
215+
~~~ shell
216+
curl -X POST http://<host>:<http-port>/_status/critical_nodes
217+
~~~
218+
219+
For a secure cluster, authenticate to the HTTPS endpoint with [`cockroach auth-session login`]({% link {{ page.version.version }}/cockroach-auth-session.md %}#log-in-to-the-http-interface), then pass the authentication cookie to `curl`.
220+
221+
{% include_cached copy-clipboard.html %}
222+
~~~ shell
223+
cockroach auth-session login <user> --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key
224+
curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://<host>:<http-port>/_status/critical_nodes
225+
~~~
226+
208227
#### Fields
209228

210229
The JSON object returned by the critical nodes status endpoint contains the following top-level fields.

‎src/current/v25.2/monitoring-and-alerting.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,25 @@ The critical nodes status endpoint is used to:
202202

203203
If you find under-replicated ranges or constraint violations, you will need to [Troubleshoot your replication zones]({% link {{ page.version.version }}/troubleshoot-replication-zones.md %}).
204204

205+
#### Request the endpoint
206+
207+
To return the JSON response, send a `POST` request to `/_status/critical_nodes`.
208+
209+
For an insecure or local testing cluster, use HTTP:
210+
211+
{% include_cached copy-clipboard.html %}
212+
~~~ shell
213+
curl -X POST http://<host>:<http-port>/_status/critical_nodes
214+
~~~
215+
216+
For a secure cluster, authenticate to the HTTPS endpoint with [`cockroach auth-session login`]({% link {{ page.version.version }}/cockroach-auth-session.md %}#log-in-to-the-http-interface), then pass the authentication cookie to `curl`.
217+
218+
{% include_cached copy-clipboard.html %}
219+
~~~ shell
220+
cockroach auth-session login <user> --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key
221+
curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://<host>:<http-port>/_status/critical_nodes
222+
~~~
223+
205224
#### Fields
206225

207226
The JSON object returned by the critical nodes status endpoint contains the following top-level fields.

‎src/current/v25.4/monitoring-and-alerting.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,25 @@ The critical nodes status endpoint is used to:
179179

180180
If you find under-replicated ranges or constraint violations, you will need to [Troubleshoot your replication zones]({% link {{ page.version.version }}/troubleshoot-replication-zones.md %}).
181181

182+
#### Request the endpoint
183+
184+
To return the JSON response, send a `POST` request to `/_status/critical_nodes`.
185+
186+
For an insecure or local testing cluster, use HTTP:
187+
188+
{% include_cached copy-clipboard.html %}
189+
~~~ shell
190+
curl -X POST http://<host>:<http-port>/_status/critical_nodes
191+
~~~
192+
193+
For a secure cluster, authenticate to the HTTPS endpoint with [`cockroach auth-session login`]({% link {{ page.version.version }}/cockroach-auth-session.md %}#log-in-to-the-http-interface), then pass the authentication cookie to `curl`.
194+
195+
{% include_cached copy-clipboard.html %}
196+
~~~ shell
197+
cockroach auth-session login <user> --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key
198+
curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://<host>:<http-port>/_status/critical_nodes
199+
~~~
200+
182201
#### Fields
183202

184203
The JSON object returned by the critical nodes status endpoint contains the following top-level fields.

‎src/current/v26.1/monitoring-and-alerting.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,25 @@ The critical nodes status endpoint is used to:
179179

180180
If you find under-replicated ranges or constraint violations, you will need to [Troubleshoot your replication zones]({% link {{ page.version.version }}/troubleshoot-replication-zones.md %}).
181181

182+
#### Request the endpoint
183+
184+
To return the JSON response, send a `POST` request to `/_status/critical_nodes`.
185+
186+
For an insecure or local testing cluster, use HTTP:
187+
188+
{% include_cached copy-clipboard.html %}
189+
~~~ shell
190+
curl -X POST http://<host>:<http-port>/_status/critical_nodes
191+
~~~
192+
193+
For a secure cluster, authenticate to the HTTPS endpoint with [`cockroach auth-session login`]({% link {{ page.version.version }}/cockroach-auth-session.md %}#log-in-to-the-http-interface), then pass the authentication cookie to `curl`.
194+
195+
{% include_cached copy-clipboard.html %}
196+
~~~ shell
197+
cockroach auth-session login <user> --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key
198+
curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://<host>:<http-port>/_status/critical_nodes
199+
~~~
200+
182201
#### Fields
183202

184203
The JSON object returned by the critical nodes status endpoint contains the following top-level fields.

‎src/current/v26.2/monitoring-and-alerting.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,25 @@ The critical nodes status endpoint is used to:
191191

192192
If you find under-replicated ranges or constraint violations, you will need to [Troubleshoot your replication zones]({% link {{ page.version.version }}/troubleshoot-replication-zones.md %}).
193193

194+
#### Request the endpoint
195+
196+
To return the JSON response, send a `POST` request to `/_status/critical_nodes`.
197+
198+
For an insecure or local testing cluster, use HTTP:
199+
200+
{% include_cached copy-clipboard.html %}
201+
~~~ shell
202+
curl -X POST http://<host>:<http-port>/_status/critical_nodes
203+
~~~
204+
205+
For a secure cluster, authenticate to the HTTPS endpoint with [`cockroach auth-session login`]({% link {{ page.version.version }}/cockroach-auth-session.md %}#log-in-to-the-http-interface), then pass the authentication cookie to `curl`.
206+
207+
{% include_cached copy-clipboard.html %}
208+
~~~ shell
209+
cockroach auth-session login <user> --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key
210+
curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://<host>:<http-port>/_status/critical_nodes
211+
~~~
212+
194213
#### Fields
195214

196215
The JSON object returned by the critical nodes status endpoint contains the following top-level fields.

0 commit comments

Comments
 (0)