Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In this example, you'll set up a core changefeed for a single-node cluster that
--background
~~~

1. Download and extract the [Confluent Open Source platform](https://www.confluent.io/download/).
1. Download and extract the [Confluent platform](https://www.confluent.io/download/).

1. Move into the extracted `confluent-<version>` directory and start Confluent:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In this example, you'll set up a basic changefeed for a single-node cluster that
--background
~~~

1. Download and extract the [Confluent Open Source platform](https://www.confluent.io/download/).
1. Download and extract the [Confluent platform](https://www.confluent.io/download/).

1. Move into the extracted `confluent-<version>` directory and start Confluent:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In this example, you'll set up a basic changefeed for a single-node cluster that
--background
~~~

1. Download and extract the [Confluent Open Source platform](https://www.confluent.io/download/).
1. Download and extract the [Confluent platform](https://www.confluent.io/download/).

1. Move into the extracted `confluent-<version>` directory and start Confluent:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In this example, you'll set up a sinkless changefeed for a single-node cluster t
--background
~~~

1. Download and extract the [Confluent Open Source platform](https://www.confluent.io/download/).
1. Download and extract the [Confluent platform](https://www.confluent.io/download/).

1. Move into the extracted `confluent-<version>` directory and start Confluent:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In this example, you'll set up a sinkless changefeed for a single-node cluster t
--background
~~~

1. Download and extract the [Confluent Open Source platform](https://www.confluent.io/download/).
1. Download and extract the [Confluent platform](https://www.confluent.io/download/).

1. Move into the extracted `confluent-<version>` directory and start Confluent:

Expand Down
2 changes: 1 addition & 1 deletion src/current/v24.1/architecture/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ An extension to the [PostgreSQL](https://postgresql.org/) database that adds sup

#### GEOS

An open source geometry library used by CockroachDB, [PostGIS](#postgis), and other projects to provide the calculations underlying various spatial predicate functions and operators. For more information, see <http://trac.osgeo.org/geos/>.
A geometry library used by CockroachDB, [PostGIS](#postgis), and other projects to provide the calculations underlying various spatial predicate functions and operators. For more information, see <http://trac.osgeo.org/geos/>.

#### GeographicLib

Expand Down
4 changes: 2 additions & 2 deletions src/current/v24.1/changefeed-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ In this example, you'll set up a changefeed for a single-node cluster that is co
cockroach start-single-node --insecure --listen-addr=localhost
~~~

1. Download and extract the [Confluent Open Source platform](https://www.confluent.io/download/) (which includes Kafka).
1. Download and extract the [Confluent platform](https://www.confluent.io/download/) (which includes Kafka).

1. In a new terminal window, go to the extracted `confluent-<version>` directory and start Confluent:

Expand Down Expand Up @@ -191,7 +191,7 @@ In this example, you'll set up a changefeed for a single-node cluster that is co
cockroach start-single-node --insecure --listen-addr=localhost
~~~

1. Download and extract the [Confluent Open Source platform](https://www.confluent.io/download/) (which includes Kafka).
1. Download and extract the [Confluent platform](https://www.confluent.io/download/) (which includes Kafka).

1. Move into the extracted `confluent-<version>` directory and start Confluent:

Expand Down
2 changes: 1 addition & 1 deletion src/current/v24.1/frequently-asked-questions.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ See [Install Client Drivers]({% link {{ page.version.version }}/install-client-d

### Why does CockroachDB use the PostgreSQL wire protocol instead of the MySQL protocol?

CockroachDB uses the PostgreSQL wire protocol because it is better documented than the MySQL protocol, and because PostgreSQL has a liberal Open Source license, similar to BSD or MIT licenses, whereas MySQL has the more restrictive GNU General Public License.
CockroachDB uses the PostgreSQL wire protocol because it is better documented than the MySQL protocol, and because PostgreSQL has a liberal license, similar to BSD or MIT licenses, whereas MySQL has the more restrictive GNU General Public License.

Note, however, that the protocol used doesn't significantly impact how easy it is to port applications. Swapping out SQL network drivers is rather straightforward in nearly every language. What makes it hard to move from one database to another is the dialect of SQL in use. CockroachDB's dialect is based on PostgreSQL as well.

Expand Down
2 changes: 1 addition & 1 deletion src/current/v24.1/kubernetes-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ docs_area: deploy
key: operate-cockroachdb-kubernetes.html
---

Kubernetes is a portable, extensible, open source platform for managing containerized workloads and services. For a given workload, you provide Kubernetes with a configuration, and Kubernetes applies that configuration to all Kubernetes nodes that are running the application.
Kubernetes is a portable, extensible platform for managing containerized workloads and services. For a given workload, you provide Kubernetes with a configuration, and Kubernetes applies that configuration to all Kubernetes nodes that are running the application.

CockroachDB can be deployed and managed on Kubernetes using the following methods:

Expand Down
2 changes: 1 addition & 1 deletion src/current/v24.1/monitor-cockroachdb-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ If you [deployed CockroachDB on Red Hat OpenShift]({% link {{ page.version.versi

## Configure Prometheus

Every node of a CockroachDB cluster exports granular timeseries metrics formatted for easy integration with [Prometheus](https://prometheus.io/), an open source tool for storing, aggregating, and querying timeseries data. This section shows you how to orchestrate Prometheus as part of your Kubernetes cluster and pull these metrics into Prometheus for external monitoring.
Every node of a CockroachDB cluster exports granular timeseries metrics formatted for easy integration with [Prometheus](https://prometheus.io/), a tool for storing, aggregating, and querying timeseries data. This section shows you how to orchestrate Prometheus as part of your Kubernetes cluster and pull these metrics into Prometheus for external monitoring.

This guidance is based on [CoreOS's Prometheus Operator](https://github.com/coreos/prometheus-operator/blob/master/Documentation/user-guides/getting-started.md), which allows a Prometheus instance to be managed using built-in Kubernetes concepts.

Expand Down
2 changes: 1 addition & 1 deletion src/current/v24.1/monitor-cockroachdb-with-prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ toc: true
docs_area: manage
---

CockroachDB generates detailed time series metrics for each node in a cluster. This page shows you how to pull these metrics into [Prometheus](https://prometheus.io/), an open source tool for storing, aggregating, and querying time series data. It also shows you how to connect [Grafana](https://grafana.com/) and [Alertmanager](https://prometheus.io/docs/alerting/alertmanager/) to Prometheus for flexible data visualizations and notifications.
CockroachDB generates detailed time series metrics for each node in a cluster. This page shows you how to pull these metrics into [Prometheus](https://prometheus.io/), a tool for storing, aggregating, and querying time series data. It also shows you how to connect [Grafana](https://grafana.com/) and [Alertmanager](https://prometheus.io/docs/alerting/alertmanager/) to Prometheus for flexible data visualizations and notifications.

{{site.data.alerts.callout_success}}
This tutorial explores the CockroachDB {{ site.data.products.core }} integration with Prometheus. For the CockroachDB {{ site.data.products.advanced }} integration with Prometheus, refer to [Export Metrics From a CockroachDB {{ site.data.products.advanced }} Cluster]({% link cockroachcloud/export-metrics-advanced.md %}?filters=prometheus-metrics-export) instead of this page.
Expand Down
4 changes: 2 additions & 2 deletions src/current/v24.1/monitoring-and-alerting.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ The [`cockroach node status`]({% link {{ page.version.version }}/cockroach-node.

### Prometheus endpoint

Every node of a CockroachDB cluster exports granular time-series metrics at `http://<host>:<http-port>/_status/vars`. The metrics are formatted for easy integration with [Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}), an open source tool for storing, aggregating, and querying time-series data. The Prometheus format is human-readable and can be processed to work with other third-party monitoring systems such as [Sysdig](https://sysdig.atlassian.net/wiki/plugins/servlet/mobile?contentId=64946336#content/view/64946336) and [stackdriver](https://github.com/GoogleCloudPlatform/k8s-stackdriver/tree/master/prometheus-to-sd). Many of the [third-party monitoring integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}), such as [Datadog]({% link {{ page.version.version }}/datadog.md %}) and [Kibana]({% link {{ page.version.version }}/kibana.md %}), collect metrics from a cluster's Prometheus endpoint.
Every node of a CockroachDB cluster exports granular time-series metrics at `http://<host>:<http-port>/_status/vars`. The metrics are formatted for easy integration with [Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}), a tool for storing, aggregating, and querying time-series data. The Prometheus format is human-readable and can be processed to work with other third-party monitoring systems such as [Sysdig](https://sysdig.atlassian.net/wiki/plugins/servlet/mobile?contentId=64946336#content/view/64946336) and [stackdriver](https://github.com/GoogleCloudPlatform/k8s-stackdriver/tree/master/prometheus-to-sd). Many of the [third-party monitoring integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}), such as [Datadog]({% link {{ page.version.version }}/datadog.md %}) and [Kibana]({% link {{ page.version.version }}/kibana.md %}), collect metrics from a cluster's Prometheus endpoint.

To access the Prometheus endpoint of a cluster running on `localhost:8080`:

Expand Down Expand Up @@ -1036,7 +1036,7 @@ curl http://localhost:8080/_status/stores/1

In addition to actively monitoring the overall health and performance of a cluster, it is also essential to configure alerting rules that promptly send notifications when CockroachDB experiences events that require investigation or intervention.

Many of the [third-party monitoring integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}), such as [Datadog]({% link {{ page.version.version }}/datadog.md %}) and [Kibana]({% link {{ page.version.version }}/kibana.md %}), also support event-based alerting using metrics collected from a cluster's [Prometheus endpoint](#prometheus-endpoint). Refer to the documentation for an integration for more details. This section identifies the most important events that you might want to create alerting rules for, and provides pre-defined rules definitions for these events appropriate for use with Prometheus's open source [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) service.
Many of the [third-party monitoring integrations]({% link {{ page.version.version }}/third-party-monitoring-tools.md %}), such as [Datadog]({% link {{ page.version.version }}/datadog.md %}) and [Kibana]({% link {{ page.version.version }}/kibana.md %}), also support event-based alerting using metrics collected from a cluster's [Prometheus endpoint](#prometheus-endpoint). Refer to the documentation for an integration for more details. This section identifies the most important events that you might want to create alerting rules for, and provides pre-defined rules definitions for these events appropriate for use with Prometheus's [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) service.

### Alertmanager

Expand Down
2 changes: 1 addition & 1 deletion src/current/v24.1/spatial-data-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,5 +66,5 @@ In addition to the [generated reference documentation for spatial functions]({%

## See also

- [Introducing Distributed Spatial Data in Free, Open Source CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Introducing Distributed Spatial Data in CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Using GeoServer with CockroachDB]({% link {{ page.version.version }}/geoserver.md %})
2 changes: 1 addition & 1 deletion src/current/v24.1/spatial-indexes.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,5 +235,5 @@ CREATE INDEX geog_idx_3 ON geo_table USING GIST(geog);
- [Migrate from GeoJSON]({% link {{ page.version.version }}/migrate-from-geojson.md %})
- [Migrate from GeoPackage]({% link {{ page.version.version }}/migrate-from-geopackage.md %})
- [Migrate from OpenStreetMap]({% link {{ page.version.version }}/migrate-from-openstreetmap.md %})
- [Introducing Distributed Spatial Data in Free, Open Source CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Introducing Distributed Spatial Data in CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Using GeoServer with CockroachDB]({% link {{ page.version.version }}/geoserver.md %})
2 changes: 1 addition & 1 deletion src/current/v24.1/spatial-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -1744,7 +1744,7 @@ For more information about production quality map routing software that uses Ope
{{site.data.alerts.end}}

{{site.data.alerts.callout_info}}
There are multiple ways to do geocoding. You can use REST API-based services or do the geocoding yourself by processing [TIGER/LINE address data](https://www2.census.gov/geo/tiger/tigerua/) using a library for that purpose. For more information about some of the options available to you, see [this OpenStreetMap wiki page on geocoders](https://wiki.openstreetmap.org/wiki/Search_engines) or [this list of open source geocoding software](http://www.tsusiatsoftware.net/geocode.html).
There are multiple ways to do geocoding. You can use REST API-based services or do the geocoding yourself by processing [TIGER/LINE address data](https://www2.census.gov/geo/tiger/tigerua/) using a library for that purpose. For more information about some of the options available to you, see [this OpenStreetMap wiki page on geocoders](https://wiki.openstreetmap.org/wiki/Search_engines) or [this list of geocoding software](http://www.tsusiatsoftware.net/geocode.html).
{{site.data.alerts.end}}

##### The `roads` table
Expand Down
2 changes: 1 addition & 1 deletion src/current/v24.1/srid-4326.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,5 +124,5 @@ ERROR: st_contains(): operation on mixed SRIDs forbidden: (Point, 0) != (Point,
- [Well known text]({% link {{ page.version.version }}/well-known-text.md %})
- [Well known binary]({% link {{ page.version.version }}/well-known-binary.md %})
- [GeoJSON]({% link {{ page.version.version }}/geojson.md %})
- [Introducing Distributed Spatial Data in Free, Open Source CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Introducing Distributed Spatial Data in CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Using GeoServer with CockroachDB]({% link {{ page.version.version }}/geoserver.md %})
2 changes: 1 addition & 1 deletion src/current/v24.1/st_contains.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,5 +100,5 @@ SELECT st_contains(st_geomfromtext('SRID=4326;POLYGON((-87.906471 43.038902, -95
- [Migrate from GeoJSON]({% link {{ page.version.version }}/migrate-from-geojson.md %})
- [Migrate from GeoPackage]({% link {{ page.version.version }}/migrate-from-geopackage.md %})
- [Migrate from OpenStreetMap]({% link {{ page.version.version }}/migrate-from-openstreetmap.md %})
- [Introducing Distributed Spatial Data in Free, Open Source CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Introducing Distributed Spatial Data in CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Using GeoServer with CockroachDB]({% link {{ page.version.version }}/geoserver.md %})
2 changes: 1 addition & 1 deletion src/current/v24.1/st_convexhull.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,5 +267,5 @@ In this example, we will generate the convex hull of a single geometry. The geo
- [Migrate from GeoJSON]({% link {{ page.version.version }}/migrate-from-geojson.md %})
- [Migrate from GeoPackage]({% link {{ page.version.version }}/migrate-from-geopackage.md %})
- [Migrate from OpenStreetMap]({% link {{ page.version.version }}/migrate-from-openstreetmap.md %})
- [Introducing Distributed Spatial Data in Free, Open Source CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Introducing Distributed Spatial Data in CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Using GeoServer with CockroachDB]({% link {{ page.version.version }}/geoserver.md %})
2 changes: 1 addition & 1 deletion src/current/v24.1/st_coveredby.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,5 +93,5 @@ SELECT ST_CoveredBy(st_geomfromtext('SRID=4326;POLYGON((-87.906471 43.038902, -9
- [Migrate from GeoJSON]({% link {{ page.version.version }}/migrate-from-geojson.md %})
- [Migrate from GeoPackage]({% link {{ page.version.version }}/migrate-from-geopackage.md %})
- [Migrate from OpenStreetMap]({% link {{ page.version.version }}/migrate-from-openstreetmap.md %})
- [Introducing Distributed Spatial Data in Free, Open Source CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Introducing Distributed Spatial Data in CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Using GeoServer with CockroachDB]({% link {{ page.version.version }}/geoserver.md %})
2 changes: 1 addition & 1 deletion src/current/v24.1/st_covers.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,5 +94,5 @@ SELECT ST_Covers(st_geomfromtext('SRID=4326;POLYGON((-87.906471 43.038902, -95.9
- [Migrate from GeoJSON]({% link {{ page.version.version }}/migrate-from-geojson.md %})
- [Migrate from GeoPackage]({% link {{ page.version.version }}/migrate-from-geopackage.md %})
- [Migrate from OpenStreetMap]({% link {{ page.version.version }}/migrate-from-openstreetmap.md %})
- [Introducing Distributed Spatial Data in Free, Open Source CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Introducing Distributed Spatial Data in CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Using GeoServer with CockroachDB]({% link {{ page.version.version }}/geoserver.md %})
2 changes: 1 addition & 1 deletion src/current/v24.1/st_disjoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,5 +94,5 @@ SELECT st_disjoint(st_geomfromtext('SRID=4326;POLYGON((-87.906471 43.038902, -95
- [Migrate from GeoJSON]({% link {{ page.version.version }}/migrate-from-geojson.md %})
- [Migrate from GeoPackage]({% link {{ page.version.version }}/migrate-from-geopackage.md %})
- [Migrate from OpenStreetMap]({% link {{ page.version.version }}/migrate-from-openstreetmap.md %})
- [Introducing Distributed Spatial Data in Free, Open Source CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Introducing Distributed Spatial Data in CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Using GeoServer with CockroachDB]({% link {{ page.version.version }}/geoserver.md %})
2 changes: 1 addition & 1 deletion src/current/v24.1/st_equals.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,5 +90,5 @@ SELECT st_equals(st_geomfromtext('SRID=4326;POLYGON((-87.906471 43.038902, -95.9
- [Migrate from GeoJSON]({% link {{ page.version.version }}/migrate-from-geojson.md %})
- [Migrate from GeoPackage]({% link {{ page.version.version }}/migrate-from-geopackage.md %})
- [Migrate from OpenStreetMap]({% link {{ page.version.version }}/migrate-from-openstreetmap.md %})
- [Introducing Distributed Spatial Data in Free, Open Source CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Introducing Distributed Spatial Data in CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Using GeoServer with CockroachDB]({% link {{ page.version.version }}/geoserver.md %})
2 changes: 1 addition & 1 deletion src/current/v24.1/st_intersects.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,5 +91,5 @@ SELECT st_intersects(st_geomfromtext('SRID=4326;POLYGON((-87.906471 43.038902, -
- [Migrate from GeoJSON]({% link {{ page.version.version }}/migrate-from-geojson.md %})
- [Migrate from GeoPackage]({% link {{ page.version.version }}/migrate-from-geopackage.md %})
- [Migrate from OpenStreetMap]({% link {{ page.version.version }}/migrate-from-openstreetmap.md %})
- [Introducing Distributed Spatial Data in Free, Open Source CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Introducing Distributed Spatial Data in CockroachDB](https://www.cockroachlabs.com/blog/spatial-data/) (blog post)
- [Using GeoServer with CockroachDB]({% link {{ page.version.version }}/geoserver.md %})
Loading
Loading