Merge pull request #1383 from splunk/repo-sync

Pulling refs/heads/main into main
splunk · Jun 7, 2024 · dc06c1d · dc06c1d
2 parents 572e87a + 3b11d2d
commit dc06c1d
Show file tree

Hide file tree

Showing 4 changed files with 231 additions and 51 deletions.
diff --git a/_templates/404.html b/_templates/404.html
@@ -33,18 +33,6 @@
 
 
 
-<!-- Hotjar Tracking Code for https://docs.splunk.com/observability/ -->
-<script>
-    (function(h,o,t,j,a,r){
-        h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};
-        h._hjSettings={hjid:2659668,hjsv:6};
-        a=o.getElementsByTagName('head')[0];
-        r=o.createElement('script');r.async=1;
-        r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;
-        a.appendChild(r);
-    })(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');
-</script>
-
 <script>
   if(window.location.toString().includes("docs.signalfx")){
     window.location.href = "https://docs.splunk.com/Observability/";
@@ -334,4 +322,19 @@ <h2 style="font-size:21px;font-family: 'Open Sans'; font-weight: bold;">Was this
 
 {%- endblock %}
 
-{% block footer %}{% endblock footer %}
+{% block footer %}
+<script>
+   (function(apiKey){
+       (function(p,e,n,d,o){var v,w,x,y,z;o=p[d]=p[d]||{};o._q=o._q||[];
+       v=['initialize','identify','updateOptions','pageLoad','track'];for(w=0,x=v.length;w<x;++w)(function(m){
+           o[m]=o[m]||function(){o._q[m===v[0]?'unshift':'push']([m].concat([].slice.call(arguments,0)));};})(v[w]);
+           y=e.createElement(n);y.async=!0;y.src='https://cdn.pendo.io/agent/static/'+apiKey+'/pendo.js';
+           z=e.getElementsByTagName(n)[0];z.parentNode.insertBefore(y,z);})(window,document,'script','pendo');
+
+           // This function creates visitors and accounts in Pendo
+           // You will need to replace <visitor-id-goes-here> and <account-id-goes-here> with values you use in your app
+           // Please use Strings, Numbers, or Bools for value types.
+           pendo.initialize();
+   })('8bd24911-c812-4bd5-7ba6-1a9171fea693');
+   </script>
+{% endblock footer %}
diff --git a/_templates/layout.html b/_templates/layout.html
@@ -35,17 +35,6 @@
 <!--
 <script src="https://cdnjs.cloudflare.com/ajax/libs/mermaid/10.3.0/mermaid.min.js" integrity="sha512-FwnznVYc+d1qqPe2F+6IxQCa5j/3kCqUUgkJfMjP5r71sHNuDvQYn5h/aUkVwkh+Gihu5licMvcItyF06s5uRw==" crossorigin="anonymous" referrerpolicy="no-referrer" async></script>
 -->
-<!-- Hotjar Tracking Code for https://docs.splunk.com/observability/ -->
-<script>
-    (function(h,o,t,j,a,r){
-        h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};
-        h._hjSettings={hjid:2659668,hjsv:6};
-        a=o.getElementsByTagName('head')[0];
-        r=o.createElement('script');r.async=1;
-        r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;
-        a.appendChild(r);
-    })(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');
-</script>
 
 <script>
   if(window.location.toString().includes("docs.signalfx")){
@@ -333,4 +322,19 @@ <h2 style="font-size:21px;font-family: 'Open Sans'; font-weight: bold;">Was this
 
 {%- endblock %}
 
-{% block footer %}{% endblock footer %}
+{% block footer %}
+<script>
+   (function(apiKey){
+       (function(p,e,n,d,o){var v,w,x,y,z;o=p[d]=p[d]||{};o._q=o._q||[];
+       v=['initialize','identify','updateOptions','pageLoad','track'];for(w=0,x=v.length;w<x;++w)(function(m){
+           o[m]=o[m]||function(){o._q[m===v[0]?'unshift':'push']([m].concat([].slice.call(arguments,0)));};})(v[w]);
+           y=e.createElement(n);y.async=!0;y.src='https://cdn.pendo.io/agent/static/'+apiKey+'/pendo.js';
+           z=e.getElementsByTagName(n)[0];z.parentNode.insertBefore(y,z);})(window,document,'script','pendo');
+
+           // This function creates visitors and accounts in Pendo
+           // You will need to replace <visitor-id-goes-here> and <account-id-goes-here> with values you use in your app
+           // Please use Strings, Numbers, or Bools for value types.
+           pendo.initialize();
+   })('8bd24911-c812-4bd5-7ba6-1a9171fea693');
+   </script>
+{% endblock footer %}
diff --git a/_templates/search.html b/_templates/search.html
@@ -24,19 +24,6 @@
             height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
 
 
-
-<!-- Hotjar Tracking Code for https://docs.splunk.com/observability/ -->
-<script>
-    (function(h,o,t,j,a,r){
-        h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};
-        h._hjSettings={hjid:2659668,hjsv:6};
-        a=o.getElementsByTagName('head')[0];
-        r=o.createElement('script');r.async=1;
-        r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;
-        a.appendChild(r);
-    })(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');
-</script>
-
 <script>
     if(window.location.toString().includes("docs.signalfx")){
         window.location.href = "https://docs.splunk.com/Observability/";
@@ -399,4 +386,19 @@ <h2 style="font-size:21px;font-family: 'Open Sans'; font-weight: bold;">Was this
 
     {%- endblock %}
 
-    {% block footer %}{% endblock footer %}
+    {% block footer %}
+    <script>
+      (function(apiKey){
+          (function(p,e,n,d,o){var v,w,x,y,z;o=p[d]=p[d]||{};o._q=o._q||[];
+          v=['initialize','identify','updateOptions','pageLoad','track'];for(w=0,x=v.length;w<x;++w)(function(m){
+              o[m]=o[m]||function(){o._q[m===v[0]?'unshift':'push']([m].concat([].slice.call(arguments,0)));};})(v[w]);
+              y=e.createElement(n);y.async=!0;y.src='https://cdn.pendo.io/agent/static/'+apiKey+'/pendo.js';
+              z=e.getElementsByTagName(n)[0];z.parentNode.insertBefore(y,z);})(window,document,'script','pendo');
+
+              // This function creates visitors and accounts in Pendo
+              // You will need to replace <visitor-id-goes-here> and <account-id-goes-here> with values you use in your app
+              // Please use Strings, Numbers, or Bools for value types.
+              pendo.initialize();
+      })('8bd24911-c812-4bd5-7ba6-1a9171fea693');
+      </script>
+    {% endblock footer %}
diff --git a/apm/apm-spans-traces/service-view.rst b/apm/apm-spans-traces/service-view.rst
@@ -57,17 +57,9 @@ Use the following metrics in the :guilabel:`Service metrics` section to monitor
 Runtime metrics
 -----------------
 
-Instrument your back-end applications to send spans to Splunk APM to view runtime metrics. The following runtime metrics are available for Java, Node.js, and .NET in the service view. See :ref:`get-started-application`.
-
-* Memory usage
-* Allocation rate
-* Class loading
-* GC activity
-* GC overhead
-* Thread count
-* GC overhead
-* Thread count
-* Thread pools
+Instrument your back-end applications to send spans to Splunk APM to view runtime metrics. See :ref:`get-started-application`.
+
+The available runtime metrics vary based on language. See :ref:`metric-reference` for more information.
 
 Infrastructure metrics
 -----------------------
@@ -81,7 +73,7 @@ The following infrastructure metrics are available:
 * Host disk usage
 * Host network usage
 * Pod CPU usage
-* Pod memory utilization
+* Pod memory usage
 * Pod disk usage
 * Pod network utilization
 
@@ -129,6 +121,185 @@ Select :guilabel:`Configure service view` to modify the Log Observer Connect con
 
 The connection and indices you select are saved for all users in your organization for each unique service and environment combination.
 
+.. _metric-reference:
+
+Metric reference
+===================
+
+The following metrics are used in the service view. 
+
+Service metrics
+----------------
+
+.. list-table::
+   :header-rows: 1
+   :width: 100%
+   :widths: 50, 50
+
+   * - :strong:`Chart`
+     - :strong:`Metrics`
+
+   * - Service requests
+     - ``service.request.count``
+
+   * - Service latency
+     - * ``service.request.duration.ns.median``
+       * ``service.request.duration.ns.p90``
+       * ``service.request.duration.ns.p99``
+
+   * - Service errors
+     - ``service.requests.count`` with a ``sf_error:True`` filter
+
+   * - SLI/SLO 
+     - ``service.request.count``
+
+.NET runtime metrics 
+-----------------------
+
+.. list-table::
+   :header-rows: 1
+   :width: 100%
+   :widths: 50, 50
+
+   * - :strong:`Chart`
+     - :strong:`Metrics`
+
+   * - Heap usage
+     - ``process.runtime.dotnet.gc.committed_memory.size``
+
+   * - GC collections
+     - ``process.runtime.dotnet.gc.collections.count``
+
+   * - Application activity
+     - ``process.runtime.dotnet.gc.allocations.size``
+
+   * - GC heap size
+     - ``process.runtime.dotnet.gc.heap.size``
+
+   * - GC pause time
+     - ``process.runtime.dotnet.gc.pause.time``
+
+   * - Monitor lock contention
+     - ``process.runtime.dotnet.monitor.lock_contention.count``
+
+   * - Threadpool thread
+     - ``process.runtime.dotnet.monitor.lock_contention.count``
+
+   * - Exceptions
+     - ``process.runtime.dotnet.exceptions.count``
+
+Java runtime metrics
+---------------------
+
+.. list-table::
+   :header-rows: 1
+   :width: 100%
+   :widths: 50, 50
+
+   * - :strong:`Charts`
+     - :strong:`Metrics`
+
+   * - Memory usage
+     - * ``runtime.jvm.gc.live.data.size``
+       * ``runtime.jvm.memory.max``
+       * ``runtime.jvm.memory.used``
+
+   * - Allocation rate
+     - ``process.runtime.jvm.memory.allocated``
+
+   * - Class loading
+     - * ``runtime.jvm.classes.loaded``
+       * ``runtime.jvm.classes.unloaded``
+
+   * - GC activity
+     - * ``runtime.jvm.gc.pause.totalTime``
+       * ``runtime.jvm.gc.pause.count``
+
+   * - GC overhead
+     - ``runtime.jvm.gc.overhead``
+
+   * - Thread count
+     - * ``runtime.jvm.threads.live``
+       * ``runtime.jvm.threads.peak``
+
+   * - Thread pools
+     - * ``executor.threads.active``
+       * ``executor.threads.idle``
+       * ``executor.threads.max``
+
+Node.js runtime metrics 
+-------------------------
+
+.. list-table::
+   :header-rows: 1
+   :width: 100%
+   :widths: 50, 50
+
+   * - :strong:`Charts`
+     - :strong:`Metrics`
+
+   * - Heap usage
+     - * ``Process.runtime.nodejs.memory.heap.total``
+       * ``process.runtime.nodejs.memory.heap.used``
+
+   * - Resident set size
+     - ``process.runtime.nodejs.memory.rss``
+
+   * - GC activity
+     - * ``process.runtime.nodejs.memory.gc.size``
+       * ``process.runtime.nodejs.memory.gc.pause``
+       * ``process.runtime.nodejs.memory.gc.count``
+
+   * - Event loop lag
+     - * ``Process.runtime.nodejs.event_loop.lag.max``
+       * ``process.runtime.nodejs.event_loop.lag.min``
+
+Infrastructure metrics
+-------------------------
+
+.. list-table::
+   :header-rows: 1
+   :width: 100%
+   :widths: 50, 50
+
+   * - :strong:`Chart`
+     - :strong:`Metrics`
+
+   * - Host CPU usage
+     - ``cpu.utilization``
+
+   * - Host memory usage
+     - ``memory.utilization``
+
+   * - Host disk usage
+     - ``disk.summary_utilization``
+
+   * - Host network usage
+     - ``network.total``
+
+   * - Pod CPU usage
+     - * ``container_cpu_utilization``
+       * ``cpu.num_processors``
+       * ``machine_cpu_cores``
+       * ``k8s.container.ready``
+
+   * - Pod memory usage
+     - * ``k8s.container.ready``
+       * ``container_memory_usage_bytes``
+       * ``container_spec_memory_limit_bytes``
+
+   * - Pod disk usage
+     - * ``k8s.container.ready``
+       * ``container_fs_usage_bytes``
+
+   * - Pod network utilization
+     - * ``k8s.container.ready``
+       * ``pod_network_receive_bytes_total``
+       * ``pod_network_transmit_bytes_total``
+
+
+
+