Merge pull request #1509 from splunk/repo-sync

Pulling refs/heads/main into main

Author: aurbiztondo-splunk

_images/rum/metric-set-left-nav.png

@@ -0,0 +1,24 @@
+Span tags
+-----------
+
+Use span tags or processes to break down services and inter-service calls along trace characteristics or attributes. To get additional value from a span tag or process, an  administrator can run an action known as indexing, which activates additional analysis of the indexed span tag or process. One benefit of indexing is to get aggregated metrics, called MetricSets, across all spans that contain a specified indexed tag or process.
+
+
+MetricSets
+-----------
+
+MetricSets are metric time series (MTS) you can use to track the performance of specific metrics over time. 
+
+Default tags
+-------------
+
+The following tags are automatically indexed during ingestion by default depending on the metric:
+
+       * URL name
+       * operation
+       * HTTP method and status code
+       * custom event name
+       * browser and version
+       * OS name and version
+       * city, region, country
+

_includes/synthetics/metricset-def.rst

@@ -793,6 +793,11 @@ View a list of all supported integrations :ref:`supported-data-sources`
 
    rum/rum-session-replay
 
+.. toctree::
+   :maxdepth:   3
+   
+   rum/rum-custom-indexed-tags
+
 .. toctree::
    :maxdepth:   3
 

index.rst

@@ -1,4 +1,3 @@
-:orphan:
 
 .. _rum-custom-indexed-tags:
 
@@ -11,53 +10,63 @@ Filter and troubleshoot with custom tags
    :description: words
 
 
-Create custom tags to improve filtering and troubleshooting capabilities in Tag Spotlight. First, create a custom span tag, then index it by adding a MetricSet to the span tag. Adding a MetricSet to the span tags lets you use all of the features associated with indexed span tags. See, :ref:`apm-index-span-tags`. 
+Create custom tags to improve filtering and troubleshooting capabilities in Tag Spotlight in Splunk RUM. First, create a custom span tag, then index it by adding a MetricSet to the span tag. Adding a MetricSet to a span tag gives you all of the features associated with indexed span tags.
 
-Track custom processes 
-=================================
+Key concepts
+==================
+How span tags, indexed span tags, and MetricSets relate to each other. 
+
+.. include:: /_includes/synthetics/metricset-def.rst
 
+Example: track custom processes 
+=================================
 
-Adding your own tags that are meaningful to your organization like custom tags, helps you refine results and glean insights most pertinent to you. Custom span tags are especially useful for tracking processes that are unique to your organization. For example, customer support, tier, department, or internal geo locations for facilities.  
+Adding your own tags that are meaningful to your organization like custom tags, helps you refine results and glean insights most pertinent to you. Custom span tags are especially useful for tracking processes that are unique to your organization. 
 
+Here are some examples of what you could use as span tags:
 
+* customer support tier or loyalty level
+* department
+* internal geo locations for facilities
+* branch locations
 
  ..
    "How can I add my own tags to Tag Spotlight?", "How can I filter on custom tags?" "How can I troubleshoot with custom tags?
 
 
-Avoid high cardinality in MetricSets
-=============================================
-Choose tags with a reasonable amount of cardinality. Tags like userID, or sessionID are inefficient choices because there could be a huge number of users in your organization and visitors to your application, so creating a troubleshooting MetricSet for each userID is not optimal for performance. For high cardinality ID based tags full-fidelity session search is a better option. High cardinality MetricSets can also affect your org limits :ref:`rum-limits`. Limits are determined by your subscription: enterprise and standard. For more information on each type of subscription, see :new-page:`Splunk RUM Pricing <https://www.splunk.com/en_us/products/pricing/faqs/observability.html#splunk-rum>`.
 
+Add custom tags to Tag Spotlight
+========================================================
+
+You need to be an admin to do this task. Follow these steps to add custom tags to Tag Spotlight: 
 
-Default tags
-==============
+1. Add a span tag following these steps: :ref:`create-a-span-rum`.
 
-The following tags are automatically indexed during ingestion by default depending on the metric:
+2. There are two ways to navigate to the MetricSets configuration page. Choose either one: 
 
-       * url name
-       * operation
-       * HTTP Method and status code
-       * custom event name
-       * browser and version
-       * OS name and version
-       * city, region, country
+   * In Splunk RUM, select :strong:`RUM MetricSet` from the MetricSets configuration page as seen in the screenshot below. 
 
+      .. image:: /_images/rum/rum-metricset.png
+            :width: 20%
+            :alt: Settings panel for adding metric sets. 
 
-Add custom tags to Tag Spotlight
-========================================================
+   * From the left navigation menu, select :strong:`Settings`, then :strong:`MetricSets` then the :strong:`RUM` tab. 
 
-Follow these steps to add custom tags to Tag Spotlight 
 
-1. Add a span tag following these steps: :ref:`create-a-span-rum`.
+      .. image:: /_images/rum/metric-set-left-nav.png
+            :width: 20%
+            :alt: Settings panel for adding metric sets. 
 
-2. In Splunk RUM, select :strong:`RUM MetricSet`. 
+3. Choose the tag you want to index to trigger the cardinality analyzer. If the cardinality check passes, select :strong:`Add MetricSet` and confirm with the check mark. 
 
-.. image:: /_images/rum/rum-metricset.png
-      :width: 20%
-      :alt: Settings panel for adding metric sets. 
 
+Troubleshooting
+================
 
-3. Select :strong:`Add MetricSet` and confirm with the checkmark. 
+If the cardinality analysis fails, then you might have exceeded your entitlements. 
 
+Avoid high cardinality in MetricSets
+--------------------------------------
+Choose tags with a reasonable amount of cardinality. Tags like userID, or sessionID have high cardinality because there is a unique value for users in your organization and visitors to your application. Creating a troubleshooting MetricSet for each userID is not optimal for performance. For high-cardinality, ID-based tags, full-fidelity session search is a better option, see :ref:`rum-tag-search`.
 
+High cardinality MetricSets can also affect your org limits :ref:`rum-limits`. Limits are determined by your subscription: enterprise and standard. For more information on each type of subscription, see :new-page:`Splunk RUM Pricing <https://www.splunk.com/en_us/products/pricing/faqs/observability.html#splunk-rum>`.