Skip to content

Commit a3a4e0a

Browse files
docs: update README.md (#891)
1 parent 117029c commit a3a4e0a

1 file changed

Lines changed: 12 additions & 10 deletions

File tree

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -176,14 +176,15 @@ metrics:
176176
GROUP BY Market
177177
```
178178
179-
### Data Source Names (DSN)
179+
### Database URLs (URL-format DSNs)
180180
181-
To keep things simple and yet allow fully configurable database connections, SQL Exporter uses DSNs (like
182-
`sqlserver://prom_user:prom_password@dbserver1.example.com:1433`) to refer to database instances.
181+
To keep things simple and yet allow fully configurable database connections, SQL Exporter uses database URLs
182+
(URL-format DSNs) (like `sqlserver://prom_user:prom_password@dbserver1.example.com:1433`) to refer to database
183+
instances.
183184

184-
This exporter relies on `xo/dburl` package for parsing Data Source Names (DSN). The goal is to have a
185-
unified way to specify DSNs across all supported databases. This can potentially affect your connection to certain
186-
databases like MySQL, so you might want to adjust your connection string accordingly:
185+
This exporter relies on `xo/dburl` package for parsing URL-format DSNs. The goal is to have a unified way to specify
186+
DSNs across all supported databases. This can potentially affect your connection to certain databases like MySQL, so
187+
you might want to adjust your connection string accordingly:
187188

188189
```plaintext
189190
mysql://user:pass@localhost/dbname - for TCP connection
@@ -192,8 +193,8 @@ mysql:/var/run/mysqld/mysqld.sock - for Unix socket connection
192193

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

198199
For additional details please refer to [xo/dburl](https://github.com/xo/dburl) documentation.
199200

@@ -301,8 +302,9 @@ This may result in the following error:
301302
unsupported Scan, storing driver.Value type []uint8 into type *time.Time
302303
```
303304

304-
To resolve the issue, make sure to include `parseTime=true` as a parameter on the DSN, so values with TIMESTAMP, DATETIME, TIME, DATE types
305-
will end up as `time.Time` type, which is a requirement on the sql_exporter side to process the value correctly.
305+
To resolve the issue, make sure to include `parseTime=true` as a parameter on the DSN, so values with TIMESTAMP,
306+
DATETIME, TIME, DATE types will end up as `time.Time` type, which is a requirement on the sql_exporter side to process
307+
the value correctly.
306308
</details>
307309

308310
<details>

0 commit comments

Comments
 (0)