Skip to content

Commit 5ba6579

Browse files
committed
Improve Acrolinx
1 parent f43098f commit 5ba6579

14 files changed

+121
-121
lines changed

articles/service-fabric/monitor-service-fabric.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ You can monitor how your applications are used, the actions taken by the Service
3535

3636
Application monitoring tracks how features and components of your application are being used. You want to monitor your applications to make sure issues that impact users are caught. The responsibility of application monitoring is on the users developing an application and its services since it is unique to the business logic of your application. Monitoring your applications can be useful in the following scenarios:
3737
* How much traffic is my application experiencing? - Do you need to scale your services to meet user demands or address a potential bottleneck in your application?
38-
* Are my service to service calls successful and tracked?
38+
* Are my service-to-service calls successful and tracked?
3939
* What actions are taken by the users of my application? - Collecting telemetry can guide future feature development and better diagnostics for application errors
4040
* Is my application throwing unhandled exceptions?
4141
* What is happening within the services running inside my containers?
@@ -84,7 +84,7 @@ The events are sent through standard channels on both Windows and Linux and can
8484

8585
The Service Fabric platform includes a health model, which provides extensible health reporting for the status of entities in a cluster. Each node, application, service, partition, replica, or instance, has a continuously updatable health status. The health status can either be "OK", "Warning", or "Error". Think of Service Fabric events as verbs done by the cluster to various entities and health as an adjective for each entity. Each time the health of a particular entity transitions, an event will also be emitted. This way you can set up queries and alerts for health events in your monitoring tool of choice, just like any other event.
8686

87-
Additionally, we even let users override health for entities. If your application is going through an upgrade and you have validation tests failing, you can write to Service Fabric Health using the Health API to indicate your application is no longer healthy, and Service Fabric will automatically rollback the upgrade! For more on the health model, check out the [introduction to Service Fabric health monitoring](service-fabric-health-introduction.md)
87+
Additionally, we even let users override health for entities. If your application is going through an upgrade and you have validation tests failing, you can write to Service Fabric Health using the Health API to indicate your application is no longer healthy, and Service Fabric will automatically roll back the upgrade! For more on the health model, check out the [introduction to Service Fabric health monitoring](service-fabric-health-introduction.md)
8888

8989
![Screenshot of SFX health dashboard.](media/service-fabric-diagnostics-overview/sfx-healthstatus.png)
9090

articles/service-fabric/service-fabric-diagnostics-common-scenarios.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ ms.date: 07/14/2022
1111

1212
# Diagnose common scenarios with Service Fabric
1313

14-
This article illustrates common scenarios users have encountered in the area of monitoring and diagnostics with Service Fabric. The scenarios presented cover all 3 layers of service fabric: Application, Cluster, and Infrastructure. Each solution uses Application Insights and Azure Monitor logs, Azure monitoring tools, to complete each scenario. The steps in each solution give users an introduction on how to use Application Insights and Azure Monitor logs in the context of Service Fabric.
14+
This article illustrates common scenarios users have encountered in the area of monitoring and diagnostics with Service Fabric. The scenarios presented cover all three layers of service fabric: Application, Cluster, and Infrastructure. Each solution uses Application Insights and Azure Monitor logs, Azure monitoring tools, to complete each scenario. The steps in each solution give users an introduction on how to use Application Insights and Azure Monitor logs in the context of Service Fabric.
1515

1616
## Prerequisites and Recommendations
1717

18-
The solutions in this article will use the following tools. We recommend you have these set up and configured:
18+
The solutions in this article use the following tools. We recommend you have these set up and configured:
1919

2020
* [Application Insights with Service Fabric](service-fabric-tutorial-monitoring-aspnet.md)
2121
* [Enable Azure Diagnostics on your cluster](service-fabric-diagnostics-event-aggregation-wad.md)
@@ -25,22 +25,22 @@ The solutions in this article will use the following tools. We recommend you hav
2525
## How can I see unhandled exceptions in my application?
2626

2727
1. Navigate to your Application Insights resource that your application is configured with.
28-
2. Click on *Search* in the top left. Then click filter on the next panel.
28+
2. Select *Search* in the top left. Then select filter on the next panel.
2929

3030
![AI Overview](media/service-fabric-diagnostics-common-scenarios/ai-search-filter.png)
3131

3232
3. You will see lots of types of events (traces, requests, custom events). Choose "Exception" as your filter.
3333

3434
![AI Filter List](media/service-fabric-diagnostics-common-scenarios/ai-filter-list.png)
3535

36-
By clicking an exception in the list, you can look at more details including the service context if you are using the Service Fabric Application Insights SDK.
36+
By clicking an exception in the list, you can look at more details including the service context if you're using the Service Fabric Application Insights SDK.
3737

