From 24a807f03ecad7beb8ae142d68c4034f35f4d2fc Mon Sep 17 00:00:00 2001 From: atovpeko Date: Fri, 13 Nov 2026 16:28:16 +0200 Subject: [PATCH 1/2] Document the TimescaleDB metrics exporter option Console 10.18.0 adds a TimescaleDB metrics checkbox to the exporter form. Split out of the combined Console 10.18 PR: on 2026-11-13 a Prometheus exporter with the option on returned no timescaledb_* metrics, so this waits until they are delivered. --- .../integrate/observability-alerting/azure-monitor.mdx | 2 +- .../integrate/observability-alerting/exported-metrics.mdx | 8 ++++++++ src/partials/_cloudwatch-data-exporter.mdx | 4 ++-- src/partials/_datadog-data-exporter.mdx | 2 +- src/partials/_prometheus-integrate.mdx | 2 +- 5 files changed, 13 insertions(+), 5 deletions(-) diff --git a/src/content/docs/integrate/observability-alerting/azure-monitor.mdx b/src/content/docs/integrate/observability-alerting/azure-monitor.mdx index 086bed25e..f000fa7fb 100644 --- a/src/content/docs/integrate/observability-alerting/azure-monitor.mdx +++ b/src/content/docs/integrate/observability-alerting/azure-monitor.mdx @@ -69,7 +69,7 @@ The exporter name appears in {C.CONSOLE}, best practice is to make this name eas -Optionally tick `PostgreSQL metrics` to export [additional metrics](/integrate/observability-alerting/exported-metrics#postgresql-metrics), then click `Create exporter`. +Under `Additional metrics`, optionally tick `PostgreSQL metrics` to export [database-level metrics](/integrate/observability-alerting/exported-metrics#postgresql-metrics), and `TimescaleDB metrics` to export [{C.TIMESCALE_DB} metrics](/integrate/observability-alerting/exported-metrics#timescaledb-metrics). Then click `Create exporter`. diff --git a/src/content/docs/integrate/observability-alerting/exported-metrics.mdx b/src/content/docs/integrate/observability-alerting/exported-metrics.mdx index c823ead34..9c962a141 100644 --- a/src/content/docs/integrate/observability-alerting/exported-metrics.mdx +++ b/src/content/docs/integrate/observability-alerting/exported-metrics.mdx @@ -70,6 +70,14 @@ These metrics show the health and status of the metrics collection process, incl +## {C.TIMESCALE_DB} metrics + +These additional metrics are collected if you enable `TimescaleDB metrics` when creating {C.CLOUD_LONG} exporters. This option is separate from `PostgreSQL metrics`. + +|Metric|Description| +|-|-| +|`timescaledb_job_runs_total`|Total number of background job runs, by outcome.| + ## {C.LAKE} metrics If your service has an active [{C.ICEBERG_CONNECTOR_LONG}](/integrate/connectors/destination/tigerlake), {C.CLOUD_LONG} exporters also export these metrics. They appear automatically while the connector is running, and you don't need to enable them separately. diff --git a/src/partials/_cloudwatch-data-exporter.mdx b/src/partials/_cloudwatch-data-exporter.mdx index f31e0e86f..18668f03b 100644 --- a/src/partials/_cloudwatch-data-exporter.mdx +++ b/src/partials/_cloudwatch-data-exporter.mdx @@ -141,9 +141,9 @@ When you use CloudWatch credentials, you link an Identity and Access Management - + -See [Exported metrics](/integrate/observability-alerting/exported-metrics#postgresql-metrics) for the full list. +Tick `PostgreSQL metrics` to export database-level metrics, and `TimescaleDB metrics` to export {C.TIMESCALE_DB} metrics. See [Exported metrics](/integrate/observability-alerting/exported-metrics#postgresql-metrics) for the full list. diff --git a/src/partials/_datadog-data-exporter.mdx b/src/partials/_datadog-data-exporter.mdx index 655e09da9..0c235f1cf 100644 --- a/src/partials/_datadog-data-exporter.mdx +++ b/src/partials/_datadog-data-exporter.mdx @@ -27,7 +27,7 @@ The AWS region must be the same for your {C.CLOUD_LONG} exporter and the Datadog -Optionally tick `PostgreSQL metrics` to export [additional metrics](/integrate/observability-alerting/exported-metrics#postgresql-metrics), then click `Create exporter`. +Under `Additional metrics`, optionally tick `PostgreSQL metrics` to export [database-level metrics](/integrate/observability-alerting/exported-metrics#postgresql-metrics), and `TimescaleDB metrics` to export [{C.TIMESCALE_DB} metrics](/integrate/observability-alerting/exported-metrics#timescaledb-metrics). Then click `Create exporter`. diff --git a/src/partials/_prometheus-integrate.mdx b/src/partials/_prometheus-integrate.mdx index 2da291339..3101bdc62 100644 --- a/src/partials/_prometheus-integrate.mdx +++ b/src/partials/_prometheus-integrate.mdx @@ -60,7 +60,7 @@ To export metrics from a {C.SERVICE_LONG}, you create a dedicated Prometheus exp Click `Copy password` and store the password somewhere safe. {C.CONSOLE} does not show it again after you create the exporter. If you lose it, open the exporter's `Edit` form and click `Generate new password`. -1. Optionally tick `PostgreSQL metrics` to export [additional metrics](/integrate/observability-alerting/exported-metrics#postgresql-metrics), then click `Create exporter`. +1. Under `Additional metrics`, optionally tick `PostgreSQL metrics` to export [database-level metrics](/integrate/observability-alerting/exported-metrics#postgresql-metrics), and `TimescaleDB metrics` to export [{C.TIMESCALE_DB} metrics](/integrate/observability-alerting/exported-metrics#timescaledb-metrics). Then click `Create exporter`. From d6911cc21302114b30f666234f62ee9ccac8c6ff Mon Sep 17 00:00:00 2001 From: Adrin Lopez Calvo Date: Mon, 16 Nov 2026 17:44:50 +0100 Subject: [PATCH 2/2] List the TimescaleDB job metrics Replace the single metric row with a Job metrics subsection that lists the five job metrics and their labels. --- .../exported-metrics.mdx | 20 ++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/src/content/docs/integrate/observability-alerting/exported-metrics.mdx b/src/content/docs/integrate/observability-alerting/exported-metrics.mdx index 9c962a141..9e9431695 100644 --- a/src/content/docs/integrate/observability-alerting/exported-metrics.mdx +++ b/src/content/docs/integrate/observability-alerting/exported-metrics.mdx @@ -74,9 +74,27 @@ These metrics show the health and status of the metrics collection process, incl These additional metrics are collected if you enable `TimescaleDB metrics` when creating {C.CLOUD_LONG} exporters. This option is separate from `PostgreSQL metrics`. +### Job metrics + +These metrics show the state of the background jobs of your service. This includes policy jobs, such as compression, retention, and continuous aggregate refresh, and your own user-defined jobs. + |Metric|Description| |-|-| -|`timescaledb_job_runs_total`|Total number of background job runs, by outcome.| +|`timescaledb_job_runs_total`|Total number of finished job runs. The `status` label is `success` or `failure`.| +|`timescaledb_job_failing_for_seconds`|Seconds since the job last succeeded. This metric exists only while the last run of the job failed.| +|`timescaledb_job_overdue_seconds`|Seconds a scheduled job that is not running is late. This metric exists only while the job is late.| +|`timescaledb_job_running`|Number of jobs running now. This metric exists only while a job is running.| +|`timescaledb_job_schedule_interval_seconds`|How often the job is scheduled to run, in seconds. Paused jobs are included, with the `scheduled` label set to `false`.| + +Job metrics carry these extra labels: + +|Label|Description| +|-|-| +|`job_type`|The kind of built-in policy the job runs: `columnstore`, `compaction`, `continuous aggregate refresh`, `reorder`, `retention`, or `tiered storage`. It is `user defined` for any other job.| +|`proc_name`|The procedure the job runs, as `schema.name`.| +|`target_object`|The hypertable or continuous aggregate the job acts on, as `schema.name`. It is empty if the job has no target.| + +Each metric covers at most 1000 jobs per service. In `timescaledb_job_runs_total`, the jobs beyond the first 1000 are summed into one series for each `job_type` and `status`, with `proc_name` and `target_object` set to `overflow`. ## {C.LAKE} metrics