Skip to content

Commit

Permalink
Modified Observability instructions to reflect upgraded components (#128
Browse files Browse the repository at this point in the history
)

* Modified Observability instructions to reflect upgraded components
  • Loading branch information
Cortex-DMS authored Apr 11, 2024
1 parent 8652586 commit 752218d
Show file tree
Hide file tree
Showing 24 changed files with 63 additions and 58 deletions.
2 changes: 1 addition & 1 deletion content/en/docs/2024.3/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
title: "2024.3"
linkTitle: "2024.3"
description: "Product documentation for the {{% ctx %}} automation platform, including guides, tutorials and reference documentation."
weight: 994
weight: 993
---
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ This section explains how to change the colour coding of thresholds set for the

1. Log in to your configured Grafana with a user that has the *Admin* role.
1. To open a dashboard:
1. Click the Dashboards icon {{< image src="/images/DashboardsIcon.png" title="Dashboards Icon" >}} in the side menu, and then click *Browse*.
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 name of the dashboard you wish to modify to open it.
1. Open the panel you wish to configure in edit mode:
1. Click the title of the panel to display a drop-down menu.
1. Click *Edit*.
1. On the Edit Panel page, on the right-hand side, scroll down through the list of options until you reach the Thresholds section.
1. On the *Edit Panel* page, on the right-hand side, scroll down through the list of options until you reach the *Thresholds* section.
1. You can change the value configured for the colours defined if the thresholds should be different to the default set for that panel.
1. You can change the colours defined for the thresholds to be different to the default set for that panel.
1. You can add additional threshold levels by clicking *+ add threshold* and configuring the colours and numbers appropriately. E.g. on the [Total Requests Errored][] panel on the [Flow Execution Requests][] dashboard, you may wish to add a warning threshold level to be >= 1 errors and change the critical threshold to be >= 10. For this you should add a threshold and set the colour to your preferred colour, set the value to 1 and change the value for red to be 10.
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/2024.5/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "2024.3"
linkTitle: "2024.3"
title: "2024.5"
linkTitle: "2024.5"
description: "Product documentation for the {{% ctx %}} automation platform, including guides, tutorials and reference documentation."
weight: 994
weight: 992
---
2 changes: 1 addition & 1 deletion content/en/docs/2024.5/_shared/currentVersion.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2024.3
2024.5
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Please ensure that the set up for [Grafana][] and [Loki][] have been completed b

1. Log in to Grafana Cloud with a user that has the *Admin* role.
1. Click the Menu icon {{< image src="/images/GrafanaMenuIcon.png" title="Menu icon" >}} to view the available options.
1. Click the Dashboards menu item {{< image src="/images/Grafana Cloud - Dashboards Link.png" title="Dashboards menu item" >}}.
1. Click the Dashboards menu item.
1. Click the *New* dropdown and select *New folder*.
1. Enter a folder name, e.g. `Cortex`.
1. Click *Create*.
Expand All @@ -29,13 +29,13 @@ Please ensure that the set up for [Grafana][] and [Loki][] have been completed b

1. Log in to Grafana Cloud with a user that has the *Admin* role.
1. Click the Menu icon {{< image src="/images/GrafanaMenuIcon.png" title="Menu icon" >}} to view the available options.
1. Click the Dashboards menu item {{< image src="/images/Grafana Cloud - Dashboards Link.png" title="Dashboards menu item" >}}.
1. Click the Dashboards menu item.
1. Click the *New* dropdown and select *Import*.
1. Click on *Upload dashboard JSON file*.
1. Locate the `Flow Execution Requests.json` file extracted from the downloaded `Grafana.Dashboards.zip`.
1. Select the file and click *Open*.
1. Select the folder in Grafana you wish the dashboard to be saved in, e.g. *Cortex*.
1. Select your [configured] Loki data source from the dropdown menu, e.g. *grafanacloud-cortexinnovation-logs*.
1. Select your [configured Loki data source][] from the dropdown menu, e.g. *grafanacloud-cortexinnovation-logs*.
1. Click *Import*.
1. Repeat steps 2 - 10 for the `Platform Health.json` file.

