Skip to content

Commit e055c82

Browse files
author
Donna-Marie Smith
committed
Modified following review
1 parent 77b2822 commit e055c82

File tree

17 files changed

+257
-171
lines changed

17 files changed

+257
-171
lines changed

‎content/en/docs/2025.3/FAQs/_index.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,3 @@ linkTitle: "FAQs"
44
description: "Answers to our most frequently asked questions."
55
weight: 10000
66
---
7-
8-
{{< workinprogress >}}

‎content/en/docs/2025.3/FAQs/check-cluster-health/_index.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "How do I check cluster health?"
3+
linkTitle: "How do I check cluster health?"
4+
description: "Instructions on how to check the health of your cluster."
5+
weight: 100
6+
---

‎content/en/docs/2025.3/FAQs/check-cluster-health/multi-server-with-ha.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Multiple Server with HA"
3+
linkTitle: "Multiple Server with HA"
4+
description: "Instructions on how to check the health of your multiple server cluster."
5+
weight: 1
6+
---
7+
8+
# Check Cluster Health
9+
10+
{{< section "/install-application-server/multi-server/check-application-services.md">}}

‎content/en/docs/2025.3/FAQs/check-cluster-health/single-server-without-ha.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Single Server without HA"
3+
linkTitle: "Single Server without HA"
4+
description: "Instructions on how to check the health of your single server cluster."
5+
weight: 2
6+
---
7+
8+
# Check Cluster Health
9+
10+
{{< section "/install-application-server/single-server/check-application-services.md">}}

‎content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/ops/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
title: "Ops"
33
linkTitle: "Ops"
44
description: "This section includes user guides related to the Operations section in {{% ctx %}} Gateway."
5-
weight: 10
5+
weight: 5
66
---

