diff --git a/content/en/docs/2025.3/FAQs/change-logging-levels/_index.md b/content/en/docs/2025.3/FAQs/change-logging-levels/_index.md new file mode 100644 index 000000000..09a7c8d67 --- /dev/null +++ b/content/en/docs/2025.3/FAQs/change-logging-levels/_index.md @@ -0,0 +1,20 @@ +--- +title: "How do I change the Logging Level?" +linkTitle: "How do I change the Logging Level?" +description: "Instructions on how to change the {{% ctx %}} Logging Level." +weight: 1000 +--- + +{{% ctx %}} Logging Levels are set to `Error` by default for most services. However, levels can be changed whilst {{% ctx %}} is running by sending REST calls to the {{% ctx %}} API Gateway service. + +{{% alert title="Note" %}} +Although the Logging Level for the {{% ctx %}} API Gateway service can be increased, it will still always log all API calls regardless of Logging Level configured. +{{% / alert %}} + +If increasing the Logging Level, particularly if increasing for everything or for Block Logging, we recommend that this is done only when required. Increasing log levels will lead to an increase in disk usage and disk writes, which can impact the performance of the {{% ctx %}} platform if not monitored. + +Whilst increased Logging Levels are in place, we would recommend closely monitoring system performance and disk space usage. + +All REST calls to update Logging Levels use Basic Auth and can be made using REST clients such as [Postman][] or using scripts such as PowerShell. + +[Postman]: {{< url path="Postman.Downloads.MainDoc" >}} diff --git a/content/en/docs/2025.3/FAQs/change-logging-levels/change-all-logging.md b/content/en/docs/2025.3/FAQs/change-logging-levels/change-all-logging.md new file mode 100644 index 000000000..5ae906fd3 --- /dev/null +++ b/content/en/docs/2025.3/FAQs/change-logging-levels/change-all-logging.md @@ -0,0 +1,63 @@ +--- +title: "Change All Logging Levels" +linkTitle: "Change All Logging Levels" +description: "Instructions on how to change the Logging Level for All Logging." +weight: 10 +--- + +# {{% param title %}} + +To change the Logging Level for all services, the below PowerShell script can be used to make a REST call against your {{% ctx %}} platform. + +1. Run Windows PowerShell ISE as Administrator. +1. Copy the following script into the PowerShell window: + + ``` powershell + $serverFQDN = "server.domain.com" + $APIGatewayPort = 8722 + $loglevel = 4 + $user = "BasicAuthUser" + + $securePass = Read-Host -Prompt "Enter password for $user" -AsSecureString + + $ptr = [Runtime.InteropServices.Marshal]::SecureStringToBSTR($securePass) + try { + $plainPass = [Runtime.InteropServices.Marshal]::PtrToStringBSTR($ptr) + + $authBytes = [System.Text.Encoding]::ASCII.GetBytes("$user`:$plainPass") + $base64AuthInfo = [Convert]::ToBase64String($authBytes) + } + finally { + [Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ptr) + + $plainPass = $null + Remove-Variable -Name plainPass -Force + } + + $headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]" + $headers.Add("Content-Type", "application/json") + $headers.Add("Accept", "application/json") + $headers.Add("Authorization", "Basic $base64AuthInfo") + $path = "applications/logging" + $body = @" + $loglevel + "@ + + $response = Invoke-RestMethod "https://${serverFQDN}:$APIGatewayPort/api/v1/default/default/$path" -Method PUT -Headers $headers -Body $body + $response + ``` + +1. Configure the following variables: + * `$serverFQDN` – The fully qualified domain name for the Application Server or Load Balancer + * `$APIGatewayPort` – {{% ctx %}} API Gateway Service Port (8722) or Load Balancer port (typically 443 or 8722) + * `$loglevel` – Desired log level as an integer, `1` is enabled and `4` is the default error level + * `$user` – {{% ctx %}} API Gateway Basic Auth Username + +1. Execute the script, entering the Basic Auth User's password when prompted. +1. Confirm success response: + + If the call was successful, there should be no errors and the following response should be received + + ``` powershell + LogLevel was successfully configured. + ``` diff --git a/content/en/docs/2025.3/FAQs/change-logging-levels/change-block-logging.md b/content/en/docs/2025.3/FAQs/change-logging-levels/change-block-logging.md new file mode 100644 index 000000000..0bb8518e9 --- /dev/null +++ b/content/en/docs/2025.3/FAQs/change-logging-levels/change-block-logging.md @@ -0,0 +1,84 @@ +--- +title: "Change Block Logging Level" +linkTitle: "Change Block Logging Level" +description: "Instructions on how to change the Logging Level for Block Logging." +weight: 5 +--- + +# {{% param title %}} + +Block Logging in {{% ctx %}} logs the following Block Properties by default regardless of the log level configured: + +* Execute Data Command + * Command > commandText + * Command > parameters +* Execute Http Request + * Http Request + * Http Response +* Execute Soap Request + * Soap Request + * Soap Response +* Execute PowerShell Script + * Script + * Parameters + * Outputs + * Records +* Execute Ssh Command + * Command + * Response + * Ssh Logs + +To change the Logging Level for Block Logging so that every block is logged when executed, the below PowerShell script can be used to make a REST call against your {{% ctx %}} platform. + +1. Run Windows PowerShell ISE as Administrator. +1. Copy the following script into the PowerShell window: + + ``` powershell + $serverFQDN = "server.domain.com" + $APIGatewayPort = 8722 + $loglevel = 4 + $user = "BasicAuthUser" + + $securePass = Read-Host -Prompt "Enter password for $user" -AsSecureString + + $ptr = [Runtime.InteropServices.Marshal]::SecureStringToBSTR($securePass) + try { + $plainPass = [Runtime.InteropServices.Marshal]::PtrToStringBSTR($ptr) + + $authBytes = [System.Text.Encoding]::ASCII.GetBytes("$user`:$plainPass") + $base64AuthInfo = [Convert]::ToBase64String($authBytes) + } + finally { + [Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ptr) + + $plainPass = $null + Remove-Variable -Name plainPass -Force + } + + $headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]" + $headers.Add("Content-Type", "application/json") + $headers.Add("Accept", "application/json") + $headers.Add("Authorization", "Basic $base64AuthInfo") + $path = "applications/execution/services/engine/blocks/packages/versions/executions/flows/workspaces/blocks/logging" + $body = @" + $loglevel + "@ + + $response = Invoke-RestMethod "https://${serverFQDN}:$APIGatewayPort/api/v1/default/default/$path" -Method PUT -Headers $headers -Body $body + $response + ``` + +1. Configure the following variables: + * `$serverFQDN` – The fully qualified domain name for the Application Server or Load Balancer + * `$APIGatewayPort` – {{% ctx %}} API Gateway Service Port (8722) or Load Balancer port (typically 443 or 8722) + * `$loglevel` – Desired log level as an integer, `1` is enabled and `4` is the default error level + * `$user` – {{% ctx %}} API Gateway Basic Auth Username + +1. Execute the script, entering the Basic Auth User's password when prompted. +1. Confirm success response: + + If the call was successful, there should be no errors and the following response should be received + + ``` powershell + LogLevel was successfully configured. + ``` diff --git a/content/en/docs/2025.3/FAQs/change-logging-levels/change-flow-logging.md b/content/en/docs/2025.3/FAQs/change-logging-levels/change-flow-logging.md new file mode 100644 index 000000000..6ceb48cf2 --- /dev/null +++ b/content/en/docs/2025.3/FAQs/change-logging-levels/change-flow-logging.md @@ -0,0 +1,63 @@ +--- +title: "Change Flow Logging Level" +linkTitle: "Change Flow Logging Level" +description: "Instructions on how to change the Logging Level for Flow Logging." +weight: 1 +--- + +# {{% param title %}} + +To change the Logging Level for Flow Logging, the below PowerShell script can be used to make a REST call against your {{% ctx %}} platform. + +1. Run Windows PowerShell ISE as Administrator. +1. Copy the following script into the PowerShell window: + + ``` powershell + $serverFQDN = "server.domain.com" + $APIGatewayPort = 8722 + $loglevel = 4 + $user = "BasicAuthUser" + + $securePass = Read-Host -Prompt "Enter password for $user" -AsSecureString + + $ptr = [Runtime.InteropServices.Marshal]::SecureStringToBSTR($securePass) + try { + $plainPass = [Runtime.InteropServices.Marshal]::PtrToStringBSTR($ptr) + + $authBytes = [System.Text.Encoding]::ASCII.GetBytes("$user`:$plainPass") + $base64AuthInfo = [Convert]::ToBase64String($authBytes) + } + finally { + [Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ptr) + + $plainPass = $null + Remove-Variable -Name plainPass -Force + } + + $headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]" + $headers.Add("Content-Type", "application/json") + $headers.Add("Accept", "application/json") + $headers.Add("Authorization", "Basic $base64AuthInfo") + $path = "applications/execution/services/engine/blocks/packages/versions/executions/flows/logging" + $body = @" + $loglevel + "@ + + $response = Invoke-RestMethod "https://${serverFQDN}:$APIGatewayPort/api/v1/default/default/$path" -Method PUT -Headers $headers -Body $body + $response + ``` + +1. Configure the following variables: + * `$serverFQDN` – The fully qualified domain name for the Application Server or Load Balancer + * `$APIGatewayPort` – {{% ctx %}} API Gateway Service Port (8722) or Load Balancer port (typically 443 or 8722) + * `$loglevel` – Desired log level as an integer, `1` is enabled and `4` is the default error level + * `$user` – {{% ctx %}} API Gateway Basic Auth Username + +1. Execute the script, entering the Basic Auth User's password when prompted. +1. Confirm success response: + + If the call was successful, there should be no errors and the following response should be received + + ``` powershell + LogLevel was successfully configured. + ``` diff --git a/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/architecture.md b/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/architecture.md index 6c2b36499..5bf3764c2 100644 --- a/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/architecture.md +++ b/content/en/docs/2025.3/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.3/getting-started/cloud/add-observability-to-innovation/Grafana/import-dashboards.md b/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/import-dashboards.md index 25665a706..d1c53e8da 100644 --- a/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/import-dashboards.md +++ b/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/import-dashboards.md @@ -32,13 +32,18 @@ Please ensure that the set up for [Grafana][] and [Loki][] have been completed b 1. Click the Dashboards menu item. 1. Click the *New* dropdown and select *Import*. 1. Click on *Upload dashboard JSON file*. -1. Locate the `Flow Execution Requests.json` file extracted from the downloaded `Grafana.Dashboards.zip`. +1. Locate the `Flow Execution Details.json` file extracted from the downloaded `Grafana.Dashboards.zip`. 1. Select the file and click *Open*. 1. Select the folder in Grafana you wish the dashboard to be saved in, e.g. *Cortex*. 1. Select your [configured Loki data source][] from the dropdown menu, e.g. *grafanacloud-cortex-logs*. 1. Click *Import*. +1. Repeat steps 2 - 10 for the `Flow Execution Requests.json` file. 1. Repeat steps 2 - 10 for the `Platform Health.json` file. +{{% alert title="Warning" color="warning" %}} +The *Flow Execution Details* dashboard will only work if `Flow Logging` is enabled on your platform. See {{< ahref path="Cortex.Faqs.ChangeLoggingLevels.FlowLogging.MainDoc" title="Change Flow Logging Level" >}} for instructions on how to do this. +{{% / alert %}} + ## Configure Data Sources It is necessary to update the Custom Filter inside the dashboards to use the correct data source. @@ -57,7 +62,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 +71,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.5_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.3/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/_index.md b/content/en/docs/2025.3/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.3/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.3/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md b/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md new file mode 100644 index 000000000..ee755708d --- /dev/null +++ b/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md @@ -0,0 +1,36 @@ +--- +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 for 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 `__path__` in the `local.file_match "ExecutionService"` > `path_targets` section to the path of the `Logs` folder for the Execution Service, e.g. `"C:/ProgramData/Cortex/Execution Service/Logs/**/*.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.3/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md b/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md new file mode 100644 index 000000000..90e348d2b --- /dev/null +++ b/content/en/docs/2025.3/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.15.1][] archive. +1. Extract content of the downloaded archive to a suitable location, e.g. `C:\ProgramData\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:\ProgramData\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.15.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaAlloy.1_15_1.Windows" >}} +[Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.5_0_0.GrafanaAlloyInstallZip" >}} +[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}} diff --git a/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/install-promtail/_index.md b/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/install-promtail/_index.md deleted file mode 100644 index 6f53df537..000000000 --- a/content/en/docs/2025.3/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.3/getting-started/cloud/add-observability-to-innovation/Grafana/install-promtail/configure-promtail.md b/content/en/docs/2025.3/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.3/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.3/getting-started/cloud/add-observability-to-innovation/Grafana/install-promtail/install-promtail.md b/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/install-promtail/install-promtail.md deleted file mode 100644 index 5eed9d97d..000000000 --- a/content/en/docs/2025.3/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.3/getting-started/cloud/add-observability-to-innovation/Grafana/prerequisites.md b/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/prerequisites.md index b7a1163f1..6acc51610 100644 --- a/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/prerequisites.md +++ b/content/en/docs/2025.3/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.15.1][] | [^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.15.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaAlloy.1_15_1.Windows" >}} [Set up Grafana]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupGrafana.MainDoc" >}} diff --git a/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/setup-loki.md b/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/setup-loki.md index d8495b8b6..f086f2c35 100644 --- a/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/setup-loki.md +++ b/content/en/docs/2025.3/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.3/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md b/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md index 0ab653084..db6b83f4b 100644 --- a/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md +++ b/content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md @@ -17,7 +17,7 @@ This test uses the test flow published as part of testing the {{% ctx %}} instal | Property | Value | |---------------|-------------------------------------------------------------------------------------| | Action | POST | - | URL | For HA installation use:
`https://{FQDN of Load Balancer Server}/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://load-balancer.domain.com/api/default/default/flows/NewFlow/executions?packageName=NewPackage`

For non-HA installation use:
`https://{FQDN of server}:8722/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://server.domain.com:8722/api/default/default/flows/NewFlow/executions?packageName=NewPackage`| + | URL | For HA installation use:
`https://{FQDN of Load Balancer Server}/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://load-balancer.domain.com/api/default/default/flows/NewFlow/executions?packageName=NewPackage`