Expand All @@ -48,13 +48,13 @@ To do this, follow these steps for all default {{% ctx %}} Innovation dashboards
1. Log in to Grafana Cloud with a user that has the *Admin* role.
1. To open a dashboard:
1. Click the Menu icon {{< image src="/images/GrafanaMenuIcon.png" title="Menu icon" >}} to view the available options.
1. Click the Dashboards menu item {{< image src="/images/Grafana Cloud - Dashboards Link.png" title="Dashboards menu item" >}}.
1. Click the Dashboards menu item.
1. Click the folder name that the dashboards were imported to.
1. Click the first dashboard to open.
1. Open the Dashboard Settings menu via the cog icon next to the time range filter on the dashboard.
1. Click *Variables* on the left-hand side of the page.
1. Click *Custom Filter* in the *Variables* list.
1. Select your [configured] Loki data source in the *Adhoc Options* > *Data source* drop-down menu, e.g. *grafanacloud-cortexinnovation-logs*.
1. Open the *Dashboard settings* menu via the cog icon in the top right-hand side of the dashboard.
1. Click *Variables* from the top menu of the *Settings* page.
1. Click *CustomFilter* in the *Variables* list.
1. Select your [configured Loki data source][] in the *Adhoc Options* > *Data source* drop-down menu, e.g. *grafanacloud-cortexinnovation-logs*.
1. Click *Apply*.
1. Click the dashboard name in the breadcrumb at the top left corner of the page to go back to the dashboard.
1. Click the + icon next to the Custom Filter to confirm that a list of available filter options is visible. If Grafana Loki has not received any logs from Promtail there will be no options available for selection.
Expand All @@ -64,8 +64,8 @@ To do this, follow these steps for all default {{% ctx %}} Innovation dashboards

1. [Try it Out][]

