Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MSSQL Integration - Update documentation with extra windows authentication details #6325

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ Main (unreleased)

- Use Go 1.22 for builds. (@rfratto)

- Updated docs for MSSQL Integration to show additional authentication capabilities. (@StefanKurek)

v0.39.2 (2024-1-31)
--------------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,23 @@ If specified, the `query_config` argument must be a YAML document as string defi

See [sql_exporter](https://github.com/burningalchemist/sql_exporter#collectors) for details on how to create a configuration.

### Authentication
By default, the `USERNAME` and `PASSWORD` used within the `connection_string` argument corresponds to a SQL Server username and password.

If {{< param "PRODUCT_ROOT_NAME" >}} is running in the same Windows domain as the SQL Server, then you can use the parameter `authenticator=winsspi` within the `connection_string` to authenticate without any additional credentials.

```conn
sqlserver://@<HOST>:<PORT>?authenticator=winsspi
```

If you want to use Windows credentials to authenticate, instead of SQL Server credentials, you can use the parameter `authenticator=ntlm` within the `connection_string`.
The `USERNAME` and `PASSWORD` then corresponds to a Windows username and password.
The Windows domain may need to be prefixed to the username with a trailing `\`.

```conn
sqlserver://<DOMAIN\USERNAME>:<PASSWORD>@<HOST>:<PORT>?authenticator=ntlm
```

## Blocks

The `prometheus.exporter.mssql` component does not support any blocks, and is configured
Expand Down
17 changes: 17 additions & 0 deletions docs/sources/static/configuration/integrations/mssql-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,23 @@ Full reference of options:
[- <queries> ... ]]
```

### Authentication
By default, the `USERNAME` and `PASSWORD` used within the `connection_string` argument corresponds to a SQL Server username and password.

If Grafana Agent is running in the same Windows domain as the SQL Server, then you can use the parameter `authenticator=winsspi` within the `connection_string` to authenticate without any additional credentials.

```conn
sqlserver://@<HOST>:<PORT>?authenticator=winsspi
```

If you want to use Windows credentials to authenticate, instead of SQL Server credentials, you can use the parameter `authenticator=ntlm` within the `connection_string`.
The `USERNAME` and `PASSWORD` then corresponds to a Windows username and password.
The Windows domain may need to be prefixed to the username with a trailing `\`.

```conn
sqlserver://<DOMAIN\USERNAME>:<PASSWORD>@<HOST>:<PORT>?authenticator=ntlm
```

## Custom metrics
You can use the optional `query_config` parameter to retrieve custom Prometheus metrics for a MSSQL instance.

Expand Down
Loading