‎content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/ops/overview.md‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
---
2+
title: "Overview"
3+
linkTitle: "Overview"
4+
description: "Summary and Anatomy of the Operations Overview."
5+
weight: 10
6+
---
7+
8+
# {{% param title %}}
9+
10+
## Summary
11+
12+
The Operations Overview shows a synopsis of the current platform status, and a graphical display of the flow execution statistics.
13+
14+
## Anatomy
15+
16+
{{< figure src="/images/Operations Overview.png" title="Operations Overview" >}}
17+
18+
### Current Status
19+
20+
#### License Consumption
21+
22+
This tile displays the current License Consumption. The {{< image src="/images/GoTo.png" >}} icon navigates to the License Consumption feature, to provide visibility of the license consumption by group and by flow.
23+
24+
#### Cluster Health
25+
26+
This tile displays the current Cluster Health. The {{< image src="/images/GoTo.png" >}} icon opens a new browser tab and navigates to the [Service Fabric Explorer][], which allows [inspection and management][Check Cluster Health] of the cluster.
27+
28+
{{% alert title="Note" %}}
29+
To view the Service Fabric Explorer, the Service Fabric certificate must be installed as a client certificate on the machine from which you are browsing.
30+
{{% /alert %}}
31+
32+
#### Running Executions
33+
34+
This tile displays the current number of [Running Executions][]. The {{< image src="/images/GoTo.png" >}} icon navigates to the [Package Management][Package Management] feature, to provide a breakdown of running executions by package version and flow.
35+
36+
### Filters
37+
38+
#### Package Names
39+
40+
This filter displays the packages that have executions during the [Time Period][] selected. One or more packages can be selected, the default is `All`.
41+
42+
If a Package Name is selected that does not contain a previously selected Package Version, then all Package Versions for the selected Package Name will be automatically selected.
43+
44+
#### Package Versions
45+
46+
This filter displays the package versions that have executions during the [Time Period][] selected. One or more package versions can be selected, the default is `All`. This filter will only include package versions for the packages selected in the [Package Names][] filter.
47+
48+
If a Package Version is selected that does not contain a previously selected flow, then all flows for the selected Package Version will be automatically selected.
49+
50+
#### Flows
51+
52+
This filter displays the flows that have executions during the [Time Period][] selected. One or more flows can be selected, the default is `All`. This filter will only include flows for the package versions and packages selected in the [Package Versions][] and [Package Names][] filters.
53+
54+
{{% alert title="Note" %}}
55+
When any of the above filters are changed, a `Refresh Data` button will appear that must be clicked to apply the filters.
56+
{{% /alert %}}
57+
58+
#### Time Period
59+
60+
This filter displays a set of pre-defined periods to filter the data by:
61+
62+
| Time Period | Start of Period | End of Period | Interval |
63+
|---------------------|------------------------------|-----------------------|----------|
64+
| Today (so far) | Today at 00:00:00 | Now | 1 hour |
65+
| Yesterday | Yesterday at 00:00:00 | Yesterday at 23:59:59 | 1 hour |
66+
| This week (so far) | Monday at 00:00:00 | Now | 1 hour |
67+
| Last day | Now - 24 hours | Now | 1 hour |
68+
| Last 2 days | Now - 48 hours | Now | 1 hour |
69+
| Last 3 days | Now - 72 hours | Now | 1 hour |
70+
| Last 5 days | Now - 120 hours | Now | 1 hour |
71+
| Last 7 days | Now - 168 hours | Now | 1 hour |
72+
| This month (so far) | 1st day of month at 00:00:00 | Now | 1 day |
73+
| Last month | Now - 1 month | Now | 1 day |
74+
| Last 3 months | Now - 3 months | Now | 1 day |
75+
| Last 6 months | Now - 6 months | Now | 1 day |
76+
| Last 12 months | Now - 12 months | Now | 1 day |
77+
78+
#### Refresh
79+
80+
This button, located next to the [Time Period][] filter, refreshes the filters and then the data displayed.
81+
82+
### Flows
83+
84+
#### Success Rate
85+
86+
Success Rate represents the percentage of flow executions that completed successfully.
87+
88+
The value displayed is the average success rate for the selected time period, rounded down to the nearest whole percentage point.
89+
90+
The graph displays the trend of flow execution success rate during the selected time period.
91+
92+
#### Completed
93+
94+
Completed represents the number of flow executions that completed successfully or errored.
95+
96+
The value displayed is the total number of flow executions that completed during the selected time period.
97+
98+
The graph displays the trend of completed flow executions during the selected time period.
99+
100+
#### Errored
101+
102+
Errored represents the number of flow executions that errored; this includes executions that have been stopped in the [Running Executions] tab of the [Package Management][] feature.
103+
104+
The value displayed is the total number of flow executions that errored during the selected time period.
105+
106+
The graph displays the trend of errored flow executions during the selected time period.
107+
108+
#### Duration
109+
110+
Duration represents the time taken in seconds for flow executions to have completed successfully or errored.
111+
112+
The value displayed is the average flow execution duration during the selected time period.
113+
114+
The graph displays the trend of average flow execution duration during the selected time period.
115+
116+
## Remarks
117+
118+
### Known Limitations
119+
120+
None
121+
122+
## See Also
123+
124+
### Related Concepts
125+
126+
None
127+
128+
### Related Tutorials
129+
130+
* [Using the Operations Overview][Using the Operations Overview tutorial]
131+
132+
[Package Names]: {{< ref "#package-names" >}}
133+
[Package Versions]: {{< ref "#package-versions" >}}
134+
[Time Period]: {{< ref "#time-period" >}}
135+
136+
[Check Cluster Health]: {{< url path="Cortex.Faqs.CheckClusterHealth">}}
137+
[Package Management]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.Overview.MainDoc" >}}
138+
[Running Executions]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin.Packages.PackageVersionEditor.RunningExecutions" >}}
139+
[Service Fabric Explorer]: {{< url path="Cortex.Reference.Glossary.P-T.ServiceFabricExplorer" >}}
140+
[Using the Operations Overview tutorial]: {{< url path="Cortex.Tutorials.Operations.Overview.UseOperationsOverview" >}}

‎content/en/docs/2025.3/Guides/user-guides/user-interfaces/gateway/ops/overview/_index.md‎

Lines changed: 0 additions & 98 deletions
This file was deleted.

‎content/en/docs/2025.3/Reference/Glossary/p-t.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,12 @@ Service Fabric is an open source project developed by Microsoft used to deliver
105105

106106
For more information see [What is Service Fabric?][]
107107

108+
### Service Fabric Explorer
109+
110+
Service Fabric Explorer is an open source tool developed by Microsoft used to inspect and manage service fabric clusters.
111+
112+
For more information see [Visualise your cluster with Service Fabric Explorer][].
113+
108114
### Single
109115

