Skip to content

Commit fffe9f0

Browse files
authored
Merge branch 'main' into ltree
2 parents 3d3fef9 + 4d0e124 commit fffe9f0

File tree

8 files changed

+1112
-621
lines changed

8 files changed

+1112
-621
lines changed

src/current/_data/v25.4/metrics/available-metrics-in-metrics-list.csv

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -483,3 +483,11 @@ rebalancing.range.rebalances
483483
rebalancing.replicas.cpunanospersecond
484484
rebalancing.replicas.queriespersecond
485485
rebalancing.state.imbalanced_overfull_options_exhausted
486+
sql.routine.delete.count
487+
sql.routine.delete.started.count
488+
sql.routine.insert.count
489+
sql.routine.insert.started.count
490+
sql.routine.select.count
491+
sql.routine.select.started.count
492+
sql.routine.update.count
493+
sql.routine.update.started.count

src/current/_data/v25.4/metrics/metrics.yaml

Lines changed: 1026 additions & 604 deletions
Large diffs are not rendered by default.

src/current/_includes/v25.3/essential-metrics.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
{% assign version = page.version.version | replace: ".", "" %}
22
{% comment %}DEBUG: {{ version }}{% endcomment %}
33

4-
These essential CockroachDB metrics let you monitor your CockroachDB {{ site.data.products.core }} cluster. Use them to build custom dashboards with the following tools:
5-
64
{% comment %} STEP 1. Assign variables specific to deployment {% endcomment %}
75
{% if include.deployment == 'self-hosted' %}
86
{% assign metrics_datadog = site.data[version].metrics.datadog-cockroachdb %}
97
{% assign datadog_link = "https://docs.datadoghq.com/integrations/cockroachdb/?tab=host#metrics" %}
108
{% assign datadog_prefix = "cockroachdb" %}
119
{% assign category_order = "HARDWARE,STORAGE,OVERLOAD,NETWORKING,DISTRIBUTED,REPLICATION,SQL,CHANGEFEEDS,TTL,UNSET," %}
1210

11+
These essential CockroachDB metrics let you monitor your CockroachDB {{ site.data.products.core }} cluster. Use them to build custom dashboards with the following tools:
12+
1313
- [Grafana]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}#step-5-visualize-metrics-in-grafana)
1414
- [Datadog Integration]({% link {{ page.version.version }}/datadog.md %}): The [**Datadog Integration Metric Name**]({{ datadog_link }}) column lists the corresponding Datadog metric which requires the `{{ datadog_prefix }}.` prefix.
1515

