Merge pull request #1632 from splunk/gschatz-O11YDOCS-5879

Custom indexed tags GA doc prep

Author: gschatz-splunk

_images/rum/rum-metricset.png

@@ -23,6 +23,8 @@ To manually instrument your application, the version of ``@opentelemetry/api`` y
 
 To verify this, run ``window[Symbol.for('opentelemetry.js.api.1')].version`` in the browser's console from any page that you've instrumented. The command returns the full version of the OpenTelemetry API.
 
+.. _create-a-span-rum: 
+
 Create a span
 ---------------------------------------
 

gdi/get-data-in/rum/browser/manual-rum-browser-instrumentation.rst

@@ -82,7 +82,7 @@ The following tables list all of the metrics available in Splunk RUM for Browser
      - The total number of page views and route changes sorted by page for the given time range.
    * - ``rum.page_view.time.ns.p75``
      - Page views and route change duration
-     - ``rum.node.rum.page_view.time.ns.p75``
+     - ``rum.node.page_view.time.ns.p75``
      - The p75 time in nanoseconds of the document load and, or, the route change time for the given time range. Route changes in Splunk RUM are events with zero second durations. For more, see :ref:`browser-rum-data-doc-load`.
    * - ``rum.client_error.count``
      - JavaScript errors
@@ -92,13 +92,13 @@ The following tables list all of the metrics available in Splunk RUM for Browser
      - Largest contentful paint (LCP) Time 
      - ``rum.node.webvitals_lcp.time.ns.p75``
      - The p75 time of the LCP in nanoseconds for the given time range.
-   * - ``rum.webvitals_fid.time.ns.p75``
-     - First input delay time (FID)
-     - ``rum.node.rum.webvitals_fid.time.ns.p75``
-     - The p75 time of the FID in nanoseconds for the given time range. 
+   * - ``rum.webvitals_inp.time.ns.p75``
+     - INP (Interaction to next paint)
+     - ``rum.node.rum.webvitals_inp.time.ns.p75``
+     - The p75 time of the INP in nanoseconds for the given time range. 
    * - ``rum.webvitals_cls.score.p75``
      - Cumulative layout shift (CLS) 
-     -  ``rum.node.rum.webvitals_cls.score.p75``
+     -  ``rum.node.webvitals_cls.score.p75``
      - The p75 time of the CLS in nanoseconds for the given time range. 
    * - ``rum.long_task.count``
      - Long task count 

gdi/get-data-in/rum/browser/rum-browser-data-model.rst

@@ -57,9 +57,9 @@ To learn more about web vitals, see :new-page:`https://web.dev/vitals/` in the G
    * - :strong:`Category`
      - :strong:`Metrics`
    * - Web vitals
-     -  * LCP (Largest Contentful Paint) 
-        * FID (First Input Delay)
-        * CLS (Cumulative Layout Shift) 
+     -  * LCP (Largest conctentful paint) 
+        * INP (Interaction to next paint)
+        * CLS (Cumulative layout shift) 
    * - Custom events  
      -  * :ref:`Create custom events<rum-custom-event>`
    * - Page metrics 

rum/rum-alerts.rst

@@ -0,0 +1,63 @@
+:orphan:
+
+.. _rum-custom-indexed-tags:
+
+**********************************************************************
+Filter and troubleshoot with custom tags 
+**********************************************************************
+
+
+.. meta::
+   :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`. 
+
+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.  
+
+
+
+ ..
+   "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>`.
+
+
+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
+
+
+Add custom tags to Tag Spotlight
+========================================================
+
+Follow these steps to add custom tags to Tag Spotlight 
+
+1. Add a span tag following these steps: :ref:`create-a-span-rum`.
+
+2. In Splunk RUM, select :strong:`RUM MetricSet`. 
+
+.. image:: /_images/rum/rum-metricset.png
+      :width: 20%
+      :alt: Settings panel for adding metric sets. 
+
+
+3. Select :strong:`Add MetricSet` and confirm with the checkmark. 
+
+

rum/rum-custom-indexed-tags.rst

@@ -22,7 +22,7 @@ Web Vitals are made up of three metrics that measure user experience:
 
 * LCP (largest contentful paint)
 * CLS (cumulative layout shift)
-* FID (first input delay).
+* INP (interaction to next paint).
 
 Monitor Web Vitals 
 ======================

rum/rum-scenario-library/scenario-monitoring.rst

@@ -93,6 +93,9 @@ Try these steps to troubleshoot:
 * If the environment tag is undefined, try setting it in the instrumentation by following the steps here: :ref:`rum-gdi`. 
 * If the tag is related to a geo location that is calculated based off of an IP address, this data could be missing if the user is on VPN. 
 
+
+.. _search-indexed-tags: 
+
 Search for indexed tags 
 =========================
 

rum/rum-tag-search.rst

@@ -38,7 +38,7 @@ This topic introduces important terminology and concepts in Splunk RUM for Brows
       - Web Vitals are made up of three metrics that measure user experience:
             * Largest contentful paint (LCP)
             * Cumulative layout shift (CLS)
-            * First input delay (FID)
+            * Interaction to next paint (INP)
     * - :ref:`rum-error-id`
       - In Splunk RUM, the error ID is created by hashing the associated stack trace, error message, and error type. 
     * - :ref:`rum-custom-event-term`
@@ -219,7 +219,7 @@ Web Vitals are made up of three metrics that measure user experience:
 
 * LCP (largest contentful paint)
 * CLS (cumulative layout shift)
-* FID (first input delay).
+* INP (Interaction to next paint)
 
  Google uses web vitals to determine page ranking. Splunk RUM automatically measures Web Vital metrics. To learn more about web vitals, see :new-page:`https://web.dev/vitals/` in the Google developer documentation.
 

rum/rum-terminology-concepts.rst

@@ -182,7 +182,7 @@ Web vitals capture key metrics that affect user experience.
 
    * - Total blocking time (TBT)
      - ``synthetics.webvitals_tbt.time.ms``
-     -  Captures issues that affect interactivity. TBT is a synthetic alternative for First Input Delay (FID), which measures page responsiveness to user input. Optimizations that improve TBT in the lab can also help improve FID for your users.
+     -  Captures issues that affect interactivity. TBT is a synthetic alternative for First Input Delay (INP), which measures page responsiveness to user input. Optimizations that improve TBT in the lab can also help improve INP for your users.
 
 
 To learn more about web vitals, see :new-page:`https://web.dev/vitals/` in the Google developer documentation.

synthetics/browser-test/browser-test-metrics.rst

@@ -21,11 +21,11 @@ Splunk Synthetic Monitoring automatically collects Web Vitals for Browser tests.
      - Measures loading performance by capturing the render time of the largest image or text block visible within the viewport.
    * - Cumulative layout shift (CLS)
      -  Measures visual stability by capturing the sum of all individual layout shift scores for every unexpected layout shift that occurs during the entire lifespan of the page. A layout shift occurs any time a visible element changes its position from one rendered frame to the next. Fewer shifts are better for page stability.
-   * - First input delay (FID)
+   * - INP (interaction to next paint)
      - Measures the time from when a user first interacts with a web page to the time when the browser responds to that interaction.
    * - Total blocking time (TBT)
      - Measures the time it takes a page to become interactive and responsive for a user. 
-       TBT is collected from a synthetic test, while FID is collected from real user data. They are considered equivalent to each other because they measure the same metric.
+       TBT is collected from a synthetic test, while INP is collected from real user data. They are considered equivalent to each other because they measure the same metric.
 
 Prerequisites 
 ===================