[configured]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupLoki.MainDoc" >}}
[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.2.2.0.GrafanaDashboardsZip" >}}
[configured Loki data source]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupLoki.MainDoc" >}}
[Grafana]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupGrafana.MainDoc" >}}
[Grafana.Dashboards.zip]: {{< url path="GitHub.Cortex.Observability.2.2.0.GrafanaDashboardsZip" >}}
[Loki]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupLoki.MainDoc" >}}
[Try it Out]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.TryItOut.MainDoc" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This guide describes how to install Promtail on the Application Server(s). Pleas

## Install Promtail

1. Download [Promtail 2.5.0][] archive.
1. Download [Promtail 3.0.0][] archive.
1. Extract content of the downloaded archive to a suitable location, e.g. `C:\Promtail`.
1. Download the [Promtail Install.zip][] archive and extract its contents alongside the previously extracted Promtail `promtail-windows-amd64.exe`.
This archive contains the `promtail-local-config.yaml` configuration file, [NSSM][] (the Non-Sucking Service Manager program) and PowerShell scripts to help manage Promtail as a Windows service.
Expand All @@ -26,5 +26,5 @@ This archive contains the `promtail-local-config.yaml` configuration file, [NSSM
[Configure Promtail]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.InstallPromtail.ConfigurePromtail.MainDoc" >}}
[NSSM]: {{< url path="NSSM.MainDoc" >}}
[Prerequisites]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.Prerequisites.MainDoc" >}}
[Promtail 2.5.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.PromtailInstallZip" >}}
[Promtail 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.3.0.0.PromtailInstallZip" >}}
[Promtail Install.zip]: {{< url path="GitHub.Cortex.Observability.2.2.0.PromtailInstallZip" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -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*<br>[2019 (x64)][] | [Promtail 2.5.0][] |
| Application Server | [2022 (x64)][] *Recommended*<br>[2019 (x64)][] | [Promtail 3.0.0][] |

[^1]: Windows Server Standard and Datacenter editions are supported. Filesystem **must be NTFS** and networking **must use IPv4**. Linux is not supported, but may be in the future.

Expand Down Expand Up @@ -55,5 +55,5 @@ A domain user which is a member of the Local Administrators group on all Applica
[2019 (x64)]: {{< url path="Microsoft.Downloads.Windows.Server2019" >}}
[2022 (x64)]: {{< url path="Microsoft.Downloads.Windows.Server2022" >}}
[Architecture]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.Architecture.MainDoc" >}}
[Promtail 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.3.0.0.PromtailInstallZip" >}}
[Set up Grafana]: {{< url path="Cortex.GettingStarted.Cloud.AddObservabilityToInnovation.Grafana.SetupGrafana.MainDoc" >}}
[Promtail 2.5.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.PromtailInstallZip" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ weight: 30

1. Browse to [Grafana Labs][].
1. Find and click the link to create free account.
1. Review the terms and conditions as well as any agreements.
1. Create your account and follow any account verification steps.
1. If asked to start a free trial, do so.
1. On the **Let's create your Grafana Stack** dialog:
Expand All @@ -20,7 +19,8 @@ weight: 30

* Enter an appropriate `Team URL` which will be used as a customised link to access the Grafana Cloud.
* Select the `Deployment region` which is where the service will be deployed to. This should be preferably close to the High Availability nodes.
* Click `Finish setup`.
* Review the terms and conditions as well as any agreements.
* Click `Finish Setup`.

1. Wait for Grafana Cloud to load

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ This guide describes how to set up Grafana Loki in the cloud. Please ensure that
## Set up Grafana Loki

1. Browse to the *Team URL* created during [Sign Up For Grafana Cloud][].
1. If presented with the *Get started in a few easy steps* page, click *I'm already familiar with Grafana. Skip setup →* in the top right corner.
1. Click the Menu icon {{< image src="/images/GrafanaMenuIcon.png" title="Menu icon" >}} to view the available options.
1. Click the Connections menu item {{< image src="/images/GrafanaConnectionsLink.png" title="Connections menu item" >}}.
1. Click the *Connections* menu item and select *Add new connection*.
1. In the *Custom data* section click on *Hosted logs*.
{{< figure src="/images/Grafana Cloud - Hosted Logs.png" >}}
1. In the *Choose your use case* section select *Send logs from a standalone host*.
{{< figure src="/images/Grafana Cloud - Hosted Logs Config Usecase.png" >}}
1. Enter an *API Token name* in the *Configure promtail to send logs to your Grafana Cloud* section and click the *Create API token* button.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ This test uses the test flow published as part of testing the Innovation install

1. Once the request has completed, using a web browser, log in to your configured Grafana.
1. Click the Menu icon {{< image src="/images/GrafanaMenuIcon.png" title="Menu icon" >}} to view the available options.
1. Click the Dashboards menu item {{< image src="/images/Grafana Cloud - Dashboards Link.png" title="Dashboards menu item" >}}.
1. Click the Dashboards menu item.
1. Click the folder name that the dashboards were imported to, if not already expanded.
1. Click the *Flow Execution Requests* dashboard to open it.
1. The request made at step 1 should be visible on the dashboard.
{{% alert title="Note" %}}
If other requests have been made then there may be more than one request visible on the dashboard.
{{% / alert %}}
1. Click the Menu icon {{< image src="/images/GrafanaMenuIcon.png" title="Menu icon" >}} to view the available options.
1. Click the Dashboards menu item {{< image src="/images/Grafana Cloud - Dashboards Link.png" title="Dashboards menu item" >}}.
1. Click the Dashboards menu item.
1. Click the folder name that the dashboards were imported to, if not already expanded.
1. Click the *Platform Health* dashboard to open it.
1. The request made at step 1 should be visible on the dashboard.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ This guide describes how to install Grafana on the Web Application Server. Pleas

## Install Grafana

1. Download the [Grafana 8.5.4][] Windows installer.
1. Download the [Grafana 10.4.1][] Windows installer.
1. Run the installer and install Grafana to a suitable location.

## Next Steps?

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" >}}
[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}}
[Software Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.SoftwareRequirements" >}}
[Grafana 8.5.4]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.Windows" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This guide describes how to install Grafana Loki on the Web Application Server.

## Install Grafana Loki

1. Download [Grafana Loki 2.5.0][] archive.
1. Download [Grafana Loki 3.0.0][] archive.
1. Extract content of the downloaded archive to a suitable location, e.g. `C:\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.
Expand All @@ -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 2.5.0]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.GrafanaLokiInstallZip" >}}
[Grafana Loki 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.3.0.0.GrafanaLokiInstallZip" >}}
[Grafana Loki Install.zip]: {{< url path="GitHub.Cortex.Observability.2.2.0.GrafanaLokiInstallZip" >}}
[NSSM]: {{< url path="NSSM.MainDoc" >}}
[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This guide describes how to install Promtail on the Application Server(s). Pleas

## Install Promtail

1. Download [Promtail 2.5.0][] archive.
1. Download [Promtail 3.0.0][] archive.
1. Extract content of the downloaded archive to a suitable location, e.g. `C:\Promtail`.
1. Download the [Promtail Install.zip][] archive and extract its contents alongside the previously extracted Promtail `promtail-windows-amd64.exe`.
This archive contains the `promtail-local-config.yaml` configuration file, [NSSM][] (the Non-Sucking Service Manager program) and PowerShell scripts to help manage Promtail as a Windows service.
Expand All @@ -26,6 +26,6 @@ This archive contains the `promtail-local-config.yaml` configuration file, [NSSM
[Configure Promtail]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallPromtail.ConfigurePromtail" >}}
[NSSM]: {{< url path="NSSM.MainDoc" >}}
[Prerequisites]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Prerequisites" >}}
[Promtail 2.5.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.PromtailInstallZip" >}}
[Promtail 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.3.0.0.PromtailInstallZip" >}}
[Promtail Install.zip]: {{< url path="GitHub.Cortex.Observability.2.2.0.PromtailInstallZip" >}}
[Software Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.SoftwareRequirements" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ The application servers (as described in {{< ahref path="Cortex.GettingStarted.O

| Server&nbsp;Role | Windows&nbsp;Server[^1] | IIS[^2] | Other&nbsp;Software |
|------------------|-------------------------|---------|----------|
| Web Application Server | [2022 (x64)][] *Recommended*<br>[2019 (x64)][] | 10.0.20348[^3]<br>10.0.17763[^4]<br>IIS Basic Authentication[^5]<br>[URL Rewrite module 2.1][] | [Grafana 8.5.4][] *Enterprise Edition*<br>[Grafana Loki 2.5.0][]|
| Application Server | [2022 (x64)][] *Recommended*<br>[2019 (x64)][] | | [Promtail 2.5.0][]|
| Web Application Server | [2022 (x64)][] *Recommended*<br>[2019 (x64)][] | 10.0.20348[^3]<br>10.0.17763[^4]<br>IIS Basic Authentication[^5]<br>[URL Rewrite module 2.1][] | [Grafana 10.4.1][] *Enterprise Edition*<br>[Grafana Loki 3.0.0][]|
| Application Server | [2022 (x64)][] *Recommended*<br>[2019 (x64)][] | | [Promtail 3.0.0][]|

[^1]: Windows Server Standard and Datacenter editions are supported. Filesystem **must be NTFS** and networking **must use IPv4**. Linux is not supported, but may be in the future.
[^2]: IIS is supported; other web servers, including IIS Express are not supported.
Expand Down Expand Up @@ -158,13 +158,13 @@ A domain user which is a member of the Local Administrators group on all Applica
[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.MakeInstallationArtefactsAvailable" >}}
[Grafana 8.5.4]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.Windows" >}}
[Grafana Loki 2.5.0]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaLoki.GrafanaLokiInstallZip" >}}
[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" >}}
[Install Grafana]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallGrafana.MainDoc" >}}
[Install IIS Basic Authentication]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.InstallIISBasicAuthentication" >}}
[installation]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.InstallLoki.InstallCertificate" >}}
[Let’s Encrypt]: {{< url path="LetsEncrypt.MainDoc" >}}
[Promtail 2.5.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.PromtailInstallZip" >}}
[Promtail 3.0.0]: {{< url path="Grafana.SelfManaged.Downloads.Promtail.3.0.0.PromtailInstallZip" >}}
[SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Advanced.SSLBestPractices" >}}
[URL Rewrite module 2.1]: {{< url path="IIS.Downloads.UrlRewrite-2_1" >}}
[Port Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.AddObservabilityToInnovation.Grafana.Advanced.PortRequirements" >}}
Loading

0 comments on commit 752218d

Please sign in to comment.