@@ -20,6 +20,8 @@ These essential CockroachDB metrics let you monitor your CockroachDB {{ site.dat
2020
{% comment %} Removed NETWORKING category for advanced deployment {% endcomment %}
2121
{% assign category_order = "HARDWARE,STORAGE,OVERLOAD,DISTRIBUTED,REPLICATION,SQL,CHANGEFEEDS,TTL,UNSET," %}
2222

23+
These essential CockroachDB metrics let you monitor your CockroachDB {{ site.data.products.advanced }} cluster. Use them to build custom dashboards with the following tools:
24+
2325
- [Datadog integration]({% link cockroachcloud/tools-page.md %}#monitor-cockroachdb-cloud-with-datadog) - The [**Datadog Integration Metric Name**]({{ datadog_link }}) column lists the corresponding Datadog metric which requires the `{{ datadog_prefix }}` prefix.
2426
- [Metrics export]({% link cockroachcloud/export-metrics-advanced.md %})
2527

src/current/_includes/v25.4/essential-metrics.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
{% assign version = page.version.version | replace: ".", "" %}
22
{% comment %}DEBUG: {{ version }}{% endcomment %}
33

4-
These essential CockroachDB metrics let you monitor your CockroachDB {{ site.data.products.core }} cluster. Use them to build custom dashboards with the following tools:
5-
64
{% comment %} STEP 1. Assign variables specific to deployment {% endcomment %}
75
{% if include.deployment == 'self-hosted' %}
86
{% assign metrics_datadog = site.data[version].metrics.datadog-cockroachdb %}
97
{% assign datadog_link = "https://docs.datadoghq.com/integrations/cockroachdb/?tab=host#metrics" %}
108
{% assign datadog_prefix = "cockroachdb" %}
11-
{% assign category_order = "HARDWARE,STORAGE,OVERLOAD,NETWORKING,DISTRIBUTED,REPLICATION,SQL,CHANGEFEEDS,TTL,UNSET," %}
9+
{% assign category_order = "HARDWARE,STORAGE,OVERLOAD,NETWORKING,DISTRIBUTED,REPLICATION,SQL,CHANGEFEEDS,TTL,CROSS_CLUSTER_REPLICATION,LOGICAL_DATA_REPLICATION,UNSET," %}
10+
11+
These essential CockroachDB metrics let you monitor your CockroachDB {{ site.data.products.core }} cluster. Use them to build custom dashboards with the following tools:
1212

1313
- [Grafana]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}#step-5-visualize-metrics-in-grafana)
1414
- [Datadog Integration]({% link {{ page.version.version }}/datadog.md %}): The [**Datadog Integration Metric Name**]({{ datadog_link }}) column lists the corresponding Datadog metric which requires the `{{ datadog_prefix }}.` prefix.
@@ -18,7 +18,9 @@ These essential CockroachDB metrics let you monitor your CockroachDB {{ site.dat
1818
{% assign datadog_link = "https://docs.datadoghq.com/integrations/cockroach-cloud/#metrics" %}
1919
{% assign datadog_prefix = "crdb_dedicated" %}
2020
{% comment %} Removed NETWORKING category for advanced deployment {% endcomment %}
21-
{% assign category_order = "HARDWARE,STORAGE,OVERLOAD,DISTRIBUTED,REPLICATION,SQL,CHANGEFEEDS,TTL,UNSET," %}
21+
{% assign category_order = "HARDWARE,STORAGE,OVERLOAD,DISTRIBUTED,REPLICATION,SQL,CHANGEFEEDS,TTL,CROSS_CLUSTER_REPLICATION,LOGICAL_DATA_REPLICATION,UNSET," %}
22+
23+
These essential CockroachDB metrics let you monitor your CockroachDB {{ site.data.products.advanced }} cluster. Use them to build custom dashboards with the following tools:
2224

2325
- [Datadog integration]({% link cockroachcloud/tools-page.md %}#monitor-cockroachdb-cloud-with-datadog) - The [**Datadog Integration Metric Name**]({{ datadog_link }}) column lists the corresponding Datadog metric which requires the `{{ datadog_prefix }}` prefix.
2426
- [Metrics export]({% link cockroachcloud/export-metrics-advanced.md %})
@@ -56,7 +58,7 @@ The **Usage** column explains why each metric is important to visualize and how
5658

5759
{% comment %} Order categories, NOTE: new categories may break this order, however all relevant categories will be displayed though not in the desired order{% endcomment %}
5860
{% comment %}DEBUG: category_names_string = {{ category_names_string }}{% endcomment %}
59-
{% assign category_names_string_ordered = category_names_string | replace: "CHANGEFEEDS,DISTRIBUTED,NETWORKING,SQL,TTL,UNSET,HARDWARE,OVERLOAD,REPLICATION,STORAGE,", category_order %}
61+
{% assign category_names_string_ordered = category_names_string | replace: "CHANGEFEEDS,CROSS_CLUSTER_REPLICATION,DISTRIBUTED,LOGICAL_DATA_REPLICATION,NETWORKING,SQL,TTL,UNSET,HARDWARE,OVERLOAD,STORAGE,", category_order %}
6062
{% comment %}DEBUG: category_names_string_ordered = {{ category_names_string_ordered }}{% endcomment %}
6163
{% assign category_names_array = category_names_string_ordered | split: "," %}
6264

@@ -90,6 +92,8 @@ The **Usage** column explains why each metric is important to visualize and how
9092
{% elsif category_name == "REPLICATION" %}{% assign category_display_name = "KV Replication" %}
9193
{% elsif category_name == "CHANGEFEEDS" %}{% assign category_display_name = "Changefeeds" %}
9294
{% elsif category_name == "TTL" %}{% assign category_display_name = "Row-level TTL" %}
95+
{% elsif category_name == "CROSS_CLUSTER_REPLICATION" %}{% assign category_display_name = "Physical Replication" %}
96+
{% elsif category_name == "LOGICAL_DATA_REPLICATION" %}{% assign category_display_name = "Logical Replication" %}
9397
{% else %}{% assign category_display_name = category_name %}{% comment %} For example, SQL {% endcomment %}
9498
{% endif %}
9599

src/current/v25.4/configure-logs.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ This page describes how to configure CockroachDB logs with the [`--log` or `log-
1515

1616
For examples of how these settings can be used in practice, see [Logging Use Cases]({% link {{ page.version.version }}/logging-use-cases.md %}).
1717

18+
{{site.data.alerts.callout_info}}
19+
In a future major release, certain events will be directed by default to new [logging channels]({% link {{ page.version.version }}/logging-overview.md %}#logging-channels).
20+
21+
To prepare for the change and assess potential downstream impacts on your logging setup and pipelines, review the [`log.channel_compatibility_mode.enabled`]({% link {{ page.version.version }}/logging-overview.md %}#log-channel_compatibility_mode-enabled) cluster setting. After reviewing the documentation, set `log.channel_compatibility_mode.enabled` to `false` in a non-production environment.
22+
{{site.data.alerts.end}}
23+
1824
## Flag
1925

2026
To configure the logging behavior of a `cockroach` command, include one of these flags with the command:
@@ -865,6 +871,19 @@ sinks:
865871
redactable: true
866872
exit-on-error: true
867873
buffering: NONE
874+
kv-exec:
875+
channels: {INFO: [KV_EXEC]}
876+
dir: /cockroach-data/logs
877+
max-file-size: 10MiB
878+
max-group-size: 100MiB
879+
file-permissions: "0640"
880+
buffered-writes: true
881+
filter: INFO
882+
format: crdb-v2
883+
redact: false
884+
redactable: true
885+
exit-on-error: true
886+
buffering: NONE
868887
pebble:
869888
channels: {INFO: [STORAGE]}
870889
dir: /cockroach-data/logs

src/current/v25.4/log-sql-activity-to-datadog.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ docs_area: manage
77

88
This tutorial describes how to configure logging of telemetry events, including [`sampled_query`]({% link {{ page.version.version }}/eventlog.md %}#sampled_query) and [`sampled_transaction`]({% link {{ page.version.version }}/eventlog.md %}#sampled_query), to [Datadog](https://www.datadoghq.com/) for finer granularity and long-term retention of SQL activity. The `sampled_query` and `sampled_transaction` events contain common SQL event and execution details for [statements]({% link {{ page.version.version }}/sql-statements.md %}) and [transactions]({% link {{ page.version.version }}/transactions.md %}).
99

10+
{{site.data.alerts.callout_info}}
11+
`sampled_query` and `sampled_transaction` events, which are sent by default to the [`TELEMETRY`]({% link {{ page.version.version }}/logging-overview.md %}#telemetry) channel in {{ page.version.version }} and earlier versions, will instead be routed by default to the [`SQL_EXEC`]({% link {{ page.version.version }}/logging-overview.md %}#sql_exec) channel in a future major release.
12+
13+
To prepare for the change and assess potential downstream impacts on your logging setup and pipelines, review the [`log.channel_compatibility_mode.enabled`]({% link {{ page.version.version }}/logging-overview.md %}#log-channel_compatibility_mode-enabled) cluster setting. After reviewing the documentation, set `log.channel_compatibility_mode.enabled` to `false` in a non-production environment to log `sampled_query` and `sampled_transaction` events to the [SQL_EXEC]({% link {{ page.version.version }}/logging-overview.md %}#sql_exec) channel.
14+
{{site.data.alerts.end}}
15+
1016
CockroachDB supports a built-in integration with Datadog which sends these events as logs via the [Datadog HTTP API](https://docs.datadoghq.com/api/latest/logs/). This integration is the recommended path to achieve high throughput data ingestion, which will in turn provide more query and transaction events for greater workload observability.
1117

1218
{{site.data.alerts.callout_info}}

0 commit comments

Comments
 (0)