Skip to content

Commit

Permalink
Merge branch 'latest' into datatiering-limitations-lana
Browse files Browse the repository at this point in the history
  • Loading branch information
Loquacity authored Aug 16, 2023
2 parents c5f8325 + b5a3cc0 commit 17df410
Show file tree
Hide file tree
Showing 7 changed files with 53 additions and 47 deletions.
28 changes: 15 additions & 13 deletions api/drop_chunks.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,19 @@ specified one.
Chunks can only be dropped based on their time intervals. They cannot be dropped
based on a space partition.

### Required arguments
## Required arguments

|Name|Type|Description|
|---|---|---|
| `relation` | REGCLASS | Hypertable or continuous aggregate from which to drop chunks. |
| `older_than` | INTERVAL | Specification of cut-off point where any full chunks older than this timestamp should be removed. |
|-|-|-|
|`relation`|REGCLASS|Hypertable or continuous aggregate from which to drop chunks.|
|`older_than`|INTERVAL|Specification of cut-off point where any full chunks older than this timestamp should be removed.|

### Optional arguments
## Optional arguments

|Name|Type|Description|
|---|---|---|
| `newer_than` | INTERVAL | Specification of cut-off point where any full chunks newer than this timestamp should be removed. |
| `verbose` | BOOLEAN | Setting to true displays messages about the progress of the reorder command. Defaults to false.|
|-|-|-|
|`newer_than`|INTERVAL|Specification of cut-off point where any full chunks newer than this timestamp should be removed.|
|`verbose`|BOOLEAN|Setting to true displays messages about the progress of the reorder command. Defaults to false.|

The `older_than` and `newer_than` parameters can be specified in two ways:

Expand All @@ -60,13 +60,15 @@ you are removing things _in the past_. If you want to remove data
in the future, for example to delete erroneous entries, use a timestamp.
</Highlight>

When both arguments are used, the function returns the intersection of the resulting two ranges. For example,
specifying `newer_than => 4 months` and `older_than => 3 months` drops all full chunks that are between 3 and
4 months old. Similarly, specifying `newer_than => '2017-01-01'` and `older_than => '2017-02-01'` drops
all full chunks between '2017-01-01' and '2017-02-01'. Specifying parameters that do not result in an overlapping
When both arguments are used, the function returns the intersection of the
resulting two ranges. For example, specifying `newer_than => 4 months` and
`older_than => 3 months` drops all full chunks that are between 3 and 4 months
old. Similarly, specifying `newer_than => '2017-01-01'` and
`older_than => '2017-02-01'` drops all full chunks between '2017-01-01' and
'2017-02-01'. Specifying parameters that do not result in an overlapping
intersection between two ranges results in an error.

### Sample usage
## Sample usage

Drop all chunks from hypertable `conditions` older than 3 months:

Expand Down
11 changes: 6 additions & 5 deletions api/set_chunk_time_interval.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,15 @@ Sets the `chunk_time_interval` on a hypertable. The new interval is used
when new chunks are created, and time intervals on existing chunks are
not changed.

### Required arguments
## Required arguments

|Name|Type|Description|
|-|-|-|
|`hypertable`|REGCLASS| Hypertable to update interval for|
|`hypertable`|REGCLASS|Hypertable or continuous aggregate to update interval for|
|`chunk_time_interval`|See note|Event time that each new chunk covers|

The valid types for the `chunk_time_interval` depend on the type used for the hypertable `time` column:
The valid types for the `chunk_time_interval` depend on the type used for the
hypertable `time` column:

|`time` column type|`chunk_time_interval` type|Time unit|
|-|-|-|
Expand All @@ -38,7 +39,7 @@ The valid types for the `chunk_time_interval` depend on the type used for the hy

For more information, see the [`create_hypertable` section][create-hypertable].

### Optional arguments
## Optional arguments

|TEXT|Description|
|-|-|-|
Expand All @@ -47,7 +48,7 @@ For more information, see the [`create_hypertable` section][create-hypertable].
You need to use `dimension_name` argument only if your hypertable has multiple
time dimensions.

### Sample usage
## Sample usage

For a TIMESTAMP column, set `chunk_time_interval` to 24 hours:

Expand Down
43 changes: 23 additions & 20 deletions api/show_chunks.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,37 +16,40 @@ Get list of chunks associated with a hypertable.
Function accepts the following required and optional arguments. These arguments
have the same semantics as the `drop_chunks` [function][drop_chunks].

### Required arguments
## Required arguments

|Name|Type|Description|
|---|---|---|
| `relation` | REGCLASS | Hypertable or continuous aggregate from which to select chunks. |
|-|-|-|
|`relation`|REGCLASS|Hypertable or continuous aggregate from which to select chunks.|

### Optional arguments
## Optional arguments

|Name|Type|Description|
|---|---|---|
| `older_than` | ANY | Specification of cut-off point where any full chunks older than this timestamp should be shown. |
| `newer_than` | ANY | Specification of cut-off point where any full chunks newer than this timestamp should be shown. |
|-|-|-|
|`older_than`|ANY|Specification of cut-off point where any full chunks older than this timestamp should be shown.|
|`newer_than`|ANY|Specification of cut-off point where any full chunks newer than this timestamp should be shown.|

The `older_than` and `newer_than` parameters can be specified in two ways:

* **interval type:** The cut-off point is computed as `now() -
older_than` and similarly `now() - newer_than`. An error is returned if an INTERVAL is supplied
and the time column is not one of a TIMESTAMP, TIMESTAMPTZ, or
DATE.