For non-HA installation use:
`https://{FQDN of server}:8722/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://server.domain.com:8722/api/default/default/flows/NewFlow/executions?packageName=NewPackage`| | Content Type | application/json | | Body | {} | | Authentication| Basic | @@ -27,6 +27,16 @@ This test uses the test flow published as part of testing the {{% ctx %}} instal {{% alert title="Note" %}} If you used self-signed certificates when installing the Application Servers you may need to disable SSL certificate validation in your HTTP client. {{% /alert %}} 1. Once the request has completed, using a web browser, log in to your configured Grafana. +1. Click the Menu icon {{< image src="/images/GrafanaMenuIcon.png" title="Menu icon" >}} to view the available options. +1. Click the Dashboards menu item. +1. Click the folder name that the dashboards were imported to, if not already expanded. +1. Click the *Flow Execution Details* dashboard to open it. +1. The request made at step 1 should be visible on the dashboard. + + {{% alert title="Note" %}}If Flow Logging has not been enabled then this dashboard will not display any data. See {{< ahref path="Cortex.Faqs.ChangeLoggingLevels.FlowLogging.MainDoc" title="Change Flow Logging Level" >}} for instructions on how to do this.
+ If other requests have been made then there may be more than one request visible on the dashboard. + {{% / alert %}} + 1. Click the Menu icon {{< image src="/images/GrafanaMenuIcon.png" title="Menu icon" >}} to view the available options. 1. Click the Dashboards menu item. 1. Click the folder name that the dashboards were imported to, if not already expanded. diff --git a/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/architecture.md b/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/architecture.md index 09c898254..322188254 100644 --- a/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/architecture.md +++ b/content/en/docs/2025.3/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.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/_index.md b/content/en/docs/2025.3/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.3/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.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md b/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md new file mode 100644 index 000000000..990eae7ad --- /dev/null +++ b/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md @@ -0,0 +1,60 @@ +--- +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 for 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 `__path__` in the `local.file_match "ExecutionService"` > `path_targets` section to the path of the `Logs` folder for the Execution Service, e.g. `"C:/ProgramData/Cortex/Execution Service/Logs/**/*.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.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md b/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md new file mode 100644 index 000000000..5cea6a2c8 --- /dev/null +++ b/content/en/docs/2025.3/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.15.1][] archive. +1. Extract content of the downloaded archive to a suitable location, e.g. `C:\ProgramData\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:\ProgramData\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.15.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaAlloy.1_15_1.Windows" >}} +[Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.5_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.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-grafana/install-grafana.md b/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-grafana/install-grafana.md index 58de4bcdd..754c6e072 100644 --- a/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-grafana/install-grafana.md +++ b/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-grafana/install-grafana.md @@ -11,7 +11,7 @@ This guide describes how to install Grafana on the Web Application Server. Pleas ## Install Grafana -1. Download the [Grafana 10.4.1][] Windows installer. +1. Download the [Grafana 13.0.1][] Windows installer. 1. Run the installer and install Grafana to a suitable location. ## Next Steps? @@ -19,6 +19,5 @@ This guide describes how to install Grafana on the Web Application Server. Pleas 1. [Configure Grafana][] [Configure Grafana]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallGrafana.ConfigureGrafana" >}} -[Grafana 10.4.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.10_4_1.Windows" >}} +[Grafana 13.0.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.13.0.1.WindowsInstaller" >}} [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.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/configure-loki.md b/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/configure-loki.md index 3db8584be..c8a5c1799 100644 --- a/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/configure-loki.md +++ b/content/en/docs/2025.3/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,52 @@ 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 + +The URL Rewrite rules should be in the following order: + +1. Bearer Authentication +2. ReverseProxyInboundRule + +If the order is incorrect: + +1. Select the *Bearer Authentication* rule. +1. In the *Actions* pane, click *Move Up*. +1. If prompted that inheritance will be affected, click *Yes*. + +##### Restart the Website 1. In the *Connection* pane, browse to *Sites*. 1. Select the newly created website. 1. In the *Manage Website* pane, click *Restart*. -#### Create Loki User +## Configure Log Retention + +Grafana Loki is configured with a default retention period of 12 months for it's logs. This means that Grafana can query data up to 12 months old. Once the 12 months is reached, Loki will remove older logs. + +If a different retention period is required then this can be set, however, it should only be set to the period that is needed otherwise excessive disk space may be used unnecessarily. + +To change the retention period: -1. Run Windows PowerShell as Administrator. -1. Execute the following command to create a new local user on the Web Application Server: +1. Open the `loki-local-config.yaml` configuration file, which is located in the folder that Loki was installed to eg `C:\ProgramData\Cortex\Observability\Loki`. +1. Locate the `retention_period:` configuration value at approximately line 55. +1. Set the value of the retention required in hours, e.g. 6 months would be `4380h` or 9 months would be `6570h`. +1. Save the file. - ```Powershell - New-LocalUser "" -Password (ConvertTo-SecureString "" -AsPlainText -force) -FullName "" -Description "" –PasswordNeverExpires - ``` +### Re-Start the Grafana Loki Service - | 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. Open `services.msc`. +1. Locate the `Loki` service. +1. Right click on the service name and select `Restart`. If the service is not already running, select `Start`. ## 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.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md b/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md index 8e3f9b8f1..dce9df684 100644 --- a/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md +++ b/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md @@ -11,12 +11,12 @@ This guide describes how to install Grafana Loki on the Web Application Server. ## Install Grafana Loki -1. Download [Grafana Loki 3.0.0][] archive. -1. Extract content of the downloaded archive to a suitable location, e.g. `C:\Program Data\Cortex\Observability\Loki`. +1. Download [Grafana Loki 3.7.1][] archive. +1. Extract content of the downloaded archive to a suitable location, e.g. `C:\ProgramData\Cortex\Observability\Loki`. 1. Download the [Grafana Loki Install.zip][] archive and extract its contents alongside the previously extracted Grafana Loki `loki-windows-amd64.exe`. This archive contains the `loki-local-config.yaml` configuration file, [NSSM][] (the Non-Sucking Service Manager program) and PowerShell scripts to help manage Grafana Loki 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\Loki"`. +1. Change the location to where all the files were extracted to in step 2, e.g. `cd "C:\ProgramData\Cortex\Observability\Loki"`. 1. Execute the `.\Install-Loki.ps1` command to install the downloaded Grafana Loki `loki-windows-amd64.exe` as a service. 1. Execute the `.\Start-Loki.ps1` command to start the Grafana Loki service. @@ -25,8 +25,7 @@ This archive contains the `loki-local-config.yaml` configuration file, [NSSM][] 1. [Configure Loki][] [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 3.7.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3_7_1.GrafanaLokiInstallZip" >}} +[Grafana Loki Install.zip]: {{< url path="GitHub.Cortex.Observability.5_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.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-promtail/_index.md b/content/en/docs/2025.3/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.3/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.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-promtail/configure-promtail.md b/content/en/docs/2025.3/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.3/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.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-promtail/install-promtail.md b/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-promtail/install-promtail.md deleted file mode 100644 index a4a13c486..000000000 --- a/content/en/docs/2025.3/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.3/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md b/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md index 7b7c0a4e9..60331b85b 100644 --- a/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md +++ b/content/en/docs/2025.3/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 13.0.1][] *Enterprise Edition*
[Grafana Loki 3.7.1][]| +| Application Server | [2022 (x64)][] *Recommended*
[2019 (x64)][] | | [Grafana Alloy 1.15.1][]| [^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][] @@ -156,15 +159,13 @@ A domain user which is a member of the Local Administrators group on all Applica [2022 (x64)]: {{< url path="Microsoft.Downloads.Windows.Server2022" >}} [Architecture]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Architecture" >}} [configuring Grafana to use HTTPS]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallGrafana.ConfigureHTTPS" >}} -[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 Loki 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3_0_0.GrafanaLokiInstallZip" >}} +[Grafana 13.0.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.13.0.1.WindowsInstaller" >}} +[Grafana Alloy 1.15.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaAlloy.1_15_1.Windows" >}} +[Grafana Loki 3.7.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3_7_1.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.3/getting-started/on-premise/add-observability-to-innovation/Grafana/setup-grafana.md b/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/setup-grafana.md index a0373aefd..823154490 100644 --- a/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/setup-grafana.md +++ b/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/setup-grafana.md @@ -9,7 +9,7 @@ weight: 60 This guide describes where to get the default {{% ctx %}} Dashboards from and how to import them for use in Grafana. -Please ensure that the Installations for [Grafana][] and [Loki][] have been completed before starting this section. +Please ensure that the Installations for [Grafana][], [Loki][] and [Alloy] have been completed before starting this section. ## Configure Loki Data Source in Grafana @@ -47,13 +47,18 @@ Please ensure that the Installations for [Grafana][] and [Loki][] have been comp 1. Go to *Dashboards* via the menu on the left sidebar. 1. Click the *New* button and select *Import* from the drop-down menu. 1. Click the *Upload JSON file* button. -1. Locate the `Flow Execution Requests.json` file extracted from the downloaded `Grafana.Dashboards.zip`. +1. Locate the `Flow Execution Details.json` file extracted from the downloaded `Grafana.Dashboards.zip`. 1. Select the file and click *Open*. 1. Select the folder in Grafana you wish the dashboard to be saved in, e.g. *Cortex*. 1. Select your configured Loki data source from the dropdown menu. 1. Click *Import*. +1. Repeat steps 2 - 8 for the `Flow Execution Requests.json` file. 1. Repeat steps 2 - 8 for the `Platform Health.json` file. +{{% alert title="Warning" color="warning" %}} +The *Flow Execution Details* dashboard will only work if `Flow Logging` is enabled on your platform. See {{< ahref path="Cortex.Faqs.ChangeLoggingLevels.FlowLogging.MainDoc" title="Change Flow Logging Level" >}} for instructions on how to do this. +{{% / alert %}} + ## Configure Data Sources It is necessary to update the Custom Filter inside the dashboards to use the correct data source. @@ -64,7 +69,7 @@ To do this, follow these steps for all default {{% ctx %}} dashboards imported: 1. To open a dashboard: 1. Go to *Dashboards* via the menu on the left sidebar. 1. Click the folder name that the dashboards were imported to. - 1. Click the *Flow Execution Requests* dashboard to open it. + 1. Click the *Flow Execution Details* dashboard to open it. 1. Open the *Dashboard settings* menu via the cog icon in the top right-hand side of the dashboard. 1. Click *Variables* from the top menu of the *Settings* page. 1. Click *CustomFilter* at the bottom of the *Variables* list. @@ -72,13 +77,15 @@ To do this, follow these steps for all default {{% ctx %}} dashboards imported: 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. +1. Repeat steps 2 - 9 for the *Flow Execution Requests* dashboard. 1. Repeat steps 2 - 9 for the *Platform Health* dashboard. ## Next Steps? 1. [Try it Out][] -[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.3_0_0.GrafanaDashboardsZip" >}} +[Alloy]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallAlloy.MainDoc" >}} +[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.5_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/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md b/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md index 8e60d6f7a..76dbd552c 100644 --- a/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md +++ b/content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md @@ -17,7 +17,7 @@ This test uses the test flow published as part of testing the {{% ctx %}} instal | Property | Value | |---------------|-------------------------------------------------------------------------------------| | Action | POST | - | URL | For HA installation use:
`https://{FQDN of Load Balancer Server}/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://load-balancer.domain.com/api/default/default/flows/NewFlow/executions?packageName=NewPackage`

For non-HA installation use:
`https://{FQDN of server}:8722/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://server.domain.com:8722/api/default/default/flows/NewFlow/executions?packageName=NewPackage`| + | URL | For HA installation use:
`https://{FQDN of Load Balancer Server}/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://load-balancer.domain.com/api/default/default/flows/NewFlow/executions?packageName=NewPackage`

