Skip to content

Commit df5d7f8

Browse files
committed
Added screenshot
1 parent 9de24d3 commit df5d7f8

File tree

3 files changed

+27
-31
lines changed

3 files changed

+27
-31
lines changed
56.8 KB
Loading

articles/search/search-manage.md

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -78,33 +78,22 @@ You can also use the management client libraries in the Azure SDKs for .NET, Pyt
7878

7979
## Data collection and retention
8080

81-
Cognitive Search collects service data for monitoring and troubleshooting purposes.
81+
Because Azure Cognitive Search is a [monitored resource](/azure/azure-monitor/monitor-reference), you can review the built-in [**activity logs**](/azure/azure-monitor/essentials/activity-log) and [**platform metrics**](/azure/azure-monitor/essentials/data-platform-metrics#types-of-metrics) for insights into service operations. Activity logs and the data used to report on platform metrics are retained for the periods described in the following table.
8282

83-
Platform metrics are found on the portal pages of your service. It includes query latency, queries per second, and queries throttled during indexing. This data is stored on a rolling 93-day cycle, but portal visualization is limited to a 30 day window. Data collection and reporting of these metrics occurs automatically as part of the portal experience and is non-configurable.
83+
If you opt in for [**resource logging**](/azure/azure-monitor/essentials/resource-logs), you'll specify durable storage over which you'll have full control over data retention and data access through Kusto queries. For more information on how to set up resource logging in Cognitive Search, see [Collect and analyze log data](monitor-azure-cognitive-search.md).
8484

85-
Durable monitoring data is collected when you opt-in for diagnostic logging. When monitoring and diagnostic requirements exceed what the portal provides automatically, you can add [Azure Monitor](../azure-monitor/index.yml) and adopt a supported approach for retaining log data. For more information, see [Collect and analyze log data](monitor-azure-cognitive-search.md).
85+
Internally, Microsoft collects telemetry data about your service and the platform. It's stored internally in Microsoft data centers and made globally available to Microsoft support engineers when you open a support ticket.
8686

87-
Internally, Microsoft Support collects telemetry data to support your service and the platform. Telemetry data is retained for one and one half years. It's stored internally in Microsoft data centers and made globally available to Microsoft support engineers when you open a support ticket.
87+
| Monitoring data | Retention |
88+
|-----------------|-----------|
89+
| Activity logs | 90 days on a rolling schedule |
90+
| Platform metrics | 93 days on a rolling schedule, except that portal visualization is limited to a 30 day window |
91+
| Resource logs | User-managed |
92+
| Telemetry | One and a half years |
8893

89-
Frequently, customers need specific details about data collection, residency, and retention. Documentation about data privacy and retention can be found in the ["Data residency"](search-security-overview.md#data-residency) section of the security overview.
94+
> [!NOTE]
95+
> This section is about monitoring data. For questions about customer data and privacy, see the ["Data residency"](search-security-overview.md#data-residency) section of the security overview article.
9096
91-
<!-- Cognitive Search uses other Azure services for deeper monitoring and management. On the search service itself, the only saved customer data are the structures that support indexing, enrichment, and queries. These data structures include indexes, indexers, data sources, skillsets, and synonym maps. All other saved customer data, including debug session state and caching, is stored in Azure Storage.
92-
93-
Usage metrics (such as query latency and queries per second) are reported out to portal pages. These metrics are pulled from internal logs on a rolling 30-day cycle. Data collection and reporting of these metrics on the portal pages occurs automatically as part of the portal experience.
94-
95-
If your monitoring and diagnostic requirements exceed what the portal provides, you can add [Azure Monitor](../azure-monitor/index.yml) and adopt a supported approach for retaining log data. For more information about setting up resource logging for a search service, see [Collect and analyze log data](monitor-azure-cognitive-search.md).
96-
97-
Internally, Azure Cognitive Search retains telemetry for a longer period (more than 30 days) so that support engineers can troubleshoot problems on your service. Data retention for telemetry is one and a half years. During that period, support engineers might access and reference this data under these conditions:
98-
99-
* Diagnose an issue, improve a feature, or fix a bug.
100-
* Proactively suggest to the original customer a workaround or alternative to a problem detected by Microsoft Support.
101-
102-
You can [file a support ticket](/azure/azure-portal/supportability/how-to-create-azure-support-request) to remove object names from the telemetry logs or to shorten the retention period. You should specify the following categories when filing this request:
103-
104-
+ **Issue type**: Technical
105-
+ **Problem type**: Setup and configuration
106-
+ **Problem subtype**: Issue with security configuration of the service
107-
-->
10897
## Administrator permissions
10998

11099
When you open the search service overview page, the Azure role assigned to your account determines what portal content is available to you. The overview page at the beginning of the article shows the portal content available to an Owner or Contributor.

articles/search/search-security-overview.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -160,29 +160,36 @@ In Azure Cognitive Search, Resource Manager is used to create or delete the serv
160160
161161
## Data residency
162162

163-
When you set up a search service, you choose a location or region that determines where data is stored and processed. Azure Cognitive Search won't store data outside of your specified region unless you configure a feature that has a dependency on another Azure resource, and that resource is provisioned in a different region.
163+
When you set up a search service, you choose a location or region that determines where customer data is stored and processed. Azure Cognitive Search won't store customer data outside of your specified region unless you configure a feature that has a dependency on another Azure resource, and that resource is provisioned in a different region.
164164

165-
Currently, the only external resource that a search service writes to is Azure Storage. The storage account is one that you provide, and it could be in any region. A search service will write to Azure Storage if you use any of the following features: [enrichment cache](cognitive-search-incremental-indexing-conceptual.md), [debug session](cognitive-search-debug-session.md), [knowledge store](knowledge-store-concept-intro.md).
165+
Currently, the only external resource that a search service writes customer data to is Azure Storage. The storage account is one that you provide, and it could be in any region. A search service will write to Azure Storage if you use any of the following features: [enrichment cache](cognitive-search-incremental-indexing-conceptual.md), [debug session](cognitive-search-debug-session.md), [knowledge store](knowledge-store-concept-intro.md).
166166

167167
### Exceptions to data residency commitments
168168

169-
Although data isn't stored outside of your region, some elements of customer data are collected during routine service monitoring and retained in telemetry logs for global access by Microsoft support engineers. For a search service, this customer data consists of the *names* of indexes, indexers, data sources, skillsets, containers, and key vault store.
169+
Although customer data isn't stored outside of your region, the names of user-defined objects are collected during routine service monitoring and retained in telemetry logs for global access by Microsoft support engineers. For a search service, this customer data consists of the names of indexes, indexers, data sources, skillsets, containers, and key vault store.
170170

171-
These names aren't obfuscated in the telemetry logs. If possible, when naming objects, avoid names that convey sensitive information.
171+
Object names aren't obfuscated in the telemetry logs. If possible, avoid using names that convey sensitive information.
172172

173173
Telemetry logs are retained for one and a half years. During that period, support engineers might access and reference object names under these conditions:
174174

175175
+ Diagnose an issue, improve a feature, or fix a bug. In this scenario, data access is internal only, with no third-party access.
176176

177-
+ Proactively suggest to the original customer a workaround or alternative to a problem detected by Microsoft Support. For example, "Based on your usage of the product, consider using `<feature name>` since it would perform better." In this scenario, Microsoft might expose an object name through dashboards visible to the customer.
177+
+ Proactively suggest to the original customer a workaround or alternative. For example, "Based on your usage of the product, consider using `<feature name>` since it would perform better." In this scenario, Microsoft might expose an object name through dashboards visible to the customer.
178178

179179
Upon request, Microsoft can shorten the retention interval or remove references to specific objects in the telemetry logs. Remember that if you request data removal, the trade off is reduced ability to troubleshoot any issues related to the object in question.
180180

181-
To remove references to specific objects, or to change the data retention period, [file a support ticket](/azure/azure-portal/supportability/how-to-create-azure-support-request) for your search service, categorized as follows:
181+
To remove references to specific objects, or to change the data retention period, [file a support ticket](/azure/azure-portal/supportability/how-to-create-azure-support-request) for your search service.
182+
183+
1. In **Problem details**, tag your request using the following selections:
184+
185+
+ **Issue type**: Technical
186+
+ **Problem type**: Setup and configuration
187+
+ **Problem subtype**: Issue with security configuration of the service
188+
189+
1. In **Additional details**, describe the object names you would like removed, or specify the retention period that you require.
190+
191+
:::image type="content" source="media/search-security-overview/support-request.png" alt-text="First page of the support ticket with issue and problem types selected." border="true":::
182192

183-
+ **Issue type**: Technical
184-
+ **Problem type**: Setup and configuration
185-
+ **Problem subtype**: Issue with security configuration of the service
186193

187194
<a name="encryption"></a>
188195

0 commit comments

Comments
 (0)