Skip to content

Commit b0787cd

Browse files
committed
copy edit
1 parent d9aebc6 commit b0787cd

File tree

1 file changed

+17
-22
lines changed

1 file changed

+17
-22
lines changed

docs/tutorials/best-practices/scale-coder.md

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Scale Coder
1+
kl# Scale Coder
22

33
December 20, 2024
44

@@ -61,45 +61,40 @@ For a more comprehensive overview, integrate metrics with an observability dashb
6161

6262
### Observability key metrics
6363

64+
Configure alerting based on these metrics to ensure you surface problems before they affect the end-user experience.
65+
6466
**CPU and Memory Utilization**
6567

66-
- Monitor the utilization as a fraction of the available resources on the
67-
instance. Its utilization will vary with use throughout the day and over the
68-
course of the week. Monitor the trends, paying special attention to the daily
69-
and weekly peak utilization. Use long-term trends to plan infrastructure
68+
- Monitor the utilization as a fraction of the available resources on the instance.
69+
70+
Utilization will vary with use throughout the course of a day, week, and longer timelines. Monitor trends and pay special attention to the daily and weekly peak utilization. Use long-term trends to plan infrastructure
7071
upgrades.
7172

7273
**Tail latency of Coder Server API requests**
7374

74-
- Use the `coderd_api_request_latencies_seconds` metric.
75-
- High tail latency can indicate Coder Server or the PostgreSQL database is
76-
being starved for resources.
75+
- High tail latency can indicate Coder Server or the PostgreSQL database is low on resources.
76+
77+
Use the `coderd_api_request_latencies_seconds` metric.
7778

7879
**Tail latency of database queries**
7980

80-
- Use the `coderd_db_query_latencies_seconds` metric.
8181
- High tail latency can indicate the PostgreSQL database is low in resources.
8282

83-
Configure alerting based on these metrics to ensure you surface problems before
84-
end users notice them.
83+
Use the `coderd_db_query_latencies_seconds` metric.
8584

8685
## Coder Server
8786

8887
### Locality
8988

90-
If increased availability of the Coder API is a concern, deploy at least three
91-
instances. Spread the instances across nodes (e.g. via anti-affinity rules in
92-
Kubernetes), and/or in different availability zones of the same geographic
93-
region.
89+
To ensure increased availability of the Coder API, deploy at least three instances. Spread the instances across nodes with anti-affinity rules in
90+
Kubernetes or in different availability zones of the same geographic region.
91+
92+
Do not deploy in different geographic regions.
9493

95-
Do not deploy in different geographic regions. Coder Servers need to be able to
96-
communicate with one another directly with low latency, under 10ms. Note that
97-
this is for the availability of the Coder API – workspaces will not be fault
98-
tolerant unless they are explicitly built that way at the template level.
94+
Coder Servers need to be able to
95+
communicate with one another directly with low latency, under 10ms. Note that this is for the availability of the Coder API. Workspaces are not fault tolerant unless they are explicitly built that way at the template level.
9996

100-
Deploy Coder Server instances as geographically close to PostgreSQL as possible.
101-
Low-latency communication (under 10ms) with Postgres is essential for Coder
102-
Server's performance.
97+
Deploy Coder Server instances as geographically close to PostgreSQL as possible. Low-latency communication (under 10ms) with Postgres is essential for Coder Server's performance.
10398

10499
### Scaling
105100

0 commit comments

Comments
 (0)