Skip to content

Commit

Permalink
Add admon about autoscaling to disk management section (github#570)
Browse files Browse the repository at this point in the history
* Add admon about autoscaling to disk management section

* Fix link

* Update cloud/disk-management.md

Co-authored-by: Jacob Prall <prall.jacob@gmail.com>
  • Loading branch information
Loquacity and jacobprall authored Nov 2, 2021
1 parent 162c5dd commit 9e2554b
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 29 deletions.
59 changes: 31 additions & 28 deletions cloud/disk-management.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Disk management

Timescale Cloud contains several mechanisms for managing disk space on your
services. There are four key tasks that Cloud performs to handle disk space:

1. Detect if storage capacity begins to fill up
1. Notify you about the growth of storage consumption
1. Automatically activate overload protections
Expand All @@ -11,8 +9,15 @@ services. There are four key tasks that Cloud performs to handle disk space:
This section explains what the various mechanisms are, and how to best make use
of them.

## Continuous storage monitoring
<highlight type="important">
By default, Timescale Cloud services have autoscaling enabled. Autoscaling
automatically increases your disk size, up to a maximum amount, as you fill the
disk. For more information about autoscaling, including instructions for setting
the maximum limit, or turning autoscaling off, see the
[scaling a service](cloud/latest/scaling-a-service/) section.
</highlight>

## Continuous storage monitoring
Timescale Cloud continuously monitors the health and resource consumption of all
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
Expand All @@ -25,10 +30,8 @@ automated actions are triggered, including notifications, and preventative
actions.

## Automated user alerting

When your disk usage exceeds certain thresholds, you will recieve email
notifications. These notifications occur at:

When your disk usage exceeds certain thresholds, you receive an email
notification. These notifications occur at:
* 75%
* 85%
* 95%
Expand All @@ -38,62 +41,61 @@ low- and high-watermarks, and we limit the frequency of messages we send you
about a particular service.

## Automated overload protection

If your database continues to increase in size past these thresholds, automated
overload protection is activated when your disk becomes 99% full. When this
happens, your database is put into read-only mode, and you receive a
notification on email and the Timescale Cloud console shows the changed status.

When this happens, you can still query your database, but you cannot add any new
data to it. This is to ensure that your disk does not fill up to 100%, which
could prevent you from crashing due to an out of memory (OOM) error.
When your disk is in read-only mode, you can still query your database, but you
cannot add any new data to it. This is to ensure that your disk does not fill up
to 100%, which could prevent you from crashing due to an out of memory (OOM)
error.

With your database in read-only mode, you need to decide if you are going to
increase your storage capacity, or reduce the size of your database. When you
have done that, you can also add a retention policy, or turn on compression, to
avoid the problem occurring again in the future.

## Online storage resizing

You can increase your storage size in the Timescale Cloud console.

<highlight type="warning">
You can only increase your service's storage once every six hours, and you cannot
currently decrease your storage size once set.
You can only increase your service's storage once every six hours, and you
cannot currently decrease your storage size once set.
</highlight>

<procedure>

### Increasing service resources
1. In the Timescale Cloud console, navigate to `Services` and click the service
you want to adjust. Navigate to the `Operations` tab, and go to the `Resources`
section.
you want to adjust. Navigate to the `Operations` tab, and go to
the `Resources` section.
1. Adjust the sliders for CPU and disk size as required. If you increase the
disk size past a certain point, we also recommend increasing the CPU size to
handle the increased disk size (although not required).
disk size past a certain point, we also recommend increasing the CPU size to
handle the increased disk size (although not required).
1. Review the new sizes and costs in the panel on the right-hand side, and
click `Restart and apply` when you are happy with the changes.
click `Restart and apply` when you are happy with the changes.
1. The resources take a few seconds to increase, and when the increase is
complete, your database is immediately available on the new resources. If your
database is in read-only mode, the read-only protection is automatically removed,
and you can begin writing data immediately.
complete, your database is immediately available on the new resources. If
your database is in read-only mode, the read-only protection is
automatically removed, and you can begin writing data immediately.

<img class="main-content__illustration" src="https://s3.amazonaws.com/assets.timescale.com/docs/images/tsc-resources-changed.png" alt="Timescale Cloud change resources"/>

</procedure>

## Storage recovery

If you need to perform actions on your database to reduce your data usage, you
can turn off read-only mode. For example, you need read-write access if you want
to compress data, delete rows or tables, or drop old data using data retention
policies.

<highlight type="warning"> We highly recommend that you do not manually enable
read-write mode on a database that is over 99% capacity. You should consider
increasing the disk size before you do this. Alternatively, you can enable
read-write access on an individual session, while leaving the database in
read-only mode. </highlight>
<highlight type="warning">
Do not manually enable read-write access on a database that is over 99%
capacity. Increase the disk size before you enable read-write access.
Alternatively, you can enable read-write access on an individual session, while
leaving the database in read-only mode.
</highlight>

<procedure>

Expand All @@ -118,5 +120,6 @@ read-only mode. </highlight>
```

</procedure>

As soon as the storage consumption drops below the threshold, the read-only
protection is automatically removed, and you can start writing data again.
1 change: 0 additions & 1 deletion cloud/scaling-a-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,6 @@ optimization process does not require downtime, and in most cases it happens
very quickly. However, if you have a lot of existing data, optimization can take
longer, and in some cases this could create a delay longer than six hours.


Autoscaling can only increase disk size, not decrease it. You can have a disk up
to 10&nbsp;TB in size.

Expand Down

0 comments on commit 9e2554b

Please sign in to comment.