diff --git a/.htmltest.yml b/.htmltest.yml index 8500da2c8..109d0012b 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -45,3 +45,5 @@ IgnoreDirs: - "docs/2024.5/?.*/" - "docs/2024.7/?.*/" - "docs/2024.11/?.*/" +- "docs/2025.1/?.*/" +- "docs/2025.5/?.*/" diff --git a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/architecture.md b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/architecture.md index 6c2b36499..5bf3764c2 100644 --- a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/architecture.md +++ b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/architecture.md @@ -12,8 +12,8 @@ weight: 10 | Component | Purpose | Required/Optional |Server Role | |-----------|---------|----------|------------| | [Grafana][] | Web application that provides querying and visualisation of data in the form of dashboards. | Required | Grafana Cloud managed service | +| [Grafana Alloy][] | An observability collector that can ingest logs and send them to a Grafana Loki instance. It should be deployed to every machine that has a Microsoft Service Fabric node used by {{% ctx %}}. | Required | Application Server | | [Grafana Loki][Grafana Loki] | Log aggregation system designed to store and query logs from applications and infrastructure. | Required | Grafana Cloud managed service | -| [Promtail][] | An agent which ships the contents of local logs to a Grafana Loki instance. It should be deployed to every machine that has a Microsoft Service Fabric node used by {{% ctx %}}. | Required | Application Server | ## Recommended Architecture @@ -27,6 +27,6 @@ The following architecture requires 1..n Application servers and 1 [Grafana Clou [Prerequisites]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.Prerequisites.MainDoc" >}} [Grafana]: {{< url path="Grafana.Products.Grafana.MainDoc" >}} +[Grafana Alloy]: {{< url path="Grafana.Products.Loki.Alloy.MainDoc" >}} [Grafana Cloud]: {{< url path="Grafana.MainDoc" >}} [Grafana Loki]: {{< url path="Grafana.Products.Loki.MainDoc" >}} -[Promtail]: {{< url path="Grafana.Products.Loki.Promtail.MainDoc" >}} diff --git a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/import-dashboards.md b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/import-dashboards.md index 9a481bc26..89add7acd 100644 --- a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/import-dashboards.md +++ b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/import-dashboards.md @@ -57,7 +57,7 @@ To do this, follow these steps for all default {{% ctx %}} dashboards imported: 1. Select your [configured Loki data source][] in the *Adhoc Options* > *Data source* drop-down menu, e.g. *grafanacloud-cortex-logs*. 1. Click *Apply*. 1. Click the dashboard name in the breadcrumb at the top left corner of the page to go back to the dashboard. -1. Click the + icon next to the Custom Filter to confirm that a list of available filter options is visible. If Grafana Loki has not received any logs from Promtail there will be no options available for selection. +1. Click the + icon next to the Custom Filter to confirm that a list of available filter options is visible. If Grafana Loki has not received any logs from Grafana Alloy there will be no options available for selection. 1. Repeat steps 2 - 9 for all additional default dashboards. ## Next Steps? @@ -66,6 +66,6 @@ To do this, follow these steps for all default {{% ctx %}} dashboards imported: [configured Loki data source]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupLoki.MainDoc" >}} [Grafana]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupGrafana.MainDoc" >}} -[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.3.0.0.GrafanaDashboardsZip" >}} +[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.4.0.0.GrafanaDashboardsZip" >}} [Loki]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupLoki.MainDoc" >}} [Try it Out]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.TryItOut.MainDoc" >}} \ No newline at end of file diff --git a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/_index.md b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/_index.md new file mode 100644 index 000000000..eab08d409 --- /dev/null +++ b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/_index.md @@ -0,0 +1,6 @@ +--- +title: "Install Grafana Alloy" +linkTitle: "Install Grafana Alloy" +description: "Information about installing and configuring Grafana Alloy on the Application Server(s)." +weight: 50 +--- diff --git a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md new file mode 100644 index 000000000..c5996a07e --- /dev/null +++ b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md @@ -0,0 +1,35 @@ +--- +title: "Configure Grafana Alloy" +linkTitle: "Configure Grafana Alloy" +description: "Information about configuring Grafana Alloy on the Application Server(s)." +weight: 20 +--- + +# {{% param title %}} + +This guide describes how to configure Grafana Alloy on the Application Server(s). + +{{% alert type="note" title="Note" %}}These steps must be performed for every Grafana Alloy installation in the cluster.{{% /alert %}} + +## Configure Grafana Alloy + +1. Open the `config.alloy` configuration file, which is located in the folder alongside the `alloy-installer-windows-amd64.exe` file. +1. Set the `__path__` in the `local.file_match "ApiGateway"` > `path_targets` section to the path of the `Logs` folder specified in the `appSettings.json` file during installation of the API Gateway Service, e.g. `"C:/ProgramData/Cortex/API Gateway Service/Logs/**/ServiceFabricHttpEventLog-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]{_[0-9][0-9][0-9],}.json"`. +1. Set the Grafana Loki `url` in the `loki.write "default"` > `endpoint` section, which can be found at the end of the file, with the url value noted down during the [Setup Grafana Loki][] steps. + + A correct URL should be similar to `https://239948:eyJrIjoiaWVjNzE4MmVjOThkNTgxMMQ5MzIyZjdlMjAyYWY4NWJjO1I1OTc4NSIsIm4iOiJUZXN0S2V5IiwiaWQiOjY4Nzk0MX0=@logs-prod-008.grafana.net/api/prom/push`. +1. Delete the line containing `bearer_token_file` in the `loki.write "default"` > `endpoint` section, which can be found at the end of the file. +1. Save the file. + +### Re-Start the Grafana Alloy Service + +1. Open `services.msc`. +1. Locate the `Alloy` service. +1. Right click on the service name and select `Restart`. If the service is not already running, select `Start`. + +## Next Steps? + +1. [Import Dashboards][] + +[Import Dashboards]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.ImportDashboards.MainDoc" >}} +[Setup Grafana Loki]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupLoki.SetUpGrafanaLoki" >}} diff --git a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md new file mode 100644 index 000000000..edd3cfed4 --- /dev/null +++ b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md @@ -0,0 +1,31 @@ +--- +title: "Install Grafana Alloy" +linkTitle: "Install Grafana Alloy" +description: "Information about installing Grafana Alloy on the Application Server(s)." +weight: 10 +--- + +# {{% param title %}} + +This guide describes how to install Grafana Alloy on the Application Server(s). Please ensure that the [Prerequisites][] have been completed before starting this installation. + +## Install Grafana Alloy + +1. Download the [Grafana Alloy 1.10.0][] archive. +1. Extract content of the downloaded archive to a suitable location, e.g. `C:\Program Data\Cortex\Observability\Grafana Alloy`. +1. Download the [Grafana Alloy.zip][] archive and extract its contents alongside the previously extracted Grafana Alloy `alloy-installer-windows-amd64.exe`. +This archive contains the `config.alloy` configuration file and PowerShell scripts to install Grafana Alloy as a Windows service. +1. Run Windows PowerShell as Administrator +1. Change the location to where all the files were extracted to in step 2, e.g. `cd "C:\Program Data\Cortex\Observability\Grafana Alloy"`. +1. Execute the `.\Install-Alloy.ps1` command to install the downloaded `alloy-installer-windows-amd64.exe` as a service. +1. When prompted, enter the credentials that the Grafana Alloy Service should run as. +1. When prompted to enter the bearer token, leave it blank and press Enter. + +## Next Steps? + +1. [Configure Grafana Alloy][] + +[Configure Grafana Alloy]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.InstallAlloy.ConfigureAlloy.MainDoc" >}} +[Grafana Alloy 1.10.0]: {{< url path="Grafana.Products.Loki.Alloy.1.10.0" >}} +[Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.4.0.0.GrafanaAlloyInstallZip" >}} +[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}} diff --git a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-promtail/_index.md b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-promtail/_index.md deleted file mode 100644 index 6f53df537..000000000 --- a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-promtail/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Install Promtail" -linkTitle: "Install Promtail" -description: "Information about installing and configuring Promtail on the Application Server(s)." -weight: 50 ---- diff --git a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-promtail/configure-promtail.md b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-promtail/configure-promtail.md deleted file mode 100644 index 4546b0a10..000000000 --- a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-promtail/configure-promtail.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "Configure Promtail" -linkTitle: "Configure Promtail" -description: "Information about configuring Promtail on the Application Server(s)." -weight: 20 ---- - -# {{% param title %}} - -This guide describes how to configure Promtail on the Application Server(s). - -{{% alert type="note" title="Note" %}}These steps must be performed for every Promtail installation in the cluster.{{% /alert %}} - -## Configure Promtail - -### Set Client URL for Grafana Loki - -1. Open the `promtail-local-config.yaml` configuration file, which is located in the folder alongside the `promtail-windows-amd64.exe` file. -1. Replace the Grafana Loki `URL` template in the `clients` section with the `url` value noted down during [Set Up Grafana Loki][] steps. - A correct URL should be similar to `https://239948:eyJrIjoiaWVjNzE4MmVjOThkNTgxMMQ5MzIyZjdlMjAyYWY4NWJjO1I1OTc4NSIsIm4iOiJUZXN0S2V5IiwiaWQiOjY4Nzk0MX0=@logs-prod-008.grafana.net/api/prom/push`. -1. Save the file. - -### Set the positions.yaml File Path - -1. Open the `promtail-local-config.yaml` configuration file, which is located in the folder alongside the `promtail-windows-amd64.exe` file. -1. Set the `filename` in the `positions` section to the location where you want the `positions.yaml` file to be created on Promtail startup, e.g. `C:/Program Data/Cortex/Observability/Promtail/Positions.yaml`. -1. Create all the folders of the path specified in the previous step. -1. Save the file. - -{{% alert title="Note" %}} -If the specified path to the folder for the `positions.yaml` file doesn't exists, the file will not get created on Promtail startup. -{{% /alert %}} - -### Set the Path to the API Gateway Service Log Files - -1. Open the `promtail-local-config.yaml` configuration file, which is located in the folder alongside the `promtail-windows-amd64.exe` file. -1. Set the `__path__` in the `static_configs` > `targets` > `labels` section to the path of the `Logs` folder specified in the `appSettings.json` file during installation of the API Gateway Service, e.g. `"C:/ProgramData/Cortex/API Gateway Service/Logs/*.json"`. -1. Save the file. - -### Start Promtail - -1. Run Windows PowerShell as Administrator. -1. Change the location to the folder where the `promtail-windows-amd64.exe` file is located. -1. Execute the `.\Start-Promtail.ps1` command to start the Promtail Windows service. - -## Next Steps? - -1. [Import Dashboards][] - -[Import Dashboards]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.ImportDashboards.MainDoc" >}} -[Set Up Grafana Loki]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupLoki.SetUpGrafanaLoki" >}} diff --git a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-promtail/install-promtail.md b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-promtail/install-promtail.md deleted file mode 100644 index c40dde7a5..000000000 --- a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-promtail/install-promtail.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Install Promtail" -linkTitle: "Install Promtail" -description: "Information about installing Promtail on the Application Server(s)." -weight: 10 ---- - -# {{% param title %}} - -This guide describes how to install Promtail on the Application Server(s). Please ensure that the [Prerequisites][] have been completed before starting this installation. - -## Install Promtail - -1. Download [Promtail 3.0.0][] archive. -1. Extract content of the downloaded archive to a suitable location, e.g. `C:\Program Data\Cortex\Observability\Promtail`. -1. Download the [Promtail Install.zip][] archive and extract its contents alongside the previously extracted Promtail `promtail-windows-amd64.exe`. -This archive contains the `promtail-local-config.yaml` configuration file, [NSSM][] (the Non-Sucking Service Manager program) and PowerShell scripts to help manage Promtail as a Windows service. -1. Run Windows PowerShell as Administrator -1. Change the location to where all the files were extracted to in step 2, e.g. `cd "C:\Program Data\Cortex\Observability\Promtail"`. -1. Execute the `.\Install-Promtail.ps1` command to install the downloaded `promtail-windows-amd64.exe` as a service. - -## Next Steps? - -1. [Configure Promtail][] - -[Configure Promtail]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.InstallPromtail.ConfigurePromtail.MainDoc" >}} -[NSSM]: {{< url path="NSSM.MainDoc" >}} -[Prerequisites]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.Prerequisites.MainDoc" >}} -[Promtail 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.3.0.0.PromtailInstallZip" >}} -[Promtail Install.zip]: {{< url path="GitHub.Cortex.Observability.3.0.0.PromtailInstallZip" >}} diff --git a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/prerequisites.md b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/prerequisites.md index 76e8f4072..d6cc2bb0e 100644 --- a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/prerequisites.md +++ b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/prerequisites.md @@ -10,7 +10,7 @@ The prerequisites required for each server role (as described in [Architecture][ ## Hardware Requirements -The application servers (as described in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Architecture" title="Architecture" >}}) to which Promtail will be added have already been installed as part of the {{% ctx %}} install process and do not require any hardware modifications for the observability platform installation. +The application servers (as described in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Architecture" title="Architecture" >}}) to which Grafana Alloy will be added have already been installed as part of the {{% ctx %}} install process and do not require any hardware modifications for the observability platform installation. {{% alert title="Note" %}} The application servers must have internet access in order to communicate with the Grafana Cloud managed service. @@ -21,7 +21,7 @@ The application servers must have internet access in order to communicate with t | Server Role | Windows Server[^1] | Other Software | |--------------------|------------------------------------------------|--------------------| -| Application Server | [2022 (x64)][] *Recommended*
[2019 (x64)][] | [Promtail 3.0.0][] | +| Application Server | [2022 (x64)][] *Recommended*
[2019 (x64)][] | [Grafana Alloy 1.10.0][] | [^1]: Windows Server Standard and Datacenter editions are supported. Filesystem **must be NTFS** and networking **must use IPv4**. Linux is not supported, but may be in the future. @@ -48,6 +48,10 @@ These requirements apply to each of the Application Servers. A domain user which is a member of the Local Administrators group on all Application Servers must be available to perform the installation. +#### Service User + +Grafana Alloy requires a domain user that is not a member of the Local Administrators group on any of the Application Servers. This user must be given the `Log on as a service` right otherwise the service will not be able to run. This permission will be granted as part of the install if it is not already granted. + ## Next Steps? 1. [Set up Grafana][] @@ -55,5 +59,5 @@ A domain user which is a member of the Local Administrators group on all Applica [2019 (x64)]: {{< url path="Microsoft.Downloads.Windows.Server2019" >}} [2022 (x64)]: {{< url path="Microsoft.Downloads.Windows.Server2022" >}} [Architecture]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.Architecture.MainDoc" >}} -[Promtail 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.3.0.0.PromtailInstallZip" >}} +[Grafana Alloy 1.10.0]: {{< url path="Grafana.Products.Loki.Alloy.1.10.0" >}} [Set up Grafana]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupGrafana.MainDoc" >}} diff --git a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/setup-loki.md b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/setup-loki.md index d8495b8b6..f086f2c35 100644 --- a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/setup-loki.md +++ b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/setup-loki.md @@ -26,8 +26,8 @@ The token name is used in the Grafana Cloud website to easily identify the key a ## Next Steps? -1. [Install Promtail][] +1. [Install Grafana Alloy][] -[Install Promtail]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.InstallPromtail.MainDoc" >}} +[Install Grafana Alloy]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.InstallAlloy.MainDoc" >}} [Prerequisites]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.Prerequisites.MainDoc" >}} [Sign Up For Grafana Cloud]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupGrafana.SignUpForGrafanaCloud" >}} diff --git a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/architecture.md b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/architecture.md index 09c898254..322188254 100644 --- a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/architecture.md +++ b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/architecture.md @@ -12,9 +12,9 @@ weight: 10 | Component | Purpose | Required/Optional |Server Role | |-----------|---------|----------|------------| | [Grafana][] | Web application that provides querying and visualisation of data in the form of dashboards. | Required | Web Application Server | +| [Grafana Alloy][] | An observability collector that can ingest logs and send them to a Grafana Loki instance. It should be deployed to every machine that has a Microsoft Service Fabric node used by {{% ctx %}}. | Required | Application Server | | [Grafana Loki][] | Log aggregation system designed to store and query logs from applications and infrastructure. | Required | Web Application Server | | [Microsoft Internet Information Services (IIS)][IIS] | Web server used as a reverse proxy for Grafana Loki. | Required | Web Application Server | -| [Promtail][] | An agent which ships the contents of local logs to a Grafana Loki instance. It should be deployed to every machine that has a Microsoft Service Fabric node used by {{% ctx %}}. | Required | Application Server | ## Recommended Architecture @@ -35,6 +35,6 @@ The following architecture requires 1 + 1..n servers: [Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}} [Grafana]: {{< url path="Grafana.Products.Grafana.MainDoc" >}} +[Grafana Alloy]: {{< url path="Grafana.Products.Loki.Alloy.MainDoc" >}} [Grafana Loki]: {{< url path="Grafana.Products.Loki.MainDoc" >}} -[Promtail]: {{< url path="Grafana.Products.Loki.Promtail.MainDoc" >}} [IIS]: {{< url path="IIS.MainDoc" >}} diff --git a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/_index.md b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/_index.md new file mode 100644 index 000000000..eab08d409 --- /dev/null +++ b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/_index.md @@ -0,0 +1,6 @@ +--- +title: "Install Grafana Alloy" +linkTitle: "Install Grafana Alloy" +description: "Information about installing and configuring Grafana Alloy on the Application Server(s)." +weight: 50 +--- diff --git a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md new file mode 100644 index 000000000..999518b37 --- /dev/null +++ b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md @@ -0,0 +1,59 @@ +--- +title: "Configure Grafana Alloy" +linkTitle: "Configure Grafana Alloy" +description: "Information about configuring Grafana Alloy on the Application Server(s)." +weight: 20 +--- + +# {{% param title %}} + +This guide describes how to configure Grafana Alloy on the Application Server(s). + +{{% alert type="note" title="Note" %}}These steps must be performed for every Grafana Alloy installation in the cluster.{{% /alert %}} + +## Install Certificate + +If a self-signed certificate was obtained in the [prerequisites][], the CA certificate used to create this certificate must be imported on each Application Server. Otherwise, Grafana Alloy will not be able to establish communication with Grafana Loki. + +To import the CA certificate: + +1. Copy the `cortexCA.pfx` CA certificate created during the [root CA certificate generation][Generate The Root CA Certificate] steps into a suitable location on the Application Server. +1. Double click on the `cortexCA.pfx` file to import the certificate into the Windows Certificate Store. +1. Select `Local Machine` then click `Next`. +1. Click `Next`. +1. Enter the Export Password which the certificate was generated with then click `Next`. +1. Select `Place all certificates in the following store`. +1. Click `Browse…`. +1. Select `Trusted Root Certification Authorities`, click `OK` then click `Next`. +1. Click `Finish`. + +## Configure Grafana Alloy + +1. Open the `config.alloy` configuration file, which is located in the folder alongside the `alloy-installer-windows-amd64.exe` file. +1. Set the `__path__` in the `local.file_match "ApiGateway"` > `path_targets` section to the path of the `Logs` folder specified in the `appSettings.json` file during installation of the API Gateway Service, e.g. `"C:/ProgramData/Cortex/API Gateway Service/Logs/**/ServiceFabricHttpEventLog-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]{_[0-9][0-9][0-9],}.json"`. +1. Set the Grafana Loki `url` in the `loki.write "default"` > `endpoint` section which can be found at the end of the file. + + The following template has been provided for convenience: + `https://:/loki/api/v1/push` +| Element | Description | +|------|-------------| +| loki host address | The host address of the machine where the Grafana Loki reverse proxy was configured during [Add a New Website][] steps. This must match the configured host name. | +| loki reverse proxy port | The port of the Grafana Loki reverse proxy configured during [Add a New Website][] steps. Usually 2100. | + + A correct URL should be similar to `https://hostaddress:2100/loki/api/v1/push`. +1. Save the file. + +### Re-Start the Grafana Alloy Service + +1. Open `services.msc`. +1. Locate the `Alloy` service. +1. Right click on the service name and select `Restart`. If the service is not already running, select `Start`. + +## Next Steps? + +1. [Setup Grafana][] + +[Add a New Website]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.AddANewWebsite" >}} +[Generate The Root CA Certificate]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Advanced.GenerateTheRootCaCertificate" >}} +[prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.WebAppCertificateRequirements" >}} +[Setup Grafana]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.SetupGrafana" >}} diff --git a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md new file mode 100644 index 000000000..d81d8bfe1 --- /dev/null +++ b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md @@ -0,0 +1,32 @@ +--- +title: "Install Grafana Alloy" +linkTitle: "Install Grafana Alloy" +description: "Information about installing Grafana Alloy on the Application Server(s)." +weight: 10 +--- + +# {{% param title %}} + +This guide describes how to install Grafana Alloy on the Application Server(s). Please ensure that the [Prerequisites][] have been completed before starting this installation. + +## Install Grafana Alloy + +1. Download the [Grafana Alloy 1.10.0][] archive. +1. Extract content of the downloaded archive to a suitable location, e.g. `C:\Program Data\Cortex\Observability\Grafana Alloy`. +1. Download the [Grafana Alloy.zip][] archive and extract its contents alongside the previously extracted Grafana Alloy `alloy-installer-windows-amd64.exe`. +This archive contains the `config.alloy` configuration file and PowerShell scripts to install Grafana Alloy as a Windows service. +1. Run Windows PowerShell as Administrator +1. Change the location to where all the files were extracted to in step 2, e.g. `cd "C:\Program Data\Cortex\Observability\Grafana Alloy"`. +1. Execute the `.\Install-Alloy.ps1` command to install the downloaded `alloy-installer-windows-amd64.exe` as a service. +1. When prompted, enter the credentials that the Grafana Alloy Service should run as. +1. When prompted, enter the bearer token that was specified when [configuring authentication for the Reverse Proxy][Reverse Proxy Authentication] + +## Next Steps? + +1. [Configure Grafana Alloy][] + +[Configure Grafana Alloy]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallAlloy.ConfigureAlloy" >}} +[Grafana Alloy 1.10.0]: {{< url path="Grafana.Products.Loki.Alloy.1.10.0" >}} +[Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.4.0.0.GrafanaAlloyInstallZip" >}} +[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}} +[Reverse Proxy Authentication]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.ConfigureAuthentication" >}} diff --git a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/configure-loki.md b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/configure-loki.md index 3db8584be..22d70b1cc 100644 --- a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/configure-loki.md +++ b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/configure-loki.md @@ -28,18 +28,6 @@ To verify the certificate is imported: All of the steps must be carried out on the Web Application Server. -### Install IIS Basic Authentication - -1. Run *Server Manager*. -1. Expand the *Manage* menu and select *Add Roles and Features*. -1. In the left-hand menu, select *Server Selection*. -1. Select the name of the Web Application Server, click *Next*. -1. On the *Server Roles* page, in the *Roles* tree, expand *Web Server (IIS)* --> *Web Server* --> *Security*. -1. Select *Basic Authentication*, click *Next*. -1. Click *Next* to get to the *Confirm installation selections* page. -1. Click *Install*. -1. Click *Close* on the *Results* page. - ### Install IIS URL Rewrite Module 1. Download the [URL Rewrite module 2.1][] @@ -78,15 +66,43 @@ To set up a reverse proxy, carry out the following configuration. - *SSL certificate*: Select the certificate created as part of the [Certificate Requirements][prerequisites] instructions. - Click *OK* to add the website. -#### Enable Basic Authentication +#### Configure URL Rewrite Rules + +##### Configure Authentication for the Reverse Proxy 1. In the *Connection* pane, browse to *Sites*. 1. Select the newly created website. -1. Double-click on the *Authentication* icon. -1. Disable *Anonymous Authentication*. -1. Enable *Basic Authentication*. - -## Configure URL Rewrite Rule +1. Double-click on the *URL Rewrite* icon. +1. In the *Actions* pane, click *Add Rule(s)...*. +1. Select *Blank rule* from the *Inbound Rules* section. +1. Click *OK*. +1. In the *Edit Inbound Rule* Dialog: + * Enter a *Name* for the rule, e.g. *Bearer Authentication*. + * Configure the *Match URL* section: + * *Requested URL* should be set to `Matches the Pattern`. + * *Using* should be set to `Regular Expressions`. + * *Pattern* should be set to `.*`. + * *Ignore case* should be checked. + * In the *Conditions* section: + * *Logical Grouping* should be set to `Match Any`. + * Click `Add...` to add a new condition. + * In the *Edit Condition* dialog: + * *Condition Input* should be set to `{HTTP_AUTHORIZATION}`. + * *Check if input string:* should be set to `Does Not Match the Pattern`. + * *Pattern* should be set to `^Bearer $` replacing <Bearer Token> with an appropriate value. + + A valid Bearer Token can be generated by any token generator, e.g. [Token Generator][], and should be a minimum of 64 characters consisting of uppercase and lowercase letters as well as numbers but should not contain any symbols. This token value should be saved for use when [installing Grafana Alloy][]. + * *Ignore case* should be unchecked. + * Click `OK`. + * In the *Action* section: + * *Action Type* should be set to `Custom Response`. + * *Action Properties* should be configured as follows: + * *Status code* should be set to `401`. + * *Reason* should be set to `Unauthorised`. + * *Error description* should be set to `Invalid Bearer Token`. +1. In the *Actions* pane, click *Apply*. + +##### Configure the Routing for the Reverse Proxy 1. In the *Connection* pane, browse to *Sites*. 1. Select the newly created website. @@ -99,34 +115,33 @@ To set up a reverse proxy, carry out the following configuration. 1. Ensure that *Enable SSL Offloading* is checked. 1. Click *OK*. -#### Restart the Website +##### Ensure Correct Ordering of URL Rewrite Rules -1. In the *Connection* pane, browse to *Sites*. -1. Select the newly created website. -1. In the *Manage Website* pane, click *Restart*. +The URL Rewrite rules should be in the following order: + +1. Bearer Authentication +2. ReverseProxyInboundRule -#### Create Loki User +If the order is incorrect: -1. Run Windows PowerShell as Administrator. -1. Execute the following command to create a new local user on the Web Application Server: +1. Select the *Bearer Authentication* rule. +1. In the *Actions* pane, click *Move Up*. +1. If prompted that inheritance will be affected, click *Yes*. - ```Powershell - New-LocalUser "" -Password (ConvertTo-SecureString "" -AsPlainText -force) -FullName "" -Description "" –PasswordNeverExpires - ``` +##### Restart the Website - | Parameter | Description | - |------|-------------| - | username | The username of the user to be created. | - | password | The password for the user account. | - | name | The full name for the user account. | - | description | The description of the user account. | +1. In the *Connection* pane, browse to *Sites*. +1. Select the newly created website. +1. In the *Manage Website* pane, click *Restart*. ## Next Steps? -1. [Install Promtail][] +1. [Install Grafana Alloy][] +[Token Generator]: {{< url path="IT-Tools.TokenGenerator" >}} [Application Request Routing 3.0]: {{< url path="IIS.Downloads.ApplicationRequestRouting-3_0" >}} -[Install Promtail]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallPromtail.MainDoc" >}} +[Install Grafana Alloy]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallAlloy.MainDoc" >}} +[Installing Grafana Alloy]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallAlloy.InstallAlloy.MainDoc" >}} [prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.WebAppCertificateRequirements" >}} [Software Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.SoftwareRequirements" >}} [URL Rewrite module 2.1]: {{< url path="IIS.Downloads.UrlRewrite-2_1" >}} diff --git a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md index e1d70e6fd..8fdc0ac57 100644 --- a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md +++ b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md @@ -26,7 +26,7 @@ This archive contains the `loki-local-config.yaml` configuration file, [NSSM][] [Configure Loki]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.ConfigureLoki" >}} [Grafana Loki 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3.0.0.GrafanaLokiInstallZip" >}} -[Grafana Loki Install.zip]: {{< url path="GitHub.Cortex.Observability.3.0.0.GrafanaLokiInstallZip" >}} +[Grafana Loki Install.zip]: {{< url path="GitHub.Cortex.Observability.4.0.0.GrafanaLokiInstallZip" >}} [NSSM]: {{< url path="NSSM.MainDoc" >}} [Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}} [Software Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.SoftwareRequirements" >}} diff --git a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-promtail/_index.md b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-promtail/_index.md deleted file mode 100644 index 6f53df537..000000000 --- a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-promtail/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Install Promtail" -linkTitle: "Install Promtail" -description: "Information about installing and configuring Promtail on the Application Server(s)." -weight: 50 ---- diff --git a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-promtail/configure-promtail.md b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-promtail/configure-promtail.md deleted file mode 100644 index 3e9433911..000000000 --- a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-promtail/configure-promtail.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "Configure Promtail" -linkTitle: "Configure Promtail" -description: "Information about configuring Promtail on the Application Server(s)." -weight: 20 ---- - -# {{% param title %}} - -This guide describes how to configure Promtail on the Application Server(s). - -{{% alert type="note" title="Note" %}}These steps must be performed for every Promtail installation in the cluster.{{% /alert %}} - -## Install Certificate - -If a self-signed certificate was obtained in the [prerequisites][], the CA certificate used to create this certificate must be imported on each Application Server. Otherwise, Promtail will not be able to establish communication with Grafana Loki. - -To import the CA certificate: - -1. Copy the `cortexCA.pfx` CA certificate created during the [root CA certificate generation][Generate The Root CA Certificate] steps into a suitable location on the Application Server. -1. Double click on the `cortexCA.pfx` file to import the certificate into the Windows Certificate Store. -1. Select `Local Machine` then click `Next`. -1. Click `Next`. -1. Enter the Export Password which the certificate was generated with then click `Next`. -1. Select `Place all certificates in the following store`. -1. Click `Browse…`. -1. Select `Trusted Root Certification Authorities`, click `OK` then click `Next`. -1. Click `Finish`. - -## Configure Promtail - -### Set Client URL for Grafana Loki - -1. Open the `promtail-local-config.yaml` configuration file, which is located in the folder alongside the `promtail-windows-amd64.exe` file. -1. Set the Grafana Loki `URL` in the `clients` section. - - The following template has been provided for convenience: - `https://:@:/loki/api/v1/push` -| Element | Description | -|------|-------------| -| username | The username of the user created during [Create Loki User][] steps. | -| password | The password which was set for the user during [Create Loki User][] steps. | -| loki host address | The host address of the machine where the Grafana Loki reverse proxy was configured during [Add a New Website][] steps . This must match the configured host name. | -| loki reverse proxy port | The port of the Grafana Loki reverse proxy configured during [Add a New Website][] steps. Usually 2100. | - - A correct URL should be similar to `https://username:password@hostaddress:2100/loki/api/v1/push`. -1. Save the file. - -### Set the positions.yaml File Path - -1. Open the `promtail-local-config.yaml` configuration file, which is located in the folder alongside the `promtail-windows-amd64.exe` file. -1. Set the `filename` in the `positions` section to the location where you want the `positions.yaml` file to be created on Promtail startup, e.g. `C:/Program Data/Cortex/Observability/Promtail/Positions.yaml`. -1. Create all the folders of the path specified in the previous step. -1. Save the file. - -{{% alert title="Note" %}} -If the specified path to the folder for the `positions.yaml` file doesn't exists, the file will not get created on Promtail startup. -{{% /alert %}} - -### Set the Path to the API Gateway Service Log Files - -1. Open the `promtail-local-config.yaml` configuration file, which is located in the folder alongside the `promtail-windows-amd64.exe` file. -1. Set the `__path__` in the `static_configs` > `targets` > `labels` section to the path of the `Logs` folder specified in the `appSettings.json` file during installation of the API Gateway Service, e.g. `"C:/ProgramData/Cortex/API Gateway Service/Logs/**/ServiceFabricHttpEventLog-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]{_[0-9][0-9][0-9],}.json"`. -1. Save the file. - -### Start Promtail - -1. Run Windows PowerShell as Administrator. -1. Change the location to the folder where the `promtail-windows-amd64.exe` file is located. -1. Execute the `.\Start-Promtail.ps1` command to start the Promtail Windows service. - -## Next Steps? - -1. [Setup Grafana][] - -[Add a New Website]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.AddANewWebsite" >}} -[Create Loki User]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.CreateLokiUser" >}} -[Generate The Root CA Certificate]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Advanced.GenerateTheRootCaCertificate" >}} -[prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.WebAppCertificateRequirements" >}} -[Setup Grafana]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.SetupGrafana" >}} diff --git a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-promtail/install-promtail.md b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-promtail/install-promtail.md deleted file mode 100644 index 9d257e4ad..000000000 --- a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-promtail/install-promtail.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "Install Promtail" -linkTitle: "Install Promtail" -description: "Information about installing Promtail on the Application Server(s)." -weight: 10 ---- - -# {{% param title %}} - -This guide describes how to install Promtail on the Application Server(s). Please ensure that the [Prerequisites][] have been completed before starting this installation. - -## Install Promtail - -1. Download [Promtail 3.0.0][] archive. -1. Extract content of the downloaded archive to a suitable location, e.g. `C:\Program Data\Cortex\Observability\Promtail`. -1. Download the [Promtail Install.zip][] archive and extract its contents alongside the previously extracted Promtail `promtail-windows-amd64.exe`. -This archive contains the `promtail-local-config.yaml` configuration file, [NSSM][] (the Non-Sucking Service Manager program) and PowerShell scripts to help manage Promtail as a Windows service. -1. Run Windows PowerShell as Administrator -1. Change the location to where all the files were extracted to in step 2, e.g. `cd "C:\Program Data\Cortex\Observability\Promtail"`. -1. Execute the `.\Install-Promtail.ps1` command to install the downloaded `promtail-windows-amd64.exe` as a service. - -## Next Steps? - -1. [Configure Promtail][] - -[Configure Promtail]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallPromtail.ConfigurePromtail" >}} -[NSSM]: {{< url path="NSSM.MainDoc" >}} -[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}} -[Promtail 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.3.0.0.PromtailInstallZip" >}} -[Promtail Install.zip]: {{< url path="GitHub.Cortex.Observability.3.0.0.PromtailInstallZip" >}} -[Software Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.SoftwareRequirements" >}} diff --git a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md index a0e80e379..b3b768492 100644 --- a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md +++ b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md @@ -33,21 +33,20 @@ The table below specifies additional resources that are recommended to be added | Web Application Server
(Shared with {{% ctx %}} Gateway) | 4+ *Recommended*
2 *Minimum* | 12+ *Recommended*
6 *Minimum* | 10+ *Recommended*
5 *Minimum*| {{% alert title="Note" %}} -The application servers (as described in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Architecture" title="Architecture" >}}) to which Promtail will be added have already been installed as part of the {{% ctx %}} install process and do not require any hardware modifications for the observability platform installation. +The application servers (as described in {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Architecture" title="Architecture" >}}) to which Grafana Alloy will be added have already been installed as part of the {{% ctx %}} install process and do not require any hardware modifications for the observability platform installation. {{% /alert %}} ## Software Requirements | Server Role | Windows Server[^1] | IIS[^2] | Other Software | |------------------|-------------------------|---------|----------| -| Web Application Server | [2022 (x64)][] *Recommended*
[2019 (x64)][] | 10.0.20348[^3]
10.0.17763[^4]
IIS Basic Authentication[^5]
[URL Rewrite module 2.1][] | [Grafana 10.4.1][] *Enterprise Edition*
[Grafana Loki 3.0.0][]| -| Application Server | [2022 (x64)][] *Recommended*
[2019 (x64)][] | | [Promtail 3.0.0][]| +| Web Application Server | [2022 (x64)][] *Recommended*
[2019 (x64)][] | 10.0.20348[^3]
10.0.17763[^4]
[URL Rewrite module 2.1][] | [Grafana 10.4.1][] *Enterprise Edition*
[Grafana Loki 3.0.0][]| +| Application Server | [2022 (x64)][] *Recommended*
[2019 (x64)][] | | [Grafana Alloy 1.10.0][]| [^1]: Windows Server Standard and Datacenter editions are supported. Filesystem **must be NTFS** and networking **must use IPv4**. Linux is not supported, but may be in the future. [^2]: IIS is supported; other web servers, including IIS Express are not supported. [^3]: Ships as a windows role within Windows Server 2022. [^4]: Ships as a windows role within Windows Server 2019. -[^5]: Installed during the [Install IIS Basic Authentication][] configuration steps. ## Domain Requirements @@ -86,7 +85,7 @@ For production systems, it is recommended that X.509 SSL certificates are obtain An X.509 SSL certificate (standard, wildcard or self-signed) should be used to secure communication between: -* Promtail on the Application Servers and the reverse proxy configured for Grafana Loki on the Web Application Server. +* Grafana Alloy on the Application Servers and the reverse proxy configured for Grafana Loki on the Web Application Server. * Grafana end users and the Grafana Web Application on the Web Application Server. The wildcard certificate used for installing {{% ctx %}} can be used if it is available in the .PEM file format, otherwise a new certificate can be obtained from a Certificate Authority, such as [Let’s Encrypt][], and must meet the following requirements: @@ -148,6 +147,10 @@ These requirements apply to each of the Application Servers. A domain user which is a member of the Local Administrators group on all Application Servers must be available to perform the installation. +#### Service User + +Grafana Alloy requires a domain user that is not a member of the Local Administrators group on any of the Application Servers. This user must be given the `Log on as a service` right otherwise the service will not be able to run. This permission will be granted as part of the install if it is not already granted. + ## Next Steps? 1. [Install Grafana][] @@ -159,12 +162,11 @@ A domain user which is a member of the Local Administrators group on all Applica [Create Self-Signed Certificates]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Advanced.CreateSelfSignedCertificates" >}} [Make Installation Artefacts Available]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.MakeInstallationArtefactsAvailableNew" >}} [Grafana 10.4.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.10.4.1.Windows" >}} +[Grafana Alloy 1.10.0]: {{< url path="Grafana.Products.Loki.Alloy.1.10.0" >}} [Grafana Loki 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3.0.0.GrafanaLokiInstallZip" >}} [Install Grafana]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallGrafana.MainDoc" >}} -[Install IIS Basic Authentication]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.InstallIISBasicAuthentication" >}} [installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.InstallCertificate" >}} [Let’s Encrypt]: {{< url path="LetsEncrypt.MainDoc" >}} -[Promtail 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.3.0.0.PromtailInstallZip" >}} [SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Advanced.SSLBestPractices" >}} [URL Rewrite module 2.1]: {{< url path="IIS.Downloads.UrlRewrite-2_1" >}} [Port Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Advanced.PortRequirements" >}} diff --git a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/setup-grafana.md b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/setup-grafana.md index 12e0c1e2a..e08eb296e 100644 --- a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/setup-grafana.md +++ b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/setup-grafana.md @@ -78,7 +78,7 @@ To do this, follow these steps for all default {{% ctx %}} dashboards imported: 1. [Try it Out][] -[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.3.0.0.GrafanaDashboardsZip" >}} +[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.4.0.0.GrafanaDashboardsZip" >}} [Grafana]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallGrafana.MainDoc" >}} [Loki]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.MainDoc" >}} [Try it Out]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.TryItOut" >}} diff --git a/content/static/2025.7/images/editable/Grafana Platform Architecture Diagram - Cloud.png b/content/static/2025.7/images/editable/Grafana Platform Architecture Diagram - Cloud.png index 249d19958..c485d655b 100644 Binary files a/content/static/2025.7/images/editable/Grafana Platform Architecture Diagram - Cloud.png and b/content/static/2025.7/images/editable/Grafana Platform Architecture Diagram - Cloud.png differ diff --git a/content/static/2025.7/images/editable/Grafana Platform Architecture Diagram - On-Premise.png b/content/static/2025.7/images/editable/Grafana Platform Architecture Diagram - On-Premise.png index 3f7a8e417..581805a3c 100644 Binary files a/content/static/2025.7/images/editable/Grafana Platform Architecture Diagram - On-Premise.png and b/content/static/2025.7/images/editable/Grafana Platform Architecture Diagram - On-Premise.png differ diff --git a/data/urls.toml b/data/urls.toml index 7ae21490b..b514f1f92 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -512,12 +512,18 @@ MainDoc = "/docs/getting-started/on-premise/add-observability-to-innovation/grafana/install-loki/" AddANewWebsite = "/docs/getting-started/on-premise/add-observability-to-innovation/grafana/install-loki/configure-loki/#add-a-new-website" CreateLokiUser = "/docs/getting-started/on-premise/add-observability-to-innovation/grafana/install-loki/configure-loki/#create-loki-user" + ConfigureAuthentication = "/docs/getting-started/on-premise/add-observability-to-innovation/grafana/install-loki/configure-loki/#configure-authentication-for-the-reverse-proxy" ConfigureLoki = "/docs/getting-started/on-premise/add-observability-to-innovation/grafana/install-loki/configure-loki" InstallIISBasicAuthentication = "/docs/getting-started/on-premise/add-observability-to-innovation/grafana/install-loki/configure-loki/#install-iis-basic-authentication" InstallCertificate = "/docs/getting-started/on-premise/add-observability-to-innovation/grafana/install-loki/configure-loki/#install-certificate" [Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallPromtail] MainDoc = "/docs/getting-started/on-premise/add-observability-to-innovation/grafana/install-promtail/" ConfigurePromtail = "/docs/getting-started/on-premise/add-observability-to-innovation/grafana/install-promtail/configure-promtail" + [Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallAlloy] + MainDoc = "/docs/getting-started/on-premise/add-observability-to-innovation/grafana/install-alloy/" + ConfigureAlloy = "/docs/getting-started/on-premise/add-observability-to-innovation/grafana/install-alloy/configure-alloy" + [Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallAlloy.InstallAlloy] + MainDoc = "/docs/getting-started/on-premise/add-observability-to-innovation/grafana/install-alloy/install-alloy" [Cortex.GettingStarted.Cloud] MainDoc = "/docs/getting-started/cloud" [Cortex.GettingStarted.Cloud.AddObservabilityToInnovation] @@ -536,6 +542,10 @@ SetUpGrafanaLoki = "/docs/getting-started/cloud/add-observability-to-innovation/grafana/setup-loki/#set-up-grafana-loki" [Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.ImportDashboards] MainDoc = "/docs/getting-started/cloud/add-observability-to-innovation/grafana/import-dashboards" + [Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.InstallAlloy] + MainDoc = "/docs/getting-started/cloud/add-observability-to-innovation/grafana/install-alloy/" + [Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.InstallAlloy.ConfigureAlloy] + MainDoc = "/docs/getting-started/cloud/add-observability-to-innovation/grafana/install-alloy/configure-alloy" [Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.InstallPromtail] MainDoc = "/docs/getting-started/cloud/add-observability-to-innovation/grafana/install-promtail/" [Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.InstallPromtail.ConfigurePromtail] @@ -3024,6 +3034,9 @@ # External links [Anycast] MainDoc = "https://en.wikipedia.org/wiki/Anycast" +[IT-Tools] + MainDoc = "https://it-tools.tech" + TokenGenerator = "https://it-tools.tech/token-generator" [CancelCommands] MainDoc = "https://www.physics.udel.edu/~watson/scen103/ascii.html" [ConnectionStrings] @@ -3078,6 +3091,11 @@ GrafanaLokiInstallZip = "https://github.com/CortexIntelligentAutomation/observability/releases/download/v3.0.0/Grafana.Loki.Install.zip" PromtailInstallZip = "https://github.com/CortexIntelligentAutomation/observability/releases/download/v3.0.0/Promtail.Install.zip" GrafanaDashboardsZip = "https://github.com/CortexIntelligentAutomation/observability/releases/download/v3.0.0/Grafana.Dashboards.zip" + [GitHub.Cortex.Observability.4.0.0] + Release = "https://github.com/CortexIntelligentAutomation/observability/releases/tag/v4.0.0" + GrafanaAlloyInstallZip = "https://github.com/CortexIntelligentAutomation/observability/releases/download/v4.0.0/Grafana.Alloy.Install.zip" + GrafanaLokiInstallZip = "https://github.com/CortexIntelligentAutomation/observability/releases/download/v4.0.0/Grafana.Loki.Install.zip" + GrafanaDashboardsZip = "https://github.com/CortexIntelligentAutomation/observability/releases/download/v4.0.0/Grafana.Dashboards.zip" [Grafana] MainDoc = "https://grafana.com/" [Grafana.Products.Grafana] @@ -3087,6 +3105,9 @@ MainDoc = "https://grafana.com/oss/loki/" [Grafana.Products.Loki.Promtail] MainDoc = "https://grafana.com/docs/loki/latest/clients/promtail/" + [Grafana.Products.Loki.Alloy] + MainDoc = "https://grafana.com/docs/loki/latest/send-data/alloy/" + 1.10.0 = "https://github.com/grafana/alloy/releases/download/v1.10.0/alloy-installer-windows-amd64.exe.zip" [Grafana.SelfManaged.Downloads.GrafanaWebApp] Windows = "https://grafana.com/grafana/download/8.5.4?pg=get&plcmt=selfmanaged-box1-cta1&platform=windows" [Grafana.SelfManaged.Downloads.GrafanaWebApp.10.4.1]