Merge branch 'main' into remove-unused-path-prefix-in-pyroscope-scrape

CHANGELOG.md

@@ -87,6 +87,10 @@ Main (unreleased)
 
 - Remove unused `path_prefix` argument in `pyroscope.scrape` component. (@hainenber)
 
+- Updated docs for MSSQL Integration to show additional authentication capabilities. (@StefanKurek)
+
+- Remove unused `path_prefix` argument in `pyroscope.scrape` component. (@hainenber)
+
 v0.39.2 (2024-1-31)
 --------------------
 

docs/sources/flow/get-started/install/ansible.md

@@ -17,15 +17,15 @@ You can use Ansible to install and manage {{< param "PRODUCT_NAME" >}} on Linux
 
 ## Before you begin
 
-- These steps assume you already have a working [Ansible](https://www.ansible.com/) setup,
-and a pre-existing inventory.
-- You can add the tasks below to any new or existing Role you choose.
+- These steps assume you already have a working [Ansible](https://www.ansible.com/) setup and a pre-existing inventory.
+- You can add the tasks below to any new or existing role.
 
 ## Steps
 
 To add {{% param "PRODUCT_NAME" %}} to a host:
 
 1. Create a file named `grafana-agent.yml` and add the following:
+
     ```yaml
     - name: Install Grafana Agent Flow
       hosts: all
@@ -43,39 +43,44 @@ To add {{% param "PRODUCT_NAME" %}} to a host:
             grafana_agent_flags_extra:
               server.http.listen-addr: '0.0.0.0:12345'
     ```
-1. Replace the following field values:
 
-   - `<path-to-config-file-on-localhost>` with the path to river configuration file on the Ansible Controller (Localhost).
+   Replace the following:
 
-1. Run the Ansible playbook
-  In the Linux machine's terminal, run the following command from the directory where the Ansible playbook is located.
+   - _`<path-to-config-file-on-localhost>`_: The path to the River configuration file on the Ansible Controller (Localhost).
+
+1. Run the Ansible playbook. Open a terminal window and run the following command from the Ansible playbook directory.
+
+   ```shell
+   ansible-playbook grafana-agent.yml
+   ```
 
-    ```shell
-    ansible-playbook grafana-agent.yml
-    ```
 ## Validate
 
-1. Grafana Agent service on the target machine should be `active` and `running`. You should see a similar output:
-<!-- vale Grafana.ReferTo = NO -->
+To verify that the {{< param "PRODUCT_NAME" >}} service on the target machine is `active` and `running`, open a terminal window and run the following command:
+
 ```shell
 $ sudo systemctl status grafana-agent.service
-  grafana-agent.service - Grafana Agent
-    Loaded: loaded (/etc/systemd/system/grafana-agent.service; enabled; vendor preset: enabled)
-    Active: active (running) since Wed 2022-07-20 09:56:15 UTC; 36s ago
-  Main PID: 3176 (agent-linux-amd)
-    Tasks: 8 (limit: 515)
-    Memory: 92.5M
-      CPU: 380ms
-    CGroup: /system.slice/grafana-agent.service
-      └─3176 /usr/local/bin/agent-linux-amd64 --config.file=/etc/grafana-cloud/agent-config.yaml
+```
+
+If the service is `active` and `running`, the output should look similar to this:
+
+```
+grafana-agent.service - Grafana Agent
+  Loaded: loaded (/etc/systemd/system/grafana-agent.service; enabled; vendor preset: enabled)
+  Active: active (running) since Wed 2022-07-20 09:56:15 UTC; 36s ago
+Main PID: 3176 (agent-linux-amd)
+  Tasks: 8 (limit: 515)
+  Memory: 92.5M
+    CPU: 380ms
+  CGroup: /system.slice/grafana-agent.service
+    └─3176 /usr/local/bin/agent-linux-amd64 --config.file=/etc/grafana-cloud/agent-config.yaml
 ```
 
 ## Next steps
 
 - [Configure {{< param "PRODUCT_NAME" >}}][Configure]
 
 {{% docs/reference %}}
-
 [Configure]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/configure/configure-linux.md"
 [Configure]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/configure/configure-linux.md"
-{{% /docs/reference %}}
+{{% /docs/reference %}}

docs/sources/flow/reference/components/prometheus.exporter.mssql.md

@@ -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

docs/sources/static/configuration/integrations/mssql-config.md

@@ -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.