Merge pull request #226729 from seesharprun/cosmos-cassandra-metrics-mv-faq

Cosmos DB | Added materialized view metrics screenshots

Author: v-dirichards

articles/cosmos-db/cassandra/TOC.yml

@@ -264,7 +264,11 @@
         - name: Preventing rate-limiting errors
           href: prevent-rate-limiting-errors.md
         - name: Materialized View (Preview)
-          href: materialized-views.md
+          items:
+            - name: Overview            
+              href: materialized-views.md
+            - name: FAQ
+              href: materialized-views-faq.yml
         - name: Lightweight Transactions in API for Apache Cassandra
           href: lightweight-transactions.md
         - name: Change feed for API for Apache Cassandra

articles/cosmos-db/cassandra/materialized-views-faq.yml

@@ -8,7 +8,7 @@ metadata:
   ms.service: cosmos-db
   ms.subservice: apache-cassandra
   ms.topic: faq
-  ms.date: 11/17/2022
+  ms.date: 02/08/2023
 title: Frequently asked questions on materialized views in Azure Cosmos DB for Apache Cassandra (preview)
 summary: |
   [!INCLUDE[Cassandra](../includes/appliesto-cassandra.md)]
@@ -24,19 +24,19 @@ sections:
           - Filtering rows from a base table in the materialized view based on conditions evaluated on primary key columns of the base table row. 
             - Filters supported include: equalities, inequalities, and contains.
       - question: |
-          What consistency levels will be supported with materialized views in Azure Cosmos DB for Apache Cassandra?
+          What consistency levels are supported with materialized views in Azure Cosmos DB for Apache Cassandra?
         answer: |
           Only eventual consistency is guaranteed on the materialized view. You may read stale rows when compared to data on base table due to retrying some operations on materialized views. 
           
           You can scale up or scale down the materialized view builder layer depending on your latency requirements for the view to be consistent with base table.
       - question: |
-          Will there be an autoscale layer for the materialized view builder instances in Azure Cosmos DB for Apache Cassandra?
+          Is there an autoscale layer for the materialized view builder instances in Azure Cosmos DB for Apache Cassandra?
         answer: |
           Autoscaling for the materialized view builder isn't available right now. The materialized view builder instances can be manually scaled by modifying the instance count or size.
       - question: |
           What type of time to live (TTL) support do we have with materialized views in Azure Cosmos DB for Apache Cassandra?
         answer: |
-          Time to live (TTL) from base table rows will be applied on the matching row in the materialized view. Setting table-level TTL on materialized views is currently not allowed.
+          Time to live (TTL) from base table rows is applied on the matching row in the materialized view. Setting table-level TTL on materialized views is currently not allowed.
       - question: |
           How can we troubleshoot materialized views that aren't up to date in Azure Cosmos DB for Apache Cassandra?
         answer: |
@@ -47,13 +47,17 @@ sections:
           The following metrics are available:
 
           - **Max Materialized View Catchup Gap in Minutes**: The value `t` indicates rows written to base table in last `t` minutes that are yet to be propagated to the materialized view.
+            :::image type="content" source="media/materialized-views-faq/catchup-metrics.png" lightbox="media/materialized-views-faq/catchup-metrics.png" alt-text="Screenshot of the Catchup metrics for materialized views in Azure Cosmos DB for Apache Cassandra.":::
           - **Read change feed cost**: Request units consumed on the base table to read data for the materialized view.
+            :::image type="content" source="media/materialized-views-faq/cpu-usage-metrics.png" lightbox="media/materialized-views-faq/cpu-usage-metrics.png" alt-text="Screenshot of the CPU Usage metrics for materialized views in Azure Cosmos DB for Apache Cassandra.":::
           - **Write cost**: Request units consumed on the materialized view to transform and persist data that was read from the base table.
+            :::image type="content" source="media/materialized-views-faq/max-cpu-metrics.png" lightbox="media/materialized-views-faq/max-cpu-metrics.png" alt-text="Screenshot of the Memory metrics for materialized views in Azure Cosmos DB for Apache Cassandra.":::
           - Other metrics related to typical resource consumption on materialized view builders. These metrics include **CPU** and **memory usage**.
+            :::image type="content" source="media/materialized-views-faq/memory-metrics.png" lightbox="media/materialized-views-faq/memory-metrics.png" alt-text="Screenshot of the Max CPU metrics for materialized views in Azure Cosmos DB for Apache Cassandra.":::
       - question: |
           What are the restore options available for materialized views in Azure Cosmos DB for Apache Cassandra?
         answer: |
-          Materialized views can't be restored. Hence, thee views will need to be recreated once the base table is restored.
+          Materialized views can't be restored. Hence, thee views need to be recreated once the base table is restored.
       - question: |
           Can you create more than one materialized view on a single base table in Azure Cosmos DB for Apache Cassandra?
         answer: |
@@ -65,7 +69,7 @@ sections:
       - question: |
           Can we add or remove columns on the base table once a materialized view is defined in Azure Cosmos DB for Apache Cassandra?
         answer: |
-          You'll be able to add a column to the base table, but you can't remove a column. After a materialized view is created against a base table, `ALTER TABLE ADD`` operations aren't allowed on the base table. `ALTER TABLE ADD` operations are only allowed if none of the views have selected `*`` in their definition. 
+          You're able to add a column to the base table, but you can't remove a column. After a materialized view is created against a base table, `ALTER TABLE ADD`` operations aren't allowed on the base table. `ALTER TABLE ADD` operations are only allowed if none of the views have selected `*`` in their definition. 
           
           Apache Cassandra doesn't support dropping columns on the base table if it has a materialized view defined on it.
       - question: |
@@ -77,14 +81,14 @@ sections:
           
           To use materialized views, create a new table after the feature is enabled.
       - question: |
-          What are the conditions on which records won't make it to a materialized view in Azure Cosmos DB for Apache Cassandra?
+          What conditions can cause records to not make it to a materialized view in Azure Cosmos DB for Apache Cassandra?
         answer: |
-          Below are some of the identified cases where data from a base table can't be written to materialized view as they violate known constraints on a materialized view table:
+          Here are some of the identified cases where data from a base table can't be written to materialized view as they violate known constraints on a materialized view table:
           
           - Rows that don't satisfy partition key size (2 kb) limit in the materialized views
           - Rows that don't satisfy clustering key size (1 kb) limit in materialized views
 
-          Currently, the builder will drop these rows.
+          Currently, the builder drops these rows.
       - question: |
           Can we use materialized views with customer-managed keys in Azure Cosmos DB for Apache Cassandra?
         answer: |