From 1702b5a78e3b15f7fcad89cab51d8f03d8718e51 Mon Sep 17 00:00:00 2001 From: Stefan Kurek Date: Wed, 7 Feb 2024 15:34:07 -0500 Subject: [PATCH] Tweaks wording of MSSQL integration auth section in docs --- .../reference/components/prometheus.exporter.mssql.md | 8 +++++--- .../static/configuration/integrations/mssql-config.md | 8 +++++--- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/sources/flow/reference/components/prometheus.exporter.mssql.md b/docs/sources/flow/reference/components/prometheus.exporter.mssql.md index 012574eba7b7..b3c593e8f84d 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.mssql.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.mssql.md @@ -52,15 +52,17 @@ 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` should correspond with a SQL Server username and password. +By default, the `USERNAME` and `PASSWORD` used within the `connection_string` argument corresponds to a SQL Server username and password. -If the Grafana Agent is running in the same Windows domain as the SQL Server, then the parameter `authenticator=winsspi` can be used within the `connection_string` without any additional credentials in order to authenticate. +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://@:?authenticator=winsspi ``` -Otherwise if you would like 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` would then be the Windows username and password (domain may need to be prefixed to the username). +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://:@:?authenticator=ntlm diff --git a/docs/sources/static/configuration/integrations/mssql-config.md b/docs/sources/static/configuration/integrations/mssql-config.md index c3d991d184e8..9152414c4fc9 100644 --- a/docs/sources/static/configuration/integrations/mssql-config.md +++ b/docs/sources/static/configuration/integrations/mssql-config.md @@ -97,15 +97,17 @@ Full reference of options: ``` ### Authentication -By default, the `USERNAME` and `PASSWORD` used within the `connection_string` should correspond with a SQL Server username and password. +By default, the `USERNAME` and `PASSWORD` used within the `connection_string` argument corresponds to a SQL Server username and password. -If the Grafana Agent is running in the same Windows domain as the SQL Server, then the parameter `authenticator=winsspi` can be used within the `connection_string` without any additional credentials in order to authenticate. +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://@:?authenticator=winsspi ``` -Otherwise if you would like 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` would then be the Windows username and password (domain may need to be prefixed to the username). +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://:@:?authenticator=ntlm