3838
![AI Exception](media/service-fabric-diagnostics-common-scenarios/ai-exception.png)
3939

4040
## How do I view which HTTP calls are used in my services?
4141

4242
1. In the same Application Insights resource, you can filter on "requests" instead of exceptions and view all requests made
43-
2. If you are using the Service Fabric Application Insights SDK, you can see a visual representation of your services connected to one another, and the number of succeeded and failed requests. On the left click "Application Map"
43+
2. If you're using the Service Fabric Application Insights SDK, you can see a visual representation of your services connected to one another, and the number of succeeded and failed requests. On the left, select "Application Map"
4444

4545
![AI App Map Blade](media/service-fabric-diagnostics-common-scenarios/app-map-blade.png)
4646
![AI App Map](media/service-fabric-diagnostics-common-scenarios/app-map-new.png)
@@ -50,36 +50,36 @@ The solutions in this article will use the following tools. We recommend you hav
5050
## How do I create an alert when a node goes down
5151

5252
1. Node events are tracked by your Service Fabric cluster. Navigate to the Service Fabric Analytics solution resource named **ServiceFabric(NameofResourceGroup)**
53-
2. Click on the graph on the bottom of the blade titled "Summary"
53+
2. Select the graph on the bottom of the blade titled "Summary"
5454

5555
![Azure Monitor logs solution](media/service-fabric-diagnostics-common-scenarios/oms-solution-azure-portal.png)
5656

