Skip to content

Commit 0fc258f

Browse files
author
Donna-Marie Smith
committed
added FAQ for changing Logging Levels and linked to it from Upgrade Guide
1 parent b8b46b0 commit 0fc258f

21 files changed

Lines changed: 607 additions & 16 deletions

File tree

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: "How do I change the logging level?"
3+
linkTitle: "How do I change the logging level?"
4+
description: "Instructions on how to change the {{% ctx %}} logging level."
5+
weight: 1000
6+
---
7+
8+
{{% ctx %}} Logging Levels are set to `Error` by default for most services. However, levels can be changed whilst {{% ctx %}} is running by sending REST calls to the {{% ctx %}} API Gateway service.
9+
10+
{{% alert title="Note" %}}
11+
Although the logging level for the {{% ctx %}} API Gateway service can be increased, it will still always log all API calls received regardless of logging level.
12+
{{% / alert %}}
13+
14+
If increasing the logging level, particularly if increasing for everything or for Block Logging, we recommend that this is done only when required. Increasing log levels will lead to an increase in disk usage and disk writes, which can impact the performance of the {{% ctx %}} platform if not monitored.
15+
16+
Whilst increased logging levels are in place, we would recommend closely monitoring system performance and disk space usage.
17+
18+
All REST calls to update logging levels use Basic Auth and can be made using REST clients such as [Postman][] or using scripts such as PowerShell. For each of the below solutions, an example PowerShell script will be provided with instructions on how to use.
19+
20+
[Postman]: {{< url path="Postman.Downloads.MainDoc" >}}
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: "Change All Logging Levels"
3+
linkTitle: "Change All Logging Levels"
4+
description: "Instructions on how to change the Logging Level for All Logging."
5+
weight: 10
6+
---
7+
8+
# {{% param title %}}
9+
10+
To change logging levels for everything, the below PowerShell script can be used to make a REST call against your {{% ctx %}} platform.
11+
12+
1. Run Windows PowerShell ISE as Administrator.
13+
1. Copy the following script into the PowerShell window:
14+
15+
``` powershell
16+
$serverFQDN = "server.domain.com"
17+
$APIGatewayPort = 8722
18+
$loglevel = 4
19+
20+
$user = "UserName"
21+
$pass = Read-Host -Prompt "Enter Password for Basic Auth User"
22+
$base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(("{0}:{1}" -f $user,$pass)))
23+
24+
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
25+
$headers.Add("Content-Type", "application/json")
26+
$headers.Add("Accept", "application/json")
27+
$headers.Add("Authorization", "Basic $base64AuthInfo")
28+
$path = "applications/logging"
29+
$body = @"
30+
$loglevel
31+
"@
32+
33+
$response = Invoke-RestMethod "https://${serverFQDN}:$APIGatewayPort/api/v1/default/default/$path" -Method 'PUT' -Headers $headers -Body $body
34+
$response | ConvertTo-Json
35+
```
36+
37+
1. Configure the following variables:
38+
* `$serverFQDN` – The fully qualified domain name for the Application Server Or Load Balancer
39+
* `$APIGatewayPort` – {{% ctx %}} API Gateway Service Port (8722) or Load Balancer port (typically 443 or 8722)
40+
* `$loglevel` – Desired log level as an integer, `1` is enabled and `4` is the default error level
41+
* `$user` – {{% ctx %}} API Gateway Basic Auth Username
42+
43+
1. Execute the script, entering the Basic Auth User's password when prompted.
44+
1. Confirm success response:
45+
46+
If the call was successful, the following response should be received
47+
48+
``` powershell
49+
LogLevel was successfully configured.
50+
```
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: "Change Block Logging Levels"
3+
linkTitle: "Change Block Logging Levels"
4+
description: "Instructions on how to change the Logging Level for Block Logging."
5+
weight: 5
6+
---
7+
8+
# {{% param title %}}
9+
10+
Block logging in {{% ctx %}} logs the following by default:
11+
12+
* Command.CommandText
13+
* Command.Parameters
14+
* HTTPRequest
15+
* HTTPResponse
16+
* SOAPRequest
17+
* SOAPResponse
18+
* Script
19+
* Parameters
20+
* Outputs
21+
* Records
22+
* Command
23+
* Response
24+
* SSH Logs
25+
26+
To change logging levels for block logging so that every block is logged when executed, the below PowerShell script can be used to make a REST call against your {{% ctx %}} platform.
27+
28+
1. Run Windows PowerShell ISE as Administrator.
29+
1. Copy the following script into the PowerShell window:
30+
31+
``` powershell
32+
$serverFQDN = "server.domain.com"
33+
$APIGatewayPort = 8722
34+
$loglevel = 4
35+
36+
$user = "UserName"
37+
$pass = Read-Host -Prompt "Enter Password for Basic Auth User"
38+
$base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(("{0}:{1}" -f $user,$pass)))
39+
40+
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
41+
$headers.Add("Content-Type", "application/json")
42+
$headers.Add("Accept", "application/json")
43+
$headers.Add("Authorization", "Basic $base64AuthInfo")
44+
$path = "applications/ execution/services/engine/blocks/packages/versions/executions/flows/workspaces/blocks/logging"
45+
$body = @"
46+
$loglevel
47+
"@
48+
49+
$response = Invoke-RestMethod "https://${serverFQDN}:$APIGatewayPort/api/v1/default/default/$path" -Method 'PUT' -Headers $headers -Body $body
50+
$response | ConvertTo-Json
51+
```
52+
53+
1. Configure the following variables:
54+
* `$serverFQDN` – The fully qualified domain name for the Application Server Or Load Balancer
55+
* `$APIGatewayPort` – {{% ctx %}} API Gateway Service Port (8722) or Load Balancer port (typically 443 or 8722)
56+
* `$loglevel` – Desired log level as an integer, `1` is enabled and `4` is the default error level
57+
* `$user` – {{% ctx %}} API Gateway Basic Auth Username
58+
59+
1. Execute the script, entering the Basic Auth User's password when prompted.
60+
1. Confirm success response:
61+
62+
If the call was successful, the following response should be received
63+
64+
``` powershell
65+
LogLevel was successfully configured.
66+
```
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: "Change Flow Logging Levels"
3+
linkTitle: "Change Flow Logging Levels"
4+
description: "Instructions on how to change the Logging Level for Flow Logging."
5+
weight: 1
6+
---
7+
8+
# {{% param title %}}
9+
10+
To change logging levels for Flow Logging, the below PowerShell script can be used to make a REST call against your {{% ctx %}} platform.
11+
12+
1. Run Windows PowerShell ISE as Administrator.
13+
1. Copy the following script into the PowerShell window:
14+
15+
``` powershell
16+
$serverFQDN = "server.domain.com"
17+
$APIGatewayPort = 8722
18+
$loglevel = 4
19+
20+
$user = "UserName"
21+
$pass = Read-Host -Prompt "Enter Password for Basic Auth User"
22+
$base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(("{0}:{1}" -f $user,$pass)))
23+
24+
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
25+
$headers.Add("Content-Type", "application/json")
26+
$headers.Add("Accept", "application/json")
27+
$headers.Add("Authorization", "Basic $base64AuthInfo")
28+
$path = "applications/ execution/services/engine/blocks/packages/versions/executions/flows/logging"
29+
$body = @"
30+
$loglevel
31+
"@
32+
33+
$response = Invoke-RestMethod "https://${serverFQDN}:$APIGatewayPort/api/v1/default/default/$path" -Method 'PUT' -Headers $headers -Body $body
34+
$response | ConvertTo-Json
35+
```
36+
37+
1. Configure the following variables:
38+
* `$serverFQDN` – The fully qualified domain name for the Application Server Or Load Balancer
39+
* `$APIGatewayPort` – {{% ctx %}} API Gateway Service Port (8722) or Load Balancer port (typically 443 or 8722)
40+
* `$loglevel` – Desired log level as an integer, `1` is enabled and `4` is the default error level
41+
* `$user` – {{% ctx %}} API Gateway Basic Auth Username
42+
43+
1. Execute the script, entering the Basic Auth User's password when prompted.
44+
1. Confirm success response:
45+
46+
If the call was successful, the following response should be received
47+
48+
``` powershell
49+
LogLevel was successfully configured.
50+
```

