From 3275ad4d6cda4e053590042d881fa5db3389ecd6 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Thu, 6 Jun 2024 16:12:12 +0200 Subject: [PATCH 01/10] Add Pendo snippet to layout --- _templates/layout.html | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/_templates/layout.html b/_templates/layout.html index 35139c023..0eb196203 100644 --- a/_templates/layout.html +++ b/_templates/layout.html @@ -333,4 +333,29 @@

Was this {%- endblock %} -{% block footer %}{% endblock footer %} +{% block footer %} + +{% endblock footer %} From 7312847235ad6f78c1759df6ddf160daab5044c5 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Thu, 6 Jun 2024 16:12:42 +0200 Subject: [PATCH 02/10] Add to 404 and search --- _templates/404.html | 27 ++++++++++++++++++++++++++- _templates/search.html | 27 ++++++++++++++++++++++++++- 2 files changed, 52 insertions(+), 2 deletions(-) diff --git a/_templates/404.html b/_templates/404.html index e52a029ed..c27ca92cb 100644 --- a/_templates/404.html +++ b/_templates/404.html @@ -334,4 +334,29 @@

Was this {%- endblock %} -{% block footer %}{% endblock footer %} +{% block footer %} + +{% endblock footer %} diff --git a/_templates/search.html b/_templates/search.html index 932dadaf3..13ab99673 100644 --- a/_templates/search.html +++ b/_templates/search.html @@ -399,4 +399,29 @@

Was this {%- endblock %} - {% block footer %}{% endblock footer %} \ No newline at end of file + {% block footer %} + + {% endblock footer %} \ No newline at end of file From 0cacec54c41fedebf3b024766f2cb33576500961 Mon Sep 17 00:00:00 2001 From: Bri Hillmer Date: Thu, 6 Jun 2024 15:31:27 -0600 Subject: [PATCH 03/10] add metrics --- apm/apm-spans-traces/service-view.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/apm/apm-spans-traces/service-view.rst b/apm/apm-spans-traces/service-view.rst index 31c4547f5..e0fd182ed 100644 --- a/apm/apm-spans-traces/service-view.rst +++ b/apm/apm-spans-traces/service-view.rst @@ -129,6 +129,33 @@ 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 +=================== + +The following metrics are used in the service view. + +Runtime metrics +------------------- + +Java + +* ``service`` +* ``deployment_environment`` + +Node.js and .NET + +* ``service.name`` +* ``deployment.environment`` + +Infrastructure metrics +----------------------- + +* ``sf_service`` +* ``sf_environment`` + + + + From b6974a11854cd10962c1f7ed85086dc26863460e Mon Sep 17 00:00:00 2001 From: Bri Hillmer Date: Thu, 6 Jun 2024 16:37:43 -0600 Subject: [PATCH 04/10] add metrics --- apm/apm-spans-traces/service-view.rst | 186 +++++++++++++++++++++++--- 1 file changed, 164 insertions(+), 22 deletions(-) diff --git a/apm/apm-spans-traces/service-view.rst b/apm/apm-spans-traces/service-view.rst index e0fd182ed..9fbcb233c 100644 --- 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 ----------------------- @@ -129,31 +121,181 @@ 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. -Runtime metrics -------------------- +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`` -Java + * - Exceptions + - ``process.runtime.dotnet.exceptions.count`` -* ``service`` -* ``deployment_environment`` +Java runtime metrics +--------------------- -Node.js and .NET +.. list-table:: + :header-rows: 1 + :width: 100% + :widths: 50, 50 -* ``service.name`` -* ``deployment.environment`` + * - :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 network usage chart + - ``network.total`` + + * - Host CPU usage + - ``cpu.utilization`` + + * - Host memory usage + - ``memory.utilization`` + + * - Host disk usage + - ``disk.summary_utilization`` + + * - Pod CPU usage + - * ``container_cpu_utilization`` + * ``cpu.num_processors`` + * ``machine_cpu_cores`` + * ``k8s.container.ready`` -* ``sf_service`` -* ``sf_environment`` + * - Pod memory usage + - * ``k8s.container.ready`` + * ``container_memory_usage_bytes`` + * ``container_spec_memory_limit_bytes`` + * - Pod network utilization + - * ``k8s.container.ready`` + * ``pod_network_receive_bytes_total`` + * ``pod_network_transmit_bytes_total`` + * - Pod disk usage + - * ``k8s.container.ready`` + * ``container_fs_usage_bytes`` From 20d3992a0843099b25abea7e8cf95e7a289b7511 Mon Sep 17 00:00:00 2001 From: Bri Hillmer Date: Thu, 6 Jun 2024 16:46:25 -0600 Subject: [PATCH 05/10] reorder content --- apm/apm-spans-traces/service-view.rst | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/apm/apm-spans-traces/service-view.rst b/apm/apm-spans-traces/service-view.rst index 9fbcb233c..80a2b92c3 100644 --- a/apm/apm-spans-traces/service-view.rst +++ b/apm/apm-spans-traces/service-view.rst @@ -73,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 @@ -265,9 +265,6 @@ Infrastructure metrics * - :strong:`Chart` - :strong:`Metrics` - * - Host network usage chart - - ``network.total`` - * - Host CPU usage - ``cpu.utilization`` @@ -277,6 +274,9 @@ Infrastructure metrics * - Host disk usage - ``disk.summary_utilization`` + * - Host network usage + - ``network.total`` + * - Pod CPU usage - * ``container_cpu_utilization`` * ``cpu.num_processors`` @@ -288,14 +288,16 @@ Infrastructure metrics * ``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`` - * - Pod disk usage - - * ``k8s.container.ready`` - * ``container_fs_usage_bytes`` + From 6ccd96050b2bc622a66d9196ed6bf2fdee6bfc25 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Fri, 7 Jun 2024 09:40:48 +0200 Subject: [PATCH 06/10] Update 404.html --- _templates/404.html | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/_templates/404.html b/_templates/404.html index c27ca92cb..88e76085a 100644 --- a/_templates/404.html +++ b/_templates/404.html @@ -346,17 +346,7 @@

