Skip to content

Commit 7de77e3

Browse files
rmlovelandrmloveland
committed
Update critical nodes endpoint to make curl POST more prominent / clearer
Fixes DOC-17121
1 parent e142f72 commit 7de77e3

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
@@ -201,6 +201,25 @@ The critical nodes status endpoint is used to:
201201

202202
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 %}).
203203

204+
#### Request the endpoint
205+
206+
To return the JSON response, send a `POST` request to `/_status/critical_nodes`.
207+
208+
For an insecure or local testing cluster, use HTTP:
209+
210+
{% include_cached copy-clipboard.html %}
211+
~~~ shell
212+
curl -X POST http://<host>:<http-port>/_status/critical_nodes
213+
~~~
214+
215+
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`.
216+
217+
{% include_cached copy-clipboard.html %}
218+
~~~ shell
219+
cockroach auth-session login <user> --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key
220+
curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://<host>:<http-port>/_status/critical_nodes
221+
~~~
222+
204223
#### Fields
205224

206225
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
@@ -199,6 +199,25 @@ The critical nodes status endpoint is used to:
199199

200200
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 %}).
201201

202+
#### Request the endpoint
203+
204+
To return the JSON response, send a `POST` request to `/_status/critical_nodes`.
205+
206+
For an insecure or local testing cluster, use HTTP:
207+
208+
{% include_cached copy-clipboard.html %}
209+
~~~ shell
210+
curl -X POST http://<host>:<http-port>/_status/critical_nodes
211+
~~~
212+
213+
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`.
214+
215+
{% include_cached copy-clipboard.html %}
216+
~~~ shell
217+
cockroach auth-session login <user> --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key
218+
curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://<host>:<http-port>/_status/critical_nodes
219+
~~~
220+
202221
#### Fields
203222

204223
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
@@ -199,6 +199,25 @@ The critical nodes status endpoint is used to:
199199

200200
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 %}).
201201

202+
#### Request the endpoint
203+
204+
To return the JSON response, send a `POST` request to `/_status/critical_nodes`.
205+
206+
For an insecure or local testing cluster, use HTTP:
207+
208+
{% include_cached copy-clipboard.html %}
209+
~~~ shell
210+
curl -X POST http://<host>:<http-port>/_status/critical_nodes
211+
~~~
212+
213+
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`.
214+
215+
{% include_cached copy-clipboard.html %}
216+
~~~ shell
217+
cockroach auth-session login <user> --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key
218+
curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://<host>:<http-port>/_status/critical_nodes
219+
~~~
220+
202221
#### Fields
203222

204223
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
@@ -196,6 +196,25 @@ The critical nodes status endpoint is used to:
196196

197197
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 %}).
198198

199+
#### Request the endpoint
200+
201+
To return the JSON response, send a `POST` request to `/_status/critical_nodes`.
202+
203+
For an insecure or local testing cluster, use HTTP:
204+
205+
{% include_cached copy-clipboard.html %}
206+
~~~ shell
207+
curl -X POST http://<host>:<http-port>/_status/critical_nodes
208+
~~~
209+
210+
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`.
211+
212+
{% include_cached copy-clipboard.html %}
213+
~~~ shell
214+
cockroach auth-session login <user> --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key
215+
curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://<host>:<http-port>/_status/critical_nodes
216+
~~~
217+
199218
#### Fields
200219

201220
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
@@ -173,6 +173,25 @@ The critical nodes status endpoint is used to:
173173

174174
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 %}).
175175

176+
#### Request the endpoint
177+
178+
To return the JSON response, send a `POST` request to `/_status/critical_nodes`.
179+
180+
For an insecure or local testing cluster, use HTTP:
181+
182+
{% include_cached copy-clipboard.html %}
183+
~~~ shell
184+
curl -X POST http://<host>:<http-port>/_status/critical_nodes
185+
~~~
186+
187+
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`.
188+
189+
{% include_cached copy-clipboard.html %}
190+
~~~ shell
191+
cockroach auth-session login <user> --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key
192+
curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://<host>:<http-port>/_status/critical_nodes
193+
~~~
194+
176195
#### Fields
177196

178197
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
@@ -173,6 +173,25 @@ The critical nodes status endpoint is used to:
173173

174174
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 %}).
175175

176+
#### Request the endpoint
177+
178+
To return the JSON response, send a `POST` request to `/_status/critical_nodes`.
179+
180+
For an insecure or local testing cluster, use HTTP:
181+
182+
{% include_cached copy-clipboard.html %}
183+
~~~ shell
184+
curl -X POST http://<host>:<http-port>/_status/critical_nodes
185+
~~~
186+
187+
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`.
188+
189+
{% include_cached copy-clipboard.html %}
190+
~~~ shell
191+
cockroach auth-session login <user> --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key
192+
curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://<host>:<http-port>/_status/critical_nodes
193+
~~~
194+
176195
#### Fields
177196

178197
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
@@ -185,6 +185,25 @@ The critical nodes status endpoint is used to:
185185

186186
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 %}).
187187

188+
#### Request the endpoint
189+
190+
To return the JSON response, send a `POST` request to `/_status/critical_nodes`.
191+
192+
For an insecure or local testing cluster, use HTTP:
193+
194+
{% include_cached copy-clipboard.html %}
195+
~~~ shell
196+
curl -X POST http://<host>:<http-port>/_status/critical_nodes
197+
~~~
198+
199+
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`.
200+
201+
{% include_cached copy-clipboard.html %}
202+
~~~ shell
203+
cockroach auth-session login <user> --certs-dir=certs --only-cookie > $HOME/.cockroachdb_api_key
204+
curl -X POST --cookie $HOME/.cockroachdb_api_key --cacert certs/ca.crt https://<host>:<http-port>/_status/critical_nodes
205+
~~~
206+
188207
#### Fields
189208

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

0 commit comments

Comments
 (0)