content/en/docs/2025.3/getting-started/cloud/add-observability-to-innovation/Grafana/import-dashboards.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,12 @@ Please ensure that the set up for [Grafana][] and [Loki][] have been completed b
3232
1. Click the Dashboards menu item.
3333
1. Click the *New* dropdown and select *Import*.
3434
1. Click on *Upload dashboard JSON file*.
35-
1. Locate the `Flow Execution Requests.json` file extracted from the downloaded `Grafana.Dashboards.zip`.
35+
1. Locate the `Flow Execution Details.json` file extracted from the downloaded `Grafana.Dashboards.zip`.
3636
1. Select the file and click *Open*.
3737
1. Select the folder in Grafana you wish the dashboard to be saved in, e.g. *Cortex*.
3838
1. Select your [configured Loki data source][] from the dropdown menu, e.g. *grafanacloud-cortex-logs*.
3939
1. Click *Import*.
40+
1. Repeat steps 2 - 10 for the `Flow Execution Requests.json` file.
4041
1. Repeat steps 2 - 10 for the `Platform Health.json` file.
4142

4243
## Configure Data Sources

content/en/docs/2025.3/getting-started/on-premise/add-observability-to-innovation/Grafana/setup-grafana.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,12 @@ Please ensure that the Installations for [Grafana][] and [Loki][] have been comp
4747
1. Go to *Dashboards* via the menu on the left sidebar.
4848
1. Click the *New* button and select *Import* from the drop-down menu.
4949
1. Click the *Upload JSON file* button.
50-
1. Locate the `Flow Execution Requests.json` file extracted from the downloaded `Grafana.Dashboards.zip`.
50+
1. Locate the `Flow Execution Details.json` file extracted from the downloaded `Grafana.Dashboards.zip`.
5151
1. Select the file and click *Open*.
5252
1. Select the folder in Grafana you wish the dashboard to be saved in, e.g. *Cortex*.
5353
1. Select your configured Loki data source from the dropdown menu.
5454
1. Click *Import*.
55+
1. Repeat steps 2 - 8 for the `Flow Execution Requests.json` file.
5556
1. Repeat steps 2 - 8 for the `Platform Health.json` file.
5657