Was this // This function creates visitors and accounts in Pendo // You will need to replace and with values you use in your app // Please use Strings, Numbers, or Bools for value types. - pendo.initialize({ - visitor: { - //id: // Required if user is logged in - // email: // Recommended if using Pendo Feedback, or NPS Email - // full_name: // Recommended if using Pendo Feedback - // role: // Optional - - // You can add any additional visitor level key-values here, - // as long as it's not one of the above reserved names. - } - }); + pendo.initialize(); })('780a75be-e49a-41b4-64ec-2ebf30a068c0'); {% endblock footer %} From 00c3a633c59ed7f636905c2b905904fe04f7a626 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Fri, 7 Jun 2024 09:41:12 +0200 Subject: [PATCH 07/10] Update layout.html --- _templates/layout.html | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/_templates/layout.html b/_templates/layout.html index 0eb196203..e9f78c36b 100644 --- a/_templates/layout.html +++ b/_templates/layout.html @@ -345,17 +345,7 @@

Was this // This function creates visitors and accounts in Pendo // You will need to replace and with values you use in your app // Please use Strings, Numbers, or Bools for value types. - pendo.initialize({ - visitor: { - //id: // Required if user is logged in - // email: // Recommended if using Pendo Feedback, or NPS Email - // full_name: // Recommended if using Pendo Feedback - // role: // Optional - - // You can add any additional visitor level key-values here, - // as long as it's not one of the above reserved names. - } - }); + pendo.initialize(); })('780a75be-e49a-41b4-64ec-2ebf30a068c0'); {% endblock footer %} From d51270ba20644c92846eaf59006b6a92fec1c8cc Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Fri, 7 Jun 2024 09:41:29 +0200 Subject: [PATCH 08/10] Update search.html --- _templates/search.html | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/_templates/search.html b/_templates/search.html index 13ab99673..08ac651d0 100644 --- a/_templates/search.html +++ b/_templates/search.html @@ -411,17 +411,7 @@

Was this // This function creates visitors and accounts in Pendo // You will need to replace and with values you use in your app // Please use Strings, Numbers, or Bools for value types. - pendo.initialize({ - visitor: { - //id: // Required if user is logged in - // email: // Recommended if using Pendo Feedback, or NPS Email - // full_name: // Recommended if using Pendo Feedback - // role: // Optional - - // You can add any additional visitor level key-values here, - // as long as it's not one of the above reserved names. - } - }); + pendo.initialize(); })('780a75be-e49a-41b4-64ec-2ebf30a068c0'); - {% endblock footer %} \ No newline at end of file + {% endblock footer %} From 4411662574ecbd6f466291917feb7e34b063e5e6 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Fri, 7 Jun 2024 09:48:39 +0200 Subject: [PATCH 09/10] Remove Hotjar --- _templates/404.html | 12 ------------ _templates/layout.html | 11 ----------- _templates/search.html | 13 ------------- 3 files changed, 36 deletions(-) diff --git a/_templates/404.html b/_templates/404.html index 88e76085a..a0bd1d34a 100644 --- a/_templates/404.html +++ b/_templates/404.html @@ -33,18 +33,6 @@ - - - - {% endblock footer %} diff --git a/_templates/layout.html b/_templates/layout.html index c494bd391..acd9003db 100644 --- a/_templates/layout.html +++ b/_templates/layout.html @@ -335,6 +335,6 @@

Was this // You will need to replace and with values you use in your app // Please use Strings, Numbers, or Bools for value types. pendo.initialize(); - })('780a75be-e49a-41b4-64ec-2ebf30a068c0'); + })('8bd24911-c812-4bd5-7ba6-1a9171fea693'); {% endblock footer %} diff --git a/_templates/search.html b/_templates/search.html index ce19a92ea..86f24127f 100644 --- a/_templates/search.html +++ b/_templates/search.html @@ -399,6 +399,6 @@

Was this // You will need to replace and with values you use in your app // Please use Strings, Numbers, or Bools for value types. pendo.initialize(); - })('780a75be-e49a-41b4-64ec-2ebf30a068c0'); + })('8bd24911-c812-4bd5-7ba6-1a9171fea693'); {% endblock footer %}