Skip to content

Commit 56513fa

Browse files
docs: minor updates [skip ci] (burningalchemist#546)
1 parent 607a51e commit 56513fa

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,8 @@ collector_files:
132132
- "*.collector.yml"
133133
```
134134
135-
**NOTE:** The `collectors` and `collector_files` configurations support [Glob pattern matching](https://pkg.go.dev/path/filepath#Match).
135+
> [!NOTE]
136+
> The `collectors` and `collector_files` configurations support [Glob pattern matching](https://pkg.go.dev/path/filepath#Match).
136137
To match names with literal pattern terms in them, e.g. `collector_*1*`, these must be escaped: `collector_\*1\*`.
137138

138139
### Collectors
@@ -177,16 +178,17 @@ metrics:
177178
To keep things simple and yet allow fully configurable database connections, SQL Exporter uses DSNs (like
178179
`sqlserver://prom_user:prom_password@dbserver1.example.com:1433`) to refer to database instances.
179180

180-
Since v0.9.0 `sql_exporter` relies on `github.com/xo/dburl` package for parsing Data Source Names (DSN).
181-
This can potentially affect your connection to certain databases like MySQL, so you might want to adjust your connection
182-
string accordingly:
181+
This exporter relies on `xo/dburl` package for parsing Data Source Names (DSN). The goal is to have a
182+
unified way to specify DSNs across all supported databases. This can potentially affect your connection to certain
183+
databases like MySQL, so you might want to adjust your connection string accordingly:
183184

184185
```plaintext
185186
mysql://user:pass@localhost/dbname - for TCP connection
186187
mysql:/var/run/mysqld/mysqld.sock - for Unix socket connection
187188
```
188189

189-
If your DSN contains special characters in any part of your connection string (including passwords), you might need to
190+
> [!IMPORTANT]
191+
> If your DSN contains special characters in any part of your connection string (including passwords), you might need to
190192
apply [URL encoding](https://en.wikipedia.org/wiki/URL_encoding#Reserved_characters) (percent-encoding) to them.
191193
For example, `p@$$w0rd#abc` then becomes `p%40%24%24w0rd%23abc`.
192194

@@ -243,7 +245,7 @@ we need to make some adjustments to the configuration:
243245
- add `enable_ping: false` to the metric/job configuration as PgBouncer doesn't support the ping command;
244246
- add `no_prepared_statement: true` to the metric/job configuration as PgBouncer doesn't support the extended query protocol;
245247

246-
Note: For libpq(postgres) we only need to add `no_prepared_statement: true` parameter. For pgx driver, we also need to
248+
For libpq (postgres) driver we only need to set `no_prepared_statement: true` parameter. For pgx driver, we also need to
247249
add `default_query_exec_mode=simple_protocol` parameter to the DSN (for v5).
248250

249251
Below is an example of a metric configuration for PgBouncer:

0 commit comments

Comments
 (0)