5758
## Configure Data Sources
@@ -64,14 +65,15 @@ To do this, follow these steps for all default {{% ctx %}} dashboards imported:
6465
1. To open a dashboard:
6566
1. Go to *Dashboards* via the menu on the left sidebar.
6667
1. Click the folder name that the dashboards were imported to.
67-
1. Click the *Flow Execution Requests* dashboard to open it.
68+
1. Click the *Flow Execution Details* dashboard to open it.
6869
1. Open the *Dashboard settings* menu via the cog icon in the top right-hand side of the dashboard.
6970
1. Click *Variables* from the top menu of the *Settings* page.
7071
1. Click *CustomFilter* at the bottom of the *Variables* list.
7172
1. Select your configured Loki data source in the *Ad-hoc options* > *Data source* drop-down menu.
7273
1. Click *Apply*.
7374
1. Click the dashboard name in the breadcrumb at the top left corner of the page to go back to the dashboard.
7475
1. Click the + icon next to the Custom Filter to confirm that a list of available filter options is visible.
76+
1. Repeat steps 2 - 9 for the *Flow Execution Requests* dashboard.
7577
1. Repeat steps 2 - 9 for the *Platform Health* dashboard.
7678

7779
## Next Steps?
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: "How do I change the logging level?"
3+
linkTitle: "How do I change the logging level?"
4+
description: "Instructions on how to change the {{% ctx %}} logging level."
5+
weight: 1000
6+
---
7+
8+
{{% ctx %}} Logging Levels are set to `Error` by default for most services. However, levels can be changed whilst {{% ctx %}} is running by sending REST calls to the {{% ctx %}} API Gateway service.
9+
10+
{{% alert title="Note" %}}
11+
Although the logging level for the {{% ctx %}} API Gateway service can be increased, it will still always log all API calls received regardless of logging level.
12+
{{% / alert %}}
13+
14+
If increasing the logging level, particularly if increasing for everything or for Block Logging, we recommend that this is done only when required. Increasing log levels will lead to an increase in disk usage and disk writes, which can impact the performance of the {{% ctx %}} platform if not monitored.
15+
16+
Whilst increased logging levels are in place, we would recommend closely monitoring system performance and disk space usage.
17+
18+
All REST calls to update logging levels use Basic Auth and can be made using REST clients such as [Postman][] or using scripts such as PowerShell. For each of the below solutions, an example PowerShell script will be provided with instructions on how to use.
19+
20+
[Postman]: {{< url path="Postman.Downloads.MainDoc" >}}
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: "Change All Logging Levels"
3+
linkTitle: "Change All Logging Levels"
4+
description: "Instructions on how to change the Logging Level for All Logging."
5+
weight: 10
6+
---
7+
8+
# {{% param title %}}
9+
10+
To change logging levels for everything, the below PowerShell script can be used to make a REST call against your {{% ctx %}} platform.
11+
12+
1. Run Windows PowerShell ISE as Administrator.
13+
1. Copy the following script into the PowerShell window:
14+
15+
``` powershell
16+
$serverFQDN = "server.domain.com"
17+
$APIGatewayPort = 8722
18+
$loglevel = 4
19+
20+
$user = "UserName"
21+
$pass = Read-Host -Prompt "Enter Password for Basic Auth User"
22+
$base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(("{0}:{1}" -f $user,$pass)))
23+
24+
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
25+
$headers.Add("Content-Type", "application/json")
26+
$headers.Add("Accept", "application/json")
27+
$headers.Add("Authorization", "Basic $base64AuthInfo")
28+
$path = "applications/logging"
29+
$body = @"
30+
$loglevel
31+
"@
32+
33+
$response = Invoke-RestMethod "https://${serverFQDN}:$APIGatewayPort/api/v1/default/default/$path" -Method 'PUT' -Headers $headers -Body $body
34+
$response | ConvertTo-Json
35+
```
36+
37+
1. Configure the following variables:
38+
* `$serverFQDN` – The fully qualified domain name for the Application Server Or Load Balancer
39+
* `$APIGatewayPort` – {{% ctx %}} API Gateway Service Port (8722) or Load Balancer port (typically 443 or 8722)
40+
* `$loglevel` – Desired log level as an integer, `1` is enabled and `4` is the default error level
41+
* `$user` – {{% ctx %}} API Gateway Basic Auth Username
42+
43+
1. Execute the script, entering the Basic Auth User's password when prompted.
44+
1. Confirm success response:
45+
46+
If the call was successful, the following response should be received
47+
48+
``` powershell
49+
LogLevel was successfully configured.
50+
```
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: "Change Block Logging Levels"
3+
linkTitle: "Change Block Logging Levels"
4+
description: "Instructions on how to change the Logging Level for Block Logging."
5+
weight: 5
6+
---
7+
8+
# {{% param title %}}
9+
10+
Block logging in {{% ctx %}} logs the following by default:
11+
12+
* Command.CommandText
13+
* Command.Parameters
14+
* HTTPRequest
15+
* HTTPResponse
16+
* SOAPRequest
17+
* SOAPResponse
18+
* Script
19+
* Parameters
20+
* Outputs
21+
* Records
22+
* Command
23+
* Response
24+
* SSH Logs
25+
26+
To change logging levels for block logging so that every block is logged when executed, the below PowerShell script can be used to make a REST call against your {{% ctx %}} platform.
27+
28+
1. Run Windows PowerShell ISE as Administrator.
29+
1. Copy the following script into the PowerShell window:
30+
31+
``` powershell
32+
$serverFQDN = "server.domain.com"
33+
$APIGatewayPort = 8722
34+
$loglevel = 4
35+
36+
$user = "UserName"
37+
$pass = Read-Host -Prompt "Enter Password for Basic Auth User"
38+
$base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(("{0}:{1}" -f $user,$pass)))
39+
40+
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
41+
$headers.Add("Content-Type", "application/json")
42+
$headers.Add("Accept", "application/json")
43+
$headers.Add("Authorization", "Basic $base64AuthInfo")
44+
$path = "applications/ execution/services/engine/blocks/packages/versions/executions/flows/workspaces/blocks/logging"
45+
$body = @"
46+
$loglevel
47+
"@
48+
49+
$response = Invoke-RestMethod "https://${serverFQDN}:$APIGatewayPort/api/v1/default/default/$path" -Method 'PUT' -Headers $headers -Body $body
50+
$response | ConvertTo-Json
51+
```
52+
53+
1. Configure the following variables:
54+
* `$serverFQDN` – The fully qualified domain name for the Application Server Or Load Balancer
55+
* `$APIGatewayPort` – {{% ctx %}} API Gateway Service Port (8722) or Load Balancer port (typically 443 or 8722)
56+
* `$loglevel` – Desired log level as an integer, `1` is enabled and `4` is the default error level
57+
* `$user` – {{% ctx %}} API Gateway Basic Auth Username
58+
59+
1. Execute the script, entering the Basic Auth User's password when prompted.
60+
1. Confirm success response:
61+
62+
If the call was successful, the following response should be received
63+
64+
``` powershell
65+
LogLevel was successfully configured.
66+
```

0 commit comments

Comments
 (0)