For non-HA installation use:
`https://{FQDN of server}:8722/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://server.domain.com:8722/api/default/default/flows/NewFlow/executions?packageName=NewPackage`| | Content Type | application/json | | Body | {} | | Authentication| Basic | @@ -27,6 +27,15 @@ This test uses the test flow published as part of testing the {{% ctx %}} instal {{% alert title="Note" %}} If you used self-signed certificates when installing the Application Servers you may need to disable SSL certificate validation in your HTTP client. {{% /alert %}} 1. Once the request has completed, using a web browser, log in to your configured Grafana. +1. Open the *Dashboards* page via the menu on the left sidebar. +1. Click the folder name that the dashboards were imported to. +1. Click the *Flow Execution Details* dashboard to open it. +1. The request made at step 1 should be visible on the dashboard. + + {{% alert title="Note" %}}If Flow Logging has not been enabled then this dashboard will not display any data. See {{< ahref path="Cortex.Faqs.ChangeLoggingLevels.FlowLogging.MainDoc" title="Change Flow Logging Level" >}} for instructions on how to do this.
+ If other requests have been made then there may be more than one request visible on the dashboard. + {{% / alert %}} + 1. Open the *Dashboards* page via the menu on the left sidebar. 1. Click the folder name that the dashboards were imported to. 1. Click the *Flow Execution Requests* dashboard to open it. diff --git a/content/en/docs/2025.9/FAQs/change-logging-levels/_index.md b/content/en/docs/2025.9/FAQs/change-logging-levels/_index.md new file mode 100644 index 000000000..09a7c8d67 --- /dev/null +++ b/content/en/docs/2025.9/FAQs/change-logging-levels/_index.md @@ -0,0 +1,20 @@ +--- +title: "How do I change the Logging Level?" +linkTitle: "How do I change the Logging Level?" +description: "Instructions on how to change the {{% ctx %}} Logging Level." +weight: 1000 +--- + +{{% ctx %}} Logging Levels are set to `Error` by default for most services. However, levels can be changed whilst {{% ctx %}} is running by sending REST calls to the {{% ctx %}} API Gateway service. + +{{% alert title="Note" %}} +Although the Logging Level for the {{% ctx %}} API Gateway service can be increased, it will still always log all API calls regardless of Logging Level configured. +{{% / alert %}} + +If increasing the Logging Level, particularly if increasing for everything or for Block Logging, we recommend that this is done only when required. Increasing log levels will lead to an increase in disk usage and disk writes, which can impact the performance of the {{% ctx %}} platform if not monitored. + +Whilst increased Logging Levels are in place, we would recommend closely monitoring system performance and disk space usage. + +All REST calls to update Logging Levels use Basic Auth and can be made using REST clients such as [Postman][] or using scripts such as PowerShell. + +[Postman]: {{< url path="Postman.Downloads.MainDoc" >}} diff --git a/content/en/docs/2025.9/FAQs/change-logging-levels/change-all-logging.md b/content/en/docs/2025.9/FAQs/change-logging-levels/change-all-logging.md new file mode 100644 index 000000000..05085ad7f --- /dev/null +++ b/content/en/docs/2025.9/FAQs/change-logging-levels/change-all-logging.md @@ -0,0 +1,63 @@ +--- +title: "Change All Logging Levels" +linkTitle: "Change All Logging Levels" +description: "Instructions on how to change the Logging Level for All Logging." +weight: 10 +--- + +# {{% param title %}} + +To change the Logging Level for all services, the below PowerShell script can be used to make a REST call against your {{% ctx %}} platform. + +1. Run Windows PowerShell ISE as Administrator. +1. Copy the following script into the PowerShell window: + + ``` powershell + $serverFQDN = "server.domain.com" + $APIGatewayPort = 8722 + $loglevel = 4 + $user = "BasicAuthUser" + + $securePass = Read-Host -Prompt "Enter password for $user" -AsSecureString + + $ptr = [Runtime.InteropServices.Marshal]::SecureStringToBSTR($securePass) + try { + $plainPass = [Runtime.InteropServices.Marshal]::PtrToStringBSTR($ptr) + + $authBytes = [System.Text.Encoding]::ASCII.GetBytes("$user`:$plainPass") + $base64AuthInfo = [Convert]::ToBase64String($authBytes) + } + finally { + [Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ptr) + + $plainPass = $null + Remove-Variable -Name plainPass -Force + } + + $headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]" + $headers.Add("Content-Type", "application/json") + $headers.Add("Accept", "application/json") + $headers.Add("Authorization", "Basic $base64AuthInfo") + $path = "applications/logging" + $body = @" + $loglevel + "@ + + $response = Invoke-RestMethod "https://${serverFQDN}:$APIGatewayPort/api/v1/default/default/$path" -Method PUT -Headers $headers -Body $body + $response + ``` + +1. Configure the following variables: + * `$serverFQDN` – The fully qualified domain name for the Application Server or Load Balancer + * `$APIGatewayPort` – {{% ctx %}} API Gateway Service port (8722) or Load Balancer port (typically 443 or 8722) + * `$loglevel` – Desired log level as an integer, `1` is enabled and `4` is the default error level + * `$user` – {{% ctx %}} API Gateway Basic Auth Username + +1. Execute the script, entering the Basic Auth User's password when prompted. +1. Confirm success response: + + If the call was successful, there should be no errors and the following response should be received + + ``` powershell + LogLevel was successfully configured. + ``` diff --git a/content/en/docs/2025.9/FAQs/change-logging-levels/change-block-logging.md b/content/en/docs/2025.9/FAQs/change-logging-levels/change-block-logging.md new file mode 100644 index 000000000..9c983c5a7 --- /dev/null +++ b/content/en/docs/2025.9/FAQs/change-logging-levels/change-block-logging.md @@ -0,0 +1,84 @@ +--- +title: "Change Block Logging Level" +linkTitle: "Change Block Logging Level" +description: "Instructions on how to change the Logging Level for Block Logging." +weight: 5 +--- + +# {{% param title %}} + +Block Logging in {{% ctx %}} logs the following Block Properties by default regardless of the log level configured: + +* Execute Data Command + * Command > commandText + * Command > parameters +* Execute Http Request + * Http Request + * Http Response +* Execute Soap Request + * Soap Request + * Soap Response +* Execute PowerShell Script + * Script + * Parameters + * Outputs + * Records +* Execute Ssh Command + * Command + * Response + * Ssh Logs + +To change the Logging Level for Block Logging so that every block is logged when executed, the below PowerShell script can be used to make a REST call against your {{% ctx %}} platform. + +1. Run Windows PowerShell ISE as Administrator. +1. Copy the following script into the PowerShell window: + + ``` powershell + $serverFQDN = "server.domain.com" + $APIGatewayPort = 8722 + $loglevel = 4 + $user = "BasicAuthUser" + + $securePass = Read-Host -Prompt "Enter password for $user" -AsSecureString + + $ptr = [Runtime.InteropServices.Marshal]::SecureStringToBSTR($securePass) + try { + $plainPass = [Runtime.InteropServices.Marshal]::PtrToStringBSTR($ptr) + + $authBytes = [System.Text.Encoding]::ASCII.GetBytes("$user`:$plainPass") + $base64AuthInfo = [Convert]::ToBase64String($authBytes) + } + finally { + [Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ptr) + + $plainPass = $null + Remove-Variable -Name plainPass -Force + } + + $headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]" + $headers.Add("Content-Type", "application/json") + $headers.Add("Accept", "application/json") + $headers.Add("Authorization", "Basic $base64AuthInfo") + $path = "applications/execution/services/engine/blocks/packages/versions/executions/flows/workspaces/blocks/logging" + $body = @" + $loglevel + "@ + + $response = Invoke-RestMethod "https://${serverFQDN}:$APIGatewayPort/api/v1/default/default/$path" -Method PUT -Headers $headers -Body $body + $response + ``` + +1. Configure the following variables: + * `$serverFQDN` – The fully qualified domain name for the Application Server or Load Balancer + * `$APIGatewayPort` – {{% ctx %}} API Gateway Service port (8722) or Load Balancer port (typically 443 or 8722) + * `$loglevel` – Desired log level as an integer, `1` is enabled and `4` is the default error level + * `$user` – {{% ctx %}} API Gateway Basic Auth Username + +1. Execute the script, entering the Basic Auth User's password when prompted. +1. Confirm success response: + + If the call was successful, there should be no errors and the following response should be received + + ``` powershell + LogLevel was successfully configured. + ``` diff --git a/content/en/docs/2025.9/FAQs/change-logging-levels/change-flow-logging.md b/content/en/docs/2025.9/FAQs/change-logging-levels/change-flow-logging.md new file mode 100644 index 000000000..6aa8a4e9d --- /dev/null +++ b/content/en/docs/2025.9/FAQs/change-logging-levels/change-flow-logging.md @@ -0,0 +1,63 @@ +--- +title: "Change Flow Logging Level" +linkTitle: "Change Flow Logging Level" +description: "Instructions on how to change the Logging Level for Flow Logging." +weight: 1 +--- + +# {{% param title %}} + +To change the Logging Level for Flow Logging, the below PowerShell script can be used to make a REST call against your {{% ctx %}} platform. + +1. Run Windows PowerShell ISE as Administrator. +1. Copy the following script into the PowerShell window: + + ``` powershell + $serverFQDN = "server.domain.com" + $APIGatewayPort = 8722 + $loglevel = 4 + $user = "BasicAuthUser" + + $securePass = Read-Host -Prompt "Enter password for $user" -AsSecureString + + $ptr = [Runtime.InteropServices.Marshal]::SecureStringToBSTR($securePass) + try { + $plainPass = [Runtime.InteropServices.Marshal]::PtrToStringBSTR($ptr) + + $authBytes = [System.Text.Encoding]::ASCII.GetBytes("$user`:$plainPass") + $base64AuthInfo = [Convert]::ToBase64String($authBytes) + } + finally { + [Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ptr) + + $plainPass = $null + Remove-Variable -Name plainPass -Force + } + + $headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]" + $headers.Add("Content-Type", "application/json") + $headers.Add("Accept", "application/json") + $headers.Add("Authorization", "Basic $base64AuthInfo") + $path = "applications/execution/services/engine/blocks/packages/versions/executions/flows/logging" + $body = @" + $loglevel + "@ + + $response = Invoke-RestMethod "https://${serverFQDN}:$APIGatewayPort/api/v1/default/default/$path" -Method PUT -Headers $headers -Body $body + $response + ``` + +1. Configure the following variables: + * `$serverFQDN` – The fully qualified domain name for the Application Server or Load Balancer + * `$APIGatewayPort` – {{% ctx %}} API Gateway Service port (8722) or Load Balancer port (typically 443 or 8722) + * `$loglevel` – Desired log level as an integer, `1` is enabled and `4` is the default error level + * `$user` – {{% ctx %}} API Gateway Basic Auth Username + +1. Execute the script, entering the Basic Auth User's password when prompted. +1. Confirm success response: + + If the call was successful, there should be no errors and the following response should be received + + ``` powershell + LogLevel was successfully configured. + ``` diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/prerequisites.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/prerequisites.md index f4130d7a5..d9491a473 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/prerequisites.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/prerequisites.md @@ -35,6 +35,6 @@ On each Application Server that Promtail is installed on: 1. [Migrate Promtail to Grafana Alloy][Migrate to Alloy] -[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1_10.2" >}} +[Grafana Alloy 1.10.2]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaAlloy.1_10_2.Windows" >}} [Grafana Alloy Install]: {{< url path="GitHub.Cortex.Observability.4_0_0.GrafanaAlloyInstallZip" >}} [Migrate to Alloy]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3_0_0to4_0_0.Cloud.Grafana.MigrateToAlloy" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/prerequisites.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/prerequisites.md index 6a54769a7..f0e157e13 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/prerequisites.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/prerequisites.md @@ -72,6 +72,6 @@ Grafana Alloy requires a domain user that is not a member of the Local Administr [Grafana 12.1.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.12_1_1.Windows" >}} [Grafana Loki 3.5.5]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3_5_5.GrafanaLokiInstallZip" >}} [Grafana Loki Install]: {{< url path="GitHub.Cortex.Observability.4_0_0.GrafanaLokiInstallZip" >}} -[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1_10.2" >}} +[Grafana Alloy 1.10.2]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaAlloy.1_10_2.Windows" >}} [Grafana Alloy Install]: {{< url path="GitHub.Cortex.Observability.4_0_0.GrafanaAlloyInstallZip" >}} [Upgrade Grafana]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3_0_0to4_0_0.OnPremise.Grafana.UpgradeGrafana" >}} diff --git a/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/import-dashboards.md b/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/import-dashboards.md index 102f60ce0..1ccc49672 100644 --- a/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/import-dashboards.md +++ b/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/import-dashboards.md @@ -32,13 +32,18 @@ Please ensure that the set up for [Grafana][] and [Loki][] have been completed b 1. Click the Dashboards menu item. 1. Click the *New* dropdown and select *Import*. 1. Click on *Upload dashboard JSON file*. -1. Locate the `Flow Execution Requests.json` file extracted from the downloaded `Grafana.Dashboards.zip`. +1. Locate the `Flow Execution Details.json` file extracted from the downloaded `Grafana.Dashboards.zip`. 1. Select the file and click *Open*. 1. Select the folder in Grafana you wish the dashboard to be saved in, e.g. *Cortex*. 1. Select your [configured Loki data source][] from the dropdown menu, e.g. *grafanacloud-cortex-logs*. 1. Click *Import*. +1. Repeat steps 2 - 10 for the `Flow Execution Requests.json` file. 1. Repeat steps 2 - 10 for the `Platform Health.json` file. +{{% alert title="Warning" color="warning" %}} +The *Flow Execution Details* dashboard will only work if `Flow Logging` is enabled on your platform. See {{< ahref path="Cortex.Faqs.ChangeLoggingLevels.FlowLogging.MainDoc" title="Change Flow Logging Level" >}} for instructions on how to do this. +{{% / alert %}} + ## Configure Data Sources It is necessary to update the Custom Filter inside the dashboards to use the correct data source. @@ -66,6 +71,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.4_2_1.GrafanaDashboardsZip" >}} +[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.5_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" >}} diff --git a/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md b/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md index 60f4c0c6e..ee755708d 100644 --- a/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md +++ b/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md @@ -14,7 +14,7 @@ This guide describes how to configure Grafana Alloy on the Application Server(s) ## 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 for 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 `__path__` in the `local.file_match "ApiGateway"` > `path_targets` section to the path of the `Logs` folder for 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 `__path__` in the `local.file_match "ExecutionService"` > `path_targets` section to the path of the `Logs` folder for the Execution Service, e.g. `"C:/ProgramData/Cortex/Execution Service/Logs/**/*.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. diff --git a/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md b/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md index 9972851c7..90e348d2b 100644 --- a/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md +++ b/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md @@ -11,7 +11,7 @@ This guide describes how to install Grafana Alloy on the Application Server(s). ## Install Grafana Alloy -1. Download the [Grafana Alloy 1.10.2][] archive. +1. Download the [Grafana Alloy 1.15.1][] archive. 1. Extract content of the downloaded archive to a suitable location, e.g. `C:\ProgramData\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. @@ -26,6 +26,6 @@ This archive contains the `config.alloy` configuration file and PowerShell scrip 1. [Configure Grafana Alloy][] [Configure Grafana Alloy]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.InstallAlloy.ConfigureAlloy.MainDoc" >}} -[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1_10.2" >}} -[Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.4_2_1.GrafanaAlloyInstallZip" >}} +[Grafana Alloy 1.15.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaAlloy.1_15_1.Windows" >}} +[Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.5_0_0.GrafanaAlloyInstallZip" >}} [Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}} diff --git a/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/prerequisites.md b/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/prerequisites.md index 1abad13b0..6acc51610 100644 --- a/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/prerequisites.md +++ b/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/prerequisites.md @@ -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)][] | [Grafana Alloy 1.10.2][] | +| Application Server | [2022 (x64)][] *Recommended*
[2019 (x64)][] | [Grafana Alloy 1.15.1][] | [^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. @@ -59,5 +59,5 @@ Grafana Alloy requires a domain user that is not a member of the Local Administr [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" >}} -[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1_10.2" >}} +[Grafana Alloy 1.15.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaAlloy.1_15_1.Windows" >}} [Set up Grafana]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupGrafana.MainDoc" >}} diff --git a/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md b/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md index 64115dc9a..c7ceaba47 100644 --- a/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md +++ b/content/en/docs/2025.9/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md @@ -27,6 +27,16 @@ This test uses the test flow published as part of testing the {{% ctx %}} instal {{% alert title="Note" %}} If you used self-signed certificates when installing the Application Servers you may need to disable SSL certificate validation in your HTTP client. {{% /alert %}} 1. Once the request has completed, using a web browser, log in to your configured Grafana. +1. Click the Menu icon {{< image src="/images/GrafanaMenuIcon.png" title="Menu icon" >}} to view the available options. +1. Click the Dashboards menu item. +1. Click the folder name that the dashboards were imported to, if not already expanded. +1. Click the *Flow Execution Details* dashboard to open it. +1. The request made at step 1 should be visible on the dashboard. + + {{% alert title="Note" %}}If Flow Logging has not been enabled then this dashboard will not display any data. See {{< ahref path="Cortex.Faqs.ChangeLoggingLevels.FlowLogging.MainDoc" title="Change Flow Logging Level" >}} for instructions on how to do this.
+ If other requests have been made then there may be more than one request visible on the dashboard. + {{% / alert %}} + 1. Click the Menu icon {{< image src="/images/GrafanaMenuIcon.png" title="Menu icon" >}} to view the available options. 1. Click the Dashboards menu item. 1. Click the folder name that the dashboards were imported to, if not already expanded. diff --git a/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md b/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md index eb7b152ee..990eae7ad 100644 --- a/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md +++ b/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md @@ -30,7 +30,7 @@ To import the CA certificate: ## 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 for 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 `__path__` in the `local.file_match "ApiGateway"` > `path_targets` section to the path of the `Logs` folder for 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 `__path__` in the `local.file_match "ExecutionService"` > `path_targets` section to the path of the `Logs` folder for the Execution Service, e.g. `"C:/ProgramData/Cortex/Execution Service/Logs/**/*.json"`. 1. Set the Grafana Loki `url` in the `loki.write "default"` > `endpoint` section which can be found at the end of the file. diff --git a/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md b/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md index d6e1e6005..5cea6a2c8 100644 --- a/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md +++ b/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md @@ -11,7 +11,7 @@ This guide describes how to install Grafana Alloy on the Application Server(s). ## Install Grafana Alloy -1. Download the [Grafana Alloy 1.10.2][] archive. +1. Download the [Grafana Alloy 1.15.1][] archive. 1. Extract content of the downloaded archive to a suitable location, e.g. `C:\ProgramData\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. @@ -26,7 +26,7 @@ This archive contains the `config.alloy` configuration file and PowerShell scrip 1. [Configure Grafana Alloy][] [Configure Grafana Alloy]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallAlloy.ConfigureAlloy" >}} -[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1_10.2" >}} -[Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.4_2_1.GrafanaAlloyInstallZip" >}} +[Grafana Alloy 1.15.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaAlloy.1_15_1.Windows" >}} +[Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.5_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.9/getting-started/on-premise/add-observability-to-innovation/Grafana/install-grafana/install-grafana.md b/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/install-grafana/install-grafana.md index 105c263c1..754c6e072 100644 --- a/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/install-grafana/install-grafana.md +++ b/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/install-grafana/install-grafana.md @@ -11,7 +11,7 @@ This guide describes how to install Grafana on the Web Application Server. Pleas ## Install Grafana -1. Download the [Grafana 12.1.1][] Windows installer. +1. Download the [Grafana 13.0.1][] Windows installer. 1. Run the installer and install Grafana to a suitable location. ## Next Steps? @@ -19,6 +19,5 @@ This guide describes how to install Grafana on the Web Application Server. Pleas 1. [Configure Grafana][] [Configure Grafana]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallGrafana.ConfigureGrafana" >}} -[Grafana 12.1.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.12_1_1.Windows" >}} +[Grafana 13.0.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.13.0.1.WindowsInstaller" >}} [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.9/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md b/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md index 5dea373d6..dce9df684 100644 --- a/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md +++ b/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md @@ -11,7 +11,7 @@ This guide describes how to install Grafana Loki on the Web Application Server. ## Install Grafana Loki -1. Download [Grafana Loki 3.5.5][] archive. +1. Download [Grafana Loki 3.7.1][] archive. 1. Extract content of the downloaded archive to a suitable location, e.g. `C:\ProgramData\Cortex\Observability\Loki`. 1. Download the [Grafana Loki Install.zip][] archive and extract its contents alongside the previously extracted Grafana Loki `loki-windows-amd64.exe`. This archive contains the `loki-local-config.yaml` configuration file, [NSSM][] (the Non-Sucking Service Manager program) and PowerShell scripts to help manage Grafana Loki as a Windows service. @@ -25,7 +25,7 @@ This archive contains the `loki-local-config.yaml` configuration file, [NSSM][] 1. [Configure Loki][] [Configure Loki]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.ConfigureLoki" >}} -[Grafana Loki 3.5.5]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3_5_5.GrafanaLokiInstallZip" >}} -[Grafana Loki Install.zip]: {{< url path="GitHub.Cortex.Observability.4_2_1.GrafanaLokiInstallZip" >}} +[Grafana Loki 3.7.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3_7_1.GrafanaLokiInstallZip" >}} +[Grafana Loki Install.zip]: {{< url path="GitHub.Cortex.Observability.5_0_0.GrafanaLokiInstallZip" >}} [NSSM]: {{< url path="NSSM.MainDoc" >}} [Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}} diff --git a/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md b/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md index 20fe1d777..60331b85b 100644 --- a/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md +++ b/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md @@ -40,8 +40,8 @@ The application servers (as described in {{< ahref path="Cortex.GettingStarted.O | 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]
[URL Rewrite module 2.1][] | [Grafana 12.1.1][] *Enterprise Edition*
[Grafana Loki 3.5.5][]| -| Application Server | [2022 (x64)][] *Recommended*
[2019 (x64)][] | | [Grafana Alloy 1.10.2][]| +| Web Application Server | [2022 (x64)][] *Recommended*
[2019 (x64)][] | 10.0.20348[^3]
10.0.17763[^4]
[URL Rewrite module 2.1][] | [Grafana 13.0.1][] *Enterprise Edition*
[Grafana Loki 3.7.1][]| +| Application Server | [2022 (x64)][] *Recommended*
[2019 (x64)][] | | [Grafana Alloy 1.15.1][]| [^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. @@ -159,11 +159,10 @@ Grafana Alloy requires a domain user that is not a member of the Local Administr [2022 (x64)]: {{< url path="Microsoft.Downloads.Windows.Server2022" >}} [Architecture]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Architecture" >}} [configuring Grafana to use HTTPS]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallGrafana.ConfigureHTTPS" >}} -[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 12.1.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.12_1_1.Windows" >}} -[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1_10.2" >}} -[Grafana Loki 3.5.5]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3_5_5.GrafanaLokiInstallZip" >}} +[Grafana 13.0.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.13.0.1.WindowsInstaller" >}} +[Grafana Alloy 1.15.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaAlloy.1_15_1.Windows" >}} +[Grafana Loki 3.7.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3_7_1.GrafanaLokiInstallZip" >}} [Install Grafana]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallGrafana.MainDoc" >}} [installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.InstallCertificate" >}} [Let’s Encrypt]: {{< url path="LetsEncrypt.MainDoc" >}} diff --git a/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/setup-grafana.md b/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/setup-grafana.md index 50bd252a7..823154490 100644 --- a/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/setup-grafana.md +++ b/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/setup-grafana.md @@ -9,7 +9,7 @@ weight: 60 This guide describes where to get the default {{% ctx %}} Dashboards from and how to import them for use in Grafana. -Please ensure that the Installations for [Grafana][] and [Loki][] have been completed before starting this section. +Please ensure that the Installations for [Grafana][], [Loki][] and [Alloy] have been completed before starting this section. ## Configure Loki Data Source in Grafana @@ -47,13 +47,18 @@ Please ensure that the Installations for [Grafana][] and [Loki][] have been comp 1. Go to *Dashboards* via the menu on the left sidebar. 1. Click the *New* button and select *Import* from the drop-down menu. 1. Click the *Upload JSON file* button. -1. Locate the `Flow Execution Requests.json` file extracted from the downloaded `Grafana.Dashboards.zip`. +1. Locate the `Flow Execution Details.json` file extracted from the downloaded `Grafana.Dashboards.zip`. 1. Select the file and click *Open*. 1. Select the folder in Grafana you wish the dashboard to be saved in, e.g. *Cortex*. 1. Select your configured Loki data source from the dropdown menu. 1. Click *Import*. +1. Repeat steps 2 - 8 for the `Flow Execution Requests.json` file. 1. Repeat steps 2 - 8 for the `Platform Health.json` file. +{{% alert title="Warning" color="warning" %}} +The *Flow Execution Details* dashboard will only work if `Flow Logging` is enabled on your platform. See {{< ahref path="Cortex.Faqs.ChangeLoggingLevels.FlowLogging.MainDoc" title="Change Flow Logging Level" >}} for instructions on how to do this. +{{% / alert %}} + ## Configure Data Sources It is necessary to update the Custom Filter inside the dashboards to use the correct data source. @@ -64,7 +69,7 @@ To do this, follow these steps for all default {{% ctx %}} dashboards imported: 1. To open a dashboard: 1. Go to *Dashboards* via the menu on the left sidebar. 1. Click the folder name that the dashboards were imported to. - 1. Click the *Flow Execution Requests* dashboard to open it. + 1. Click the *Flow Execution Details* dashboard to open it. 1. Open the *Dashboard settings* menu via the cog icon in the top right-hand side of the dashboard. 1. Click *Variables* from the top menu of the *Settings* page. 1. Click *CustomFilter* at the bottom of the *Variables* list. @@ -72,13 +77,15 @@ To do this, follow these steps for all default {{% ctx %}} dashboards imported: 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. +1. Repeat steps 2 - 9 for the *Flow Execution Requests* dashboard. 1. Repeat steps 2 - 9 for the *Platform Health* dashboard. ## Next Steps? 1. [Try it Out][] -[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.4_2_1.GrafanaDashboardsZip" >}} +[Alloy]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallAlloy.MainDoc" >}} +[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.5_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/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md b/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md index 019415dfc..c838ca748 100644 --- a/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md +++ b/content/en/docs/2025.9/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md @@ -27,6 +27,15 @@ This test uses the test flow published as part of testing the {{% ctx %}} instal {{% alert title="Note" %}} If you used self-signed certificates when installing the Application Servers you may need to disable SSL certificate validation in your HTTP client. {{% /alert %}} 1. Once the request has completed, using a web browser, log in to your configured Grafana. +1. Open the *Dashboards* page via the menu on the left sidebar. +1. Click the folder name that the dashboards were imported to. +1. Click the *Flow Execution Details* dashboard to open it. +1. The request made at step 1 should be visible on the dashboard. + + {{% alert title="Note" %}}If Flow Logging has not been enabled then this dashboard will not display any data. See {{< ahref path="Cortex.Faqs.ChangeLoggingLevels.FlowLogging.MainDoc" title="Change Flow Logging Level" >}} for instructions on how to do this.
+ If other requests have been made then there may be more than one request visible on the dashboard. + {{% / alert %}} + 1. Open the *Dashboards* page via the menu on the left sidebar. 1. Click the folder name that the dashboards were imported to. 1. Click the *Flow Execution Requests* dashboard to open it. diff --git a/content/en/docs/2026.3/FAQs/change-logging-levels/_index.md b/content/en/docs/2026.3/FAQs/change-logging-levels/_index.md new file mode 100644 index 000000000..09a7c8d67 --- /dev/null +++ b/content/en/docs/2026.3/FAQs/change-logging-levels/_index.md @@ -0,0 +1,20 @@ +--- +title: "How do I change the Logging Level?" +linkTitle: "How do I change the Logging Level?" +description: "Instructions on how to change the {{% ctx %}} Logging Level." +weight: 1000 +--- + +{{% ctx %}} Logging Levels are set to `Error` by default for most services. However, levels can be changed whilst {{% ctx %}} is running by sending REST calls to the {{% ctx %}} API Gateway service. + +{{% alert title="Note" %}} +Although the Logging Level for the {{% ctx %}} API Gateway service can be increased, it will still always log all API calls regardless of Logging Level configured. +{{% / alert %}} + +If increasing the Logging Level, particularly if increasing for everything or for Block Logging, we recommend that this is done only when required. Increasing log levels will lead to an increase in disk usage and disk writes, which can impact the performance of the {{% ctx %}} platform if not monitored. + +Whilst increased Logging Levels are in place, we would recommend closely monitoring system performance and disk space usage. + +All REST calls to update Logging Levels use Basic Auth and can be made using REST clients such as [Postman][] or using scripts such as PowerShell. + +[Postman]: {{< url path="Postman.Downloads.MainDoc" >}} diff --git a/content/en/docs/2026.3/FAQs/change-logging-levels/change-all-logging.md b/content/en/docs/2026.3/FAQs/change-logging-levels/change-all-logging.md new file mode 100644 index 000000000..05085ad7f --- /dev/null +++ b/content/en/docs/2026.3/FAQs/change-logging-levels/change-all-logging.md @@ -0,0 +1,63 @@ +--- +title: "Change All Logging Levels" +linkTitle: "Change All Logging Levels" +description: "Instructions on how to change the Logging Level for All Logging." +weight: 10 +--- + +# {{% param title %}} + +To change the Logging Level for all services, the below PowerShell script can be used to make a REST call against your {{% ctx %}} platform. + +1. Run Windows PowerShell ISE as Administrator. +1. Copy the following script into the PowerShell window: + + ``` powershell + $serverFQDN = "server.domain.com" + $APIGatewayPort = 8722 + $loglevel = 4 + $user = "BasicAuthUser" + + $securePass = Read-Host -Prompt "Enter password for $user" -AsSecureString + + $ptr = [Runtime.InteropServices.Marshal]::SecureStringToBSTR($securePass) + try { + $plainPass = [Runtime.InteropServices.Marshal]::PtrToStringBSTR($ptr) + + $authBytes = [System.Text.Encoding]::ASCII.GetBytes("$user`:$plainPass") + $base64AuthInfo = [Convert]::ToBase64String($authBytes) + } + finally { + [Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ptr) + + $plainPass = $null + Remove-Variable -Name plainPass -Force + } + + $headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]" + $headers.Add("Content-Type", "application/json") + $headers.Add("Accept", "application/json") + $headers.Add("Authorization", "Basic $base64AuthInfo") + $path = "applications/logging" + $body = @" + $loglevel + "@ + + $response = Invoke-RestMethod "https://${serverFQDN}:$APIGatewayPort/api/v1/default/default/$path" -Method PUT -Headers $headers -Body $body + $response + ``` + +1. Configure the following variables: + * `$serverFQDN` – The fully qualified domain name for the Application Server or Load Balancer + * `$APIGatewayPort` – {{% ctx %}} API Gateway Service port (8722) or Load Balancer port (typically 443 or 8722) + * `$loglevel` – Desired log level as an integer, `1` is enabled and `4` is the default error level + * `$user` – {{% ctx %}} API Gateway Basic Auth Username + +1. Execute the script, entering the Basic Auth User's password when prompted. +1. Confirm success response: + + If the call was successful, there should be no errors and the following response should be received + + ``` powershell + LogLevel was successfully configured. + ``` diff --git a/content/en/docs/2026.3/FAQs/change-logging-levels/change-block-logging.md b/content/en/docs/2026.3/FAQs/change-logging-levels/change-block-logging.md new file mode 100644 index 000000000..9c983c5a7 --- /dev/null +++ b/content/en/docs/2026.3/FAQs/change-logging-levels/change-block-logging.md @@ -0,0 +1,84 @@ +--- +title: "Change Block Logging Level" +linkTitle: "Change Block Logging Level" +description: "Instructions on how to change the Logging Level for Block Logging." +weight: 5 +--- + +# {{% param title %}} + +Block Logging in {{% ctx %}} logs the following Block Properties by default regardless of the log level configured: + +* Execute Data Command + * Command > commandText + * Command > parameters +* Execute Http Request + * Http Request + * Http Response +* Execute Soap Request + * Soap Request + * Soap Response +* Execute PowerShell Script + * Script + * Parameters + * Outputs + * Records +* Execute Ssh Command + * Command + * Response + * Ssh Logs + +To change the Logging Level for Block Logging so that every block is logged when executed, the below PowerShell script can be used to make a REST call against your {{% ctx %}} platform. + +1. Run Windows PowerShell ISE as Administrator. +1. Copy the following script into the PowerShell window: + + ``` powershell + $serverFQDN = "server.domain.com" + $APIGatewayPort = 8722 + $loglevel = 4 + $user = "BasicAuthUser" + + $securePass = Read-Host -Prompt "Enter password for $user" -AsSecureString + + $ptr = [Runtime.InteropServices.Marshal]::SecureStringToBSTR($securePass) + try { + $plainPass = [Runtime.InteropServices.Marshal]::PtrToStringBSTR($ptr) + + $authBytes = [System.Text.Encoding]::ASCII.GetBytes("$user`:$plainPass") + $base64AuthInfo = [Convert]::ToBase64String($authBytes) + } + finally { + [Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ptr) + + $plainPass = $null + Remove-Variable -Name plainPass -Force + } + + $headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]" + $headers.Add("Content-Type", "application/json") + $headers.Add("Accept", "application/json") + $headers.Add("Authorization", "Basic $base64AuthInfo") + $path = "applications/execution/services/engine/blocks/packages/versions/executions/flows/workspaces/blocks/logging" + $body = @" + $loglevel + "@ + + $response = Invoke-RestMethod "https://${serverFQDN}:$APIGatewayPort/api/v1/default/default/$path" -Method PUT -Headers $headers -Body $body + $response + ``` + +1. Configure the following variables: + * `$serverFQDN` – The fully qualified domain name for the Application Server or Load Balancer + * `$APIGatewayPort` – {{% ctx %}} API Gateway Service port (8722) or Load Balancer port (typically 443 or 8722) + * `$loglevel` – Desired log level as an integer, `1` is enabled and `4` is the default error level + * `$user` – {{% ctx %}} API Gateway Basic Auth Username + +1. Execute the script, entering the Basic Auth User's password when prompted. +1. Confirm success response: + + If the call was successful, there should be no errors and the following response should be received + + ``` powershell + LogLevel was successfully configured. + ``` diff --git a/content/en/docs/2026.3/FAQs/change-logging-levels/change-flow-logging.md b/content/en/docs/2026.3/FAQs/change-logging-levels/change-flow-logging.md new file mode 100644 index 000000000..6aa8a4e9d --- /dev/null +++ b/content/en/docs/2026.3/FAQs/change-logging-levels/change-flow-logging.md @@ -0,0 +1,63 @@ +--- +title: "Change Flow Logging Level" +linkTitle: "Change Flow Logging Level" +description: "Instructions on how to change the Logging Level for Flow Logging." +weight: 1 +--- + +# {{% param title %}} + +To change the Logging Level for Flow Logging, the below PowerShell script can be used to make a REST call against your {{% ctx %}} platform. + +1. Run Windows PowerShell ISE as Administrator. +1. Copy the following script into the PowerShell window: + + ``` powershell + $serverFQDN = "server.domain.com" + $APIGatewayPort = 8722 + $loglevel = 4 + $user = "BasicAuthUser" + + $securePass = Read-Host -Prompt "Enter password for $user" -AsSecureString + + $ptr = [Runtime.InteropServices.Marshal]::SecureStringToBSTR($securePass) + try { + $plainPass = [Runtime.InteropServices.Marshal]::PtrToStringBSTR($ptr) + + $authBytes = [System.Text.Encoding]::ASCII.GetBytes("$user`:$plainPass") + $base64AuthInfo = [Convert]::ToBase64String($authBytes) + } + finally { + [Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ptr) + + $plainPass = $null + Remove-Variable -Name plainPass -Force + } + + $headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]" + $headers.Add("Content-Type", "application/json") + $headers.Add("Accept", "application/json") + $headers.Add("Authorization", "Basic $base64AuthInfo") + $path = "applications/execution/services/engine/blocks/packages/versions/executions/flows/logging" + $body = @" + $loglevel + "@ + + $response = Invoke-RestMethod "https://${serverFQDN}:$APIGatewayPort/api/v1/default/default/$path" -Method PUT -Headers $headers -Body $body + $response + ``` + +1. Configure the following variables: + * `$serverFQDN` – The fully qualified domain name for the Application Server or Load Balancer + * `$APIGatewayPort` – {{% ctx %}} API Gateway Service port (8722) or Load Balancer port (typically 443 or 8722) + * `$loglevel` – Desired log level as an integer, `1` is enabled and `4` is the default error level + * `$user` – {{% ctx %}} API Gateway Basic Auth Username + +1. Execute the script, entering the Basic Auth User's password when prompted. +1. Confirm success response: + + If the call was successful, there should be no errors and the following response should be received + + ``` powershell + LogLevel was successfully configured. + ``` diff --git a/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/prerequisites.md b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/prerequisites.md index f4130d7a5..d9491a473 100644 --- a/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/prerequisites.md +++ b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/prerequisites.md @@ -35,6 +35,6 @@ On each Application Server that Promtail is installed on: 1. [Migrate Promtail to Grafana Alloy][Migrate to Alloy] -[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1_10.2" >}} +[Grafana Alloy 1.10.2]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaAlloy.1_10_2.Windows" >}} [Grafana Alloy Install]: {{< url path="GitHub.Cortex.Observability.4_0_0.GrafanaAlloyInstallZip" >}} [Migrate to Alloy]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3_0_0to4_0_0.Cloud.Grafana.MigrateToAlloy" >}} diff --git a/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/prerequisites.md b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/prerequisites.md index 6a54769a7..f0e157e13 100644 --- a/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/prerequisites.md +++ b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/prerequisites.md @@ -72,6 +72,6 @@ Grafana Alloy requires a domain user that is not a member of the Local Administr [Grafana 12.1.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.12_1_1.Windows" >}} [Grafana Loki 3.5.5]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3_5_5.GrafanaLokiInstallZip" >}} [Grafana Loki Install]: {{< url path="GitHub.Cortex.Observability.4_0_0.GrafanaLokiInstallZip" >}} -[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1_10.2" >}} +[Grafana Alloy 1.10.2]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaAlloy.1_10_2.Windows" >}} [Grafana Alloy Install]: {{< url path="GitHub.Cortex.Observability.4_0_0.GrafanaAlloyInstallZip" >}} [Upgrade Grafana]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3_0_0to4_0_0.OnPremise.Grafana.UpgradeGrafana" >}} diff --git a/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/_index.md b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/_index.md new file mode 100644 index 000000000..23289ecb1 --- /dev/null +++ b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/_index.md @@ -0,0 +1,6 @@ +--- +title: "4.2.1 to 5.0.0" +linkTitle: "4.2.1 to 5.0.0" +description: "Instructions to upgrade your observability platform for {{% ctx %}} from 4.2.1 to 5.0.0." +weight: 960 +--- \ No newline at end of file diff --git a/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/_index.md b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/_index.md new file mode 100644 index 000000000..4eaa242d6 --- /dev/null +++ b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/_index.md @@ -0,0 +1,6 @@ +--- +title: "Cloud" +linkTitle: "Cloud" +description: "Information about upgrading a cloud-hosted observability platform for {{% ctx %}}." +weight: 500 +--- \ No newline at end of file diff --git a/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana/_index.md b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana/_index.md new file mode 100644 index 000000000..1337f8126 --- /dev/null +++ b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana/_index.md @@ -0,0 +1,6 @@ +--- +title: "Grafana" +linkTitle: "Grafana" +description: "Information about upgrading a cloud-hosted Grafana platform for {{% ctx %}}." +weight: 1000 +--- \ No newline at end of file diff --git a/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana/prerequisites.md b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana/prerequisites.md new file mode 100644 index 000000000..335e8dd47 --- /dev/null +++ b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana/prerequisites.md @@ -0,0 +1,34 @@ +--- +title: "Prerequisites" +linkTitle: "Prerequisites" +description: "The prerequisites required before performing the observability upgrade." +weight: 1 +--- + +# {{% param title %}} + +## Make Artefacts Available + +1. Download the required artefacts to a folder on your machine: + + * [Grafana Alloy 1.15.1][] archive. + * [Grafana Dashboards][] archive. + +1. Extract the downloaded `alloy-installer-windows-amd64.exe` archive to a folder with the same name. +1. Extract the downloaded `Grafana.Dashboards` archive to a folder with the same name. + +## Backup Old Files + +On each Application Server that Grafana Alloy is installed on: + +1. Create a folder called `Observability Backups` in a known location. +1. Open File Explorer and navigate to the location where Grafana Alloy is running from, e.g. `C:\ProgramData\Cortex\Observability\Grafana Alloy`. +1. Copy the `config.alloy` file and save it to the `Observability Backups` folder created at step 1. + +## Next Steps? + +1. [Upgrade Grafana Alloy][Upgrade Alloy] + +[Grafana Alloy 1.15.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaAlloy.1_15_1.Windows" >}} +[Upgrade Alloy]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.Cloud.Grafana.UpgradeAlloy" >}} +[Grafana Dashboards]: {{< url path="GitHub.Cortex.Observability.5_0_0.GrafanaDashboardsZip" >}} diff --git a/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana/try-it-out.md b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana/try-it-out.md new file mode 100644 index 000000000..d6e31c827 --- /dev/null +++ b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana/try-it-out.md @@ -0,0 +1,62 @@ +--- +title: "Try it out" +linkTitle: "Try it out" +description: "Information about trying out the observability platform after upgrade." +weight: 4 +--- + +# {{% param title %}} + +This guide describes how to verify that the upgrade has been successful. Please ensure that [Upgrade Grafana Alloy][Upgrade Alloy] has been completed before taking these steps. + +## Confirm New Data is Processed + +{{% alert title="Note" %}} +This test uses the test flow published as part of testing the {{% ctx %}} installation. See {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.TryItOutPublishedFlowNew" title="Testing HA installation" >}} or {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.TryItOutPublishedFlowNew" title="Testing non-HA installation" >}}. An alternative flow can be used that exists on the system and can be executed. +{{% / alert %}} + +1. Open an HTTP client, such as [Postman][]. Make a request with the following format: + | Property | Value | + |---------------|-------------------------------------------------------------------------------------| + | Action | POST | + | URL | For HA installation use:
`https://{FQDN of Load Balancer Server}/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://load-balancer.domain.com/api/default/default/flows/NewFlow/executions?packageName=NewPackage`