110116
A [data type][] that represents a fractional, or very large or small number from `-3.402823e+38` through `3.402823e+38`.
@@ -205,6 +211,8 @@ Typeahead is a language prediction tool that is used to provide suggestions base
205211

206212
[Property Expressions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.PropertyExpressions" >}}
207213

214+
[Visualise your cluster with Service Fabric Explorer]: {{< url path="MSDocs.ServiceFabric.Explorer" >}}
215+
208216
[What is PowerShell?]: {{< url path="MSDocs.PowerShell.WhatIsPowerShell" >}}
209217

210218
[What is Service Fabric?]: {{< url path="MSDocs.ServiceFabric.MainDoc" >}}

‎content/en/docs/2025.3/_shared/install-application-server/multi-server/check-application-services.md‎

Lines changed: 2 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,4 @@
11
1. Log on to one of the Application Servers.
2-
1. Import the client certificate, used in the `ClientCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store. This can be achieved by double-clicking on the client certificate .PFX file and following the wizard.
3-
4-
If using self-signed certificates, the certificate can be retrieved by using the `Manage Computer Certificates` tool in Windows to export the `CortexServerCertificate` from the `Personal` store as a pfx file and then importing it to the `Current User` store by double-clicking on it and following the wizard. The certificate must also be imported to `Trusted Root Certification Authorities` in the `Local Computer` store.
2+
1. {{< section "/install-application-server/multi-server/import-client-certificate.md">}}
53
1. Open a web browser.
6-
1. Navigate to `https://app-server.domain.com:9080/Explorer`, where `app-server.domain.com` is the fully qualified domain name of any Application Server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration.
7-
8-
The screen should resemble that in the following figure:
9-
{{< figure src="/images/Service Fabric Explorer.png" >}}
10-
11-
The status circles should be entirely green - this indicates that all nodes, services and instances are healthy. Other status pages can be accessed by expanding items in the leftmost pane. Issues can be tracked down to the failing component by expanding items with warning triangles or error icons on. The next few diagrams show the status pages for a healthy system.
12-
13-
After expanding the application, clicking on any of the services should display a green circle and `Status = Active`:
14-
15-
{{< figure src="/images/Service Fabric Explorer - Service.png" >}}
16-
17-
After expanding either of the services, clicking on any of the instances/partitions should display a green circle and `Status = Ready`:
18-
19-
{{< figure src="/images/Service Fabric Explorer - Instance.png" >}}
20-
21-
Clicking on any of the nodes at the bottom of the leftmost pane should display a green circle and `Status = Up`:
22-
23-
{{< figure src="/images/Service Fabric Explorer - Node.png" >}}
24-
25-
If any warning triangles appear, wait for 5 minutes or so as the cluster may still be starting up. If the cluster looks OK, go to the next section.
26-
27-
If the warnings persist or anything on the screen goes red, expand the items to find the individual services and instances which have errors or warnings. Warnings should not be ignored as they can indicate that the service can’t start but is still in the retry phase. Error and warning messages should be displayed on the status screens and should indicate what is wrong.
28-
29-
If no useful message can be seen here, the service log files may contain more information. These can be found on each Application Server at:
30-
31-
* `%ProgramData%/Cortex/API Gateway Service/Logs`
32-
* `%ProgramData%/Cortex/Execution Service/Logs`
33-
34-
If no solution can be found, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for further assistance.
35-
36-
[Configure Installation Script]: {{< ref "#configure-installation-script" >}}
37-
[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}
4+
1. {{< section "/install-application-server/multi-server/service-fabric-explorer.md">}}

‎content/en/docs/2025.3/_shared/install-application-server/multi-server/import-client-certificate.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Import the client certificate, used in the `ClientCertificatePath` parameter of the [Configure Installation Script][] section, to your Current User certificate store.
2+
3+
This can be achieved by double-clicking on the client certificate .PFX file and following the wizard.
4+
5+
If using self-signed certificates, the certificate can be retrieved by using the `Manage Computer Certificates` tool in Windows to export the `CortexServerCertificate` from the `Personal` store as a pfx file and then importing it to the `Current User` store by double-clicking on it and following the wizard. The certificate must also be imported to `Trusted Root Certification Authorities` in the `Local Computer` store.
6+
7+
[Configure Installation Script]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureInstallationScriptNew" >}}

0 commit comments

Comments
 (0)