Skip to content

Commit 668ef14

Browse files
authored
Merge branch 'main' into hpal_azure_doc_fixes
2 parents a23d4cf + 2b8c6a4 commit 668ef14

File tree

16 files changed

+377
-82
lines changed

16 files changed

+377
-82
lines changed

docs/integrations/amazon-aws/amazon-ec2-auto-scaling.md

Lines changed: 206 additions & 11 deletions
Large diffs are not rendered by default.

docs/integrations/microsoft-azure/azure-key-vault.md

Lines changed: 88 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
88

99
<img src={useBaseUrl('img/integrations/microsoft-azure/azure-key-vault.png')} alt="Thumbnail icon" width="50"/>
1010

11-
[Azure Key Vault](https://learn.microsoft.com/en-us/azure/iot-hub/iot-concepts-and-iot-hub) is a managed service hosted in the cloud that acts as a central message hub for communication between an IoT application and its attached devices. This integration helps in comprehensive monitoring of your key vaults requests, performance, failures, and latency.
11+
[Azure Key Vault](https://learn.microsoft.com/en-us/azure/key-vault/general/overview) is a managed service hosted in the cloud that acts as a central message hub for communication between an IoT application and its attached devices. This integration helps in comprehensive monitoring of your key vaults requests, performance, failures, and latency.
1212

1313
## Log and metric types
1414

1515
For Azure Key Vault, you can collect the following logs and metrics:
1616

17-
* **Resource logs**. To learn more about the different resource log category types and schemas collected for Azure Key Vault, refer to [Azure documentation](https://learn.microsoft.com/en-gb/azure/key-vault/general/monitor-key-vault-reference#resource-logs).
18-
* **Key Vault Metrics**. These metrics are available in [Microsoft.KeyVault/vaults](https://learn.microsoft.com/en-gb/azure/azure-monitor/essentials/metrics-supported#microsoftkeyvaultvaults) namespace.
19-
* **Managed HSM Metrics**. These metrics are available in [Microsoft.KeyVault/managedhsms](https://learn.microsoft.com/en-gb/azure/azure-monitor/essentials/resource-logs-categories#microsoftkeyvaultmanagedhsms) namespace.
17+
* **Resource logs**. To learn more about the different resource log category types and schemas collected for Azure Key Vault, refer to [Azure documentation](https://learn.microsoft.com/en-us/azure/key-vault/general/monitor-key-vault-reference#resource-logs).
18+
* **Key Vault Metrics**. These metrics are available in [Microsoft.KeyVault/vaults](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-keyvault-vaults-metrics) namespace.
19+
* **Managed HSM Metrics**. These metrics are available in [Microsoft.KeyVault/managedhsms](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-keyvault-managedhsms-metrics) namespace.
2020

2121
For more information on supported metrics and their units, refer to the [Azure documentation](https://learn.microsoft.com/en-gb/azure/key-vault/general/monitor-key-vault-reference#key-vault-metrics).
2222

@@ -33,25 +33,96 @@ When you configure the event hubs source or HTTP source, plan your source catego
3333

3434
### Configure metrics collection
3535

36-
In this section, you will configure a pipeline for shipping metrics from Azure Monitor to an Event Hub, on to an Azure Function, and finally to an HTTP Source on a hosted collector in Sumo Logic.
36+
:::note
37+
Sumo Logic Metrics source is currently in Beta, to participate, contact your Sumo Logic account executive.
38+
:::
3739

38-
1. Create hosted collector and tag tenant_name field. You can get the tenant name using the instructions [here](https://learn.microsoft.com/en-us/azure/active-directory-b2c/tenant-management-read-tenant-name#get-your-tenant-name). <br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Tenant-Name.png')} alt="Azure Tag Tenant Name" style={{border: '1px solid gray'}} width="500" />
39-
1. [Configure an HTTP Source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-1-configure-an-http-source).
40-
1. [Configure and deploy the ARM Template](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-2-configure-azure-resources-using-arm-template).
41-
1. [Export metrics to Event Hub](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-3-export-metrics-for-a-particular-resource-to-event-hub). Perform below steps for each Key Vault that you want to monitor.
42-
* Choose `Stream to an event hub` as destination.
43-
* Select `AllMetrics`.
44-
* Use the Event hub namespace created by the ARM template in Step 2 above. You can create a new Event hub or use the one created by ARM template. You can use the default policy `RootManageSharedAccessKey` as the policy name.
40+
1. To set up the Azure Metrics source in Sumo Logic, refer to the shared beta documentation.
41+
1. In the Sumo Logic Azure Metrics source configuration, configure namespaces as `Microsoft.KeyVault/vaults` and `Microsoft.KeyVault/managedhsms`.
42+
<img src={useBaseUrl('img/integrations/microsoft-azure/azure-key-vaults-namespaces.png')} alt="Azure Key Vaults Namespaces" style={{border: '1px solid gray'}} width="500" />
4543

4644
### Configure logs collection
4745

4846
In this section, you will configure a pipeline for shipping diagnostic logs from Azure Monitor to an Event Hub.
49-
47+
#### Diagnostic logs
5048
1. To set up the Azure Event Hubs source in Sumo Logic, refer to [Azure Event Hubs Source for Logs](/docs/send-data/collect-from-other-data-sources/azure-monitoring/ms-azure-event-hubs-source/).
51-
2. To create the Diagnostic settings in Azure portal, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/diagnostic-settings?tabs=portal#create-diagnostic-settings) for Key Vault resource. Perform below steps for each Key Vault that you want to monitor.
52-
* Choose `Stream to an event hub` as the destination.
53-
* Select `allLogs`.
54-
* Use the Event hub namespace and Event hub name configured in previous step in destination details section. You can use the default policy `RootManageSharedAccessKey` as the policy name.
49+
1. To create the Diagnostic settings in Azure portal, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/diagnostic-settings?tabs=portal#create-diagnostic-settings). Perform the steps below for each Azure Key Vault namespace that you want to monitor.
50+
1. Choose `Stream to an event hub` as the destination.
51+
1. Select `allLogs`.
52+
1. Use the Event Hub namespace and Event Hub name configured in the previous step in the destination details section. You can use the default policy `RootManageSharedAccessKey` as the policy name.<br/><img src={useBaseUrl('img/send-data/azure-eventgrid-logs.png')} alt="Azure Event Grid logs" style={{border: '1px solid gray'}} width="800" />
53+
1. Tag the location field in the source with the right location value. <br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Location.png')} alt="Azure Key Vaults Tag Location" style={{border: '1px solid gray'}} width="400" />
54+
55+
#### Activity Logs
56+
57+
To collect activity logs, refer to the [Collecting Logs for the Azure Audit App from Event Hub](/docs/integrations/microsoft-azure/audit) section in the Azure Audit documentation. Do not perform this step in case you are already collecting activity logs for a subscription.
58+
:::note
59+
Since this source contains logs from multiple regions, make sure that you do not tag this source with the location tag.
60+
:::
61+
62+
## Viewing the Azure Key Vault dashboards
63+
64+
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
65+
66+
<ViewDashboards/>
67+
68+
### Overview
69+
70+
**Azure Key Vaults - Overview** dashboard allows you to monitor and analyze your key vault's usage metrics, including API hits, vault usage, and average latencies. Gain insights into the performance of your vaults.
71+
72+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Overview.png')} alt="Azure Key Vault - Overview dashboard" style={{border: '1px solid gray'}} width="800" />
73+
74+
### Operations Overview
75+
76+
**Azure Key Vaults - Operations** Overview dashboard provides insights of operational logs for your key vaults. Monitor key, secret, and certificate operations, including creation, storage, deletion, retrieval, setting, and recovery. Gain insights into key activities for effective management.
77+
78+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Operations-Overview.png')} alt="Azure Key Vault - Operations Overview dashboard" style={{border: '1px solid gray'}} width="800" />
79+
80+
### Operations Detailed
81+
82+
**Azure Key Vaults - Operations Detailed** dashboard provides insights of operational logs for your key vaults. Monitor key, secret, and certificate operations, including creation, storage, deletion, retrieval, setting, and recovery in detailed views. Gain insights into key activities for effective management.
83+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Operations-Detailed.png')} alt="Azure Key Vault - Operations Detailed dashboard" style={{border: '1px solid gray'}} width="800" />
84+
85+
### Errors and Failures
86+
87+
**Azure Key Vaults - Errors and Failures** dashboard provides detailed information on what is happening (errors or recent failure events) in a Key Vault.
88+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Errors-and-Failures.png')} alt="Azure Key Vault - Errors and Failures dashboard" style={{border: '1px solid gray'}} width="800" />
89+
90+
### Administrative Operations
91+
92+
**Azure Key Vaults - Administrative Operations** dashboard provides details on the operational activities and status of your Azure Key Vaults resources Use this dashboard to monitor the distribution of operation types and their success rates to ensure proper functioning of your Key Vaults. Identify potential issues by analyzing the top operations causing errors and correlating them with specific users or applications. Track recent write and delete operations to maintain an audit trail of changes made to your Key Vaults.
93+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Administrative-Operations.png')} alt="Azure Key Vault - Administrative Operations dashboard" style={{border: '1px solid gray'}} width="800" />
94+
95+
### Policy and Recommendations
96+
97+
**Azure Key Vaults - Policy and Recommendations** dashboard provides details on policy events and recommendations for your Azure Key Vaults resources. Use this dashboard to monitor the success and failure rates of policy events to ensure proper configuration and compliance. Track and analyse recent recommendations to improve the performance and security of your Vaults setup. Identify trends in policy events and recommendations over time to proactively address potential issues.
98+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Policy-and-Recommendations.png')} alt="Azure Key Vault - Policy and Recommendations dashboard" style={{border: '1px solid gray'}} width="800" />
99+
100+
### Vault Health
101+
102+
**Azure Key Vaults - Vault Health** dashboard allows you to monitor and analyze your key vault's usage metrics, including API hits, vault usage, and average latencies. Gain insights into the health of your vaults.
103+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Vault-Health.png')} alt="Azure Key Vault - Vault Health dashboard" style={{border: '1px solid gray'}} width="800" />
104+
105+
### Compliance
106+
107+
**Azure Key Vaults - Compliance** dashboard provides detailed information on what is happening with polices and compliance related events in a Key Vault and gives an overview of the objects (Keys, Secrets, etc) are adhering to specific compliance and policies in Azure.
108+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Compliance.png')} alt="Azure Key Vault - Compliance dashboard" style={{border: '1px solid gray'}} width="800" />
109+
110+
## Create monitors for Azure Key Vaults app
111+
112+
import CreateMonitors from '../../reuse/apps/create-monitors.md';
113+
114+
<CreateMonitors/>
115+
116+
### Azure Key Vaults alerts
117+
These alerts are metric based and will work for all Key Vaults.
118+
119+
| Alert Name | Alert Description and Conditions | Alert Condition | Recover Condition |
120+
|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------|:----------------|:------------------|
121+
| `Azure Key Vaults - Availability drops below 100%` | This alert is triggered when availability drops under 100% are detected for any Key Vaults. | Count < 100 | Count = 100 |
122+
| `Azure Key Vaults - Keys, Secrets, Certificates Expired Alert` | This alert triggers when any Keys, Secrets, or Certificates have expired for any Key Vaults. | Count >= 1 | Count < 1 |
123+
| `Azure Key Vaults - Keys, Secrets, Certificates Near Expiry Alert` | This alert triggers when any Keys, Secrets, or Certificates are near expiry for any Key Vaults. | Count >= 1 | Count < 1 |
124+
| `Azure Key Vaults - Latency is greater than 1000 ms` | This alert is triggered when latency of Vaults goes above 1000ms. | Count >= 1000 | Count < 1000 |
125+
| `Azure Key Vaults - Overall Vault Saturation is greater than 75%` | This alert is triggered when Overall vault saturation of any vaults is greater than 75%. | Count >= 75 | Count < 75 |
55126

56127
## Troubleshooting
57128

docs/integrations/sumo-apps/kickstart-data.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,18 +33,41 @@ import ViewDashboards from '../../reuse/apps/view-dashboards.md';
3333

3434
<ViewDashboards/>
3535

36-
### Application Health
36+
### Sumo Logic Kickstart Data - Application Health
3737

38-
The **Sumo Logic Kickstart Data - Application Health** dashboard provides a comprehensive view of the application's performance and operational metrics. It includes key indicators such as CPU and memory usage, transaction times for checkouts and payments, error rates, and service latency. Additionally, it displays deployment logs, user journeys, and error logs, allowing users to quickly identify issues and monitor the overall health of the application.
38+
The **Sumo Logic Logic Kickstart Data - Application Health** dashboard provides details on user journey, interface performance, and internal server metrics for an e-commerce application.
39+
40+
Use this dashboard to:
41+
* Monitor the user journey funnel from home page visits to completed payments, identifying potential drop-off points in the conversion process.
42+
* Track key performance indicators such as page load times, transaction times, and error rates for critical application components like the home page, checkout, and payment processes.
43+
* Correlate spikes in transaction times with potential increases in errors to quickly identify and troubleshoot performance issues affecting user experience.
44+
* Analyze the relationship between order volumes and order transaction times to ensure the internal server can handle peak loads efficiently.
3945

4046
<img src={useBaseUrl('img/integrations/sumo-apps/Sumo-Logic-Kickstart-Data-Application-Health-Dashboard.png')} style={{border: '1px solid gray'}} alt="test" />
4147

42-
### Business KPIs
48+
### Sumo Logic Kickstart Data - Business KPIs
49+
50+
The **Sumo Logic Kickstart Data - Business KPIs** dashboard provides details on revenue metrics, geographical distribution, and user journey time for business performance analysis.
4351

44-
The **Sumo Logic Kickstart Data - Business KPIs** dashboard focuses on critical business performance metrics. It tracks customer satisfaction, support tickets, revenue trends, and promotional offers redeemed. This dashboard also monitors customer churn rates and cart abandonment rates, providing insights into user engagement and revenue distribution globally. These metrics help businesses make informed decisions to enhance customer experiences and drive growth.
52+
Use this dashboard to:
53+
* Monitor revenue trends and forecast future earnings to make informed business decisions.
54+
* Analyze revenue distribution across different geographical regions to identify high-performing markets and areas for expansion.
55+
* Compare actual user journey time against expected values to optimize user experience and identify potential bottlenecks in the customer flow.
56+
* Correlate revenue trends with user journey time to understand how user experience impacts business performance.
4557

4658
<img src={useBaseUrl('img/integrations/sumo-apps/Sumo-Logic-Kickstart-Data-Business-KPIs-Dashboard.png')} style={{border: '1px solid gray'}} alt="test" />
4759

60+
### Sumo Logic Kickstart Data - Security
61+
62+
The **Sumo Logic Kickstart Data - Security** dashboard provides details on security events and failed sign-in attempts across multiple geographical locations. This dashboard enables users to monitor and analyze security-related data in real-time.
63+
64+
Use this dashboard to:
65+
* Identify potential security threats by visualizing the geolocation of clients and the volume of activity from different regions.
66+
* Compare failed sign-in events between today and yesterday for specific user accounts, helping to detect unusual patterns or potential brute-force attacks.
67+
* Monitor the total number of failed sign-in events over the last 6 hours, allowing for quick identification of spikes in unsuccessful login attempts.
68+
69+
<img src={useBaseUrl('img/integrations/sumo-apps/Sumo-Logic-Kickstart-Data-Security-Dashboard.png')} style={{border: '1px solid gray'}} alt="test" />
70+
4871
## Create monitors for the Sumo Logic Kickstart Data app
4972

5073
import CreateMonitors from '../../reuse/apps/create-monitors.md';

docs/metrics/metrics-operators/fillmissing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ _sourceCategory=Labs/VMWare6.5/Metrics hostname=thisveryhost metric=cpu_ready
3535
The chart in this section shows metric query results with the `fillmissing` operator with the `empty` option. Note that empty time slices are not filled with a derived data point. 
3636

3737
```sql
38-
_sourcecategory=labs/aws/host/metrics metric=CPU_Idle
38+
_sourceCategory=labs/aws/host/metrics metric=CPU_Idle
3939
| avg by _sourcename
4040
| fillmissing empty
4141
```

docs/platform-services/automation-service/app-central/integrations/servicenow-v2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ ServiceNow V2 SaaS is for technical management support - create, update, and gat
2222

2323
## ServiceNow V2 in Automation Service and Cloud SOAR
2424

25-
1. Access integrations in the [Automation Service](/docs/platform-services/automation-service/automation-service-integrations/#view-integrations) or [Cloud SOAR](/docs/cloud-soar/automation).2.png')}
25+
1. Access integrations in the [Automation Service](/docs/platform-services/automation-service/automation-service-integrations/#view-integrations) or [Cloud SOAR](/docs/cloud-soar/automation).
2626
1. After the list of the integrations appears, search for the integration and click on the row.
2727
1. The integration details will appear. Click on the **"+"** button to add new Resource.<br/><img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/servicenow-v2/servicenow-v2-3.png')} style={{border:'1px solid gray'}} alt="servicenow" width="400"/>
2828
1. Populate all the required fields (\*):

0 commit comments

Comments
 (0)