Skip to content

Commit 5e67b95

Browse files
committed
docs: fix built-in metrics wording and reload response example
1 parent 6b5f7c2 commit 5e67b95

File tree

2 files changed

+5
-9
lines changed

2 files changed

+5
-9
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ PG_EXPORTER_URL='postgres://user:pass@host:port/postgres' pg_exporter
6262
curl http://localhost:9630/metrics # access metrics
6363
```
6464

65-
There are 4 built-in metrics `pg_up`, `pg_version`, `pg_in_recovery`, `pg_exporter_build_info`.
65+
There are built-in metrics such as `pg_up`, `pg_version`, `pg_in_recovery`, `pg_exporter_build_info`, and exporter self-metrics under `pg_exporter_*` (disable with `--disable-intro`).
6666

6767
**All other metrics are defined in the [`pg_exporter.yml`](pg_exporter.yml) config file**.
6868

docs/api.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ PG Exporter provides a comprehensive REST API for metrics collection, health che
1616
| [`/primary`](#traffic-routing) | GET | Primary server check |
1717
| [`/replica`](#traffic-routing) | GET | Replica server check |
1818
| [`/read`](#traffic-routing) | GET | Read traffic routing |
19-
| [`/reload`](#operational) | GET | Reload configuration |
19+
| [`/reload`](#operational) | GET, POST | Reload configuration |
2020
| [`/explain`](#operational) | GET | Explain query planning |
2121
| [`/stat`](#operational) | GET | Runtime statistics |
2222

@@ -232,7 +232,7 @@ backend pg_read
232232

233233
## Operational Endpoints
234234

235-
### POST /reload
235+
### GET, POST /reload
236236

237237
Reload configuration without restarting the exporter.
238238

@@ -244,12 +244,8 @@ curl -X POST http://localhost:9630/reload
244244

245245
#### Response
246246

247-
```json
248-
{
249-
"status": "success",
250-
"message": "Configuration reloaded successfully",
251-
"timestamp": "2024-01-15T10:30:00Z"
252-
}
247+
```text
248+
server reloaded
253249
```
254250

255251
#### Response Codes

0 commit comments

Comments
 (0)