For non-HA installation use:
`https://{FQDN of server}:8722/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://server.domain.com:8722/api/default/default/flows/NewFlow/executions?packageName=NewPackage`| + | Content Type | application/json | + | Body | {} | + | Authentication| Basic | + | Username | The value used for `ApiGatewayBasicAuthUsername` when installing Application Services. See [HA Installation script configuration][] or [Non-HA Installation script configuration][] for the value specified.| + | Password | The value used for `ApiGatewayBasicAuthPassword` when installing Application Services (Unencrypted). See [HA Installation script configuration][] or [Non-HA Installation script configuration][] for the value specified.| + + {{% alert title="Note" %}} If you used self-signed certificates when installing the Application Servers you may need to disable SSL certificate validation in your HTTP client. {{% /alert %}} + +1. Once the request has completed, in your web browser, navigate to and log in to your configured Grafana. +1. Click the Menu icon {{< image src="/images/GrafanaMenuIcon.png" title="Menu icon" >}} to view the available options. +1. Click the Dashboards menu item. +1. Click the folder name that the dashboards were imported to, if not already expanded. +1. Click the *Flow Execution Details* dashboard to open it. +1. The request made at step 1 should be visible on the dashboard. + + {{% alert title="Note" %}}If Flow Logging has not been enabled then this dashboard will not display any data. See {{< ahref path="Cortex.Faqs.ChangeLoggingLevels.FlowLogging.MainDoc" title="Change Flow Logging Level" >}} for instructions on how to do this.
+ If other requests have been made then there may be more than one request visible on the dashboard. + {{% / alert %}} + +1. Click the Menu icon {{< image src="/images/GrafanaMenuIcon.png" title="Menu icon" >}} to view the available options. +1. Click the Dashboards menu item. +1. Click the folder name that the dashboards were imported to, if not already expanded. +1. Click the *Flow Execution Requests* dashboard to open it. +1. The request made at step 1 should be visible on the dashboard. +{{% alert title="Note" %}} +If other requests have been made then there may be more than one request visible on the dashboard. +{{% / alert %}} +1. Click the Menu icon {{< image src="/images/GrafanaMenuIcon.png" title="Menu icon" >}} to view the available options. +1. Click the Dashboards menu item. +1. Click the folder name that the dashboards were imported to, if not already expanded. +1. Click the *Platform Health* dashboard to open it. +1. The request made at step 1 should be visible on the dashboard. +{{% alert title="Note" %}} +If other requests have been made then there may be more than one request visible on the dashboard. +{{% / alert %}} + +[Postman]: {{< url path="Postman.Downloads.MainDoc" >}} +[HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" >}} +[Upgrade Alloy]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.Cloud.Grafana.UpgradeAlloy" >}} +[Non-HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScriptNew" >}} diff --git a/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana/upgrade-alloy.md b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana/upgrade-alloy.md new file mode 100644 index 000000000..d6c05f568 --- /dev/null +++ b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana/upgrade-alloy.md @@ -0,0 +1,80 @@ +--- +title: "Upgrade Grafana Alloy" +linkTitle: "Upgrade Grafana Alloy" +description: "The steps to Upgrade Grafana Alloy." +weight: 2 +--- + +# {{% param title %}} + +This guide describes how to upgrade Grafana Alloy. + +{{% alert title="Note" %}} +These steps will need to be performed on all application servers that host a Grafana Alloy service. +{{% / alert %}} + +## Perform Upgrade + +1. Log in to the application server. +1. Open a File Explorer and navigate to the extracted alloy-installer-windows-amd64.exe folder created as part of [Make Artefacts Available][]. +1. Copy the `alloy-installer-windows-amd64.exe` into the location that Grafana Alloy was previously installed from, e.g. `C:\ProgramData\Cortex\Observability\Grafana Alloy`, overwriting the existing file if prompted to do so. +1. Execute the `alloy-installer-windows-amd64.exe` by double clicking on the file. +1. Follow the install wizard accepting the defaults and wait for the installation to complete. +1. Click `Close` to finish the installation. + +## 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. Locate the line containing `__path__` in the `loki.file_match "ApiGateway"` > `path_targets` section, which can be found near the beginning of the file. +1. Change the `__path__` value so that the part containing the file name changes to `ServiceFabricHttpEventLog-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]{,_[0-9][0-9][0-9]}.json`. Note there is a change to the `,` location. + + The line should now look similar to `__path__ = "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. Copy the following code and paste it in to the `config.alloy` file. It should be added to the end of the `expressions` section but before the `}` typically found on line 139. + + ``` text + FlowResult = "Event.Tags.Cortex.\"Execution.Result.Status\" || 'N/A'", + Method = "'Unknown'", + ``` + +1. Copy the following code and paste it in to the `config.alloy` file. It should be added to the end of the `values` section but before the `}` typically found on line 157 after the above change. + + ``` text + FlowResult = null, + Method = null, + ``` + +1. Copy the following code and paste it in to the `config.alloy` file. It should be added to the end of the `loki.process "ExecutionService" {` section but before the `}` typically found on line 162 after the above change. + + ``` text + + stage.match { + selector = "{job=\"ExecutionService\"}|~ \"\\\"Method\\\":.?\\\"Cortex.FlowEngine.Execution.Engine.Run\\\"\"" + + stage.json { + expressions = { + Method = "'FlowExecution'", + } + } + + stage.labels { + values = { + Method = null, + } + } + } + ``` + +1. Save the file. + +### Restart the 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. [Upgrade Dashboards][] + +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.Cloud.Grafana.MakeArtefactsAvailable" >}} +[Upgrade Dashboards]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.Cloud.Grafana.UpgradeDashboards" >}} diff --git a/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana/upgrade-dashboards.md b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana/upgrade-dashboards.md new file mode 100644 index 000000000..5e3662a71 --- /dev/null +++ b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana/upgrade-dashboards.md @@ -0,0 +1,52 @@ +--- +title: "Upgrade Dashboards" +linkTitle: "Upgrade Dashboards" +description: "Information about upgrading your Grafana dashboards." +weight: 3 +--- + +# {{% param title %}} + +This guide describes how to upgrade the default dashboards that are provided for your observability platform. + +{{% alert title="Warning" color="warning" %}} +A new *Flow Execution Details* Dashboard has been added to the default dashboards. This new dashboard will only work if `Flow Logging` is enabled on your platform. See {{< ahref path="Cortex.Faqs.ChangeLoggingLevels.FlowLogging.MainDoc" title="Change Flow Logging Level" >}} for instructions on how to do this. +{{% / alert %}} + +## Import New Dashboard + +1. Log in to Grafana Cloud with a user that has the *Admin* role. +1. Click the Menu icon {{< image src="/images/GrafanaMenuIcon.png" title="Menu icon" >}} to view the available options. +1. Click the Dashboards menu item. +1. Click the *New* dropdown and select *Import*. +1. Click on *Upload dashboard JSON file*. +1. Locate the extracted `Flow Execution Details.json` file downloaded as part of [Make Artefacts Available][]. +1. Select the file and click *Open*. +1. Select the folder in Grafana you wish the dashboard to be saved in, e.g. *Cortex*. +1. Select your configured Loki data source from the dropdown menu, e.g. *grafanacloud-cortex-logs*. +1. Click *Import*. + +## Configure Data Sources + +It is necessary to update the Custom Filter inside the dashboards to use the correct data source. + +1. Log in to Grafana Cloud with a user that has the *Admin* role. +1. To open a dashboard: + 1. Click the Menu icon {{< image src="/images/GrafanaMenuIcon.png" title="Menu icon" >}} to view the available options. + 1. Click the Dashboards menu item. + 1. Click the folder name that the dashboards were imported to. + 1. Click the *Flow Execution Details* dashboard to open it. +1. Open the *Dashboard settings* menu via the cog icon in the top right-hand side of the dashboard. +1. Click *Variables* from the top menu of the *Settings* page. +1. Click *CustomFilter* in the *Variables* list. +1. Select your 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 Grafana Alloy there will be no options available for selection. + +## Next Steps? + +1. [Try it out][] + +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.Cloud.Grafana.MakeArtefactsAvailable" >}} +[Try it out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.Cloud.Grafana.TryItOut" >}} diff --git a/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/_index.md b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/_index.md new file mode 100644 index 000000000..59f2ef8fd --- /dev/null +++ b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/_index.md @@ -0,0 +1,6 @@ +--- +title: "On-Premise" +linkTitle: "On-Premise" +description: "Information about upgrading an on-premise observability platform for {{% ctx %}}." +weight: 1 +--- \ No newline at end of file diff --git a/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/_index.md b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/_index.md new file mode 100644 index 000000000..0b777445d --- /dev/null +++ b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/_index.md @@ -0,0 +1,6 @@ +--- +title: "Grafana" +linkTitle: "Grafana" +description: "Information about upgrading an on-premise Grafana platform for {{% ctx %}}." +weight: 1 +--- \ No newline at end of file diff --git a/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/prerequisites.md b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/prerequisites.md new file mode 100644 index 000000000..eb0692982 --- /dev/null +++ b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/prerequisites.md @@ -0,0 +1,70 @@ +--- +title: "Prerequisites" +linkTitle: "Prerequisites" +description: "The prerequisites required before performing the observability upgrade." +weight: 1 +--- + +# {{% param title %}} + +## Verify Old Version + +1. Navigate to your Grafana website e.g. `https://machinename.domain.com:3000` +1. Make a note of the version number under the login prompt. +1. Login to Grafana. +1. Open the *Dashboards* page via the menu on the left sidebar. +1. Select the folder that hosts the Cortex Dashboards, e.g. *Cortex* +1. Click the *Flow Execution Requests* dashboard to open it. +1. Change the time period to be *Last 90 days* and confirm data is present. +1. Make a note of values returned in the Overview tiles, or alternatively take a screenshot of the dashboard, to use later to verify the upgrade. + +## Make Artefacts Available + +1. Download the required artefacts to a folder on your machine: + + * [Grafana 13.0.1][] Standalone Windows Binaries (64 Bit) archive. + * [Grafana Alloy 1.15.1][] archive. + * [Grafana Loki 3.7.1][] archive. + * [Grafana Dashboards][] archive. + +1. Extract the downloaded `grafana-enterprise_13.0.1_24542347077_windows_amd64` archive: + 1. Open a Windows Powershell (x64) window as administrator. + 1. Navigate Powershell to inside the folder containing the `grafana-enterprise_13.0.1_24542347077_windows_amd64.tar.gz` archive using the following command modifying the path as necessary: + + ``` Powershell + cd "C:\Install" + ``` + + 1. Execute the following command and wait for it to complete: + + ``` Powershell + tar -xvzf grafana-enterprise_13.0.1_24542347077_windows_amd64.tar.gz + ``` + +1. Extract the downloaded `alloy-installer-windows-amd64.exe` archive to a folder with the same name. +1. Extract the downloaded `loki-windows-amd64.exe` archive to a folder with the same name. +1. Extract the downloaded `Grafana.Dashboards` archive to a folder with the same name. + +## Backup Old Files + +1. On the server that Grafana and Loki is installed on, create a folder called `Observability Backups` in a known location. +1. Open File Explorer and navigate to the location that Grafana was previously installed to, typically `%SystemDrive%\Program Files\GrafanaLabs\grafana\conf`. +1. Copy the `custom.ini` file and save it to the `Observability Backups` folder created at step 1. +1. Copy the `defaults.ini` file and save it to the `Observability Backups` folder created at step 1. +1. In File Explorer, navigate to the location that Loki is running from, e.g. `C:\ProgramData\Cortex\Observability\Loki\`. +1. Copy the `loki-local-config.yaml` file and save it to the `Observability Backups` folder created at step 1. +1. On each Application Server that Grafana Alloy is installed on: + + 1. Create a folder called `Observability Backups` in a known location. + 1. Open File Explorer and navigate to the location where Grafana Alloy is running from, e.g. `C:\ProgramData\Cortex\Observability\Grafana Alloy`. + 1. Copy the `config.alloy` file and save it to the `Observability Backups` folder created at step 1. + +## Next Steps? + +1. [Upgrade Grafana][] + +[Grafana 13.0.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.13.0.1.WindowsBinaries" >}} +[Grafana Dashboards]: {{< url path="GitHub.Cortex.Observability.5_0_0.GrafanaDashboardsZip" >}} +[Grafana Loki 3.7.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3_7_1.GrafanaLokiInstallZip" >}} +[Grafana Alloy 1.15.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaAlloy.1_15_1.Windows" >}} +[Upgrade Grafana]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.OnPremise.Grafana.UpgradeGrafana" >}} diff --git a/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/try-it-out.md b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/try-it-out.md new file mode 100644 index 000000000..f6aef067f --- /dev/null +++ b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/try-it-out.md @@ -0,0 +1,76 @@ +--- +title: "Try it out" +linkTitle: "Try it out" +description: "Information about trying out the observability platform after upgrade." +weight: 6 +--- + +# {{% param title %}} + +This guide describes how to verify that the upgrade has been successful. Please ensure that [Upgrade Grafana Alloy][Upgrade Alloy] has been completed before taking these steps. + +## Confirm Grafana Upgrade + +1. Navigate to your Grafana website e.g. `https://machinename.domain.com:3000`. +1. Identify the version number under the login prompt. +1. Confirm the version has updated to be 13.0.1. + +## Confirm Dashboards Load + +1. Navigate to your Grafana website e.g. `https://machinename.domain.com:3000` +1. Login to Grafana. +1. Open the *Dashboards* page via the menu on the left sidebar. +1. Select the folder that hosts the Cortex Dashboards, e.g. *Cortex* +1. Click the *Flow Execution Requests* dashboard to open it. +1. Change the time period to be *Last 90 days* and confirm data is present. +1. Confirm the data from the previous step is similar to the data captured when [verifying the old version][]. + +## Confirm New Data is Processed + +{{% alert title="Note" %}} +This test uses the test flow published as part of testing the {{% ctx %}} installation. See {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.TryItOutPublishedFlowNew" title="Testing HA installation" >}} or {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.TryItOutPublishedFlowNew" title="Testing non-HA installation" >}}. An alternative flow can be used that exists on the system and can be executed. +{{% / alert %}} + +1. Open an HTTP client, such as [Postman][]. Make a request with the following format: + | Property | Value | + |---------------|-------------------------------------------------------------------------------------| + | Action | POST | + | URL | For HA installation use:
`https://{FQDN of Load Balancer Server}/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://load-balancer.domain.com/api/default/default/flows/NewFlow/executions?packageName=NewPackage`

For non-HA installation use:
`https://{FQDN of server}:8722/api/default/default/flows/{Flow Name}/executions?packageName={Package Name}`
e.g. `https://server.domain.com:8722/api/default/default/flows/NewFlow/executions?packageName=NewPackage`| + | Content Type | application/json | + | Body | {} | + | Authentication| Basic | + | Username | The value used for `ApiGatewayBasicAuthUsername` when installing Application Services. See [HA Installation script configuration][] or [Non-HA Installation script configuration][] for the value specified.| + | Password | The value used for `ApiGatewayBasicAuthPassword` when installing Application Services (Unencrypted). See [HA Installation script configuration][] or [Non-HA Installation script configuration][] for the value specified.| + + {{% alert title="Note" %}} If you used self-signed certificates when installing the Application Servers you may need to disable SSL certificate validation in your HTTP client. {{% /alert %}} + +1. Once the request has completed, in your web browser, navigate to and log in to your configured Grafana. +1. Open the *Dashboards* page via the menu on the left sidebar. +1. Click the folder name that the dashboards were imported to. +1. Click the *Flow Execution Details* dashboard to open it. +1. The request made at step 1 should be visible on the dashboard. + + {{% alert title="Note" %}}If Flow Logging has not been enabled then this dashboard will not display any data. See {{< ahref path="Cortex.Faqs.ChangeLoggingLevels.FlowLogging.MainDoc" title="Change Flow Logging Level" >}} for instructions on how to do this.
+ If other requests have been made then there may be more than one request visible on the dashboard. + {{% / alert %}} + +1. Open the *Dashboards* page via the menu on the left sidebar. +1. Click the folder name that the dashboards were imported to. +1. Click the *Flow Execution Requests* dashboard to open it. +1. The request made at step 1 should be visible on the dashboard. +{{% alert title="Note" %}} +If other requests have been made then there may be more than one request visible on the dashboard. +{{% / alert %}} +1. Open the *Dashboards* page via the menu on the left sidebar. +1. Click the folder name that the dashboards were imported to. +1. Click the *Platform Health* dashboard to open it. +1. The request made at step 1 should be visible on the dashboard. +{{% alert title="Note" %}} +If other requests have been made then there may be more than one request visible on the dashboard. +{{% / alert %}} + +[HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" >}} +[Upgrade Alloy]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.OnPremise.Grafana.UpgradeAlloy" >}} +[Non-HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScriptNew" >}} +[Postman]: {{< url path="Postman.Downloads.MainDoc" >}} +[verifying the old version]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.OnPremise.Grafana.VerifyOldVersion" >}} diff --git a/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/upgrade-alloy.md b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/upgrade-alloy.md new file mode 100644 index 000000000..047c7291e --- /dev/null +++ b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/upgrade-alloy.md @@ -0,0 +1,83 @@ +--- +title: "Upgrade Grafana Alloy" +linkTitle: "Upgrade Grafana Alloy" +description: "The steps to upgrade Grafana Alloy." +weight: 4 +--- + +# {{% param title %}} + +This guide describes how to upgrade Grafana Alloy. Please ensure that the [Loki Upgrade][] has been completed before starting this upgrade. + +{{% alert title="Note" %}} +These steps will need to be performed on all application servers that host a Grafana Alloy service. +{{% / alert %}} + +## Perform Upgrade + +1. Log in to the application server. +1. Open a File Explorer and navigate to the extracted alloy-installer-windows-amd64.exe folder created as part of [Make Artefacts Available][]. +1. Copy the `alloy-installer-windows-amd64.exe` into the location that Grafana Alloy was previously installed from, e.g. `C:\ProgramData\Cortex\Observability\Grafana Alloy`, overwriting the existing file if prompted to do so. +1. Execute the `alloy-installer-windows-amd64.exe` by double clicking on the file. +1. Follow the install wizard accepting the defaults and wait for the installation to complete. +1. Click `Close` to finish the installation. + +## Configure Grafana Alloy + +### Update Configuration + +1. Open the `config.alloy` configuration file, which is located in the folder alongside the `alloy-installer-windows-amd64.exe` file. +1. Locate the line containing `__path__` in the `loki.file_match "ApiGateway"` > `path_targets` section, which can be found near the beginning of the file. +1. Change the `__path__` value so that the part containing the file name changes to `ServiceFabricHttpEventLog-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]{,_[0-9][0-9][0-9]}.json`. Note there is a change to the `,` location. + + The line should now look similar to `__path__ = "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. Copy the following code and paste it in to the `config.alloy` file. It should be added to the end of the `expressions` section but before the `}` typically found on line 139. + + ``` text + FlowResult = "Event.Tags.Cortex.\"Execution.Result.Status\" || 'N/A'", + Method = "'Unknown'", + ``` + +1. Copy the following code and paste it in to the `config.alloy` file. It should be added to the end of the `values` section but before the `}` typically found on line 157 after the above change. + + ``` text + FlowResult = null, + Method = null, + ``` + +1. Copy the following code and paste it in to the `config.alloy` file. It should be added to the end of the `loki.process "ExecutionService" {` section but before the `}` typically found on line 162 after the above change. + + ``` text + + stage.match { + selector = "{job=\"ExecutionService\"}|~ \"\\\"Method\\\":.?\\\"Cortex.FlowEngine.Execution.Engine.Run\\\"\"" + + stage.json { + expressions = { + Method = "'FlowExecution'", + } + } + + stage.labels { + values = { + Method = null, + } + } + } + ``` + +1. Save the file. + +### Restart the 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. [Upgrade Dashboards][] + +[Loki Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.OnPremise.Grafana.UpgradeLoki" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.OnPremise.Grafana.MakeArtefactsAvailable" >}} +[Upgrade Dashboards]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.OnPremise.Grafana.UpgradeDashboards" >}} diff --git a/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/upgrade-dashboards.md b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/upgrade-dashboards.md new file mode 100644 index 000000000..cd3302e00 --- /dev/null +++ b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/upgrade-dashboards.md @@ -0,0 +1,51 @@ +--- +title: "Upgrade Dashboards" +linkTitle: "Upgrade Dashboards" +description: "Information about upgrading your Grafana dashboards." +weight: 5 +--- + +# {{% param title %}} + +This guide describes how to upgrade the default dashboards that are provided for your observability platform. + +{{% alert title="Warning" color="warning" %}} +A new *Flow Execution Details* Dashboard has been added to the default dashboards. This new dashboard will only work if `Flow Logging` is enabled on your platform. See {{< ahref path="Cortex.Faqs.ChangeLoggingLevels.FlowLogging.MainDoc" title="Change Flow Logging Level" >}} for instructions on how to do this. +{{% / alert %}} + +## Import New Dashboard + +1. Log in to your configured Grafana with a user that has the *Admin* role. +1. Go to *Dashboards* via the menu on the left sidebar. +1. Click the *New* button and select *Import* from the drop-down menu. +1. Click the *Upload JSON file* button. +1. Locate the extracted `Flow Execution Details.json` file downloaded as part of [Make Artefacts Available][]. +1. Select the file and click *Open*. +1. Select the folder in Grafana you wish the dashboard to be saved in, e.g. *Cortex*. +1. Select your configured Loki data source from the dropdown menu. +1. Click *Import*. + +## Configure Data Sources + +It is necessary to update the Custom Filter inside the new dashboard to use the correct data source. + +1. Log in to your configured Grafana with a user that has the *Admin* role. +1. To open a dashboard: + 1. Go to *Dashboards* via the menu on the left sidebar. + 1. Click the folder name that the dashboards were imported to. + 1. Click the *Flow Execution Details* dashboard to open it. +1. Open the *Dashboard settings* panel via the cog icon on the right-hand side of the dashboard. +1. Open the *Settings Menu* by selecting the Settings button on the top right of the opened panel. +1. Click *Variables* from the top menu of the *Settings* page. +1. Click *CustomFilter* at the bottom of the *Variables* list. +1. Select your configured Loki data source in the *Filter options* > *Data source* drop-down menu. +1. Click *Save* at the top right of the window. +1. Click the dashboard name in the breadcrumb at the top left corner of the page to go back to the dashboard. +1. Click in the Custom Filter text box to confirm that a list of available filter options is visible. + +## Next Steps? + +1. [Try it out][] + +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.OnPremise.Grafana.MakeArtefactsAvailable" >}} +[Try it out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.OnPremise.Grafana.TryItOut" >}} diff --git a/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/upgrade-grafana.md b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/upgrade-grafana.md new file mode 100644 index 000000000..15d810e8d --- /dev/null +++ b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/upgrade-grafana.md @@ -0,0 +1,28 @@ +--- +title: "Upgrade Grafana" +linkTitle: "Upgrade Grafana" +description: "The steps to upgrade Grafana." +weight: 2 +--- + +# {{% param title %}} + +This guide describes how to upgrade the Grafana installation. Please ensure that the [Prerequisites] for upgrading Observability have been completed before starting this upgrade. + +## Perform Upgrade + +1. Log in to the server hosting your Grafana website. +1. Open Services.msc from the Start menu. +1. Locate the *Grafana* service and stop it by right-clicking on the service and selecting *Stop*. +1. In File Explorer, navigate to the `grafana-13.0.1` folder created as part of [Make Artefacts Available][]. +1. Copy the contents of this folder into the Grafana install location, typically `%SystemDrive%\Program Files\GrafanaLabs\grafana`, and click `Replace the files in the destination` when prompted. +1. Open Services.msc from the Start menu. +1. Locate the *Grafana* service and start it by right-clicking on the service and selecting *Start*. + +## Next Steps? + +1. [Upgrade Loki][] + +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.OnPremise.Grafana.MakeArtefactsAvailable" >}} +[Prerequisites]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.OnPremise.Grafana.Prerequisites" >}} +[Upgrade Loki]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.OnPremise.Grafana.UpgradeLoki" >}} diff --git a/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/upgrade-loki.md b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/upgrade-loki.md new file mode 100644 index 000000000..86a0f392c --- /dev/null +++ b/content/en/docs/2026.3/Guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/upgrade-loki.md @@ -0,0 +1,56 @@ +--- +title: "Upgrade Loki" +linkTitle: "Upgrade Loki" +description: "The steps to upgrade Loki." +weight: 3 +--- + +# {{% param title %}} + +This guide describes how to upgrade the Loki installation. Please ensure that the [Grafana Upgrade] has been completed before starting this upgrade. + +## Perform Upgrade + +1. Log in to the server hosting your Loki service. +1. Run Windows PowerShell as Administrator. +1. Change the directory to the folder where Loki is running from, e.g. `cd C:\ProgramData\Cortex\Observability\Loki`. +1. Remove the current Loki installation by executing the following command: + + ``` powershell + .\Remove-Loki.ps1 + ``` + +1. Click *Yes* when prompted for confirmation that you wish to remove the service. +1. Click *OK* when the successful removal of the Loki service is confirmed. +1. Open a File Explorer and navigate to the folder where Loki was running from, e.g. `C:\ProgramData\Cortex\Observability\Loki`. +1. Delete the following file from the directory: + + * loki-windows-amd64.exe + +1. In File Explorer, navigate to the extracted `loki-windows-amd64.exe` folder created as part of [Make Artefacts Available][]. +1. Copy the `loki-windows-amd64.exe` file into the folder that Loki was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Loki`. +1. Run Windows PowerShell as Administrator. +1. Change the directory to the folder where the Loki file has been copied to, e.g. `cd C:\ProgramData\Cortex\Observability\Loki`. +1. Install Loki by executing the following command: + + ``` powershell + .\Install-Loki.ps1 + ``` + +1. Start the Loki service by executing the following command: + + ``` powershell + .\Start-Loki.ps1 + ``` + +1. Check that the Loki service has installed and started correctly: + * Open Services.msc from the Start menu. + * Locate the *Loki* service and confirm that it is *Running*. + +## Next Steps? + +1. [Upgrade Grafana Alloy][Upgrade Alloy] + +[Grafana Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.OnPremise.Grafana.UpgradeGrafana" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.OnPremise.Grafana.MakeArtefactsAvailable" >}} +[Upgrade Alloy]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.OnPremise.Grafana.UpgradeAlloy" >}} diff --git a/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/import-dashboards.md b/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/import-dashboards.md index 102f60ce0..1ccc49672 100644 --- a/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/import-dashboards.md +++ b/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/import-dashboards.md @@ -32,13 +32,18 @@ Please ensure that the set up for [Grafana][] and [Loki][] have been completed b 1. Click the Dashboards menu item. 1. Click the *New* dropdown and select *Import*. 1. Click on *Upload dashboard JSON file*. -1. Locate the `Flow Execution Requests.json` file extracted from the downloaded `Grafana.Dashboards.zip`. +1. Locate the `Flow Execution Details.json` file extracted from the downloaded `Grafana.Dashboards.zip`. 1. Select the file and click *Open*. 1. Select the folder in Grafana you wish the dashboard to be saved in, e.g. *Cortex*. 1. Select your [configured Loki data source][] from the dropdown menu, e.g. *grafanacloud-cortex-logs*. 1. Click *Import*. +1. Repeat steps 2 - 10 for the `Flow Execution Requests.json` file. 1. Repeat steps 2 - 10 for the `Platform Health.json` file. +{{% alert title="Warning" color="warning" %}} +The *Flow Execution Details* dashboard will only work if `Flow Logging` is enabled on your platform. See {{< ahref path="Cortex.Faqs.ChangeLoggingLevels.FlowLogging.MainDoc" title="Change Flow Logging Level" >}} for instructions on how to do this. +{{% / alert %}} + ## Configure Data Sources It is necessary to update the Custom Filter inside the dashboards to use the correct data source. @@ -66,6 +71,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.4_2_1.GrafanaDashboardsZip" >}} +[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.5_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" >}} diff --git a/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md b/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md index 60f4c0c6e..ee755708d 100644 --- a/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md +++ b/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md @@ -14,7 +14,7 @@ This guide describes how to configure Grafana Alloy on the Application Server(s) ## 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 for 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 `__path__` in the `local.file_match "ApiGateway"` > `path_targets` section to the path of the `Logs` folder for 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 `__path__` in the `local.file_match "ExecutionService"` > `path_targets` section to the path of the `Logs` folder for the Execution Service, e.g. `"C:/ProgramData/Cortex/Execution Service/Logs/**/*.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. diff --git a/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md b/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md index 9972851c7..90e348d2b 100644 --- a/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md +++ b/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md @@ -11,7 +11,7 @@ This guide describes how to install Grafana Alloy on the Application Server(s). ## Install Grafana Alloy -1. Download the [Grafana Alloy 1.10.2][] archive. +1. Download the [Grafana Alloy 1.15.1][] archive. 1. Extract content of the downloaded archive to a suitable location, e.g. `C:\ProgramData\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. @@ -26,6 +26,6 @@ This archive contains the `config.alloy` configuration file and PowerShell scrip 1. [Configure Grafana Alloy][] [Configure Grafana Alloy]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.InstallAlloy.ConfigureAlloy.MainDoc" >}} -[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1_10.2" >}} -[Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.4_2_1.GrafanaAlloyInstallZip" >}} +[Grafana Alloy 1.15.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaAlloy.1_15_1.Windows" >}} +[Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.5_0_0.GrafanaAlloyInstallZip" >}} [Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}} diff --git a/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/prerequisites.md b/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/prerequisites.md index 1abad13b0..6acc51610 100644 --- a/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/prerequisites.md +++ b/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/prerequisites.md @@ -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)][] | [Grafana Alloy 1.10.2][] | +| Application Server | [2022 (x64)][] *Recommended*
[2019 (x64)][] | [Grafana Alloy 1.15.1][] | [^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. @@ -59,5 +59,5 @@ Grafana Alloy requires a domain user that is not a member of the Local Administr [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" >}} -[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1_10.2" >}} +[Grafana Alloy 1.15.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaAlloy.1_15_1.Windows" >}} [Set up Grafana]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupGrafana.MainDoc" >}} diff --git a/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md b/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md index 64115dc9a..c7ceaba47 100644 --- a/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md +++ b/content/en/docs/2026.3/getting-started/cloud/add-observability-to-innovation/Grafana/try-it-out.md @@ -27,6 +27,16 @@ This test uses the test flow published as part of testing the {{% ctx %}} instal {{% alert title="Note" %}} If you used self-signed certificates when installing the Application Servers you may need to disable SSL certificate validation in your HTTP client. {{% /alert %}} 1. Once the request has completed, using a web browser, log in to your configured Grafana. +1. Click the Menu icon {{< image src="/images/GrafanaMenuIcon.png" title="Menu icon" >}} to view the available options. +1. Click the Dashboards menu item. +1. Click the folder name that the dashboards were imported to, if not already expanded. +1. Click the *Flow Execution Details* dashboard to open it. +1. The request made at step 1 should be visible on the dashboard. + + {{% alert title="Note" %}}If Flow Logging has not been enabled then this dashboard will not display any data. See {{< ahref path="Cortex.Faqs.ChangeLoggingLevels.FlowLogging.MainDoc" title="Change Flow Logging Level" >}} for instructions on how to do this.
+ If other requests have been made then there may be more than one request visible on the dashboard. + {{% / alert %}} + 1. Click the Menu icon {{< image src="/images/GrafanaMenuIcon.png" title="Menu icon" >}} to view the available options. 1. Click the Dashboards menu item. 1. Click the folder name that the dashboards were imported to, if not already expanded. diff --git a/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/_index.md b/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/_index.md index ee6b14d41..c5b0abb5d 100644 --- a/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/_index.md +++ b/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/_index.md @@ -7,4 +7,4 @@ weight: 10 {{% pageinfo %}} For instructions on how to set up Grafana and Grafana Loki in the cloud see {{< ahref path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.MainDoc" title="Grafana Cloud" >}}. -{{% /pageinfo %}} \ No newline at end of file +{{% /pageinfo %}} diff --git a/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md b/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md index eb7b152ee..990eae7ad 100644 --- a/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md +++ b/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/configure-alloy.md @@ -30,7 +30,7 @@ To import the CA certificate: ## 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 for 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 `__path__` in the `local.file_match "ApiGateway"` > `path_targets` section to the path of the `Logs` folder for 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 `__path__` in the `local.file_match "ExecutionService"` > `path_targets` section to the path of the `Logs` folder for the Execution Service, e.g. `"C:/ProgramData/Cortex/Execution Service/Logs/**/*.json"`. 1. Set the Grafana Loki `url` in the `loki.write "default"` > `endpoint` section which can be found at the end of the file. diff --git a/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md b/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md index d6e1e6005..5cea6a2c8 100644 --- a/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md +++ b/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md @@ -11,7 +11,7 @@ This guide describes how to install Grafana Alloy on the Application Server(s). ## Install Grafana Alloy -1. Download the [Grafana Alloy 1.10.2][] archive. +1. Download the [Grafana Alloy 1.15.1][] archive. 1. Extract content of the downloaded archive to a suitable location, e.g. `C:\ProgramData\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. @@ -26,7 +26,7 @@ This archive contains the `config.alloy` configuration file and PowerShell scrip 1. [Configure Grafana Alloy][] [Configure Grafana Alloy]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallAlloy.ConfigureAlloy" >}} -[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1_10.2" >}} -[Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.4_2_1.GrafanaAlloyInstallZip" >}} +[Grafana Alloy 1.15.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaAlloy.1_15_1.Windows" >}} +[Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.5_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/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-grafana/install-grafana.md b/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-grafana/install-grafana.md index 105c263c1..754c6e072 100644 --- a/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-grafana/install-grafana.md +++ b/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-grafana/install-grafana.md @@ -11,7 +11,7 @@ This guide describes how to install Grafana on the Web Application Server. Pleas ## Install Grafana -1. Download the [Grafana 12.1.1][] Windows installer. +1. Download the [Grafana 13.0.1][] Windows installer. 1. Run the installer and install Grafana to a suitable location. ## Next Steps? @@ -19,6 +19,5 @@ This guide describes how to install Grafana on the Web Application Server. Pleas 1. [Configure Grafana][] [Configure Grafana]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallGrafana.ConfigureGrafana" >}} -[Grafana 12.1.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.12_1_1.Windows" >}} +[Grafana 13.0.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.13.0.1.WindowsInstaller" >}} [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/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/configure-loki.md b/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/configure-loki.md index c8a5c1799..c82b712c5 100644 --- a/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/configure-loki.md +++ b/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/configure-loki.md @@ -162,5 +162,4 @@ To change the retention period: [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/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md b/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md index 5dea373d6..dce9df684 100644 --- a/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md +++ b/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md @@ -11,7 +11,7 @@ This guide describes how to install Grafana Loki on the Web Application Server. ## Install Grafana Loki -1. Download [Grafana Loki 3.5.5][] archive. +1. Download [Grafana Loki 3.7.1][] archive. 1. Extract content of the downloaded archive to a suitable location, e.g. `C:\ProgramData\Cortex\Observability\Loki`. 1. Download the [Grafana Loki Install.zip][] archive and extract its contents alongside the previously extracted Grafana Loki `loki-windows-amd64.exe`. This archive contains the `loki-local-config.yaml` configuration file, [NSSM][] (the Non-Sucking Service Manager program) and PowerShell scripts to help manage Grafana Loki as a Windows service. @@ -25,7 +25,7 @@ This archive contains the `loki-local-config.yaml` configuration file, [NSSM][] 1. [Configure Loki][] [Configure Loki]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.ConfigureLoki" >}} -[Grafana Loki 3.5.5]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3_5_5.GrafanaLokiInstallZip" >}} -[Grafana Loki Install.zip]: {{< url path="GitHub.Cortex.Observability.4_2_1.GrafanaLokiInstallZip" >}} +[Grafana Loki 3.7.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3_7_1.GrafanaLokiInstallZip" >}} +[Grafana Loki Install.zip]: {{< url path="GitHub.Cortex.Observability.5_0_0.GrafanaLokiInstallZip" >}} [NSSM]: {{< url path="NSSM.MainDoc" >}} [Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}} diff --git a/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md b/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md index 20fe1d777..f2041bb9b 100644 --- a/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md +++ b/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md @@ -40,8 +40,8 @@ The application servers (as described in {{< ahref path="Cortex.GettingStarted.O | 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]
[URL Rewrite module 2.1][] | [Grafana 12.1.1][] *Enterprise Edition*
[Grafana Loki 3.5.5][]| -| Application Server | [2022 (x64)][] *Recommended*
[2019 (x64)][] | | [Grafana Alloy 1.10.2][]| +| Web Application Server | [2022 (x64)][] *Recommended*
[2019 (x64)][] | 10.0.20348[^3]
10.0.17763[^4]
[URL Rewrite module 2.1][] | [Grafana 13.0.1][] *Enterprise Edition*
[Grafana Loki 3.7.1][]| +| Application Server | [2022 (x64)][] *Recommended*
[2019 (x64)][] | | [Grafana Alloy 1.15.1][]| [^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. @@ -159,14 +159,13 @@ Grafana Alloy requires a domain user that is not a member of the Local Administr [2022 (x64)]: {{< url path="Microsoft.Downloads.Windows.Server2022" >}} [Architecture]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Architecture" >}} [configuring Grafana to use HTTPS]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallGrafana.ConfigureHTTPS" >}} -[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 12.1.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.12_1_1.Windows" >}} -[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1_10.2" >}} -[Grafana Loki 3.5.5]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3_5_5.GrafanaLokiInstallZip" >}} +[Grafana 13.0.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.13.0.1.WindowsInstaller" >}} +[Grafana Alloy 1.15.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaAlloy.1_15_1.Windows" >}} +[Grafana Loki 3.7.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3_7_1.GrafanaLokiInstallZip" >}} [Install Grafana]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallGrafana.MainDoc" >}} [installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.InstallCertificate" >}} [Let’s Encrypt]: {{< url path="LetsEncrypt.MainDoc" >}} +[Port Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Advanced.PortRequirements" >}} [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/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/setup-grafana.md b/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/setup-grafana.md index 50bd252a7..823154490 100644 --- a/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/setup-grafana.md +++ b/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/setup-grafana.md @@ -9,7 +9,7 @@ weight: 60 This guide describes where to get the default {{% ctx %}} Dashboards from and how to import them for use in Grafana. -Please ensure that the Installations for [Grafana][] and [Loki][] have been completed before starting this section. +Please ensure that the Installations for [Grafana][], [Loki][] and [Alloy] have been completed before starting this section. ## Configure Loki Data Source in Grafana @@ -47,13 +47,18 @@ Please ensure that the Installations for [Grafana][] and [Loki][] have been comp 1. Go to *Dashboards* via the menu on the left sidebar. 1. Click the *New* button and select *Import* from the drop-down menu. 1. Click the *Upload JSON file* button. -1. Locate the `Flow Execution Requests.json` file extracted from the downloaded `Grafana.Dashboards.zip`. +1. Locate the `Flow Execution Details.json` file extracted from the downloaded `Grafana.Dashboards.zip`. 1. Select the file and click *Open*. 1. Select the folder in Grafana you wish the dashboard to be saved in, e.g. *Cortex*. 1. Select your configured Loki data source from the dropdown menu. 1. Click *Import*. +1. Repeat steps 2 - 8 for the `Flow Execution Requests.json` file. 1. Repeat steps 2 - 8 for the `Platform Health.json` file. +{{% alert title="Warning" color="warning" %}} +The *Flow Execution Details* dashboard will only work if `Flow Logging` is enabled on your platform. See {{< ahref path="Cortex.Faqs.ChangeLoggingLevels.FlowLogging.MainDoc" title="Change Flow Logging Level" >}} for instructions on how to do this. +{{% / alert %}} + ## Configure Data Sources It is necessary to update the Custom Filter inside the dashboards to use the correct data source. @@ -64,7 +69,7 @@ To do this, follow these steps for all default {{% ctx %}} dashboards imported: 1. To open a dashboard: 1. Go to *Dashboards* via the menu on the left sidebar. 1. Click the folder name that the dashboards were imported to. - 1. Click the *Flow Execution Requests* dashboard to open it. + 1. Click the *Flow Execution Details* dashboard to open it. 1. Open the *Dashboard settings* menu via the cog icon in the top right-hand side of the dashboard. 1. Click *Variables* from the top menu of the *Settings* page. 1. Click *CustomFilter* at the bottom of the *Variables* list. @@ -72,13 +77,15 @@ To do this, follow these steps for all default {{% ctx %}} dashboards imported: 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. +1. Repeat steps 2 - 9 for the *Flow Execution Requests* dashboard. 1. Repeat steps 2 - 9 for the *Platform Health* dashboard. ## Next Steps? 1. [Try it Out][] -[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.4_2_1.GrafanaDashboardsZip" >}} +[Alloy]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallAlloy.MainDoc" >}} +[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.5_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/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md b/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md index 019415dfc..c838ca748 100644 --- a/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md +++ b/content/en/docs/2026.3/getting-started/on-premise/add-observability-to-innovation/Grafana/try-it-out.md @@ -27,6 +27,15 @@ This test uses the test flow published as part of testing the {{% ctx %}} instal {{% alert title="Note" %}} If you used self-signed certificates when installing the Application Servers you may need to disable SSL certificate validation in your HTTP client. {{% /alert %}} 1. Once the request has completed, using a web browser, log in to your configured Grafana. +1. Open the *Dashboards* page via the menu on the left sidebar. +1. Click the folder name that the dashboards were imported to. +1. Click the *Flow Execution Details* dashboard to open it. +1. The request made at step 1 should be visible on the dashboard. + + {{% alert title="Note" %}}If Flow Logging has not been enabled then this dashboard will not display any data. See {{< ahref path="Cortex.Faqs.ChangeLoggingLevels.FlowLogging.MainDoc" title="Change Flow Logging Level" >}} for instructions on how to do this.
+ If other requests have been made then there may be more than one request visible on the dashboard. + {{% / alert %}} + 1. Open the *Dashboards* page via the menu on the left sidebar. 1. Click the folder name that the dashboards were imported to. 1. Click the *Flow Execution Requests* dashboard to open it. diff --git a/content/static/2025.3/images/editable/Grafana Platform Architecture Diagram - Cloud.png b/content/static/2025.3/images/editable/Grafana Platform Architecture Diagram - Cloud.png index 249d19958..c485d655b 100644 Binary files a/content/static/2025.3/images/editable/Grafana Platform Architecture Diagram - Cloud.png and b/content/static/2025.3/images/editable/Grafana Platform Architecture Diagram - Cloud.png differ diff --git a/content/static/2025.3/images/editable/Grafana Platform Architecture Diagram - On-Premise.png b/content/static/2025.3/images/editable/Grafana Platform Architecture Diagram - On-Premise.png index 3f7a8e417..581805a3c 100644 Binary files a/content/static/2025.3/images/editable/Grafana Platform Architecture Diagram - On-Premise.png and b/content/static/2025.3/images/editable/Grafana Platform Architecture Diagram - On-Premise.png differ diff --git a/data/urls.toml b/data/urls.toml index c1d2fac1c..fa892a22d 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -88,6 +88,14 @@ MainDoc = "/docs/faqs/configure-oidc-authentication/" [Cortex.Faqs.ConfigureOidcAuthentication.MicrosoftEntra] Entra = "/docs/faqs/configure-oidc-authentication/microsoft-entra/#configure-microsoft-entra-oidc-provider" + [Cortex.Faqs.ChangeLoggingLevels] + MainDoc = "/docs/faqs/change-logging-levels/" + [Cortex.Faqs.ChangeLoggingLevels.AllLogging] + MainDoc = "/docs/faqs/change-logging-levels/change-all-logging/" + [Cortex.Faqs.ChangeLoggingLevels.BlockLogging] + MainDoc = "/docs/faqs/change-logging-levels/change-block-logging/" + [Cortex.Faqs.ChangeLoggingLevels.FlowLogging] + MainDoc = "/docs/faqs/change-logging-levels/change-flow-logging/" [Cortex.GettingStarted] MainDoc = "/docs/getting-started/" [Cortex.GettingStarted.OnPremise] @@ -856,6 +864,29 @@ Prerequisites = "/docs/guides/upgrade-guides/upgrade-observability/4.1.0-to-4.2.1/on-premise/grafana/prerequisites" TryItOut = "/docs/guides/upgrade-guides/upgrade-observability/4.1.0-to-4.2.1/on-premise/grafana/try-it-out" UpgradeLoki = "/docs/guides/upgrade-guides/upgrade-observability/4.1.0-to-4.2.1/on-premise/grafana/upgrade-loki" + [Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0] + MainDoc = "/docs/guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/" + [Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.OnPremise] + [Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.OnPremise.Grafana] + MainDoc = "/docs/guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana" + BackupOldFiles = "/docs/guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/prerequisites/#backup-old-files" + SetupAuthentication = "/docs/guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/upgrade-loki/#set-up-authentication" + MakeArtefactsAvailable = "/docs/guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/prerequisites/#make-artefacts-available" + Prerequisites = "/docs/guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/prerequisites" + TryItOut = "/docs/guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/try-it-out" + UpgradeGrafana = "/docs/guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/upgrade-grafana" + UpgradeLoki = "/docs/guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/upgrade-loki" + UpgradeAlloy = "/docs/guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/upgrade-alloy" + UpgradeDashboards = "/docs/guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/upgrade-dashboards" + VerifyOldVersion = "/docs/guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/on-premise/grafana/prerequisites/#verify-old-version" + [Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.Cloud] + [Cortex.Guides.UpgradeGuides.UpgradeObservability.4_2_1to5_0_0.Cloud.Grafana] + MainDoc = "/docs/guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana" + MakeArtefactsAvailable = "/docs/guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana/prerequisites/#make-artefacts-available" + UpgradeAlloy = "/docs/guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana/upgrade-alloy" + UpgradeDashboards = "/docs/guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana/upgrade-dashboards" + TryItOut = "/docs/guides/upgrade-guides/upgrade-observability/4.2.1-to-5.0.0/cloud/grafana/try-it-out" + [Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise] [Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise.Grafana] BackupOldFiles = "/docs/guides/upgrade-guides/upgrade-observability/on-premise/grafana/prerequisites/#backup-old-files" @@ -866,13 +897,6 @@ UpgradeLoki = "/docs/guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-loki" UpgradePromtail = "/docs/guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-promtail" VerifyOldVersion = "/docs/guides/upgrade-guides/upgrade-observability/on-premise/grafana/prerequisites/#verify-old-version" - [Cortex.Guides.UpgradeGuides.UpgradeObservability.4_1_0to4_2_0] - [Cortex.Guides.UpgradeGuides.UpgradeObservability.4_1_0to4_2_0.OnPremise] - [Cortex.Guides.UpgradeGuides.UpgradeObservability.4_1_0to4_2_0.OnPremise.Grafana] - BackupOldFiles = "/docs/guides/upgrade-guides/upgrade-observability/4.1.0-to-4.2.0/on-premise/grafana/prerequisites/#backup-old-files" - Prerequisites = "/docs/guides/upgrade-guides/upgrade-observability/4.1.0-to-4.2.0/on-premise/grafana/prerequisites" - TryItOut = "/docs/guides/upgrade-guides/upgrade-observability/4.1.0-to-4.2.0/on-premise/grafana/try-it-out" - UpgradeLoki = "/docs/guides/upgrade-guides/upgrade-observability/4.1.0-to-4.2.0/on-premise/grafana/upgrade-loki" [Cortex.Guides.UpgradeGuides.UpgradeObservability.Cloud] [Cortex.Guides.UpgradeGuides.UpgradeObservability.Cloud.Grafana] BackupOldFiles = "/docs/guides/upgrade-guides/upgrade-observability/cloud/grafana/prerequisites/#backup-old-files" @@ -2625,6 +2649,11 @@ GrafanaAlloyInstallZip = "https://github.com/CortexIntelligentAutomation/observability/releases/download/v4.2.1/Grafana.Alloy.Install.zip" GrafanaLokiInstallZip = "https://github.com/CortexIntelligentAutomation/observability/releases/download/v4.2.1/Grafana.Loki.Install.zip" GrafanaDashboardsZip = "https://github.com/CortexIntelligentAutomation/observability/releases/download/v4.2.1/Grafana.Dashboards.zip" + [GitHub.Cortex.Observability.5_0_0] + Release = "https://github.com/CortexIntelligentAutomation/observability/releases/tag/v5.0.0" + GrafanaAlloyInstallZip = "https://github.com/CortexIntelligentAutomation/observability/releases/download/v5.0.0/Grafana.Alloy.Install.zip" + GrafanaLokiInstallZip = "https://github.com/CortexIntelligentAutomation/observability/releases/download/v5.0.0/Grafana.Loki.Install.zip" + GrafanaDashboardsZip = "https://github.com/CortexIntelligentAutomation/observability/releases/download/v5.0.0/Grafana.Dashboards.zip" [Grafana] MainDoc = "https://grafana.com/" [Grafana.Products] @@ -2637,18 +2666,16 @@ MainDoc = "https://grafana.com/docs/loki/latest/clients/promtail/" [Grafana.Products.Loki.Alloy] MainDoc = "https://grafana.com/docs/loki/latest/send-data/alloy/" - [Grafana.Products.Loki.Alloy.1_10] - 2 = "https://github.com/grafana/alloy/releases/download/v1.10.2/alloy-installer-windows-amd64.exe.zip" [Grafana.Products.GrafanaAlloy] MainDoc = "https://grafana.com/oss/alloy-opentelemetry-collector/" [Grafana.SelfManaged] [Grafana.SelfManaged.Downloads] - [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] - Windows = "https://grafana.com/grafana/download/10.4.1?pg=get&plcmt=selfmanaged-box1-cta1&platform=windows" - [Grafana.SelfManaged.Downloads.GrafanaWebApp.12_1_1] - Windows = "https://grafana.com/grafana/download/12.1.1?pg=get&plcmt=selfmanaged-box1-cta1&platform=windows" + [Grafana.SelfManaged.Downloads.GrafanaAlloy] + [Grafana.SelfManaged.Downloads.GrafanaAlloy.1_10_2] + Windows = "https://github.com/grafana/alloy/releases/download/v1.10.2/alloy-installer-windows-amd64.exe.zip" + [Grafana.SelfManaged.Downloads.GrafanaAlloy.1_15_1] + Windows = "https://github.com/grafana/alloy/releases/download/v1.15.1/alloy-installer-windows-amd64.exe.zip" + [Grafana.SelfManaged.Downloads.GrafanaLoki] Release = "https://github.com/grafana/loki/releases/tag/v2.5.0" [Grafana.SelfManaged.Downloads.GrafanaLoki.3_0_0] @@ -2657,6 +2684,21 @@ [Grafana.SelfManaged.Downloads.GrafanaLoki.3_5_5] Release = "https://github.com/grafana/loki/releases/tag/v3.5.5" GrafanaLokiInstallZip = "https://github.com/grafana/loki/releases/download/v3.5.5/loki-windows-amd64.exe.zip" + [Grafana.SelfManaged.Downloads.GrafanaLoki.3_7_1] + Release = "https://github.com/grafana/loki/releases/tag/v3.7.1" + GrafanaLokiInstallZip = "https://github.com/grafana/loki/releases/download/v3.7.1/loki-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] + Windows = "https://grafana.com/grafana/download/10.4.1?pg=get&plcmt=selfmanaged-box1-cta1&platform=windows" + [Grafana.SelfManaged.Downloads.GrafanaWebApp.12_1_1] + Windows = "https://grafana.com/grafana/download/12.1.1?pg=get&plcmt=selfmanaged-box1-cta1&platform=windows" + [Grafana.SelfManaged.Downloads.GrafanaWebApp.13.0.1] + Windows = "https://grafana.com/grafana/download/13.0.1?platform=windows" + WindowsInstaller = "https://dl.grafana.com/grafana-enterprise/release/13.0.1/grafana-enterprise_13.0.1_24542347077_windows_amd64.msi" + WindowsBinaries = "https://dl.grafana.com/grafana-enterprise/release/13.0.1/grafana-enterprise_13.0.1_24542347077_windows_amd64.tar.gz" + [Grafana.SelfManaged.Downloads.Promtail] [Grafana.SelfManaged.Downloads.Promtail.3_0_0] PromtailInstallZip = "https://github.com/grafana/loki/releases/download/v3.0.0/promtail-windows-amd64.exe.zip"