Skip to content

Commit 7edca39

Browse files
v-thepetv-thepet
committed
start
1 parent 5da6141 commit 7edca39

File tree

2 files changed

+254
-0
lines changed

2 files changed

+254
-0
lines changed

‎articles/notification-hubs/monitor-notification-hubs-reference.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
title: Monitoring data reference for Notification Hubs
3+
description: This article contains important reference material you need when you monitor Notification Hubs.
4+
ms.date: 03/11/2024
5+
ms.custom: horz-monitor
6+
ms.topic: reference
7+
author: GitHub-alias
8+
ms.author: microsoft-alias
9+
ms.service: notification-hubs
10+
---
11+
12+
<!--
13+
IMPORTANT
14+
15+
According to the Content Pattern guidelines all comments must be removed before publication!!!
16+
17+
To make this template easier to use, first:
18+
1. Search and replace Notification Hubs with the official name of your service.
19+
2. Search and replace notification-hubs with the service name to use in GitHub filenames.-->
20+
21+
<!-- VERSION 3.0 2024_01_01
22+
For background about this template, see https://review.learn.microsoft.com/en-us/help/contribute/contribute-monitoring?branch=main -->
23+
24+
<!-- All headings are required unless otherwise noted.
25+
The #included text changes when Azure Monitor functionality changes. Add info into the designated service-specific places if necessary. Remove #includes or template content that aren't relevant to your service.
26+
27+
At a minimum your service should have the following two articles:
28+
29+
1. The primary monitoring article (based on the template monitor-service-template.md)
30+
- Title: "Monitor Notification Hubs"
31+
- TOC title: "Monitor"
32+
- Filename: "monitor-notification-hubs.md"
33+
34+
2. A reference article that lists all the metrics and logs for your service (based on this template).
35+
- Title: "Notification Hubs monitoring data reference"
36+
- TOC title: "Monitoring data reference"
37+
- Filename: "monitor-notification-hubs-reference.md".
38+
-->
39+
40+
# Notification Hubs monitoring data reference
41+
42+
<!-- Intro. Required. -->
43+
[!INCLUDE [horz-monitor-ref-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-intro.md)]
44+
45+
See [Monitor Notification Hubs](monitor-notification-hubs.md) for details on the data you can collect for Notification Hubs and how to use it.
46+
47+
<!-- ## Metrics. Required section. -->
48+
[!INCLUDE [horz-monitor-ref-metrics-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-intro.md)]
49+
50+
<!-- Repeat the following section for each resource type/namespace in your service. For each ### section, replace the <ResourceType/namespace> placeholder, add the metrics-tableheader #include, and add the table #include.
51+
52+
To add the table #include, find the table(s) for the resource type at https://review.learn.microsoft.com/azure/azure-monitor/reference/supported-metrics/metrics-index#supported-metrics-per-resource-type, which is autogenerated from underlying systems. Select each link, and on the metric page, select Edit to see the #include link that pulls in the metrics table. Use that link to add the #include. For example:
53+
[!INCLUDE [Microsoft.Storage/storageAccounts/blobServices](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-storage-storageaccounts-blobservices-metrics-include.md)]
54+
Add any further information after each metrics table.
55+
You can also link to the metrics table. Example: - [Microsoft.Storage/storageAccounts/blobServices](/azure/azure-monitor/reference/supported-metrics/microsoft-storage-storageaccounts-blobservices-metrics) -->
56+
57+
### Supported metrics for \<ResourceType/namespace>
58+
The following table lists the metrics available for the \<ResourceType/namespace> resource type.
59+
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
60+
uncomment the following line
61+
<!-- [!INCLUDE [<ResourceType/namespace>](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/<resourcetype>-metrics-include.md)]
62+
63+
<!-- ## Metric dimensions. Required section. -->
64+
[!INCLUDE [horz-monitor-ref-metrics-dimensions-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions-intro.md)]
65+
66+
<!-- If you have metrics with dimensions, use the following include and list the metrics with dimensions after the include.-->
67+
[!INCLUDE [horz-monitor-ref-metrics-dimensions](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions.md)]
68+
<!-- If you DON'T have metrics with dimensions, use the following include:
69+
[!INCLUDE [horz-monitor-ref-no-metrics-dimensions](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-no-metrics-dimensions.md)] -->
70+
71+
<!-- ## Resource logs. Required section. -->
72+
[!INCLUDE [horz-monitor-ref-resource-logs](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-resource-logs.md)]
73+
74+
<!-- Add at least one resource provider/resource type. Repeat the following section for each resource type/namespace in your service.
75+
For each ### section, follow the same instructions as for the metrics tables except find the resource logs for your service at https://review.learn.microsoft.com/azure/azure-monitor/reference/supported-logs/logs-index#supported-log-categories-per-resource-type, which is autogenerated from underlying systems. Example #include:
76+
[!INCLUDE [Microsoft.Storage/storageAccounts/blobServices](~/azure-reference-other-repo/azure-monitor-ref/supported-logs/includes/microsoft-storage-storageaccounts-blobservices-logs-include.md)] -->
77+
78+
### Supported resource logs for \<ResourceType/namespace>
79+
uncomment the following line
80+
<!-- [!INCLUDE [<ResourceType/namespace>](~/azure-reference-other-repo/azure-monitor-ref/supported-logs/includes/<resourcetype>-logs-include.md)]
81+
82+
<!-- ## Azure Monitor Logs tables. Required section. -->
83+
[!INCLUDE [horz-monitor-ref-logs-tables](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-logs-tables.md)]
84+
85+
<!-- Find the table(s) for your service at https://learn.microsoft.com/azure/azure-monitor/reference/tables/tables-resourcetype. These files are auto generated from the REST API.
86+
Link to the service-specific tables. Add any further information after each table link.
87+
88+
IMPORTANT: Field names for Log Analytics may vary from field names for other destinations. Many services need a mapping table to map the fields. -->
89+
90+
### Notification Hubs
91+
<ResourceType/namespace>
92+
- [TableName](/azure/azure-monitor/reference/tables/tablename#columns)
93+
94+
<!-- ## Activity log. Required section.
95+
Refer to https://learn.microsoft.com/azure/role-based-access-control/resource-provider-operations and add the operations for your service. If there are other operations not in the link, list them in table form. -->
96+
97+
[!INCLUDE [horz-monitor-ref-activity-log](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-activity-log.md)]
98+
- [<Namespace> resource provider operations](/azure/role-based-access-control/resource-provider-operations#namespace)
99+
100+
## Related content
101+
102+
- See [Monitor Notification Hubs](monitor-notification-hubs.md) for a description of monitoring Notification Hubs.
103+
- See [Monitor Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource) for details on monitoring Azure resources.

‎articles/notification-hubs/monitor-notification-hubs.md

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
---
2+
title: Monitor Notification Hubs
3+
description: Start here to learn how to monitor Notification Hubs.
4+
ms.date: 03/11/2024
5+
ms.custom: horz-monitor
6+
ms.topic: conceptual
7+
author: GitHub-alias
8+
ms.author: microsoft-alias
9+
ms.service: notification-hubs
10+
---
11+
12+
<!--
13+
According to the Content Pattern guidelines all comments must be removed before publication!!!
14+
15+
IMPORTANT
16+
To make this template easier to use, first:
17+
1. Search and replace Notification Hubs with the official name of your service.
18+
2. Search and replace notification-hubs with the service name to use in GitHub filenames.-->
19+
20+
<!-- VERSION 3.0 2024_01_07
21+
For background about this template, see https://review.learn.microsoft.com/en-us/help/contribute/contribute-monitoring?branch=main -->
22+
23+
<!-- Most services can use the following sections unchanged. The sections use #included text you don't have to maintain, which changes when Azure Monitor functionality changes. Add info into the designated service-specific places if necessary. Remove #includes or template content that aren't relevant to your service.
24+
25+
At a minimum your service should have the following two articles:
26+
27+
1. The primary monitoring article (based on this template)
28+
- Title: "Monitor Notification Hubs"
29+
- TOC title: "Monitor"
30+
- Filename: "monitor-notification-hubs.md"
31+
32+
2. A reference article that lists all the metrics and logs for your service (based on the template data-reference-template.md).
33+
- Title: "Notification Hubs monitoring data reference"
34+
- TOC title: "Monitoring data reference"
35+
- Filename: "monitor-notification-hubs-reference.md".
36+
-->
37+
38+
# Monitor Notification Hubs
39+
40+
<!-- Intro. Required. -->
41+
[!INCLUDE [horz-monitor-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-intro.md)]
42+
43+
<!-- ## Insights. Optional section. If your service has insights, add the following include and add information about what your Azure Monitor insights provide. You can refer to another article that gives details or add a screenshot.
44+
[!INCLUDE [horz-monitor-insights](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-insights.md)] -->
45+
46+
<!-- ## Resource types. Required section. -->
47+
[!INCLUDE [horz-monitor-resource-types](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-resource-types.md)]
48+
For more information about the resource types for Notification Hubs, see [Notification Hubs monitoring data reference](monitor-notification-hubs-reference.md).
49+
50+
<!-- ## Data storage. Required section. Optionally, add service-specific information about storing your monitoring data after the include. -->
51+
[!INCLUDE [horz-monitor-data-storage](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-data-storage.md)]
52+
53+
<!-- METRICS SECTION START ------------------------------------->
54+
55+
<!-- ## Azure Monitor platform metrics. Required section. -->
56+
[!INCLUDE [horz-monitor-platform-metrics](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-platform-metrics.md)]
57+
58+
For a list of available metrics for Notification Hubs, see [Notification Hubs monitoring data reference](monitor-notification-hubs-reference.md#metrics).
59+
60+
<!-- If your service doesn't collect Azure Monitor platform metrics, use the following include: [!INCLUDE [horz-monitor-no-platform-metrics](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-no-platform-metrics.md)] -->
61+
62+
<!-- Currently unused?:
63+
## Prometheus/container metrics. Optional. [!INCLUDE [horz-monitor-container-metrics](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-container-metrics.md)]
64+
## System metrics. Optional. [!INCLUDE [horz-monitor-system-metrics](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-system-metrics.md)]
65+
## Custom metrics. Optional. [!INCLUDE [horz-monitor-custom-metrics](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-custom-metrics.md)]
66+
67+
<!-- ## Notification Hubs metrics
68+
Optional. If your service uses any non-Azure Monitor based metrics, add the following include and more information.
69+
[!INCLUDE [horz-monitor-custom-metrics](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-non-monitor-metrics.md)] -->
70+
71+
<!-- METRICS SECTION END ------------------------------------->
72+
73+
<!-- LOGS SECTION START -------------------------------------->
74+
75+
<!-- ## Azure Monitor resource logs. Required section.
76+
NOTE: Azure Monitor already has general information on how to configure and route resource logs. See https://learn.microsoft.com/azure/azure-monitor/platform/diagnostic-settings. Ideally, don't repeat that information here. You can provide a single screenshot of the diagnostic settings portal experience if you want. -->
77+
78+
[!INCLUDE [horz-monitor-resource-logs](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-resource-logs.md)]
79+
80+
For the available resource log categories, their associated Log Analytics tables, and the logs schemas for Notification Hubs, see [Notification Hubs monitoring data reference](monitor-notification-hubs-reference.md#resource-logs).
81+
82+
<!-- Resource logs service-specific information. Add service-specific information about your resource logs here. -->
83+
84+
<!-- If your service doesn't collect resource logs, use the following include [!INCLUDE [horz-monitor-no-resource-logs](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-no-resource-logs.md)] -->
85+
86+
<!-- ## Activity log. Required section. Optionally, add service-specific information about your activity log after the include. -->
87+
[!INCLUDE [horz-monitor-activity-log](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-activity-log.md)]
88+
89+
<!-- Currently unused?:
90+
<!-- ## Imported logs. Optional section. If your service uses imported logs, add the following include and information.
91+
[!INCLUDE [horz-monitor-imported-logs](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-imported-logs.md)] -->
92+
93+
<!-- ## Notification Hubs logs
94+
Optional. If your service uses any non-Azure Monitor based logs, add the preceding H2 heading and more information. -->
95+
96+
<!-- LOGS SECTION END ------------------------------------->
97+
98+
<!-- ANALYSIS SECTION START -------------------------------------->
99+
100+
<!-- ## Analyze monitoring data. Required section. -->
101+
[!INCLUDE [horz-monitor-analyze-data](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-analyze-data.md)]
102+
103+
<!-- ### Azure Monitor export tools. Required section. -->
104+
[!INCLUDE [horz-monitor-external-tools](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-external-tools.md)]
105+
106+
<!-- ## Notification Hubs analytics. Optional section. If your service has non-Monitor analytics, add information.
107+
108+
<!-- ## Kusto queries. Required section. Add sample Kusto queries for your service after the include. -->
109+
[!INCLUDE [horz-monitor-kusto-queries](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-kusto-queries.md)]
110+
<!-- Add sample Kusto queries for your service here. -->
111+
112+
Add short information or links to specific articles that outline how to analyze data for your service. -->
113+
114+
<!-- ANALYSIS SECTION END ------------------------------------->
115+
116+
<!-- ALERTS SECTION START -------------------------------------->
117+
118+
<!-- ## Alerts. Required section. -->
119+
[!INCLUDE [horz-monitor-alerts](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-alerts.md)]
120+
121+
<!-- ONLY if your service (Azure VMs, AKS, or Log Analytics workspaces) offer out-of-the-box recommended alerts, add the following include.
122+
[!INCLUDE [horz-monitor-insights-alerts](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-recommended-alert-rules.md)]
123+
124+
<!-- ONLY if applications run on your service that work with Application Insights, add the following include.
125+
[!INCLUDE [horz-monitor-insights-alerts](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-insights-alerts.md)]
126+
127+
<!-- ### Notification Hubs alert rules. Required section.
128+
**MUST HAVE** service-specific alert rules. Include useful alerts on metrics, logs, log conditions, or activity log.
129+
Fill in the following table with metric and log alerts that would be valuable for your service. Change the format as necessary for readability. You can instead link to an article that discusses your common alerts in detail.
130+
Ask your PMs if you don't know. This information is the BIGGEST request we get in Azure Monitor, so don't avoid it long term. People don't know what to monitor for best results. Be prescriptive. -->
131+
132+
### Notification Hubs alert rules
133+
134+
The following table lists some suggested alert rules for Notification Hubs. These alerts are just examples. You can set alerts for any metric, log entry, or activity log entry that's listed in the [Notification Hubs monitoring data reference](monitor-notification-hubs-reference.md).
135+
136+
| Alert type | Condition | Description |
137+
|:---|:---|:---|
138+
| | | |
139+
| | | |
140+
141+
<!-- ### Advisor recommendations. Required section. -->
142+
[!INCLUDE [horz-monitor-advisor-recommendations](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-advisor-recommendations.md)]
143+
<!-- Add any service-specific advisor recommendations or screenshots here. -->
144+
145+
<!-- ALERTS SECTION END -------------------------------------->
146+
147+
## Related content
148+
<!-- You can change the wording and add more links if useful. -->
149+
150+
- See [Notification Hubs monitoring data reference](monitor-notification-hubs-reference.md) for a reference of the metrics, logs, and other important values created for Notification Hubs.
151+
- See [Monitoring Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource) for general details on monitoring Azure resources.

0 commit comments

Comments
 (0)