Skip to content

Commit d9aebc6

Browse files
committed
copy edit
1 parent 46831a1 commit d9aebc6

File tree

1 file changed

+27
-33
lines changed

1 file changed

+27
-33
lines changed

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

Lines changed: 27 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -13,59 +13,53 @@ operating smoothly with a high number of active users and workspaces.
1313
Observability is one of the most important aspects to a scalable Coder
1414
deployment.
1515

16-
Identify potential bottlenecks before they negatively affect the end-user
17-
experience. It will also allow you to empirically verify that modifications you
18-
make to your deployment to increase capacity have their intended effects.
16+
[Monitor your Coder deployment](../../admin/monitoring/index.md) with log output and metrics to identify potential bottlenecks before they negatively affect the end-user experience and measure the effects of modifications you make to your deployment.
1917

20-
- Capture log output from Coder Server instances and external provisioner
21-
daemons and store them in a searchable log store.
18+
**Log output**
2219

23-
- For example: Loki, CloudWatch Logs, etc.
20+
- Capture log output from Loki, CloudWatch logs, and other tools on your Coder Server instances and external provisioner
21+
daemons and store them in a searchable log store.
2422

2523
- Retain logs for a minimum of thirty days, ideally ninety days. This allows
2624
you to look back to see when anomalous behaviors began.
2725

28-
- Metrics:
26+
**Metrics**
2927

30-
- Capture infrastructure metrics like CPU, memory, open files, and network I/O
31-
for all Coder Server, external provisioner daemon, workspace proxy, and
32-
PostgreSQL instances.
28+
- Capture infrastructure metrics like CPU, memory, open files, and network I/O for all Coder Server, external provisioner daemon, workspace proxy, and PostgreSQL instances.
3329

34-
- Capture metrics from Coder Server and external provisioner daemons via
35-
Prometheus.
30+
### Capture Coder server metrics with Prometheus
3631

37-
- On Coder Server
32+
To capture metrics from Coder Server and external provisioner daemons with [Prometheus](../../admin/integrations/prometheus.md):
3833

39-
- Enable Prometheus metrics:
34+
1. Enable Prometheus metrics:
4035

41-
```yaml
42-
CODER_PROMETHEUS_ENABLE=true
43-
```
36+
```yaml
37+
CODER_PROMETHEUS_ENABLE=true
38+
```
4439

45-
- Enable database metrics:
40+
1. Enable database metrics:
4641

47-
```yaml
48-
CODER_PROMETHEUS_COLLECT_DB_METRICS=true
49-
```
42+
```yaml
43+
CODER_PROMETHEUS_COLLECT_DB_METRICS=true
44+
```
5045

51-
- Configure agent stats to avoid large cardinality:
46+
1. Configure agent stats to avoid large cardinality:
5247

53-
```yaml
54-
CODER_PROMETHEUS_AGGREGATE_AGENT_STATS_BY=agent_name
55-
```
48+
```yaml
49+
CODER_PROMETHEUS_AGGREGATE_AGENT_STATS_BY=agent_name
50+
```
5651

57-
- To disable Agent stats:
52+
- To disable agent stats:
5853

59-
```yaml
60-
CODER_PROMETHEUS_COLLECT_AGENT_STATS=false
61-
```
54+
```yaml
55+
CODER_PROMETHEUS_COLLECT_AGENT_STATS=false
56+
```
6257

63-
- Retain metric time series for at least six months. This allows you to see
64-
performance trends relative to user growth.
58+
Retain metric time series for at least six months. This allows you to see performance trends relative to user growth.
6559

66-
- Integrate metrics with an observability dashboard, for example, Grafana.
60+
For a more comprehensive overview, integrate metrics with an observability dashboard, for example, [Grafana](../../admin/monitoring/index.md).
6761

68-
### Key metrics
62+
### Observability key metrics
6963

7064
**CPU and Memory Utilization**
7165

0 commit comments

Comments
 (0)