Skip to content

Commit 5ccc51d

Browse files
Loquacitycharislam
andauthored
[MST] Add service info to about MST page (github#1474)
* Add service info to about MST page * All the typos ever * Reorg sections * CC fees, long running queries, connection limits * General linter happiness * Apply suggestions from code review Co-authored-by: Charis <[email protected]> Co-authored-by: Charis <[email protected]>
1 parent a57c866 commit 5ccc51d

File tree

1 file changed

+160
-49
lines changed

1 file changed

+160
-49
lines changed

mst/about-mst.md

Lines changed: 160 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ keywords: [services]
88
# About Managed Service for TimescaleDB
99

1010
Managed service for TimescaleDB is a managed TimescaleDB service hosted in more
11-
than 75 regions in AWS, Azure, or GCP. You can
12-
[try Managed Service for TimescaleDB for free][sign-up], no credit card
11+
than 75 regions in Amazon Web Services, Microsoft Azure, or Google Cloud. You
12+
can [try Managed Service for TimescaleDB for free][sign-up], no credit card
1313
required.
1414

1515
Powered by [TimescaleDB][timescale-features], you can create database instances
@@ -54,7 +54,82 @@ information about migrating data, see
5454
[migrating your data](https://docs.timescale.com/mst/latest/migrate-to-mst/).
5555
</highlight>
5656

57-
### Service configuration plans
57+
## Databases
58+
59+
Each service can contain one or more databases. To view existing databases, or
60+
to create a new database, click the name of the service in the services list,
61+
and navigate to the `Databases` tab.
62+
63+
<img class="main-content__illustration" src="https://s3.amazonaws.com/assets.timescale.com/mst-databases.png" alt="Managed Service for TimescaleDB databases list"/>
64+
65+
## Service level agreement
66+
67+
Managed Service for TimescaleDB is provided through a partnership with Aiven.
68+
This provides you with a service commitment to deliver 99.99% availability. For
69+
more information, see the
70+
[Aiven Service Level Agreement policy][aiven-sla].
71+
72+
## Billing
73+
74+
By default, all new Managed Service for TimescaleDB services require a credit
75+
card, which is charged at the end of the month for all charges accrued over that
76+
month. Each project is charged separately. Your credit card statement records
77+
the transaction as coming from Aiven, as Aiven provides billing services for
78+
Managed Service for TimescaleDB.
79+
80+
Managed Service for TimescaleDB uses hourly billing. This charge is
81+
automatically calculated, based on the services you have been running in your
82+
project. The price charged for your project includes:
83+
84+
* Virtual machine
85+
* Networking
86+
* Backups
87+
* Setting up
88+
89+
<highlight type="note">
90+
Managed Service for TimescaleDB does not charge you for network traffic used by
91+
your service. However, your application cloud service provider might charge you
92+
for the network traffic going to or from your service.
93+
</highlight>
94+
95+
Terminating or powering a service down stops the accumulation of new charges
96+
immediately. However, the minimum hourly charge unit is one hour. For example,
97+
if you launch a Managed Service for TimescaleDB service and shut it down after
98+
40 minutes, you are charged for one full hour.
99+
100+
Migrating to different service plan levels does not incur extra charges. Note,
101+
though, that some service plan levels are more costly per hour, and your new
102+
service is charged at the new rate.
103+
104+
Migrating a service to another cloud region or different cloud provider does not
105+
incur extra charges.
106+
107+
<highlight type="note">
108+
All prices listed for Managed Service for TimescaleDB are inclusive of credit
109+
card and processing fees. However, in some cases, your credit card provider
110+
might charge additional fees, such as an international transaction fee. These
111+
fees are not charged by Timescale or Aiven.
112+
</highlight>
113+
114+
### Corporate billing
115+
116+
If you prefer to pay by invoice, or if you are unable to provide a credit card
117+
for billing, you can switch your project to corporate billing instead. Under
118+
this model, invoices are generated at the end of the month based on actual
119+
usage, and are sent in PDF format by email to the billing email addresses you
120+
configured in your dashboard.
121+
122+
Payment terms for corporate invoices are 10 days net, by bank transfer, to the
123+
bank details provided on the invoice. By default, services are charged in US
124+
Dollars (USD), but you can request your invoices be sent in either Euros (EUR)
125+
or Pounds Sterling (GBP) at the invoice date's currency exchange rates.
126+
127+
To switch from credit card to corporate billing, make sure your billing profile
128+
and email address is correct in your project's billing settings, and send a message
129+
to the [Timescale support team][timescale-support] asking to be changed to corporate
130+
billing.
131+
132+
## Service configuration plans
58133

59134
When you create a new service, you need to select a configuration plan. The plan
60135
determines the number of VMs the service runs in, the high availability
@@ -63,11 +138,11 @@ configuration, the number of CPU cores, and size of RAM and storage volumes.
63138
The plans are:
64139

65140
* Basic Plans: include 2 days of backups and automatic backup and restore if
66-
your instance fails.
141+
your instance fails.
67142
* Dev Plans: include 1 day of backups and automatic backup and restore if your
68-
instance fails.
143+
instance fails.
69144
* Pro Plans: include 3 days of backups and automatic failover to a hot standby
70-
if your instance fails.
145+
if your instance fails.
71146

72147
The Basic and Dev plans are serviced by a single virtual machine (VM) node. This
73148
means that if the node fails, the service is unavailable until a new VM is
@@ -99,66 +174,102 @@ Within each configuration plan option, there are several plan types available:
99174

100175
<img class="main-content__illustration" src="https://s3.amazonaws.com/assets.timescale.com/mst-service-plans.png" alt="Managed Service for TimescaleDB selecting a service configuration plan"/>
101176

102-
## Databases
177+
## Connection limits
103178

104-
Each service can contain one or more databases. To view existing databases, or
105-
to create a new database, click the name of the service in the services list,
106-
and navigate to the `Databases` tab.
179+
Managed Service for TimescaleDB limits the maximum number of connections to each
180+
service. The maximum number of allowed connections depends on your service plan.
181+
To see the current connection limit for your service, navigate to the service
182+
`Overview` tab and locate the `Connection Limit` section.
107183

108-
<img class="main-content__illustration" src="https://s3.amazonaws.com/assets.timescale.com/mst-databases.png" alt="Managed Service for TimescaleDB databases list"/>
184+
If you have a lot of clients or client threads connecting to your database, use
185+
connection pooling to limit the number of connections. For more information
186+
about connection pooling, see the
187+
[connection pooling section][connection-pooling].
109188

110-
## Billing
189+
<highlight type="note">
190+
If you have a high number of connections to your database, your service might
191+
run more slowly, and could run out of memory. Remain aware of how many open
192+
connections your have to your database at any given time.
193+
</highlight>
111194

112-
By default, all new Managed Service for TimescaleDB services require a credit
113-
card, which is charged at the end of the month for all charges accrued over that
114-
month. Each project is charged separately.
195+
If you require a higher maximum number of connections, but cannot use connection
196+
pooling, contact the
197+
[Timescale support team][timescale-support].
115198

116-
Managed Service for TimescaleDB uses hourly billing. This charge is
117-
automatically calculated, based on the services you have been running in your
118-
project. The price charged for your project includes:
199+
## Service termination protection
119200

120-
* Virtual machine
121-
* Networking
122-
* Backups
123-
* Setting up
201+
You can protect your services from accidentally being terminated, by enabling
202+
service termination protection. When termination protection is enabled, you
203+
cannot power down the service from the web console, the REST API, or with a
204+
command-line client. To power down a protected service, you need to turn off
205+
termination protection first. Termination protection does not interrupt service
206+
migrations or upgrades.
124207

125-
<highlight type="note">
126-
Managed Service for TimescaleDB does not charge you for network traffic used by
127-
your service. However, your application cloud service provider might charge you
128-
for the network traffic going to or from your service.
208+
To enable service termination protection, navigate to the service `Overview`
209+
tab. Locate the `Termination protection` section, and toggle to enable
210+
protection.
211+
212+
<highlight type="important">
213+
If you run out of free sign-up credit, and have not entered a valid credit card
214+
for payment, your service is powered down, even if you have enabled termination
215+
protection.
129216
</highlight>
130217

131-
Terminating or powering a service down stops the accumulation of new charges
132-
immediately. However, the minimum hourly charge unit is one hour. For example,
133-
if you launch a Managed Service for TimescaleDB service and terminate it after
134-
40 minutes, you are charged for one full hour.
218+
## Idle connections
135219

136-
Migrating to different service plan levels does not incur extra charges. Note,
137-
though, that some service plan levels are more costly per hour, and your new
138-
service is charged at the new rate.
220+
Managed Service for TimescaleDB uses the default keep alive settings for TCP
221+
connections. The default settings are:
139222

140-
Migrating a service to another cloud region or different cloud provider does not
141-
incur extra charges.
223+
* `tcp_keepalives_idle`: 7200
224+
* `tcp_keepalive_count`: 9
225+
* `tcp_keepalives_interval`: 75
142226

143-
### Corporate billing
227+
If you have long idle database connection sessions, you might need to adjust
228+
these settings to ensure that your TCP connection remains stable. If you
229+
experience a broken TCP connection, when you reconnect make sure that your
230+
client resolves the DNS address correctly, as the underlying address changes
231+
during automatic failover.
144232

145-
If you prefer to pay by invoice, or if you are unable to provide a credit card
146-
for billing, you can switch your project to corporate billing instead. Under
147-
this model, invoices are generated at the end of the month based on actual
148-
usage, and are sent in PDF format by email to the billing email addresses you
149-
configured in your dashboard.
233+
For more information about adjusting keep alive settings, see the
234+
[PostgreSQL documentation][pg-keepalive].
150235

151-
Payment terms for corporate invoices are 10 days net, by bank transfer, to the
152-
bank details provided on the invoice. By default, services are charged in US
153-
Dollars (USD), but you can request your invoices be sent in either Euros (EUR)or
154-
Pounds Sterling (GBP) at the invoice date's currency exchange rates.
236+
## Long running queries
155237

156-
To switch from credit card to corporate billing, make sure your billing profile
157-
and email address is correct in project's billing settings, and send a message
158-
to [our support team][timescale-support] asking to be changed to corporate
159-
billing.
238+
Managed Service for TimescaleDB does not cancel database queries. If you
239+
have created a query that is taking a very long time, or that has hung, it could
240+
lock resources on your service, and could prevent database administration tasks
241+
from being performed.
242+
243+
You can find out if you have any long-running queries by navigating to the
244+
service `Current Queries` tab. You can also cancel long running queries from
245+
this tab.
246+
247+
Alternatively, you can use your connection client to view running queries with
248+
this command:
249+
250+
```sql
251+
SELECT * FROM pg_stat_activity
252+
WHERE state <> 'idle';
253+
```
254+
255+
Cancel long-running queries using this command, with the PID of the query you
256+
want to cancel:
257+
258+
```sql
259+
SELECT pg_terminate_backend(<PID>);
260+
```
261+
262+
If you want to automatically cancel any query that runs over a specified length
263+
of time, you can use this command:
264+
265+
```sql
266+
SET statement_timeout = <milliseconds>
267+
```
160268

161269
[timescale-features]: https://www.timescale.com/products/#features
162270
[mst-install]: /install/:currentVersion:/installation-mst/
163271
[sign-up]: https://www.timescale.com/cloud-signup
164272
[timescale-support]: https://www.timescale.com/support
273+
[aiven-sla]: https://aiven.io/sla
274+
[pg-keepalive]: http://www.postgresql.org/docs/9.5/static/libpq-connect.html#LIBPQ-KEEPALIVES
275+
[connection-pooling]: /mst/:currentversion/connection-pools/

0 commit comments

Comments
 (0)