57-
3. Here you have many graphs and tiles displaying various metrics. Click on one of the graphs and it will take you to the Log Search. Here you can query for any cluster events or performance counters.
57+
3. Here you have many graphs and tiles displaying various metrics. Select one of the graphs and it will take you to the Log Search. Here you can query for any cluster events or performance counters.
5858
4. Enter the following query. These event IDs are found in the [Node events reference](service-fabric-diagnostics-event-generation-operational.md#application-events)
5959

6060
```kusto
6161
ServiceFabricOperationalEvent
6262
| where EventID >= 25622 and EventID <= 25626
6363
```
6464
65-
5. Click "New Alert Rule" at the top and now anytime an event arrives based on this query, you will receive an alert in your chosen method of communication.
65+
5. Select "New Alert Rule" at the top and now anytime an event arrives based on this query, you'll receive an alert in your chosen method of communication.
6666
6767
![Azure Monitor logs New Alert](media/service-fabric-diagnostics-common-scenarios/oms-create-alert.png)
6868
6969
## How can I be alerted of application upgrade rollbacks?
7070
71-
1. On the same Log Search window as before enter the following query for upgrade rollbacks. These event IDs are found under [Application events reference](service-fabric-diagnostics-event-generation-operational.md#application-events)
71+
1. On the same Log Search window as before, enter the following query for upgrade rollbacks. These event IDs are found under [Application events reference](service-fabric-diagnostics-event-generation-operational.md#application-events)
7272
7373
```kusto
7474
ServiceFabricOperationalEvent
7575
| where EventID == 29623 or EventID == 29624
7676
```
7777
78-
2. Click "New Alert Rule" at the top and now anytime an event arrives based on this query, you will receive an alert.
78+
2. Select "New Alert Rule" at the top and now anytime an event arrives based on this query, you'll receive an alert.
7979
8080
## How do I see container metrics?
8181
82-
In the same view with all the graphs, you will see some tiles for the performance of your containers. You need the Log Analytics Agent and [Container Monitoring solution](service-fabric-diagnostics-oms-containers.md) for these tiles to populate.
82+
In the same view with all the graphs, you'll see some tiles for the performance of your containers. You need the Log Analytics Agent and [Container Monitoring solution](service-fabric-diagnostics-oms-containers.md) for these tiles to populate.
8383
8484
![Log Analytics Container Metrics](media/service-fabric-diagnostics-common-scenarios/containermetrics.png)
8585
@@ -92,11 +92,11 @@ In the same view with all the graphs, you will see some tiles for the performanc
9292
9393
![Log Analytics Workspace Tab](media/service-fabric-diagnostics-common-scenarios/workspacetab.png)
9494
95-
2. Once you’re on the workspace’s page, click on “Advanced settings” in the same left menu.
95+
2. Once you’re on the workspace’s page, Select “Advanced settings” in the same left menu.
9696
9797
![Log Analytics Advanced Settings](media/service-fabric-diagnostics-common-scenarios/advancedsettingsoms.png)
9898
99-
3. Click on Data > Windows Performance Counters (Data > Linux Performance Counters for Linux machines) to start collecting specific counters from your nodes via the Log Analytics agent. Here are examples of the format for counters to add
99+
3. Select Data > Windows Performance Counters (Data > Linux Performance Counters for Linux machines) to start collecting specific counters from your nodes via the Log Analytics agent. Here are examples of the format for counters to add
100100
101101
* `.NET CLR Memory(<ProcessNameHere>)\\# Total committed Bytes`
102102
* `Processor(_Total)\\% Processor Time`
@@ -108,7 +108,7 @@ In the same view with all the graphs, you will see some tiles for the performanc
108108
109109
![Log Analytics Perf Counters](media/service-fabric-diagnostics-common-scenarios/omsperfcounters.png)
110110
111-
4. This will allow you to see how your infrastructure is handling your workloads, and set relevant alerts based on resource utilization. For example – you may want to set an alert if the total Processor utilization goes above 90% or below 5%. The counter name you would use for this is “% Processor Time.” You could do this by creating an alert rule for the following query:
111+
4. This allows you to see how your infrastructure is handling your workloads, and set relevant alerts based on resource utilization. For example – you might want to set an alert if the total Processor utilization goes above 90% or below 5%. The counter name you would use for this is “% Processor Time.” You could do this by creating an alert rule for the following query:
112112
113113
```kusto
114114
Perf | where CounterName == "% Processor Time" and InstanceName == "_Total" | where CounterValue >= 90 or CounterValue <= 5.
@@ -136,4 +136,4 @@ Check these links for the full list of performance counters on Reliable [Service
136136
* Learn more about Azure Monitor logs [alerting](../azure-monitor/alerts/alerts-overview.md) to aid in detection and diagnostics.
137137
* For on-premises clusters, Azure Monitor logs offers a gateway (HTTP Forward Proxy) that can be used to send data to Azure Monitor logs. Read more about that in [Connecting computers without Internet access to Azure Monitor logs using the Log Analytics gateway](../azure-monitor/agents/gateway.md)
138138
* Get familiarized with the [log search and querying](../azure-monitor/logs/log-query-overview.md) features offered as part of Azure Monitor logs
139-
* Get a more detailed overview of Azure Monitor logs and what it offers, read [What is Azure Monitor logs?](../azure-monitor/overview.md)
139+
* For a detailed overview of Azure Monitor logs and what it offers, read [What is Azure Monitor logs?](../azure-monitor/overview.md)

articles/service-fabric/service-fabric-diagnostics-event-aggregation-wad.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Now that you're aggregating events in Azure Storage, [set up Azure Monitor logs]
5959
## Deploy the Diagnostics extension through Azure Resource Manager
6060

6161
### Create a cluster with the diagnostics extension
62-
To create a cluster by using Resource Manager, you need to add the Diagnostics configuration JSON to the full Resource Manager template. We provide a sample five-VM cluster Resource Manager template with Diagnostics configuration added to it as part of our Resource Manager template samples. You can see it at this location in the Azure Samples gallery: [Five-node cluster with Diagnostics Resource Manager template sample](https://azure.microsoft.com/resources/templates/service-fabric-secure-cluster-5-node-1-nodetype/).
62+
To create a cluster by using Resource Manager, you need to add the Diagnostics configuration JSON to the full Resource Manager template. We provide a Resource Manager template for a five-VM cluster with Diagnostics configuration added to it as part of our Resource Manager template samples. You can see it at this location in the Azure Samples gallery: [Five-node cluster with Diagnostics Resource Manager template sample](https://azure.microsoft.com/resources/templates/service-fabric-secure-cluster-5-node-1-nodetype/).
6363

6464
To see the Diagnostics setting in the Resource Manager template, open the azuredeploy.json file and search for **IaaSDiagnostics**. To create a cluster by using this template, select the **Deploy to Azure** button available at the previous link.
6565

@@ -191,14 +191,14 @@ After you modify the template.json file as described, republish the Resource Man
191191

192192
### Update storage quota
193193

194-
Since the tables populated by the extension grows until the quota is hit, you may want to consider decreasing the quota size. The default value is 50 GB and is configurable in the template under the `overallQuotaInMB` field under `DiagnosticMonitorConfiguration`
194+
Since the tables populated by the extension grow until the quota is hit, you might want to consider decreasing the quota size. The default value is 50 GB and is configurable in the template under the `overallQuotaInMB` field under `DiagnosticMonitorConfiguration`
195195

196196
```json
197197
"overallQuotaInMB": "50000",
198198
```
199199

200200
## Log collection configurations
201-
Logs from additional channels are also available for collection, here are some of the most common configurations you can make in the template for clusters running in Azure.
201+
Logs from additional channels are also available for collection. Here are some of the most common configurations you can make in the template for clusters running in Azure.
202202

203203
* Operational Channel - Base: Enabled by default, high-level operations performed by Service Fabric and the cluster, including events for a node coming up, a new application being deployed, or an upgrade rollback, etc. For a list of events, refer to [Operational Channel Events](./service-fabric-diagnostics-event-generation-operational.md).
204204

0 commit comments

Comments
 (0)