* **timestamp, date, or integer type:** The cut-off point is
explicitly given as a TIMESTAMP / TIMESTAMPTZ / DATE or as a
SMALLINT / INT / BIGINT. The choice of timestamp or integer must follow the type of the hypertable's time column.

When both arguments are used, the function returns the intersection of the resulting two ranges. For example,
specifying `newer_than => 4 months` and `older_than => 3 months` shows all full chunks that are between 3 and
4 months old. Similarly, specifying `newer_than => '2017-01-01'` and `older_than => '2017-02-01'` shows
all full chunks between '2017-01-01' and '2017-02-01'. Specifying parameters that do not result in an overlapping
older_than` and similarly `now() - newer_than`. An error is returned if an
INTERVAL is supplied and the time column is not one of a TIMESTAMP,
TIMESTAMPTZ, or DATE.

* **timestamp, date, or integer type:** The cut-off point is explicitly given
as a TIMESTAMP / TIMESTAMPTZ / DATE or as a SMALLINT / INT / BIGINT. The
choice of timestamp or integer must follow the type of the hypertable's time
column.

When both arguments are used, the function returns the intersection of the
resulting two ranges. For example, specifying `newer_than => 4 months` and
`older_than => 3 months` shows all full chunks that are between 3 and 4 months
old. Similarly, specifying `newer_than => '2017-01-01'` and
`older_than => '2017-02-01'` shows all full chunks between '2017-01-01' and
'2017-02-01'. Specifying parameters that do not result in an overlapping
intersection between two ranges results in an error.

### Sample usage
## Sample usage

Get list of all chunks associated with a table:

Expand Down
4 changes: 2 additions & 2 deletions use-timescale/metrics-logging/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Export telemetry data by:
1. Click `Create exporter`.

<img class="main-content__illustration"
src="https://assets.timescale.com/docs/images/tsc-integrations-datadog.png"
src="https://assets.timescale.com/docs/images/tsc-integrations-datadog.webp"
alt="Screenshot of the menu for adding a Datadog exporter" />

</Procedure>
Expand Down Expand Up @@ -95,7 +95,7 @@ safe location.
</Highlight>

<img class="main-content__illustration"
src="https://assets.timescale.com/docs/images/tsc-integrations-cloudwatch.png"
src="https://assets.timescale.com/docs/images/tsc-integrations-cloudwatch.webp"
alt="Screenshot of the menu for adding a Datadog exporter" />

</Procedure>
Expand Down
2 changes: 1 addition & 1 deletion use-timescale/metrics-logging/service-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ From the `Services` page, click the service you are interested in and navigate
to the `Logs` tab. This section contains your service's logging data.

<img class="main-content__illustration"
src="https://assets.timescale.com/docs/images/tsc-services-logs.png"
src="https://assets.timescale.com/docs/images/tsc-services-logs.webp"
alt="Timescale Services Logs"/>
6 changes: 3 additions & 3 deletions use-timescale/metrics-logging/service-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,14 @@ You can view metrics for your services for any of these time ranges:

To change the view, select the time range from the drop-down menu.

<img class="main-content__illustration" src="https://assets.timescale.com/docs/images/tsc-metrics_lastmonth.png" alt="Timescale Metrics dashboard"/>
<img class="main-content__illustration" src="https://assets.timescale.com/docs/images/tsc-metrics_lastmonth.webp" alt="Timescale Metrics dashboard"/>

Additionally, you can turn automatic metric refreshes on and off. When automatic
metric refresh is on, the dashboard updates every thirty seconds.

In some cases, gray vertical bars display on the metrics dashboard, like this:

<img class="main-content__illustration" src="https://assets.timescale.com/docs/images/tsc-metrics_graybar.png" alt="Timescale Metrics not collected"/>
<img class="main-content__illustration" src="https://assets.timescale.com/docs/images/tsc-metrics_graybar.webp" alt="Timescale Metrics not collected"/>

This indicates that metrics have not been collected for the period shown. It
does not mean that your Timescale service was down.
Expand All @@ -56,7 +56,7 @@ database services. You can check your health data by navigating to the `metrics`
tab in your service dashboard. These metrics are also monitored by the Timescale
operations team.

<img class="main-content__illustration" src="https://assets.timescale.com/docs/images/tsc-disk-metrics.png" alt="Timescale metrics dashboard"/>
<img class="main-content__illustration" src="https://assets.timescale.com/docs/images/tsc-disk-metrics.webp" alt="Timescale metrics dashboard"/>

## Query-level statistics in the Timescale dashboard

Expand Down
6 changes: 3 additions & 3 deletions use-timescale/services/service-explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ automation policies and actions, it provides pointers to tutorials and
documentation to help you get started.

<img class="main-content__illustration"
src="https://assets.timescale.com/docs/images/tsc-explorer.png"
src="https://assets.timescale.com/docs/images/tsc-explorer.webp"
alt="Timescale Explorer, General Information section"/>

## Tables
Expand All @@ -54,7 +54,7 @@ see the

<img
class="main-content__illustration"
src="https://assets.timescale.com/docs/images/tsc-explorer-tables.png"
src="https://assets.timescale.com/docs/images/tsc-explorer-tables.webp"
alt="Timescale Explorer, Tables section"
/>

Expand All @@ -69,7 +69,7 @@ configured for real-time aggregation, and their refresh periods.

<img
class="main-content__illustration"
src="https://assets.timescale.com/docs/images/tsc-explorer-caggs.png"
src="https://assets.timescale.com/docs/images/tsc-explorer-caggs.webp"
alt="Timescale Explorer, Continuous aggregates section"
/>

Expand Down

0 comments on commit 17df410

Please sign in to comment.