From 8fdbf69cda7715b8f28544f52e15c1e69f2437c7 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Thu, 28 Aug 2025 10:32:55 +0100 Subject: [PATCH 01/14] restructured the old upgrade guide to specific version and added initial new upgrade guides --- content/en/blog/releases/2025.X/2025.7.md | 2 +- .../2.2.0-to-3.0.0/_index.md | 6 ++ .../{ => 2.2.0-to-3.0.0}/cloud/_index.md | 0 .../cloud/grafana/_index.md | 0 .../cloud/grafana/prerequisites.md | 2 +- .../cloud/grafana/try-it-out.md | 4 +- .../cloud/grafana/upgrade-promtail.md | 8 +- .../dashboards/Grafana/_index.md | 0 .../dashboards/Grafana/try-it-out.md | 4 +- .../dashboards/Grafana/upgrade-dashboards.md | 4 +- .../{ => 2.2.0-to-3.0.0}/dashboards/_index.md | 0 .../{ => 2.2.0-to-3.0.0}/on-premise/_index.md | 0 .../on-premise/grafana/_index.md | 0 .../on-premise/grafana/prerequisites.md | 2 +- .../on-premise/grafana/try-it-out.md | 4 +- .../on-premise/grafana/upgrade-grafana.md | 8 +- .../on-premise/grafana/upgrade-loki.md | 8 +- .../on-premise/grafana/upgrade-promtail.md | 8 +- .../3.0.0-to-4.0.0/_index.md | 6 ++ .../3.0.0-to-4.0.0/cloud/_index.md | 6 ++ .../3.0.0-to-4.0.0/cloud/grafana/_index.md | 6 ++ .../cloud/grafana/prerequisites.md | 44 +++++++++ .../cloud/grafana/try-it-out.md | 48 ++++++++++ .../cloud/grafana/upgrade-promtail.md | 75 +++++++++++++++ .../3.0.0-to-4.0.0/on-premise/_index.md | 6 ++ .../on-premise/grafana/_index.md | 6 ++ .../on-premise/grafana/prerequisites.md | 60 ++++++++++++ .../on-premise/grafana/try-it-out.md | 54 +++++++++++ .../on-premise/grafana/upgrade-grafana.md | 31 +++++++ .../on-premise/grafana/upgrade-loki.md | 93 +++++++++++++++++++ .../on-premise/grafana/upgrade-promtail.md | 75 +++++++++++++++ .../upgrade-observability/_index.md | 2 +- data/urls.toml | 46 +++++++++ 33 files changed, 590 insertions(+), 28 deletions(-) create mode 100644 content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/_index.md rename content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/{ => 2.2.0-to-3.0.0}/cloud/_index.md (100%) rename content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/{ => 2.2.0-to-3.0.0}/cloud/grafana/_index.md (100%) rename content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/{ => 2.2.0-to-3.0.0}/cloud/grafana/prerequisites.md (96%) rename content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/{ => 2.2.0-to-3.0.0}/cloud/grafana/try-it-out.md (93%) rename content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/{ => 2.2.0-to-3.0.0}/cloud/grafana/upgrade-promtail.md (92%) rename content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/{ => 2.2.0-to-3.0.0}/dashboards/Grafana/_index.md (100%) rename content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/{ => 2.2.0-to-3.0.0}/dashboards/Grafana/try-it-out.md (91%) rename content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/{ => 2.2.0-to-3.0.0}/dashboards/Grafana/upgrade-dashboards.md (93%) rename content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/{ => 2.2.0-to-3.0.0}/dashboards/_index.md (100%) rename content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/{ => 2.2.0-to-3.0.0}/on-premise/_index.md (100%) rename content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/{ => 2.2.0-to-3.0.0}/on-premise/grafana/_index.md (100%) rename content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/{ => 2.2.0-to-3.0.0}/on-premise/grafana/prerequisites.md (97%) rename content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/{ => 2.2.0-to-3.0.0}/on-premise/grafana/try-it-out.md (94%) rename content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/{ => 2.2.0-to-3.0.0}/on-premise/grafana/upgrade-grafana.md (85%) rename content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/{ => 2.2.0-to-3.0.0}/on-premise/grafana/upgrade-loki.md (92%) rename content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/{ => 2.2.0-to-3.0.0}/on-premise/grafana/upgrade-promtail.md (92%) create mode 100644 content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/_index.md create mode 100644 content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/_index.md create mode 100644 content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/_index.md create mode 100644 content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/prerequisites.md create mode 100644 content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/try-it-out.md create mode 100644 content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/upgrade-promtail.md create mode 100644 content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/_index.md create mode 100644 content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/_index.md create mode 100644 content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/prerequisites.md create mode 100644 content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/try-it-out.md create mode 100644 content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-grafana.md create mode 100644 content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki.md create mode 100644 content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-promtail.md diff --git a/content/en/blog/releases/2025.X/2025.7.md b/content/en/blog/releases/2025.X/2025.7.md index 11a293545..a6764aea2 100644 --- a/content/en/blog/releases/2025.X/2025.7.md +++ b/content/en/blog/releases/2025.X/2025.7.md @@ -232,7 +232,7 @@ Affected Components: `{{% ctx %}} Observability` has been updated to use [Grafana Alloy][] instead of [Promtail][] for ingesting logs to [Grafana Loki][]. This is due to [Promtail][] having been deprecated and marked as end-of-life on the 2nd of March 2026. {{% alert title="Note" %}} -There is currently not documentation on how to migrate from `Promptail` to `Grafana Alloy`. This will be added in `2025.9`. +There is currently not documentation on how to migrate from `Promtail` to `Grafana Alloy`. This will be added in `2025.9`. In the meantime, for further assistance, please raise a case in the {{< ahref path="Cortex.ServicePortal.MainDoc" version="2025.7" title="{{% ctx %}} Service Portal" >}}. {{% /alert %}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/_index.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/_index.md new file mode 100644 index 000000000..993585efa --- /dev/null +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/_index.md @@ -0,0 +1,6 @@ +--- +title: "2.2.0 to 3.0.0" +linkTitle: "2.2.0 to 3.0.0" +description: "Instructions to upgrade your observability platform for {{% ctx %}} from 2.2.0 to 3.0.0." +weight: 1000 +--- \ No newline at end of file diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/cloud/_index.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/_index.md similarity index 100% rename from content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/cloud/_index.md rename to content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/_index.md diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/cloud/grafana/_index.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/_index.md similarity index 100% rename from content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/cloud/grafana/_index.md rename to content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/_index.md diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/cloud/grafana/prerequisites.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/prerequisites.md similarity index 96% rename from content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/cloud/grafana/prerequisites.md rename to content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/prerequisites.md index c18493cd6..c8ba1665d 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/cloud/grafana/prerequisites.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/prerequisites.md @@ -41,4 +41,4 @@ On each Application Server that Promtail is installed on: [Promtail 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.3.0.0.PromtailInstallZip" >}} [Promtail Install]: {{< url path="GitHub.Cortex.Observability.3.0.0.PromtailInstallZip" >}} -[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.Cloud.Grafana.UpgradePromtail" >}} +[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.UpgradePromtail" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/cloud/grafana/try-it-out.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/try-it-out.md similarity index 93% rename from content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/cloud/grafana/try-it-out.md rename to content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/try-it-out.md index f20acc5a7..c60645e18 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/cloud/grafana/try-it-out.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/try-it-out.md @@ -44,5 +44,5 @@ If other requests have been made then there may be more than one request visible If other requests have been made then there may be more than one request visible on the dashboard. {{% / alert %}} -[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.Cloud.Grafana.UpgradePromtail" >}} -[verifying the old version]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.Cloud.Grafana.VerifyOldVersion" >}} +[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.UpgradePromtail" >}} +[verifying the old version]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.VerifyOldVersion" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/cloud/grafana/upgrade-promtail.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/upgrade-promtail.md similarity index 92% rename from content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/cloud/grafana/upgrade-promtail.md rename to content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/upgrade-promtail.md index 5134badd9..14fe26219 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/cloud/grafana/upgrade-promtail.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/upgrade-promtail.md @@ -69,7 +69,7 @@ These steps will need to be performed on all application servers that host a Pro 1. [Try it out][] -[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.Cloud.Grafana.BackupOldFiles" >}} -[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.Cloud.Grafana.MakeArtefactsAvailable" >}} -[Prerequisites]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.Cloud.Grafana.Prerequisites" >}} -[Try it out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.Cloud.Grafana.TryItOut" >}} +[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.BackupOldFiles" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.MakeArtefactsAvailable" >}} +[Prerequisites]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.Prerequisites" >}} +[Try it out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.TryItOut" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/dashboards/Grafana/_index.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/dashboards/Grafana/_index.md similarity index 100% rename from content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/dashboards/Grafana/_index.md rename to content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/dashboards/Grafana/_index.md diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/dashboards/Grafana/try-it-out.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/dashboards/Grafana/try-it-out.md similarity index 91% rename from content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/dashboards/Grafana/try-it-out.md rename to content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/dashboards/Grafana/try-it-out.md index 89ed5c56f..f53a622b7 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/dashboards/Grafana/try-it-out.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/dashboards/Grafana/try-it-out.md @@ -32,5 +32,5 @@ If other requests have been made then there may be more than one request visible If other requests have been made then there may be more than one request visible on the dashboard. {{% / alert %}} -[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.Cloud.Grafana.UpgradePromtail" >}} -[verifying the old version]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.Cloud.Grafana.VerifyOldVersion" >}} +[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.UpgradePromtail" >}} +[verifying the old version]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.VerifyOldVersion" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/dashboards/Grafana/upgrade-dashboards.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/dashboards/Grafana/upgrade-dashboards.md similarity index 93% rename from content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/dashboards/Grafana/upgrade-dashboards.md rename to content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/dashboards/Grafana/upgrade-dashboards.md index f8a8e3de5..334a37743 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/dashboards/Grafana/upgrade-dashboards.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/dashboards/Grafana/upgrade-dashboards.md @@ -35,6 +35,6 @@ You will receive warnings that *A dashboard or folder with the same name already 1. [Try it out][] -[extracted]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.Dashboards.Grafana.Download" >}} +[extracted]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Dashboards.Grafana.Download" >}} [Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.3.0.0.GrafanaDashboardsZip" >}} -[Try it out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.Dashboards.Grafana.TryItOut" >}} +[Try it out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Dashboards.Grafana.TryItOut" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/dashboards/_index.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/dashboards/_index.md similarity index 100% rename from content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/dashboards/_index.md rename to content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/dashboards/_index.md diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/on-premise/_index.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/_index.md similarity index 100% rename from content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/on-premise/_index.md rename to content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/_index.md diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/_index.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/_index.md similarity index 100% rename from content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/_index.md rename to content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/_index.md diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/prerequisites.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/prerequisites.md similarity index 97% rename from content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/prerequisites.md rename to content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/prerequisites.md index 2c5be1dad..9b69adaad 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/prerequisites.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/prerequisites.md @@ -57,4 +57,4 @@ weight: 1 [Grafana Loki Install]: {{< url path="GitHub.Cortex.Observability.3.0.0.GrafanaLokiInstallZip" >}} [Promtail 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.3.0.0.PromtailInstallZip" >}} [Promtail Install]: {{< url path="GitHub.Cortex.Observability.3.0.0.PromtailInstallZip" >}} -[Upgrade Grafana]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise.Grafana.UpgradeGrafana" >}} +[Upgrade Grafana]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.UpgradeGrafana" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/try-it-out.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/try-it-out.md similarity index 94% rename from content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/try-it-out.md rename to content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/try-it-out.md index d768e16d3..71b0666c1 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/try-it-out.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/try-it-out.md @@ -50,5 +50,5 @@ If other requests have been made then there may be more than one request visible If other requests have been made then there may be more than one request visible on the dashboard. {{% / alert %}} -[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise.Grafana.UpgradePromtail" >}} -[verifying the old version]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise.Grafana.VerifyOldVersion" >}} +[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.UpgradePromtail" >}} +[verifying the old version]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.VerifyOldVersion" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-grafana.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-grafana.md similarity index 85% rename from content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-grafana.md rename to content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-grafana.md index aadb72a7b..683cb392e 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-grafana.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-grafana.md @@ -25,7 +25,7 @@ This guide describes how to upgrade the Grafana installation. Please ensure that 1. [Upgrade Loki][] -[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise.Grafana.BackupOldFiles" >}} -[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise.Grafana.MakeArtefactsAvailable" >}} -[Prerequisites]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise.Grafana.Prerequisites" >}} -[Upgrade Loki]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise.Grafana.UpgradeLoki" >}} +[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.BackupOldFiles" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.MakeArtefactsAvailable" >}} +[Prerequisites]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.Prerequisites" >}} +[Upgrade Loki]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.UpgradeLoki" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-loki.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-loki.md similarity index 92% rename from content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-loki.md rename to content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-loki.md index 2596b9b69..f4b30157a 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-loki.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-loki.md @@ -87,7 +87,7 @@ This guide describes how to upgrade the Loki installation. Please ensure that th 1. [Upgrade Promtail][] -[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise.Grafana.BackupOldFiles" >}} -[Grafana Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise.Grafana.UpgradeGrafana" >}} -[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise.Grafana.MakeArtefactsAvailable" >}} -[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise.Grafana.UpgradePromtail" >}} +[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.BackupOldFiles" >}} +[Grafana Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.UpgradeGrafana" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.MakeArtefactsAvailable" >}} +[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.UpgradePromtail" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-promtail.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-promtail.md similarity index 92% rename from content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-promtail.md rename to content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-promtail.md index 014a7b960..aeea7dc85 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-promtail.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-promtail.md @@ -69,7 +69,7 @@ These steps will need to be performed on all application servers that host a Pro 1. [Try it out][] -[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise.Grafana.BackupOldFiles" >}} -[Loki Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise.Grafana.UpgradeLoki" >}} -[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise.Grafana.MakeArtefactsAvailable" >}} -[Try it out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise.Grafana.TryItOut" >}} +[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.BackupOldFiles" >}} +[Loki Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.UpgradeLoki" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.MakeArtefactsAvailable" >}} +[Try it out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.TryItOut" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/_index.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/_index.md new file mode 100644 index 000000000..1c8b56a2b --- /dev/null +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/_index.md @@ -0,0 +1,6 @@ +--- +title: "3.0.0 to 4.0.0" +linkTitle: "3.0.0 to 4.0.0" +description: "Instructions to upgrade your observability platform for {{% ctx %}} from 3.0.0 to 4.0.0." +weight: 999 +--- \ No newline at end of file diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/_index.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/_index.md new file mode 100644 index 000000000..4eaa242d6 --- /dev/null +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.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/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/_index.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/_index.md new file mode 100644 index 000000000..1337f8126 --- /dev/null +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.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/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 new file mode 100644 index 000000000..c8ba1665d --- /dev/null +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/prerequisites.md @@ -0,0 +1,44 @@ +--- +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://{Team URL}.grafana.net` +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: + + * [Promtail 3.0.0][] archive. + * [Promtail Install][] archive. + +1. Extract the downloaded `promtail-windows-amd64.exe` archive to a folder with the same name. +1. Extract the downloaded `Promtail.Install` archive to a folder with the same name. + +## Backup Old Files + +On each Application Server that Promtail is installed on: + +1. Create a folder called `Observability Backups` in a known location. +1. Open File Explorer and navigate to the location where Promtail is running from, e.g. `C:\Promtail`. +1. Copy the `promtail-local-config.yaml` file and save it to the `Observability Backups` folder created at step 1. + +## Next Steps? + +1. [Upgrade Promtail][] + +[Promtail 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.3.0.0.PromtailInstallZip" >}} +[Promtail Install]: {{< url path="GitHub.Cortex.Observability.3.0.0.PromtailInstallZip" >}} +[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.UpgradePromtail" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/try-it-out.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/try-it-out.md new file mode 100644 index 000000000..c60645e18 --- /dev/null +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/try-it-out.md @@ -0,0 +1,48 @@ +--- +title: "Try it out" +linkTitle: "Try it out" +description: "Information about trying out the observability platform after upgrade." +weight: 3 +--- + +# {{% param title %}} + +This guide describes how to verify that the upgrade has been successful. Please ensure that [Upgrade Promtail][] has been completed before taking these steps. + +## Confirm Dashboards Load + +1. Navigate to your Grafana website e.g. `https://{Team URL}.grafana.net` +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" %}} +Any flow can be used that exists on the system and can be executed. +{{% / alert %}} + +1. Open a web browser and navigate to your installed {{% ctx %}} Gateway URL, e.g. `https://server.domain.com/gateway`, and log in when prompted. +1. Open a flow that you are able to execute on an ad hoc basis. +1. Start the flow. +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 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 %}} + +[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.UpgradePromtail" >}} +[verifying the old version]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.VerifyOldVersion" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/upgrade-promtail.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/upgrade-promtail.md new file mode 100644 index 000000000..14fe26219 --- /dev/null +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/upgrade-promtail.md @@ -0,0 +1,75 @@ +--- +title: "Upgrade Promtail" +linkTitle: "Upgrade Promtail" +description: "The steps to upgrade Promtail." +weight: 2 +--- + +# {{% param title %}} + +This guide describes how to upgrade the Promtail installation. Please ensure that the [Prerequisites] for upgrading Observability have been completed before starting this upgrade. + +## Perform Upgrade + +{{% alert title="Note" %}} +These steps will need to be performed on all application servers that host a Promtail service. +{{% / alert %}} + +1. Log in to the application server. +1. Run Windows PowerShell as Administrator. +1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Remove the current Promtail installation by executing the following command: + + ``` powershell + .\Remove-Promtail.ps1 + ``` + +1. Click *Yes* when prompted for confirmation that you wish to remove the service. +1. Click *OK* when the successful removal of the Promtail service is confirmed. +1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\Program Data\Cortex\Observability\Promtail` +1. Delete the following files from the directory: + + * Install-Promtail.ps1 + * nssm.exe + * Promtail-local-config.yaml + * Promtail-windows-amd64.exe + * Remove-Promtail.ps1 + * Start-Promtail.ps1 + * Stop-Promtail.ps1 + +1. In File Explorer, navigate to the extracted `promtail-windows-amd64.exe` folder created as part of [Make Artefacts Available][]. +1. Copy the `promtail-windows-amd64.exe` file into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. In File Explorer, navigate to the extracted `Promtail.Install` folder created as part of [Make Artefacts Available][]. +1. Copy the contents of this location into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. Open `promtail-local-config.yaml` in a text editor: + + * Update the *filename* property under *positions* to be the value found in the [backed up][] version. + * Update the *url* property under *clients* to be the value found in the [backed up][] version. + * Save the new `promtail-local-config.yaml` file. + +1. Run Windows PowerShell as Administrator. +1. Change the directory to the folder where the Promtail files have been copied to, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Install Promtail by executing the following command: + + ``` powershell + .\Install-Promtail.ps1 + ``` + +1. Start the Promtail service by executing the following command: + + ``` powershell + .\Start-Promtail.ps1 + ``` + +1. Check that the Promtail service has installed and started correctly: + * Open Services.msc from the Start menu. + * Locate the *Promtail* service and confirm that it is *Running*. + +## Next Steps? + +1. [Try it out][] + +[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.BackupOldFiles" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.MakeArtefactsAvailable" >}} +[Prerequisites]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.Prerequisites" >}} +[Try it out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.TryItOut" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/_index.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/_index.md new file mode 100644 index 000000000..59f2ef8fd --- /dev/null +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.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/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/_index.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/_index.md new file mode 100644 index 000000000..0b777445d --- /dev/null +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.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/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 new file mode 100644 index 000000000..9b69adaad --- /dev/null +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/prerequisites.md @@ -0,0 +1,60 @@ +--- +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 10.4.1][] Standalone Windows Binaries archive. + * [Grafana Loki 3.0.0][] archive. + * [Grafana Loki Install][] archive. + * [Promtail 3.0.0][] archive. + * [Promtail Install][] archive. + +1. Extract the downloaded `grafana-enterprise-10.4.1.windows-amd64` 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.Loki.Install` archive to a folder with the same name. +1. Extract the downloaded `promtail-windows-amd64.exe` archive to a folder with the same name. +1. Extract the downloaded `Promtail.Install` 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:\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 Promtail is installed on: + + 1. Create a folder called `Observability Backups` in a known location. + 1. Open File Explorer and navigate to the location that Promtail is running from, e.g. `C:\Promtail`. + 1. Copy the `promtail-local-config.yaml` file and save it to the `Observability Backups` folder created at step 7.1. + +## Next Steps? + +1. [Upgrade Grafana][] + +[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 Loki Install]: {{< url path="GitHub.Cortex.Observability.3.0.0.GrafanaLokiInstallZip" >}} +[Promtail 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.3.0.0.PromtailInstallZip" >}} +[Promtail Install]: {{< url path="GitHub.Cortex.Observability.3.0.0.PromtailInstallZip" >}} +[Upgrade Grafana]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.UpgradeGrafana" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/try-it-out.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/try-it-out.md new file mode 100644 index 000000000..71b0666c1 --- /dev/null +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/try-it-out.md @@ -0,0 +1,54 @@ +--- +title: "Try it out" +linkTitle: "Try it out" +description: "Information about trying out the observability platform after upgrade." +weight: 5 +--- + +# {{% param title %}} + +This guide describes how to verify that the upgrade has been successful. Please ensure that [Upgrade Promtail][] 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 10.4.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" %}} +Any flow can be used that exists on the system and can be executed. +{{% / alert %}} + +1. Open a web browser and navigate to your installed {{% ctx %}} Gateway URL, e.g. `https://server.domain.com/gateway`, and log in when prompted. +1. Open a flow that you are able to execute on an ad hoc basis. +1. Start the flow. +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 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 %}} + +[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.UpgradePromtail" >}} +[verifying the old version]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.VerifyOldVersion" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-grafana.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-grafana.md new file mode 100644 index 000000000..683cb392e --- /dev/null +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-grafana.md @@ -0,0 +1,31 @@ +--- +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-enterprise-10.4.1.windows-amd64` folder created as part of [Make Artefacts Available][]. +1. Open the `grafana-v10.4.1` subfolder. +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. Copy the [backed up][] `custom.ini` and `defaults.ini` files into the Grafana install configuration location, typically `%SystemDrive%\Program Files\GrafanaLabs\grafana\conf`, 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][] + +[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.BackupOldFiles" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.MakeArtefactsAvailable" >}} +[Prerequisites]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.Prerequisites" >}} +[Upgrade Loki]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.UpgradeLoki" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki.md new file mode 100644 index 000000000..f4b30157a --- /dev/null +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki.md @@ -0,0 +1,93 @@ +--- +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:\Program Data\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:\Program Data\Cortex\Observability\Loki`. +1. Delete the following files from the directory: + + * Install-Loki.ps1 + * loki-local-config.yaml + * loki-windows-amd64.exe + * nssm.exe + * Remove-Loki.ps1 + * Start-Loki.ps1 + * Stop-Loki.ps1 + +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:\Program Data\Cortex\Observability\Loki`. +1. In File Explorer, navigate to the extracted `Grafana.Loki.Install` folder created as part of [Make Artefacts Available][]. +1. Copy the contents of this location into the folder that Loki was previously running from, e.g. `C:\Program Data\Cortex\Observability\Loki`. +1. Open the new `loki-local-config.yaml` file in a text editor and compare against the [backed up][] version. If there are differences between the two files in the *schema_config* > *configs* section: + + 1. In the new file, change the date next to `- from` to be today's date. + 1. Copy the old config section from the backup and add it immediately under *configs* and before the existing `- from ` line ensuring that formatting (including indentations) remain identical to that which is used in the new file. + + The new *schema_config* should result in something similar to: + + ```yaml + schema_config: + configs: + - from: 2020-10-24 + store: boltdb-shipper + object_store: filesystem + schema: v11 + index: + prefix: index_ + period: 24h + - from: 2024-08-29 + store: tsdb + object_store: filesystem + schema: v13 + index: + prefix: index_ + period: 24h + ``` + + 1. Save the new `loki-local-config.yaml` file. + +1. Run Windows PowerShell as Administrator. +1. Change the directory to the folder where the Loki files have been copied to, e.g. `cd C:\Program Data\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 Promtail][] + +[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.BackupOldFiles" >}} +[Grafana Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.UpgradeGrafana" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.MakeArtefactsAvailable" >}} +[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.UpgradePromtail" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-promtail.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-promtail.md new file mode 100644 index 000000000..aeea7dc85 --- /dev/null +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-promtail.md @@ -0,0 +1,75 @@ +--- +title: "Upgrade Promtail" +linkTitle: "Upgrade Promtail" +description: "The steps to upgrade Promtail." +weight: 4 +--- + +# {{% param title %}} + +This guide describes how to upgrade the Promtail installation. Please ensure that the [Loki Upgrade][] has been completed before starting this upgrade. + +## Perform Upgrade + +{{% alert title="Note" %}} +These steps will need to be performed on all application servers that host a Promtail service. +{{% / alert %}} + +1. Log in to the application server. +1. Run Windows PowerShell as Administrator. +1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Remove the current Promtail installation by executing the following command: + + ``` powershell + .\Remove-Promtail.ps1 + ``` + +1. Click *Yes* when prompted for confirmation that you wish to remove the service. +1. Click *OK* when the successful removal of the Promtail service is confirmed. +1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\Program Data\Cortex\Observability\Promtail` +1. Delete the following files from the directory: + + * Install-Promtail.ps1 + * nssm.exe + * Promtail-local-config.yaml + * Promtail-windows-amd64.exe + * Remove-Promtail.ps1 + * Start-Promtail.ps1 + * Stop-Promtail.ps1 + +1. In File Explorer, navigate to the extracted `promtail-windows-amd64.exe` folder created as part of [Make Artefacts Available][]. +1. Copy the `promtail-windows-amd64.exe` file into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. In File Explorer, navigate to the extracted `Promtail.Install` folder created as part of [Make Artefacts Available][]. +1. Copy the contents of this location into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. Open the new `promtail-local-config.yaml` in a text editor: + + * Update the *filename* property under *positions* to be the value found in the [backed up][] version. + * Update the *url* property under *clients* to be the value found in the [backed up][] version. + * Save the new `promtail-local-config.yaml` file. + +1. Run Windows PowerShell as Administrator. +1. Change the directory to the folder where the Promtail files have been copied to, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Install Promtail by executing the following command: + + ``` powershell + .\Install-Promtail.ps1 + ``` + +1. Start the Promtail service by executing the following command: + + ``` powershell + .\Start-Promtail.ps1 + ``` + +1. Check that the Promtail service has installed and started correctly: + * Open Services.msc from the Start menu. + * Locate the *Promtail* service and confirm that it is *Running*. + +## Next Steps? + +1. [Try it out][] + +[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.BackupOldFiles" >}} +[Loki Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.UpgradeLoki" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.MakeArtefactsAvailable" >}} +[Try it out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.TryItOut" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/_index.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/_index.md index 8faaea3a2..7e5a6ec25 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/_index.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/_index.md @@ -1,6 +1,6 @@ --- title: "Upgrade Observability" linkTitle: "Upgrade Observability" -description: "Information about upgrading your observability platform for {{% ctx %}}." +description: "Guides to upgrade your observability platform for {{% ctx %}}." weight: 1000 --- \ No newline at end of file diff --git a/data/urls.toml b/data/urls.toml index 3461c5823..2fb2bc0c8 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -1048,6 +1048,52 @@ Download = "/docs/guides/upgrade-guides/upgrade-observability/dashboards/grafana/upgrade-dashboards/#download-the-default-dashboards" UpgradeDashboards = "/docs/guides/upgrade-guides/upgrade-observability/dashboards/grafana/upgrade-dashboards" TryItOut = "/docs/guides/upgrade-guides/upgrade-observability/dashboards/grafana/try-it-out" + + [Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0] + MainDoc = "/docs/guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/" + [Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise] + [Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana] + BackupOldFiles = "/docs/guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/prerequisites/#backup-old-files" + MakeArtefactsAvailable = "/docs/guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/prerequisites/#make-artefacts-available" + Prerequisites = "/docs/guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/prerequisites" + TryItOut = "/docs/guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/try-it-out" + UpgradeGrafana = "/docs/guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-grafana" + UpgradeLoki = "/docs/guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-loki" + UpgradePromtail = "/docs/guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-promtail" + VerifyOldVersion = "/docs/guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/prerequisites/#verify-old-version" + [Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud] + [Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana] + BackupOldFiles = "/docs/guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/prerequisites/#backup-old-files" + MakeArtefactsAvailable = "/docs/guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/prerequisites/#make-artefacts-available" + Prerequisites = "/docs/guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/prerequisites" + TryItOut = "/docs/guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/try-it-out" + UpgradePromtail = "/docs/guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/upgrade-promtail" + VerifyOldVersion = "/docs/guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/prerequisites/#verify-old-version" + [Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Dashboards] + [Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Dashboards.Grafana] + Download = "/docs/guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/dashboards/grafana/upgrade-dashboards/#download-the-default-dashboards" + UpgradeDashboards = "/docs/guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/dashboards/grafana/upgrade-dashboards" + TryItOut = "/docs/guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/dashboards/grafana/try-it-out" + [Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0] + MainDoc = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/" + [Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise] + [Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana] + BackupOldFiles = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/prerequisites/#backup-old-files" + MakeArtefactsAvailable = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/prerequisites/#make-artefacts-available" + Prerequisites = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/prerequisites" + TryItOut = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/try-it-out" + UpgradeGrafana = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-grafana" + UpgradeLoki = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki" + UpgradePromtail = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-promtail" + VerifyOldVersion = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/prerequisites/#verify-old-version" + [Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.Cloud] + [Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.Cloud.Grafana] + BackupOldFiles = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/prerequisites/#backup-old-files" + MakeArtefactsAvailable = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/prerequisites/#make-artefacts-available" + Prerequisites = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/prerequisites" + TryItOut = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/try-it-out" + UpgradePromtail = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/upgrade-promtail" + VerifyOldVersion = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/prerequisites/#verify-old-version" [Cortex.Guides.UserGuides] MainDoc = "/docs/guides/user-guides/" [Cortex.Guides.UserGuides.UserInterfaces] From 333aacf1625c5d63d5499eef7015da649d210050 Mon Sep 17 00:00:00 2001 From: Cortex-DMS <104561178+Cortex-DMS@users.noreply.github.com> Date: Wed, 10 Sep 2025 16:43:21 +0100 Subject: [PATCH 02/14] Fixed broken link (#233) Co-authored-by: Donna-Marie Smith --- .../Concepts/fundamentals/variables/using-variables.md | 2 ++ .../Concepts/fundamentals/variables/using-variables.md | 1 + 2 files changed, 3 insertions(+) diff --git a/content/en/docs/2025.5/Reference/Concepts/fundamentals/variables/using-variables.md b/content/en/docs/2025.5/Reference/Concepts/fundamentals/variables/using-variables.md index b98505ec9..6261ef142 100644 --- a/content/en/docs/2025.5/Reference/Concepts/fundamentals/variables/using-variables.md +++ b/content/en/docs/2025.5/Reference/Concepts/fundamentals/variables/using-variables.md @@ -202,6 +202,8 @@ None [Exception]: {{< url path="Cortex.Reference.DataTypes.Exceptions.Exception.MainDoc" >}} [String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}} +[Variable Editor]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.VariableEditor.MainDoc" >}} + [Variables Grid]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.BottomPanel.VariablesGrid.MainDoc" >}} [Properties]: {{< url path="Cortex.Reference.Glossary.P-T.PropertyCSharp" >}} diff --git a/content/en/docs/2025.7/Reference/Concepts/fundamentals/variables/using-variables.md b/content/en/docs/2025.7/Reference/Concepts/fundamentals/variables/using-variables.md index b98505ec9..bb31094b1 100644 --- a/content/en/docs/2025.7/Reference/Concepts/fundamentals/variables/using-variables.md +++ b/content/en/docs/2025.7/Reference/Concepts/fundamentals/variables/using-variables.md @@ -202,6 +202,7 @@ None [Exception]: {{< url path="Cortex.Reference.DataTypes.Exceptions.Exception.MainDoc" >}} [String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}} +[Variable Editor]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.VariableEditor.MainDoc" >}} [Variables Grid]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Dev.FlowEditor.BottomPanel.VariablesGrid.MainDoc" >}} [Properties]: {{< url path="Cortex.Reference.Glossary.P-T.PropertyCSharp" >}} From d6eba4e3444615e7c291c512a53220bcdd62ac3e Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Thu, 11 Sep 2025 11:07:52 +0100 Subject: [PATCH 03/14] updated install guides to use new versions for Grafana, Loki & Alloy and added required download links --- .../Grafana/install-alloy/install-alloy.md | 4 ++-- .../Grafana/install-grafana/install-grafana.md | 4 ++-- .../Grafana/install-loki/install-loki.md | 4 ++-- .../Grafana/prerequisites.md | 10 +++++----- data/urls.toml | 6 ++++++ 5 files changed, 17 insertions(+), 11 deletions(-) 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 d81d8bfe1..4d5e163a8 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.0][] archive. +1. Download the [Grafana Alloy 1.10.2][] archive. 1. Extract content of the downloaded archive to a suitable location, e.g. `C:\Program Data\Cortex\Observability\Grafana Alloy`. 1. Download the [Grafana Alloy.zip][] archive and extract its contents alongside the previously extracted Grafana Alloy `alloy-installer-windows-amd64.exe`. This archive contains the `config.alloy` configuration file and PowerShell scripts to install Grafana Alloy as a Windows service. @@ -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.0]: {{< url path="Grafana.Products.Loki.Alloy.1.10.0" >}} +[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1.10.2" >}} [Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.4.0.0.GrafanaAlloyInstallZip" >}} [Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}} [Reverse Proxy Authentication]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.ConfigureAuthentication" >}} diff --git a/content/en/docs/2025.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 ab29b8dac..0a939bf44 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 10.4.1][] Windows installer. +1. Download the [Grafana 12.1.1][] Windows installer. 1. Run the installer and install Grafana to a suitable location. ## Next Steps? @@ -19,6 +19,6 @@ 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 12.1.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.12.1.1.Windows" >}} [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 8fdc0ac57..65873f45a 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.0.0][] archive. +1. Download [Grafana Loki 3.5.5][] archive. 1. Extract content of the downloaded archive to a suitable location, e.g. `C:\Program Data\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.0.0]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3.0.0.GrafanaLokiInstallZip" >}} +[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.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 b3b768492..b008a4de8 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 10.4.1][] *Enterprise Edition*
[Grafana Loki 3.0.0][]| -| Application Server | [2022 (x64)][] *Recommended*
[2019 (x64)][] | | [Grafana Alloy 1.10.0][]| +| 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][]| [^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. @@ -161,9 +161,9 @@ Grafana Alloy requires a domain user that is not a member of the Local Administr [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 Alloy 1.10.0]: {{< url path="Grafana.Products.Loki.Alloy.1.10.0" >}} -[Grafana Loki 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3.0.0.GrafanaLokiInstallZip" >}} +[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" >}} [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/data/urls.toml b/data/urls.toml index 2fb2bc0c8..23c2ed48b 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -3198,18 +3198,24 @@ [Grafana.Products.Loki.Alloy] MainDoc = "https://grafana.com/docs/loki/latest/send-data/alloy/" 1.10.0 = "https://github.com/grafana/alloy/releases/download/v1.10.0/alloy-installer-windows-amd64.exe.zip" + 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.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.GrafanaLoki] Release = "https://github.com/grafana/loki/releases/tag/v2.5.0" GrafanaLokiInstallZip = "https://github.com/grafana/loki/releases/download/v2.5.0/loki-windows-amd64.exe.zip" [Grafana.SelfManaged.Downloads.GrafanaLoki.3.0.0] Release = "https://github.com/grafana/loki/releases/tag/v3.0.0" GrafanaLokiInstallZip = "https://github.com/grafana/loki/releases/download/v3.0.0/loki-windows-amd64.exe.zip" + [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.Promtail] PromtailInstallZip = "https://github.com/grafana/loki/releases/download/v2.5.0/promtail-windows-amd64.exe.zip" [Grafana.SelfManaged.Downloads.Promtail.3.0.0] From 0f182ded21b483553d53a987f73a33a4fb52e448 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Thu, 11 Sep 2025 12:44:48 +0100 Subject: [PATCH 04/14] Added initial 3.0.0 to 4.0.0 Upgrade Steps --- .../on-premise/grafana/migrate-to-alloy.md | 42 +++++++ .../on-premise/grafana/prerequisites.md | 45 ++++--- .../on-premise/grafana/upgrade-grafana.md | 12 +- .../on-premise/grafana/upgrade-loki.md | 119 +++++++++++------- .../on-premise/grafana/upgrade-promtail.md | 75 ----------- .../Grafana/install-alloy/install-alloy.md | 4 +- .../Grafana/prerequisites.md | 4 +- data/urls.toml | 2 +- 8 files changed, 156 insertions(+), 147 deletions(-) create mode 100644 content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md delete mode 100644 content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-promtail.md diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md new file mode 100644 index 000000000..e4762b115 --- /dev/null +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md @@ -0,0 +1,42 @@ +--- +title: "Migrate to Grafana Alloy" +linkTitle: "Migrate to Grafana Alloy" +description: "The steps to Migrate Promtail to Grafana Alloy." +weight: 4 +--- + +# {{% param title %}} + +This guide describes how to migrate from a Promtail Installation to Grafana Alloy. Please ensure that the [Loki Upgrade][] has been completed before starting this upgrade. + +## Prerequisites + +## Perform Migration + +{{% alert title="Note" %}} +These steps will need to be performed on all application servers that host a Promtail service. +{{% / alert %}} + +1. Log in to the application server. +1. Run Windows PowerShell as Administrator. +1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Remove the current Promtail installation by executing the following command: + + ``` powershell + .\Remove-Promtail.ps1 + ``` + +1. Click *Yes* when prompted for confirmation that you wish to remove the service. +1. Click *OK* when the successful removal of the Promtail service is confirmed. +1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\Program Data\Cortex\Observability\Promtail` +1. Delete the Promtail directory +1. TODO + +## Next Steps? + +1. [Try it out][] + +[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.BackupOldFiles" >}} +[Loki Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.UpgradeLoki" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.MakeArtefactsAvailable" >}} +[Try it out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.TryItOut" >}} 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 9b69adaad..20427f71c 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 @@ -22,17 +22,28 @@ weight: 1 1. Download the required artefacts to a folder on your machine: - * [Grafana 10.4.1][] Standalone Windows Binaries archive. - * [Grafana Loki 3.0.0][] archive. - * [Grafana Loki Install][] archive. - * [Promtail 3.0.0][] archive. - * [Promtail Install][] archive. + * [Grafana 12.1.1][] Standalone Windows Binaries archive. + * [Grafana Alloy 1.10.2][] archive. + * [Grafana Alloy Install][] archive. + * [Grafana Loki 3.5.5][] archive. -1. Extract the downloaded `grafana-enterprise-10.4.1.windows-amd64` archive to a folder with the same name. +1. Extract the downloaded `grafana-enterprise_12.1.1_16903967602_windows_amd64` archive: + 1. Open a Windows Powershell (x64) window as administrator. + 1. Navigate Powershell to inside the folder containing the `grafana-enterprise_12.1.1_16903967602_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_12.1.1_16903967602_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 `Grafana.Alloy.Install` 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.Loki.Install` archive to a folder with the same name. -1. Extract the downloaded `promtail-windows-amd64.exe` archive to a folder with the same name. -1. Extract the downloaded `Promtail.Install` archive to a folder with the same name. ## Backup Old Files @@ -40,21 +51,21 @@ weight: 1 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:\Loki\`. +1. In File Explorer, navigate to the location that Loki is running from, e.g. `C:\Program Data\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 Promtail is installed on: 1. Create a folder called `Observability Backups` in a known location. - 1. Open File Explorer and navigate to the location that Promtail is running from, e.g. `C:\Promtail`. + 1. Open File Explorer and navigate to the location that Promtail is running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. 1. Copy the `promtail-local-config.yaml` file and save it to the `Observability Backups` folder created at step 7.1. ## Next Steps? 1. [Upgrade Grafana][] -[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 Loki Install]: {{< url path="GitHub.Cortex.Observability.3.0.0.GrafanaLokiInstallZip" >}} -[Promtail 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.3.0.0.PromtailInstallZip" >}} -[Promtail Install]: {{< url path="GitHub.Cortex.Observability.3.0.0.PromtailInstallZip" >}} -[Upgrade Grafana]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.UpgradeGrafana" >}} +[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 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/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-grafana.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-grafana.md index 683cb392e..956d35f2f 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-grafana.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-grafana.md @@ -14,10 +14,8 @@ This guide describes how to upgrade the Grafana installation. Please ensure that 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-enterprise-10.4.1.windows-amd64` folder created as part of [Make Artefacts Available][]. -1. Open the `grafana-v10.4.1` subfolder. +1. In File Explorer, navigate to the `grafana-12.1.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. Copy the [backed up][] `custom.ini` and `defaults.ini` files into the Grafana install configuration location, typically `%SystemDrive%\Program Files\GrafanaLabs\grafana\conf`, 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*. @@ -25,7 +23,7 @@ This guide describes how to upgrade the Grafana installation. Please ensure that 1. [Upgrade Loki][] -[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.BackupOldFiles" >}} -[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.MakeArtefactsAvailable" >}} -[Prerequisites]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.Prerequisites" >}} -[Upgrade Loki]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.UpgradeLoki" >}} +[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.BackupOldFiles" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.MakeArtefactsAvailable" >}} +[Prerequisites]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.Prerequisites" >}} +[Upgrade Loki]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.UpgradeLoki" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki.md index f4b30157a..5e66f44ee 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki.md @@ -23,50 +23,14 @@ This guide describes how to upgrade the Loki installation. Please ensure that th 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:\Program Data\Cortex\Observability\Loki`. -1. Delete the following files from the directory: +1. Delete the following file from the directory: - * Install-Loki.ps1 - * loki-local-config.yaml * loki-windows-amd64.exe - * nssm.exe - * Remove-Loki.ps1 - * Start-Loki.ps1 - * Stop-Loki.ps1 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:\Program Data\Cortex\Observability\Loki`. -1. In File Explorer, navigate to the extracted `Grafana.Loki.Install` folder created as part of [Make Artefacts Available][]. -1. Copy the contents of this location into the folder that Loki was previously running from, e.g. `C:\Program Data\Cortex\Observability\Loki`. -1. Open the new `loki-local-config.yaml` file in a text editor and compare against the [backed up][] version. If there are differences between the two files in the *schema_config* > *configs* section: - - 1. In the new file, change the date next to `- from` to be today's date. - 1. Copy the old config section from the backup and add it immediately under *configs* and before the existing `- from ` line ensuring that formatting (including indentations) remain identical to that which is used in the new file. - - The new *schema_config* should result in something similar to: - - ```yaml - schema_config: - configs: - - from: 2020-10-24 - store: boltdb-shipper - object_store: filesystem - schema: v11 - index: - prefix: index_ - period: 24h - - from: 2024-08-29 - store: tsdb - object_store: filesystem - schema: v13 - index: - prefix: index_ - period: 24h - ``` - - 1. Save the new `loki-local-config.yaml` file. - 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where the Loki files have been copied to, e.g. `cd C:\Program Data\Cortex\Observability\Loki`. +1. Change the directory to the folder where the Loki file has been copied to, e.g. `cd C:\Program Data\Cortex\Observability\Loki`. 1. Install Loki by executing the following command: ``` powershell @@ -83,11 +47,80 @@ This guide describes how to upgrade the Loki installation. Please ensure that th * Open Services.msc from the Start menu. * Locate the *Loki* service and confirm that it is *Running*. +## Make Reverse Proxy changes + +### Disable Basic Authentication + +1. Run IIS Manager. +1. In the *Connection* pane, browse to *Sites*. +1. Select the website for the Loki Reverse Proxy e.g. `Grafana Loki`. +1. Double-click on the *Authentication* icon. +1. Enable *Anonymous Authentication*. +1. Disable *Basic Authentication*. + +### Configure URL Rewrite Rules + +#### Set-up Authentication + +1. Run IIS Manager. +1. In the *Connection* pane, browse to *Sites*. +1. Select the website for the Loki Reverse Proxy e.g. `Grafana Loki`. +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 [Migrating Promtail to Grafana Alloy][Migrate to 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*. + +#### 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. Run IIS Manager. +1. In the *Connection* pane, browse to *Sites*. +1. Select the website for the Loki Reverse Proxy e.g. `Grafana Loki`. +1. In the *Manage Website* pane, click *Restart*. + ## Next Steps? -1. [Upgrade Promtail][] +1. [Migrate Promtail to Grafana Alloy][Migrate to Alloy] -[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.BackupOldFiles" >}} -[Grafana Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.UpgradeGrafana" >}} -[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.MakeArtefactsAvailable" >}} -[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.UpgradePromtail" >}} +[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.BackupOldFiles" >}} +[Grafana Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.UpgradeGrafana" >}} +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.MakeArtefactsAvailable" >}} +[Migrate to Alloy]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.MigrateToAlloy" >}} +[Token Generator]: {{< url path="IT-Tools.TokenGenerator" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-promtail.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-promtail.md deleted file mode 100644 index aeea7dc85..000000000 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-promtail.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "Upgrade Promtail" -linkTitle: "Upgrade Promtail" -description: "The steps to upgrade Promtail." -weight: 4 ---- - -# {{% param title %}} - -This guide describes how to upgrade the Promtail installation. Please ensure that the [Loki Upgrade][] has been completed before starting this upgrade. - -## Perform Upgrade - -{{% alert title="Note" %}} -These steps will need to be performed on all application servers that host a Promtail service. -{{% / alert %}} - -1. Log in to the application server. -1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. -1. Remove the current Promtail installation by executing the following command: - - ``` powershell - .\Remove-Promtail.ps1 - ``` - -1. Click *Yes* when prompted for confirmation that you wish to remove the service. -1. Click *OK* when the successful removal of the Promtail service is confirmed. -1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\Program Data\Cortex\Observability\Promtail` -1. Delete the following files from the directory: - - * Install-Promtail.ps1 - * nssm.exe - * Promtail-local-config.yaml - * Promtail-windows-amd64.exe - * Remove-Promtail.ps1 - * Start-Promtail.ps1 - * Stop-Promtail.ps1 - -1. In File Explorer, navigate to the extracted `promtail-windows-amd64.exe` folder created as part of [Make Artefacts Available][]. -1. Copy the `promtail-windows-amd64.exe` file into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. -1. In File Explorer, navigate to the extracted `Promtail.Install` folder created as part of [Make Artefacts Available][]. -1. Copy the contents of this location into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. -1. Open the new `promtail-local-config.yaml` in a text editor: - - * Update the *filename* property under *positions* to be the value found in the [backed up][] version. - * Update the *url* property under *clients* to be the value found in the [backed up][] version. - * Save the new `promtail-local-config.yaml` file. - -1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where the Promtail files have been copied to, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. -1. Install Promtail by executing the following command: - - ``` powershell - .\Install-Promtail.ps1 - ``` - -1. Start the Promtail service by executing the following command: - - ``` powershell - .\Start-Promtail.ps1 - ``` - -1. Check that the Promtail service has installed and started correctly: - * Open Services.msc from the Start menu. - * Locate the *Promtail* service and confirm that it is *Running*. - -## Next Steps? - -1. [Try it out][] - -[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.BackupOldFiles" >}} -[Loki Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.UpgradeLoki" >}} -[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.MakeArtefactsAvailable" >}} -[Try it out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.TryItOut" >}} 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 edd3cfed4..84aa1b6ed 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.0][] archive. +1. Download the [Grafana Alloy 1.10.2][] archive. 1. Extract content of the downloaded archive to a suitable location, e.g. `C:\Program Data\Cortex\Observability\Grafana Alloy`. 1. Download the [Grafana Alloy.zip][] archive and extract its contents alongside the previously extracted Grafana Alloy `alloy-installer-windows-amd64.exe`. This archive contains the `config.alloy` configuration file and PowerShell scripts to install Grafana Alloy as a Windows service. @@ -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.0]: {{< url path="Grafana.Products.Loki.Alloy.1.10.0" >}} +[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1.10.2" >}} [Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.4.0.0.GrafanaAlloyInstallZip" >}} [Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}} diff --git a/content/en/docs/2025.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 d6cc2bb0e..2641c225a 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.0][] | +| Application Server | [2022 (x64)][] *Recommended*
[2019 (x64)][] | [Grafana Alloy 1.10.2][] | [^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.0]: {{< url path="Grafana.Products.Loki.Alloy.1.10.0" >}} +[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1.10.2" >}} [Set up Grafana]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupGrafana.MainDoc" >}} diff --git a/data/urls.toml b/data/urls.toml index 23c2ed48b..120916a3b 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -1084,7 +1084,7 @@ TryItOut = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/try-it-out" UpgradeGrafana = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-grafana" UpgradeLoki = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki" - UpgradePromtail = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-promtail" + MigrateToAlloy = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy" VerifyOldVersion = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/prerequisites/#verify-old-version" [Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.Cloud] [Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.Cloud.Grafana] From 0a0118abff3ae605caad0e2f8afd7c693d27b6f5 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Thu, 11 Sep 2025 12:49:04 +0100 Subject: [PATCH 05/14] added additional TODO --- .../3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md index e4762b115..cf434ec82 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md @@ -11,6 +11,8 @@ This guide describes how to migrate from a Promtail Installation to Grafana Allo ## Prerequisites +1. TODO - Url changes + ## Perform Migration {{% alert title="Note" %}} @@ -30,7 +32,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Click *OK* when the successful removal of the Promtail service is confirmed. 1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\Program Data\Cortex\Observability\Promtail` 1. Delete the Promtail directory -1. TODO +1. TODO - Migration process ## Next Steps? From a1c08b9fc8a2b6532cd75d58b54c11de890383eb Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Mon, 15 Sep 2025 12:35:03 +0100 Subject: [PATCH 06/14] Added steps to migrate Promtail to Alloy --- .../on-premise/grafana/migrate-to-alloy.md | 19 ++++++++++++++++--- .../on-premise/grafana/try-it-out.md | 8 ++++---- data/urls.toml | 1 + 3 files changed, 21 insertions(+), 7 deletions(-) diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md index cf434ec82..9fc440b15 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md @@ -9,9 +9,14 @@ weight: 4 This guide describes how to migrate from a Promtail Installation to Grafana Alloy. Please ensure that the [Loki Upgrade][] has been completed before starting this upgrade. -## Prerequisites +## Modify Client URL for Grafana Loki -1. TODO - Url changes +1. Open the `promtail-local-config.yaml` configuration file, which is located in the folder alongside the `promtail-windows-amd64.exe` file e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. Locate the Grafana Loki `URL` in the `clients` section. +1. Remove the `username:password@` from the URL + + A correct URL should be changed from `https://username:password@hostaddress:2100/loki/api/v1/push` to `https://hostaddress:2100/loki/api/v1/push`. +1. Save the file. ## Perform Migration @@ -32,7 +37,14 @@ These steps will need to be performed on all application servers that host a Pro 1. Click *OK* when the successful removal of the Promtail service is confirmed. 1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\Program Data\Cortex\Observability\Promtail` 1. Delete the Promtail directory -1. TODO - Migration process +1. In File Explorer, 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 a suitable location, e.g. `C:\Program Data\Cortex\Observability\Grafana Alloy`. +1. In File Explorer, navigate to the extracted Grafana.Alloy.Install folder created as part of [Make Artefacts Available][]. +1. Copy the contents of the folder to the same location as the previously copied alloy-installer-windows-amd64.exe. +1. In Powershell change the location to the folder that the artefacts have been copied to, e.g. `cd C:\Program Data\Cortex\Observability\Grafana Alloy`. +1. Execute the `.\Migrate-Promtail-To-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? @@ -41,4 +53,5 @@ These steps will need to be performed on all application servers that host a Pro [backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.BackupOldFiles" >}} [Loki Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.UpgradeLoki" >}} [Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.MakeArtefactsAvailable" >}} +[Reverse Proxy Authentication]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.SetupAuthentication" >}} [Try it out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.TryItOut" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/try-it-out.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/try-it-out.md index 71b0666c1..b3d27c5d6 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/try-it-out.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/try-it-out.md @@ -7,13 +7,13 @@ weight: 5 # {{% param title %}} -This guide describes how to verify that the upgrade has been successful. Please ensure that [Upgrade Promtail][] has been completed before taking these steps. +This guide describes how to verify that the upgrade has been successful. Please ensure that [Migration to Grafana Alloy][Migrate To 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 10.4.1. +1. Confirm the version has updated to be 12.1.1. ## Confirm Dashboards Load @@ -50,5 +50,5 @@ If other requests have been made then there may be more than one request visible If other requests have been made then there may be more than one request visible on the dashboard. {{% / alert %}} -[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.UpgradePromtail" >}} -[verifying the old version]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.OnPremise.Grafana.VerifyOldVersion" >}} +[Migrate To Alloy]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.MigrateToAlloy" >}} +[verifying the old version]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.VerifyOldVersion" >}} diff --git a/data/urls.toml b/data/urls.toml index 120916a3b..079a029a4 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -1079,6 +1079,7 @@ [Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise] [Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana] BackupOldFiles = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/prerequisites/#backup-old-files" + SetupAuthentication = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki/#set-up-authentication" MakeArtefactsAvailable = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/prerequisites/#make-artefacts-available" Prerequisites = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/prerequisites" TryItOut = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/try-it-out" From c34f814950b7b8c22598d48cac9c723e8182897c Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Wed, 17 Sep 2025 10:04:12 +0100 Subject: [PATCH 07/14] specified correct Grafana Standalone Binaries to download --- .../3.0.0-to-4.0.0/on-premise/grafana/prerequisites.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 20427f71c..f052e837b 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 @@ -22,7 +22,7 @@ weight: 1 1. Download the required artefacts to a folder on your machine: - * [Grafana 12.1.1][] Standalone Windows Binaries archive. + * [Grafana 12.1.1][] Standalone Windows Binaries (64 Bit) archive. * [Grafana Alloy 1.10.2][] archive. * [Grafana Alloy Install][] archive. * [Grafana Loki 3.5.5][] archive. From 374919b5b50f82634b4349cb6eb966a90d274728 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Wed, 17 Sep 2025 11:34:02 +0100 Subject: [PATCH 08/14] Fixed up paths from Program Data to ProgramData --- .../Grafana/install-alloy/install-alloy.md | 4 ++-- .../Grafana/install-loki/install-loki.md | 4 ++-- .../2.2.0-to-3.0.0/cloud/grafana/upgrade-promtail.md | 10 +++++----- .../2.2.0-to-3.0.0/on-premise/grafana/upgrade-loki.md | 10 +++++----- .../on-premise/grafana/upgrade-promtail.md | 10 +++++----- .../3.0.0-to-4.0.0/cloud/grafana/upgrade-promtail.md | 10 +++++----- .../on-premise/grafana/migrate-to-alloy.md | 10 +++++----- .../3.0.0-to-4.0.0/on-premise/grafana/prerequisites.md | 4 ++-- .../3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki.md | 8 ++++---- .../Grafana/install-alloy/install-alloy.md | 4 ++-- .../Grafana/install-alloy/install-alloy.md | 4 ++-- .../Grafana/install-loki/install-loki.md | 4 ++-- 12 files changed, 41 insertions(+), 41 deletions(-) diff --git a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md index d81d8bfe1..f31fa923c 100644 --- a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md +++ b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md @@ -12,11 +12,11 @@ This guide describes how to install Grafana Alloy on the Application Server(s). ## Install Grafana Alloy 1. Download the [Grafana Alloy 1.10.0][] archive. -1. Extract content of the downloaded archive to a suitable location, e.g. `C:\Program Data\Cortex\Observability\Grafana Alloy`. +1. 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:\Program Data\Cortex\Observability\Grafana Alloy"`. +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] diff --git a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md index 8fdc0ac57..e2b718c63 100644 --- a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md +++ b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md @@ -12,11 +12,11 @@ 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. 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. diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/upgrade-promtail.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/upgrade-promtail.md index 14fe26219..07cc0476a 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/upgrade-promtail.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/cloud/grafana/upgrade-promtail.md @@ -17,7 +17,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Log in to the application server. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\ProgramData\Cortex\Observability\Promtail`. 1. Remove the current Promtail installation by executing the following command: ``` powershell @@ -26,7 +26,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Click *Yes* when prompted for confirmation that you wish to remove the service. 1. Click *OK* when the successful removal of the Promtail service is confirmed. -1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\Program Data\Cortex\Observability\Promtail` +1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail` 1. Delete the following files from the directory: * Install-Promtail.ps1 @@ -38,9 +38,9 @@ These steps will need to be performed on all application servers that host a Pro * Stop-Promtail.ps1 1. In File Explorer, navigate to the extracted `promtail-windows-amd64.exe` folder created as part of [Make Artefacts Available][]. -1. Copy the `promtail-windows-amd64.exe` file into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. Copy the `promtail-windows-amd64.exe` file into the folder that Promtail was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail`. 1. In File Explorer, navigate to the extracted `Promtail.Install` folder created as part of [Make Artefacts Available][]. -1. Copy the contents of this location into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. Copy the contents of this location into the folder that Promtail was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail`. 1. Open `promtail-local-config.yaml` in a text editor: * Update the *filename* property under *positions* to be the value found in the [backed up][] version. @@ -48,7 +48,7 @@ These steps will need to be performed on all application servers that host a Pro * Save the new `promtail-local-config.yaml` file. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where the Promtail files have been copied to, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Change the directory to the folder where the Promtail files have been copied to, e.g. `cd C:\ProgramData\Cortex\Observability\Promtail`. 1. Install Promtail by executing the following command: ``` powershell diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-loki.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-loki.md index f4b30157a..ee3c83d26 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-loki.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-loki.md @@ -13,7 +13,7 @@ This guide describes how to upgrade the Loki installation. Please ensure that th 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:\Program Data\Cortex\Observability\Loki`. +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 @@ -22,7 +22,7 @@ This guide describes how to upgrade the Loki installation. Please ensure that th 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:\Program Data\Cortex\Observability\Loki`. +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 files from the directory: * Install-Loki.ps1 @@ -34,9 +34,9 @@ This guide describes how to upgrade the Loki installation. Please ensure that th * Stop-Loki.ps1 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:\Program Data\Cortex\Observability\Loki`. +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. In File Explorer, navigate to the extracted `Grafana.Loki.Install` folder created as part of [Make Artefacts Available][]. -1. Copy the contents of this location into the folder that Loki was previously running from, e.g. `C:\Program Data\Cortex\Observability\Loki`. +1. Copy the contents of this location into the folder that Loki was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Loki`. 1. Open the new `loki-local-config.yaml` file in a text editor and compare against the [backed up][] version. If there are differences between the two files in the *schema_config* > *configs* section: 1. In the new file, change the date next to `- from` to be today's date. @@ -66,7 +66,7 @@ This guide describes how to upgrade the Loki installation. Please ensure that th 1. Save the new `loki-local-config.yaml` file. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where the Loki files have been copied to, e.g. `cd C:\Program Data\Cortex\Observability\Loki`. +1. Change the directory to the folder where the Loki files have been copied to, e.g. `cd C:\ProgramData\Cortex\Observability\Loki`. 1. Install Loki by executing the following command: ``` powershell diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-promtail.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-promtail.md index aeea7dc85..5e7080e1b 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-promtail.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/2.2.0-to-3.0.0/on-premise/grafana/upgrade-promtail.md @@ -17,7 +17,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Log in to the application server. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\ProgramData\Cortex\Observability\Promtail`. 1. Remove the current Promtail installation by executing the following command: ``` powershell @@ -26,7 +26,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Click *Yes* when prompted for confirmation that you wish to remove the service. 1. Click *OK* when the successful removal of the Promtail service is confirmed. -1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\Program Data\Cortex\Observability\Promtail` +1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail` 1. Delete the following files from the directory: * Install-Promtail.ps1 @@ -38,9 +38,9 @@ These steps will need to be performed on all application servers that host a Pro * Stop-Promtail.ps1 1. In File Explorer, navigate to the extracted `promtail-windows-amd64.exe` folder created as part of [Make Artefacts Available][]. -1. Copy the `promtail-windows-amd64.exe` file into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. Copy the `promtail-windows-amd64.exe` file into the folder that Promtail was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail`. 1. In File Explorer, navigate to the extracted `Promtail.Install` folder created as part of [Make Artefacts Available][]. -1. Copy the contents of this location into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. Copy the contents of this location into the folder that Promtail was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail`. 1. Open the new `promtail-local-config.yaml` in a text editor: * Update the *filename* property under *positions* to be the value found in the [backed up][] version. @@ -48,7 +48,7 @@ These steps will need to be performed on all application servers that host a Pro * Save the new `promtail-local-config.yaml` file. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where the Promtail files have been copied to, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Change the directory to the folder where the Promtail files have been copied to, e.g. `cd C:\ProgramData\Cortex\Observability\Promtail`. 1. Install Promtail by executing the following command: ``` powershell diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/upgrade-promtail.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/upgrade-promtail.md index 14fe26219..07cc0476a 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/upgrade-promtail.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/upgrade-promtail.md @@ -17,7 +17,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Log in to the application server. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\ProgramData\Cortex\Observability\Promtail`. 1. Remove the current Promtail installation by executing the following command: ``` powershell @@ -26,7 +26,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Click *Yes* when prompted for confirmation that you wish to remove the service. 1. Click *OK* when the successful removal of the Promtail service is confirmed. -1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\Program Data\Cortex\Observability\Promtail` +1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail` 1. Delete the following files from the directory: * Install-Promtail.ps1 @@ -38,9 +38,9 @@ These steps will need to be performed on all application servers that host a Pro * Stop-Promtail.ps1 1. In File Explorer, navigate to the extracted `promtail-windows-amd64.exe` folder created as part of [Make Artefacts Available][]. -1. Copy the `promtail-windows-amd64.exe` file into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. Copy the `promtail-windows-amd64.exe` file into the folder that Promtail was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail`. 1. In File Explorer, navigate to the extracted `Promtail.Install` folder created as part of [Make Artefacts Available][]. -1. Copy the contents of this location into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. Copy the contents of this location into the folder that Promtail was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail`. 1. Open `promtail-local-config.yaml` in a text editor: * Update the *filename* property under *positions* to be the value found in the [backed up][] version. @@ -48,7 +48,7 @@ These steps will need to be performed on all application servers that host a Pro * Save the new `promtail-local-config.yaml` file. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where the Promtail files have been copied to, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Change the directory to the folder where the Promtail files have been copied to, e.g. `cd C:\ProgramData\Cortex\Observability\Promtail`. 1. Install Promtail by executing the following command: ``` powershell diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md index 9fc440b15..68434da9f 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md @@ -11,7 +11,7 @@ This guide describes how to migrate from a Promtail Installation to Grafana Allo ## Modify 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 e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. Open the `promtail-local-config.yaml` configuration file, which is located in the folder alongside the `promtail-windows-amd64.exe` file e.g. `C:\ProgramData\Cortex\Observability\Promtail`. 1. Locate the Grafana Loki `URL` in the `clients` section. 1. Remove the `username:password@` from the URL @@ -26,7 +26,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Log in to the application server. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\ProgramData\Cortex\Observability\Promtail`. 1. Remove the current Promtail installation by executing the following command: ``` powershell @@ -35,13 +35,13 @@ These steps will need to be performed on all application servers that host a Pro 1. Click *Yes* when prompted for confirmation that you wish to remove the service. 1. Click *OK* when the successful removal of the Promtail service is confirmed. -1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\Program Data\Cortex\Observability\Promtail` +1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail` 1. Delete the Promtail directory 1. In File Explorer, 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 a suitable location, e.g. `C:\Program Data\Cortex\Observability\Grafana Alloy`. +1. Copy the alloy-installer-windows-amd64.exe into a suitable location, e.g. `C:\ProgramData\Cortex\Observability\Grafana Alloy`. 1. In File Explorer, navigate to the extracted Grafana.Alloy.Install folder created as part of [Make Artefacts Available][]. 1. Copy the contents of the folder to the same location as the previously copied alloy-installer-windows-amd64.exe. -1. In Powershell change the location to the folder that the artefacts have been copied to, e.g. `cd C:\Program Data\Cortex\Observability\Grafana Alloy`. +1. In Powershell change the location to the folder that the artefacts have been copied to, e.g. `cd C:\ProgramData\Cortex\Observability\Grafana Alloy`. 1. Execute the `.\Migrate-Promtail-To-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] 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 f052e837b..abcda2076 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 @@ -51,12 +51,12 @@ weight: 1 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:\Program Data\Cortex\Observability\Loki\`. +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 Promtail is installed on: 1. Create a folder called `Observability Backups` in a known location. - 1. Open File Explorer and navigate to the location that Promtail is running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. + 1. Open File Explorer and navigate to the location that Promtail is running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail`. 1. Copy the `promtail-local-config.yaml` file and save it to the `Observability Backups` folder created at step 7.1. ## Next Steps? diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki.md index 5e66f44ee..9c3730022 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki.md @@ -13,7 +13,7 @@ This guide describes how to upgrade the Loki installation. Please ensure that th 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:\Program Data\Cortex\Observability\Loki`. +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 @@ -22,15 +22,15 @@ This guide describes how to upgrade the Loki installation. Please ensure that th 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:\Program Data\Cortex\Observability\Loki`. +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:\Program Data\Cortex\Observability\Loki`. +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:\Program Data\Cortex\Observability\Loki`. +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 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 84aa1b6ed..d87578dd9 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 @@ -12,11 +12,11 @@ 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. Extract content of the downloaded archive to a suitable location, e.g. `C:\Program Data\Cortex\Observability\Grafana Alloy`. +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:\Program Data\Cortex\Observability\Grafana Alloy"`. +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. 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 4d5e163a8..239dadeed 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 @@ -12,11 +12,11 @@ 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. Extract content of the downloaded archive to a suitable location, e.g. `C:\Program Data\Cortex\Observability\Grafana Alloy`. +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:\Program Data\Cortex\Observability\Grafana Alloy"`. +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] 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 65873f45a..9af9a08e0 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 @@ -12,11 +12,11 @@ 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. Extract content of the downloaded archive to a suitable location, e.g. `C:\Program Data\Cortex\Observability\Loki`. +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. From 27f4f7aa72c2f8dd85723845dd3f7f860c640a7a Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Wed, 17 Sep 2025 11:35:57 +0100 Subject: [PATCH 09/14] fixed additional Program Data ProgramData issues --- .../cloud/grafana/upgrade-promtail.md | 10 +++++----- .../on-premise/grafana/upgrade-loki.md | 10 +++++----- .../on-premise/grafana/upgrade-promtail.md | 10 +++++----- .../Grafana/install-alloy/install-alloy.md | 4 ++-- 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/cloud/grafana/upgrade-promtail.md b/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/cloud/grafana/upgrade-promtail.md index 5134badd9..a62dfb057 100644 --- a/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/cloud/grafana/upgrade-promtail.md +++ b/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/cloud/grafana/upgrade-promtail.md @@ -17,7 +17,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Log in to the application server. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\ProgramData\Cortex\Observability\Promtail`. 1. Remove the current Promtail installation by executing the following command: ``` powershell @@ -26,7 +26,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Click *Yes* when prompted for confirmation that you wish to remove the service. 1. Click *OK* when the successful removal of the Promtail service is confirmed. -1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\Program Data\Cortex\Observability\Promtail` +1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail` 1. Delete the following files from the directory: * Install-Promtail.ps1 @@ -38,9 +38,9 @@ These steps will need to be performed on all application servers that host a Pro * Stop-Promtail.ps1 1. In File Explorer, navigate to the extracted `promtail-windows-amd64.exe` folder created as part of [Make Artefacts Available][]. -1. Copy the `promtail-windows-amd64.exe` file into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. Copy the `promtail-windows-amd64.exe` file into the folder that Promtail was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail`. 1. In File Explorer, navigate to the extracted `Promtail.Install` folder created as part of [Make Artefacts Available][]. -1. Copy the contents of this location into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. Copy the contents of this location into the folder that Promtail was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail`. 1. Open `promtail-local-config.yaml` in a text editor: * Update the *filename* property under *positions* to be the value found in the [backed up][] version. @@ -48,7 +48,7 @@ These steps will need to be performed on all application servers that host a Pro * Save the new `promtail-local-config.yaml` file. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where the Promtail files have been copied to, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Change the directory to the folder where the Promtail files have been copied to, e.g. `cd C:\ProgramData\Cortex\Observability\Promtail`. 1. Install Promtail by executing the following command: ``` powershell diff --git a/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-loki.md b/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-loki.md index 2596b9b69..42b6a7187 100644 --- a/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-loki.md +++ b/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-loki.md @@ -13,7 +13,7 @@ This guide describes how to upgrade the Loki installation. Please ensure that th 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:\Program Data\Cortex\Observability\Loki`. +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 @@ -22,7 +22,7 @@ This guide describes how to upgrade the Loki installation. Please ensure that th 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:\Program Data\Cortex\Observability\Loki`. +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 files from the directory: * Install-Loki.ps1 @@ -34,9 +34,9 @@ This guide describes how to upgrade the Loki installation. Please ensure that th * Stop-Loki.ps1 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:\Program Data\Cortex\Observability\Loki`. +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. In File Explorer, navigate to the extracted `Grafana.Loki.Install` folder created as part of [Make Artefacts Available][]. -1. Copy the contents of this location into the folder that Loki was previously running from, e.g. `C:\Program Data\Cortex\Observability\Loki`. +1. Copy the contents of this location into the folder that Loki was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Loki`. 1. Open the new `loki-local-config.yaml` file in a text editor and compare against the [backed up][] version. If there are differences between the two files in the *schema_config* > *configs* section: 1. In the new file, change the date next to `- from` to be today's date. @@ -66,7 +66,7 @@ This guide describes how to upgrade the Loki installation. Please ensure that th 1. Save the new `loki-local-config.yaml` file. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where the Loki files have been copied to, e.g. `cd C:\Program Data\Cortex\Observability\Loki`. +1. Change the directory to the folder where the Loki files have been copied to, e.g. `cd C:\ProgramData\Cortex\Observability\Loki`. 1. Install Loki by executing the following command: ``` powershell diff --git a/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-promtail.md b/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-promtail.md index 014a7b960..78f25e918 100644 --- a/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-promtail.md +++ b/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-promtail.md @@ -17,7 +17,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Log in to the application server. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\ProgramData\Cortex\Observability\Promtail`. 1. Remove the current Promtail installation by executing the following command: ``` powershell @@ -26,7 +26,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Click *Yes* when prompted for confirmation that you wish to remove the service. 1. Click *OK* when the successful removal of the Promtail service is confirmed. -1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\Program Data\Cortex\Observability\Promtail` +1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail` 1. Delete the following files from the directory: * Install-Promtail.ps1 @@ -38,9 +38,9 @@ These steps will need to be performed on all application servers that host a Pro * Stop-Promtail.ps1 1. In File Explorer, navigate to the extracted `promtail-windows-amd64.exe` folder created as part of [Make Artefacts Available][]. -1. Copy the `promtail-windows-amd64.exe` file into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. Copy the `promtail-windows-amd64.exe` file into the folder that Promtail was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail`. 1. In File Explorer, navigate to the extracted `Promtail.Install` folder created as part of [Make Artefacts Available][]. -1. Copy the contents of this location into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. Copy the contents of this location into the folder that Promtail was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail`. 1. Open the new `promtail-local-config.yaml` in a text editor: * Update the *filename* property under *positions* to be the value found in the [backed up][] version. @@ -48,7 +48,7 @@ These steps will need to be performed on all application servers that host a Pro * Save the new `promtail-local-config.yaml` file. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where the Promtail files have been copied to, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Change the directory to the folder where the Promtail files have been copied to, e.g. `cd C:\ProgramData\Cortex\Observability\Promtail`. 1. Install Promtail by executing the following command: ``` powershell diff --git a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md index edd3cfed4..1fdf9be90 100644 --- a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md +++ b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md @@ -12,11 +12,11 @@ This guide describes how to install Grafana Alloy on the Application Server(s). ## Install Grafana Alloy 1. Download the [Grafana Alloy 1.10.0][] archive. -1. Extract content of the downloaded archive to a suitable location, e.g. `C:\Program Data\Cortex\Observability\Grafana Alloy`. +1. 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:\Program Data\Cortex\Observability\Grafana Alloy"`. +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. From 3a23a51bde2ef9b129da2a042090a7b0048e5a84 Mon Sep 17 00:00:00 2001 From: Cortex-DMS <104561178+Cortex-DMS@users.noreply.github.com> Date: Wed, 17 Sep 2025 12:33:55 +0100 Subject: [PATCH 10/14] Modified supported observability component versions for 2024.7 release (#235) Co-authored-by: Donna-Marie Smith --- content/en/blog/releases/2025.X/2025.7.md | 30 +++++++++++++++---- .../cloud/grafana/upgrade-promtail.md | 10 +++---- .../on-premise/grafana/upgrade-loki.md | 10 +++---- .../on-premise/grafana/upgrade-promtail.md | 10 +++---- content/en/docs/2025.7/Whats New/_index.md | 7 ++++- .../Grafana/install-alloy/install-alloy.md | 8 ++--- .../Grafana/prerequisites.md | 4 +-- .../Grafana/install-alloy/install-alloy.md | 8 ++--- .../install-grafana/install-grafana.md | 4 +-- .../Grafana/install-loki/install-loki.md | 8 ++--- .../Grafana/prerequisites.md | 10 +++---- data/urls.toml | 8 ++++- 12 files changed, 74 insertions(+), 43 deletions(-) diff --git a/content/en/blog/releases/2025.X/2025.7.md b/content/en/blog/releases/2025.X/2025.7.md index 11a293545..ca72f8242 100644 --- a/content/en/blog/releases/2025.X/2025.7.md +++ b/content/en/blog/releases/2025.X/2025.7.md @@ -39,7 +39,13 @@ The [Performance][] of the {{% ctx %}} Platform has been improved by: * [optimising stopping multiple running executions][Performance - Improved performance of stopping multiple running executions]. * [optimising the monitoring execution updates][Performance - Improved performance of monitoring execution updates]. -[Observability][] has been updated to use [Grafana Alloy instead of Promtail for ingesting logs to Grafana Loki][Observability - Migrated from Promtail to Grafana Alloy]. +[Observability][] has been updated to: + +* use [Grafana Alloy instead of Promtail for ingesting logs to Grafana Loki][Observability - Migrated from Promtail to Grafana Alloy]. +* update the following [components within the Observability platform][Observability Upgrades] to the latest versions: + + * Grafana - 12.1.1 + * Grafana Loki - 3.5.5 Finally, the [Documentation][] includes updates related to: @@ -229,10 +235,10 @@ Affected Components: ##### Migrated from Promtail to Grafana Alloy -`{{% ctx %}} Observability` has been updated to use [Grafana Alloy][] instead of [Promtail][] for ingesting logs to [Grafana Loki][]. This is due to [Promtail][] having been deprecated and marked as end-of-life on the 2nd of March 2026. +{{% ctx %}} Observability has been updated to use [Grafana Alloy][] instead of [Promtail][] for ingesting logs to [Grafana Loki][]. This is due to [Promtail][] having been deprecated and marked as end-of-life on the 2nd of March 2026. {{% alert title="Note" %}} -There is currently not documentation on how to migrate from `Promptail` to `Grafana Alloy`. This will be added in `2025.9`. +There is currently no documentation on how to migrate from `Promtail` to `Grafana Alloy`. This will be added in `2025.9`. In the meantime, for further assistance, please raise a case in the {{< ahref path="Cortex.ServicePortal.MainDoc" version="2025.7" title="{{% ctx %}} Service Portal" >}}. {{% /alert %}} @@ -240,6 +246,18 @@ Affected Components: * {{% ctx %}} Observability +##### Observability Upgrades + +Grafana and Grafana Loki have been updated to the latest versions, all related documentation and screenshots have been updated to reflect these changes. + +* Grafana - 12.1.1 +* Grafana Loki - 3.5.5 + +Affected Components: + +* Grafana +* Grafana Loki + #### Documentation ##### Added new User Guide @@ -337,7 +355,7 @@ Known limitations have been added within the 2025.7 release of the {{% ctx %}} P | Release | Grafana Version | Grafana Loki Version | {{% ctx %}} Observability Version | |---------|--------------------------|----------------------|-------------------------------------------| -| 2025.7 | [10.4.1][Grafana 10.4.1] | [3.0.0][Loki 3.0.0] | [4.0.0][Observability 4.0.0] | +| 2025.7 | [12.1.1][Grafana 12.1.1] | [3.5.5][Loki 3.5.5] | [4.0.0][Observability 4.0.0] | | 2025.3 | [10.4.1][Grafana 10.4.1] | [3.0.0][Loki 3.0.0] | [3.0.0][Observability 3.0.0] (deprecated) | | 2025.1 | [10.4.1][Grafana 10.4.1] | [3.0.0][Loki 3.0.0] | [3.0.0][Observability 3.0.0] (deprecated) | | 2024.11 | [10.4.1][Grafana 10.4.1] | [3.0.0][Loki 3.0.0] | [3.0.0][Observability 3.0.0] (deprecated) | @@ -419,7 +437,7 @@ Releases are currently forecast to be made available on: [Observability]: {{< ref "#observability" >}} [Observability - Migrated from Promtail to Grafana Alloy]: {{< ref "#migrated-from-promtail-to-grafana-alloy" >}} - +[Observability Upgrades]: {{< ref "#observability-upgrades" >}} [Documentation]: {{< ref "#documentation" >}} [Documentation - Added new User Guide]: {{< ref "#added-new-user-guide" >}} [Documentation - Added new Tutorial]: {{< ref "#added-new-tutorial" >}} @@ -456,7 +474,9 @@ Releases are currently forecast to be made available on: [Grafana Loki]: {{< url path="Grafana.Products.Loki.MainDoc" >}} [Grafana 8.5.4]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.Windows" >}} [Grafana 10.4.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.10.4.1.Windows" >}} +[Grafana 12.1.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.12.1.1.Windows" >}} [Loki 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3.0.0.Release" >}} +[Loki 3.5.5]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3.5.5.Release" >}} [Loki 2.5.0]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.Release" >}} [Observability 4.0.0]: {{< url path="GitHub.Cortex.Observability.4.0.0.Release" >}} [Observability 3.0.0]: {{< url path="GitHub.Cortex.Observability.3.0.0.Release" >}} diff --git a/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/cloud/grafana/upgrade-promtail.md b/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/cloud/grafana/upgrade-promtail.md index 5134badd9..a62dfb057 100644 --- a/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/cloud/grafana/upgrade-promtail.md +++ b/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/cloud/grafana/upgrade-promtail.md @@ -17,7 +17,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Log in to the application server. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\ProgramData\Cortex\Observability\Promtail`. 1. Remove the current Promtail installation by executing the following command: ``` powershell @@ -26,7 +26,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Click *Yes* when prompted for confirmation that you wish to remove the service. 1. Click *OK* when the successful removal of the Promtail service is confirmed. -1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\Program Data\Cortex\Observability\Promtail` +1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail` 1. Delete the following files from the directory: * Install-Promtail.ps1 @@ -38,9 +38,9 @@ These steps will need to be performed on all application servers that host a Pro * Stop-Promtail.ps1 1. In File Explorer, navigate to the extracted `promtail-windows-amd64.exe` folder created as part of [Make Artefacts Available][]. -1. Copy the `promtail-windows-amd64.exe` file into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. Copy the `promtail-windows-amd64.exe` file into the folder that Promtail was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail`. 1. In File Explorer, navigate to the extracted `Promtail.Install` folder created as part of [Make Artefacts Available][]. -1. Copy the contents of this location into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. Copy the contents of this location into the folder that Promtail was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail`. 1. Open `promtail-local-config.yaml` in a text editor: * Update the *filename* property under *positions* to be the value found in the [backed up][] version. @@ -48,7 +48,7 @@ These steps will need to be performed on all application servers that host a Pro * Save the new `promtail-local-config.yaml` file. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where the Promtail files have been copied to, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Change the directory to the folder where the Promtail files have been copied to, e.g. `cd C:\ProgramData\Cortex\Observability\Promtail`. 1. Install Promtail by executing the following command: ``` powershell diff --git a/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-loki.md b/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-loki.md index 2596b9b69..42b6a7187 100644 --- a/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-loki.md +++ b/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-loki.md @@ -13,7 +13,7 @@ This guide describes how to upgrade the Loki installation. Please ensure that th 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:\Program Data\Cortex\Observability\Loki`. +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 @@ -22,7 +22,7 @@ This guide describes how to upgrade the Loki installation. Please ensure that th 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:\Program Data\Cortex\Observability\Loki`. +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 files from the directory: * Install-Loki.ps1 @@ -34,9 +34,9 @@ This guide describes how to upgrade the Loki installation. Please ensure that th * Stop-Loki.ps1 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:\Program Data\Cortex\Observability\Loki`. +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. In File Explorer, navigate to the extracted `Grafana.Loki.Install` folder created as part of [Make Artefacts Available][]. -1. Copy the contents of this location into the folder that Loki was previously running from, e.g. `C:\Program Data\Cortex\Observability\Loki`. +1. Copy the contents of this location into the folder that Loki was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Loki`. 1. Open the new `loki-local-config.yaml` file in a text editor and compare against the [backed up][] version. If there are differences between the two files in the *schema_config* > *configs* section: 1. In the new file, change the date next to `- from` to be today's date. @@ -66,7 +66,7 @@ This guide describes how to upgrade the Loki installation. Please ensure that th 1. Save the new `loki-local-config.yaml` file. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where the Loki files have been copied to, e.g. `cd C:\Program Data\Cortex\Observability\Loki`. +1. Change the directory to the folder where the Loki files have been copied to, e.g. `cd C:\ProgramData\Cortex\Observability\Loki`. 1. Install Loki by executing the following command: ``` powershell diff --git a/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-promtail.md b/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-promtail.md index 014a7b960..78f25e918 100644 --- a/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-promtail.md +++ b/content/en/docs/2025.7/Guides/upgrade-guides/upgrade-observability/on-premise/grafana/upgrade-promtail.md @@ -17,7 +17,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Log in to the application server. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\ProgramData\Cortex\Observability\Promtail`. 1. Remove the current Promtail installation by executing the following command: ``` powershell @@ -26,7 +26,7 @@ These steps will need to be performed on all application servers that host a Pro 1. Click *Yes* when prompted for confirmation that you wish to remove the service. 1. Click *OK* when the successful removal of the Promtail service is confirmed. -1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\Program Data\Cortex\Observability\Promtail` +1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail` 1. Delete the following files from the directory: * Install-Promtail.ps1 @@ -38,9 +38,9 @@ These steps will need to be performed on all application servers that host a Pro * Stop-Promtail.ps1 1. In File Explorer, navigate to the extracted `promtail-windows-amd64.exe` folder created as part of [Make Artefacts Available][]. -1. Copy the `promtail-windows-amd64.exe` file into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. Copy the `promtail-windows-amd64.exe` file into the folder that Promtail was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail`. 1. In File Explorer, navigate to the extracted `Promtail.Install` folder created as part of [Make Artefacts Available][]. -1. Copy the contents of this location into the folder that Promtail was previously running from, e.g. `C:\Program Data\Cortex\Observability\Promtail`. +1. Copy the contents of this location into the folder that Promtail was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail`. 1. Open the new `promtail-local-config.yaml` in a text editor: * Update the *filename* property under *positions* to be the value found in the [backed up][] version. @@ -48,7 +48,7 @@ These steps will need to be performed on all application servers that host a Pro * Save the new `promtail-local-config.yaml` file. 1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where the Promtail files have been copied to, e.g. `cd C:\Program Data\Cortex\Observability\Promtail`. +1. Change the directory to the folder where the Promtail files have been copied to, e.g. `cd C:\ProgramData\Cortex\Observability\Promtail`. 1. Install Promtail by executing the following command: ``` powershell diff --git a/content/en/docs/2025.7/Whats New/_index.md b/content/en/docs/2025.7/Whats New/_index.md index 3f8ea5876..d25eb4968 100644 --- a/content/en/docs/2025.7/Whats New/_index.md +++ b/content/en/docs/2025.7/Whats New/_index.md @@ -35,7 +35,11 @@ The performance of the {{% ctx %}} Platform has been improved by: ## Improved Observability -Observability has been updated to use [Grafana Alloy instead of Promtail for ingesting logs to Grafana Loki][Observability - Migrated from Promtail to Grafana Alloy]. +* Observability has been updated to use [Grafana Alloy instead of Promtail for ingesting logs to Grafana Loki][Observability - Migrated from Promtail to Grafana Alloy]. + +* The following [components within the Observability platform have been updated][Observability Upgrades] to the latest major versions: + * Grafana - 12.1.1 + * Grafana Loki - 3.5.5 ## Improved Documentation @@ -66,6 +70,7 @@ For a full list of what has been introduced in this release, please see the [202 [Performance - Improved performance of stopping multiple running executions]: {{< url path="Cortex.Blogs.Releases.2025.7.ImprovedPerformanceOfStoppingMultipleRunningExecutions" version="2025.7" >}} [Performance - Improved performance of monitoring execution updates]: {{< url path="Cortex.Blogs.Releases.2025.7.ImprovedPerformanceOfMonitoringExecutionUpdates" version="2025.7" >}} [Observability - Migrated from Promtail to Grafana Alloy]: {{< url path="Cortex.Blogs.Releases.2025.7.MigratedFromPromtailToGrafanaAlloy" version="2025.7" >}} +[Observability Upgrades]: {{< url path="Cortex.Blogs.Releases.2025.7.ObservabilityUpgrades" version="2025.7" >}} [Documentation - Added new User Guide]: {{< url path="Cortex.Blogs.Releases.2025.7.AddedNewUserGuide" version="2025.7" >}} [Documentation - Added new Tutorial]: {{< url path="Cortex.Blogs.Releases.2025.7.AddedNewTutorial" version="2025.7" >}} [Documentation - Updated documentation to point to Flow Editor User Guide]: {{< url path="Cortex.Blogs.Releases.2025.7.UpdatedDocumentationToPointToFlowEditorUserGuide" version="2025.7" >}} diff --git a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md index edd3cfed4..d87578dd9 100644 --- a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md +++ b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md @@ -11,12 +11,12 @@ This guide describes how to install Grafana Alloy on the Application Server(s). ## Install Grafana Alloy -1. Download the [Grafana Alloy 1.10.0][] archive. -1. Extract content of the downloaded archive to a suitable location, e.g. `C:\Program Data\Cortex\Observability\Grafana Alloy`. +1. Download the [Grafana Alloy 1.10.2][] 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:\Program Data\Cortex\Observability\Grafana Alloy"`. +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. @@ -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.0]: {{< url path="Grafana.Products.Loki.Alloy.1.10.0" >}} +[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1.10.2" >}} [Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.4.0.0.GrafanaAlloyInstallZip" >}} [Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}} diff --git a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/prerequisites.md b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/prerequisites.md index d6cc2bb0e..2641c225a 100644 --- a/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/prerequisites.md +++ b/content/en/docs/2025.7/getting-started/cloud/add-observability-to-innovation/Grafana/prerequisites.md @@ -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.0][] | +| Application Server | [2022 (x64)][] *Recommended*
[2019 (x64)][] | [Grafana Alloy 1.10.2][] | [^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.0]: {{< url path="Grafana.Products.Loki.Alloy.1.10.0" >}} +[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1.10.2" >}} [Set up Grafana]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupGrafana.MainDoc" >}} diff --git a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md index d81d8bfe1..239dadeed 100644 --- a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md +++ b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-alloy/install-alloy.md @@ -11,12 +11,12 @@ This guide describes how to install Grafana Alloy on the Application Server(s). ## Install Grafana Alloy -1. Download the [Grafana Alloy 1.10.0][] archive. -1. Extract content of the downloaded archive to a suitable location, e.g. `C:\Program Data\Cortex\Observability\Grafana Alloy`. +1. Download the [Grafana Alloy 1.10.2][] 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:\Program Data\Cortex\Observability\Grafana Alloy"`. +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] @@ -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.0]: {{< url path="Grafana.Products.Loki.Alloy.1.10.0" >}} +[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1.10.2" >}} [Grafana Alloy.zip]: {{< url path="GitHub.Cortex.Observability.4.0.0.GrafanaAlloyInstallZip" >}} [Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}} [Reverse Proxy Authentication]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.ConfigureAuthentication" >}} diff --git a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-grafana/install-grafana.md b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-grafana/install-grafana.md index ab29b8dac..0a939bf44 100644 --- a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-grafana/install-grafana.md +++ b/content/en/docs/2025.7/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 12.1.1][] Windows installer. 1. Run the installer and install Grafana to a suitable location. ## Next Steps? @@ -19,6 +19,6 @@ 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 12.1.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.12.1.1.Windows" >}} [Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}} [Software Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.SoftwareRequirements" >}} diff --git a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md index 8fdc0ac57..9af9a08e0 100644 --- a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md +++ b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/install-loki/install-loki.md @@ -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.5.5][] 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,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.0.0]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3.0.0.GrafanaLokiInstallZip" >}} +[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.0.0.GrafanaLokiInstallZip" >}} [NSSM]: {{< url path="NSSM.MainDoc" >}} [Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}} diff --git a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md index b3b768492..b008a4de8 100644 --- a/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md +++ b/content/en/docs/2025.7/getting-started/on-premise/add-observability-to-innovation/Grafana/prerequisites.md @@ -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 10.4.1][] *Enterprise Edition*
[Grafana Loki 3.0.0][]| -| Application Server | [2022 (x64)][] *Recommended*
[2019 (x64)][] | | [Grafana Alloy 1.10.0][]| +| 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][]| [^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. @@ -161,9 +161,9 @@ Grafana Alloy requires a domain user that is not a member of the Local Administr [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 Alloy 1.10.0]: {{< url path="Grafana.Products.Loki.Alloy.1.10.0" >}} -[Grafana Loki 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3.0.0.GrafanaLokiInstallZip" >}} +[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" >}} [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/data/urls.toml b/data/urls.toml index 3461c5823..19d54d93a 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -62,6 +62,7 @@ ImprovedPerformanceOfStoppingMultipleRunningExecutions = "/blog/2025/08/26/2025.7/#improved-performance-of-stopping-multiple-running-executions" ImprovedPerformanceOfMonitoringExecutionUpdates = "/blog/2025/08/26/2025.7/#improved-performance-of-monitoring-execution-updates" MigratedFromPromtailToGrafanaAlloy = "/blog/2025/08/26/2025.7/#migrated-from-promtail-to-grafana-alloy" + ObservabilityUpgrades = "/blog/2025/08/26/2025.7/#observability-upgrades" AddedNewUserGuide = "/blog/2025/08/26/2025.7/#added-new-user-guide" AddedNewTutorial = "/blog/2025/08/26/2025.7/#added-new-tutorial" UpdatedDocumentationToPointToFlowEditorUserGuide = "/blog/2025/08/26/2025.7/#updated-documentation-to-point-to-flow-editor-user-guide" @@ -3151,19 +3152,24 @@ MainDoc = "https://grafana.com/docs/loki/latest/clients/promtail/" [Grafana.Products.Loki.Alloy] MainDoc = "https://grafana.com/docs/loki/latest/send-data/alloy/" - 1.10.0 = "https://github.com/grafana/alloy/releases/download/v1.10.0/alloy-installer-windows-amd64.exe.zip" + 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.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.GrafanaLoki] Release = "https://github.com/grafana/loki/releases/tag/v2.5.0" GrafanaLokiInstallZip = "https://github.com/grafana/loki/releases/download/v2.5.0/loki-windows-amd64.exe.zip" [Grafana.SelfManaged.Downloads.GrafanaLoki.3.0.0] Release = "https://github.com/grafana/loki/releases/tag/v3.0.0" GrafanaLokiInstallZip = "https://github.com/grafana/loki/releases/download/v3.0.0/loki-windows-amd64.exe.zip" + [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.Promtail] PromtailInstallZip = "https://github.com/grafana/loki/releases/download/v2.5.0/promtail-windows-amd64.exe.zip" [Grafana.SelfManaged.Downloads.Promtail.3.0.0] From 88aca621770e5c0f2226a9a87691ea2098da3fce Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Wed, 17 Sep 2025 16:13:00 +0100 Subject: [PATCH 11/14] Updated migration Process --- .../cloud/grafana/migrate-to-alloy.md | 59 +++++++++++++++ .../cloud/grafana/prerequisites.md | 16 ++-- .../cloud/grafana/upgrade-promtail.md | 75 ------------------- .../on-premise/grafana/migrate-to-alloy.md | 9 ++- .../on-premise/grafana/upgrade-loki.md | 2 +- data/urls.toml | 1 + 6 files changed, 76 insertions(+), 86 deletions(-) create mode 100644 content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/migrate-to-alloy.md delete mode 100644 content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/upgrade-promtail.md diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/migrate-to-alloy.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/migrate-to-alloy.md new file mode 100644 index 000000000..065d0f28d --- /dev/null +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/migrate-to-alloy.md @@ -0,0 +1,59 @@ +--- +title: "Migrate to Grafana Alloy" +linkTitle: "Migrate to Grafana Alloy" +description: "The steps to Migrate Promtail to Grafana Alloy." +weight: 2 +--- + +# {{% param title %}} + +This guide describes how to migrate from a Promtail Installation to Grafana Alloy. + +## Perform Migration + +{{% alert title="Note" %}} +These steps will need to be performed on all application servers that host a Promtail service. +{{% / alert %}} + +1. Log in to the application server. +1. Run Windows PowerShell as Administrator. +1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\ProgramData\Cortex\Observability\Promtail`. +1. Remove the current Promtail installation by executing the following command: + + ``` powershell + .\Remove-Promtail.ps1 + ``` + +1. Click *Yes* when prompted for confirmation that you wish to remove the service. +1. Click *OK* when the successful removal of the Promtail service is confirmed. +1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail` +1. In File Explorer, 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 a suitable location, e.g. `C:\ProgramData\Cortex\Observability\Grafana Alloy`. +1. In File Explorer, navigate to the extracted Grafana.Alloy.Install folder created as part of [Make Artefacts Available][]. +1. Copy the contents of the folder to the same location as the previously copied alloy-installer-windows-amd64.exe. +1. In Powershell change the location to the folder that the artefacts have been copied to, e.g. `cd C:\ProgramData\Cortex\Observability\Grafana Alloy`. +1. Install Grafana Alloy by executing the following command and passing in the correct path for the `promtail-local-config.yaml`: + + ``` powershell + .\Migrate-Promtail-To-Alloy.ps1 -PromtailConfig "C:\ProgramData\Cortex\Observability\Promtail\promtail-local-config.yaml" + ``` + +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. +1. Once the migration has completed, delete the now obsolete Promtail directory e.g. `C:\ProgramData\Cortex\Observability\Promtail`. + +## 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. 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. +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. [Try it out][] + +[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.Cloud.Grafana.MakeArtefactsAvailable" >}} +[Try it out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.Cloud.Grafana.TryItOut" >}} 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 c8ba1665d..cd18fb9db 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 @@ -21,11 +21,11 @@ weight: 1 1. Download the required artefacts to a folder on your machine: - * [Promtail 3.0.0][] archive. - * [Promtail Install][] archive. + * [Grafana Alloy 1.10.2][] archive. + * [Grafana Alloy Install][] archive. -1. Extract the downloaded `promtail-windows-amd64.exe` archive to a folder with the same name. -1. Extract the downloaded `Promtail.Install` archive to a folder with the same name. +1. Extract the downloaded `alloy-installer-windows-amd64.exe` archive to a folder with the same name. +1. Extract the downloaded `Grafana.Alloy.Install` archive to a folder with the same name. ## Backup Old Files @@ -37,8 +37,8 @@ On each Application Server that Promtail is installed on: ## Next Steps? -1. [Upgrade Promtail][] +1. [Migrate Promtail to Grafana Alloy][Migrate to Alloy] -[Promtail 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.3.0.0.PromtailInstallZip" >}} -[Promtail Install]: {{< url path="GitHub.Cortex.Observability.3.0.0.PromtailInstallZip" >}} -[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.UpgradePromtail" >}} +[Grafana Alloy 1.10.2]: {{< url path="Grafana.Products.Loki.Alloy.1.10.2" >}} +[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/cloud/grafana/upgrade-promtail.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/upgrade-promtail.md deleted file mode 100644 index 07cc0476a..000000000 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/upgrade-promtail.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "Upgrade Promtail" -linkTitle: "Upgrade Promtail" -description: "The steps to upgrade Promtail." -weight: 2 ---- - -# {{% param title %}} - -This guide describes how to upgrade the Promtail installation. Please ensure that the [Prerequisites] for upgrading Observability have been completed before starting this upgrade. - -## Perform Upgrade - -{{% alert title="Note" %}} -These steps will need to be performed on all application servers that host a Promtail service. -{{% / alert %}} - -1. Log in to the application server. -1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where Promtail is running from, e.g. `cd C:\ProgramData\Cortex\Observability\Promtail`. -1. Remove the current Promtail installation by executing the following command: - - ``` powershell - .\Remove-Promtail.ps1 - ``` - -1. Click *Yes* when prompted for confirmation that you wish to remove the service. -1. Click *OK* when the successful removal of the Promtail service is confirmed. -1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail` -1. Delete the following files from the directory: - - * Install-Promtail.ps1 - * nssm.exe - * Promtail-local-config.yaml - * Promtail-windows-amd64.exe - * Remove-Promtail.ps1 - * Start-Promtail.ps1 - * Stop-Promtail.ps1 - -1. In File Explorer, navigate to the extracted `promtail-windows-amd64.exe` folder created as part of [Make Artefacts Available][]. -1. Copy the `promtail-windows-amd64.exe` file into the folder that Promtail was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail`. -1. In File Explorer, navigate to the extracted `Promtail.Install` folder created as part of [Make Artefacts Available][]. -1. Copy the contents of this location into the folder that Promtail was previously running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail`. -1. Open `promtail-local-config.yaml` in a text editor: - - * Update the *filename* property under *positions* to be the value found in the [backed up][] version. - * Update the *url* property under *clients* to be the value found in the [backed up][] version. - * Save the new `promtail-local-config.yaml` file. - -1. Run Windows PowerShell as Administrator. -1. Change the directory to the folder where the Promtail files have been copied to, e.g. `cd C:\ProgramData\Cortex\Observability\Promtail`. -1. Install Promtail by executing the following command: - - ``` powershell - .\Install-Promtail.ps1 - ``` - -1. Start the Promtail service by executing the following command: - - ``` powershell - .\Start-Promtail.ps1 - ``` - -1. Check that the Promtail service has installed and started correctly: - * Open Services.msc from the Start menu. - * Locate the *Promtail* service and confirm that it is *Running*. - -## Next Steps? - -1. [Try it out][] - -[backed up]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.BackupOldFiles" >}} -[Make Artefacts Available]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.MakeArtefactsAvailable" >}} -[Prerequisites]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.Prerequisites" >}} -[Try it out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.TryItOut" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md index 68434da9f..eb8156f35 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/migrate-to-alloy.md @@ -36,15 +36,20 @@ These steps will need to be performed on all application servers that host a Pro 1. Click *Yes* when prompted for confirmation that you wish to remove the service. 1. Click *OK* when the successful removal of the Promtail service is confirmed. 1. Open a File Explorer and navigate to the folder where Promtail was running from, e.g. `C:\ProgramData\Cortex\Observability\Promtail` -1. Delete the Promtail directory 1. In File Explorer, 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 a suitable location, e.g. `C:\ProgramData\Cortex\Observability\Grafana Alloy`. 1. In File Explorer, navigate to the extracted Grafana.Alloy.Install folder created as part of [Make Artefacts Available][]. 1. Copy the contents of the folder to the same location as the previously copied alloy-installer-windows-amd64.exe. 1. In Powershell change the location to the folder that the artefacts have been copied to, e.g. `cd C:\ProgramData\Cortex\Observability\Grafana Alloy`. -1. Execute the `.\Migrate-Promtail-To-Alloy.ps1` command to install the downloaded `alloy-installer-windows-amd64.exe` as a service. +1. Install Grafana Alloy by executing the following command and passing in the correct path for the `promtail-local-config.yaml`: + + ``` powershell + .\Migrate-Promtail-To-Alloy.ps1 -PromtailConfig "C:\ProgramData\Cortex\Observability\Promtail\promtail-local-config.yaml" + ``` + 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] +1. Once the migration has completed, delete the now obsolete Promtail directory e.g. `C:\ProgramData\Cortex\Observability\Promtail`. ## Next Steps? diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki.md index 9c3730022..aecfcc048 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/upgrade-loki.md @@ -82,7 +82,7 @@ This guide describes how to upgrade the Loki installation. Please ensure that th * 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. + * *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 [Migrating Promtail to Grafana Alloy][Migrate to Alloy]. * *Ignore case* should be unchecked. diff --git a/data/urls.toml b/data/urls.toml index c5192784f..0a955f718 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -1092,6 +1092,7 @@ [Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.Cloud.Grafana] BackupOldFiles = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/prerequisites/#backup-old-files" MakeArtefactsAvailable = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/prerequisites/#make-artefacts-available" + MigrateToAlloy = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/migrate-to-alloy" Prerequisites = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/prerequisites" TryItOut = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/try-it-out" UpgradePromtail = "/docs/guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/upgrade-promtail" From cd1e4500d31f41ce99c9cad9411d1159f4ffc370 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Thu, 18 Sep 2025 10:27:50 +0100 Subject: [PATCH 12/14] Updated Try It Out for Upgrade of Observability --- .../cloud/grafana/prerequisites.md | 10 ------ .../cloud/grafana/try-it-out.md | 35 ++++++++++--------- .../on-premise/grafana/try-it-out.md | 21 ++++++++--- 3 files changed, 36 insertions(+), 30 deletions(-) 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 cd18fb9db..88afc5c11 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 @@ -7,16 +7,6 @@ weight: 1 # {{% param title %}} -## Verify Old Version - -1. Navigate to your Grafana website e.g. `https://{Team URL}.grafana.net` -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: diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/try-it-out.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/try-it-out.md index c60645e18..4e81ae50b 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/try-it-out.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/try-it-out.md @@ -7,27 +7,27 @@ weight: 3 # {{% param title %}} -This guide describes how to verify that the upgrade has been successful. Please ensure that [Upgrade Promtail][] has been completed before taking these steps. - -## Confirm Dashboards Load - -1. Navigate to your Grafana website e.g. `https://{Team URL}.grafana.net` -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][]. +This guide describes how to verify that the upgrade has been successful. Please ensure that [Migration to Grafana Alloy][Migrate To Alloy] has been completed before taking these steps. ## Confirm New Data is Processed {{% alert title="Note" %}} -Any flow can be used that exists on the system and can be executed. +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 a web browser and navigate to your installed {{% ctx %}} Gateway URL, e.g. `https://server.domain.com/gateway`, and log in when prompted. -1. Open a flow that you are able to execute on an ad hoc basis. -1. Start the flow. +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. @@ -44,5 +44,8 @@ If other requests have been made then there may be more than one request visible If other requests have been made then there may be more than one request visible on the dashboard. {{% / alert %}} -[Upgrade Promtail]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.UpgradePromtail" >}} +[Postman]: {{< url path="Postman.Downloads.MainDoc" >}} +[HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" >}} +[Migrate To Alloy]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.Cloud.Grafana.MigrateToAlloy" >}} +[Non-HA Installation script configuration]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureInstallationScriptNew" >}} [verifying the old version]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.2.2.0to3.0.0.Cloud.Grafana.VerifyOldVersion" >}} diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/try-it-out.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/try-it-out.md index b3d27c5d6..1ad31fbbe 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/try-it-out.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/try-it-out.md @@ -28,12 +28,22 @@ This guide describes how to verify that the upgrade has been successful. Please ## Confirm New Data is Processed {{% alert title="Note" %}} -Any flow can be used that exists on the system and can be executed. +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 a web browser and navigate to your installed {{% ctx %}} Gateway URL, e.g. `https://server.domain.com/gateway`, and log in when prompted. -1. Open a flow that you are able to execute on an ad hoc basis. -1. Start the flow. +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. @@ -50,5 +60,8 @@ If other requests have been made then there may be more than one request visible 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" >}} [Migrate To Alloy]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeObservability.3.0.0to4.0.0.OnPremise.Grafana.MigrateToAlloy" >}} +[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.3.0.0to4.0.0.OnPremise.Grafana.VerifyOldVersion" >}} From 44b693f36deb23eeb810ce503377f4564dfdbbd7 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Thu, 18 Sep 2025 10:32:55 +0100 Subject: [PATCH 13/14] fixed rogue characters in example URLs --- .../3.0.0-to-4.0.0/cloud/grafana/try-it-out.md | 2 +- .../3.0.0-to-4.0.0/on-premise/grafana/try-it-out.md | 2 +- .../cloud/add-observability-to-innovation/Grafana/try-it-out.md | 2 +- .../add-observability-to-innovation/Grafana/try-it-out.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/try-it-out.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/try-it-out.md index 4e81ae50b..fa7c7548f 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/try-it-out.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/cloud/grafana/try-it-out.md @@ -19,7 +19,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 | diff --git a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/try-it-out.md b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/try-it-out.md index 1ad31fbbe..6d2dbd07b 100644 --- a/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/try-it-out.md +++ b/content/en/docs/2025.9/Guides/upgrade-guides/upgrade-observability/3.0.0-to-4.0.0/on-premise/grafana/try-it-out.md @@ -35,7 +35,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 | 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 4feecd4a5..64115dc9a 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 @@ -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 | 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 260ea6fa0..019415dfc 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 @@ -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 | From fae943b59871b594f84d178eab7d098e935c2c37 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Mon, 22 Sep 2025 10:49:32 +0100 Subject: [PATCH 14/14] added services user requirements to pre-reqs for upgrade --- .../3.0.0-to-4.0.0/cloud/grafana/prerequisites.md | 6 ++++++ .../3.0.0-to-4.0.0/on-premise/grafana/prerequisites.md | 6 ++++++ 2 files changed, 12 insertions(+) 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 88afc5c11..6725f4ca8 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 @@ -17,6 +17,12 @@ weight: 1 1. Extract the downloaded `alloy-installer-windows-amd64.exe` archive to a folder with the same name. 1. Extract the downloaded `Grafana.Alloy.Install` archive to a folder with the same name. +## Security Requirements + +### 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. + ## Backup Old Files On each Application Server that Promtail is installed on: 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 abcda2076..e17e4a3ea 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 @@ -45,6 +45,12 @@ weight: 1 1. Extract the downloaded `Grafana.Alloy.Install` archive to a folder with the same name. 1. Extract the downloaded `loki-windows-amd64.exe` archive to a folder with the same name. +## Security Requirements + +### 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. + ## Backup Old Files 1. On the server that Grafana and Loki is installed on, create a folder called `Observability Backups` in a known location.