Skip to content

Commit

Permalink
improve the description of the memory in observability doc (#551)
Browse files Browse the repository at this point in the history
  • Loading branch information
sollhui authored Oct 12, 2024
1 parent bcaf9a8 commit a8cee7f
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
4 changes: 4 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ Release Notes.

## 0.8.0

### Documentation

- Improve the description of the memory in observability doc.

### Chores

- Fix metrics system typo.
Expand Down
2 changes: 1 addition & 1 deletion docs/operation/grafana-cluster.json
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"description": "The total memory is the total memory available on the system.",
"description": "The total memory is the total physical memory available on the system, which means total amount of RAM on the system.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down
2 changes: 1 addition & 1 deletion docs/operation/observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The write rate is the number of write operations per second. It is calculated by

#### Total Memory

The total memory is the total memory available on the system.
The total memory is the total physical memory available on the system, which means total amount of RAM on the system.

**Expression**: `sum(banyandb_system_memory_state{job=~\"$job\", instance=~\"$instance\",kind=\"total\"})`

Expand Down

0 comments on commit a8cee7f

Please sign in to comment.