diff --git a/_includes/collector-upgrade.rst b/_includes/collector-upgrade.rst index 33315da49..8c6b48476 100644 --- a/_includes/collector-upgrade.rst +++ b/_includes/collector-upgrade.rst @@ -14,8 +14,21 @@ Apply the following changes to the Collector configuration files for specific ve From 0.96.1 to 0.97.0 ------------------------------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-upgrade-memory-ballast.rst +.. raw:: html + +
+ + + + From 0.68.0 to 0.69.0 ------------------------------------ diff --git a/_includes/gdi/java-20-metrics-equivalences.rst b/_includes/gdi/java-20-metrics-equivalences.rst index 6df5cee23..6fbafccea 100644 --- a/_includes/gdi/java-20-metrics-equivalences.rst +++ b/_includes/gdi/java-20-metrics-equivalences.rst @@ -57,9 +57,9 @@ The following table shows the metrics produced by default by OpenTelemetry Java - ``runtime.jvm.threads.daemon`` |br| ``runtime.jvm.threads.live`` -:sup:`*` This is a Splunk specific metric and it's not present in the upstream semantic conventions. +:sup:`*` This is a Splunk-specific metric and it's not present in the upstream semantic conventions. .. note:: The previous table contains metrics generated by default. Additional metrics might be emitted by supported metrics instrumentation, for example when instrumenting application servers. -For more information on the HTTP semantic convention changes, see :new-page:`HTTP semantic convention stability migration guide ` on GitHub. +For more information on the HTTP semantic convention changes, see :new-page:`HTTP semantic convention stability migration guide ` on GitHub. diff --git a/_includes/gdi/lambda-configuration.rst b/_includes/gdi/lambda-configuration.rst index b560b4349..2505e9fa4 100644 --- a/_includes/gdi/lambda-configuration.rst +++ b/_includes/gdi/lambda-configuration.rst @@ -1,6 +1,3 @@ -Configure the Splunk OpenTelemetry Lambda layer ----------------------------------------------------- - Follow these steps to add the required configuration for the Splunk OpenTelemetry Lambda layer: 1. In the AWS Lambda console, open the function that you are instrumenting. diff --git a/admin/authentication/SSO/sso-ADSF.rst b/admin/authentication/SSO/sso-ADSF.rst index f374cfa73..e50c40f5c 100644 --- a/admin/authentication/SSO/sso-ADSF.rst +++ b/admin/authentication/SSO/sso-ADSF.rst @@ -216,4 +216,17 @@ If you want to turn off the email authentication feature, contact :ref:`support` .. note:: The ADFS portal is the only way that your users can log in to Splunk Observability Cloud. + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/admin/authentication/SSO/sso-AzureAD.rst b/admin/authentication/SSO/sso-AzureAD.rst index 809ff21f1..52ab654b0 100644 --- a/admin/authentication/SSO/sso-AzureAD.rst +++ b/admin/authentication/SSO/sso-AzureAD.rst @@ -46,4 +46,17 @@ If you want to turn off the email authentication feature, contact :ref:`support` Once you have a custom URL configured, your users can continue to log in using their existing username/password pair, or they can use their Microsoft Entra ID credentials instead. Microsoft Entra ID SSO authentication and Splunk Observability Cloud username/password authentication are independent. + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/admin/authentication/SSO/sso-Google.rst b/admin/authentication/SSO/sso-Google.rst index 20fdc2550..feb3f10e7 100644 --- a/admin/authentication/SSO/sso-Google.rst +++ b/admin/authentication/SSO/sso-Google.rst @@ -78,4 +78,17 @@ If you want to turn off the email authentication feature, contact :ref:`support` Once you have a custom URL configured, your users can continue to log in using their existing username/password pair, or they can use their GCI credentials instead. GCI SSO authentication and Splunk Observability Cloud username/password authentication are independent. + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/admin/authentication/SSO/sso-GoogleCloudIDP.rst b/admin/authentication/SSO/sso-GoogleCloudIDP.rst index 59b0e5f18..5abaadc03 100644 --- a/admin/authentication/SSO/sso-GoogleCloudIDP.rst +++ b/admin/authentication/SSO/sso-GoogleCloudIDP.rst @@ -29,4 +29,17 @@ If you want to turn off the email authentication feature, contact :ref:`support` Once you have a custom URL configured, your users can continue to log in using their existing username/password pair, or they can use their GCI credentials instead. GCI SSO authentication and Splunk Observability Cloud username/password authentication are independent. + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/admin/authentication/SSO/sso-Okta.rst b/admin/authentication/SSO/sso-Okta.rst index 9adc3e11b..6aa40e808 100644 --- a/admin/authentication/SSO/sso-Okta.rst +++ b/admin/authentication/SSO/sso-Okta.rst @@ -63,4 +63,17 @@ Once you have a custom URL configured, your users can continue to log in using t Splunk Observability Cloud generates a password for users you create in Okta SSO. If the Okta login portal is unavailable, Splunk Observability Cloud users can use the reset password link on the Splunk Observability Cloud login page to get native Splunk Observability Cloud credentials. + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/admin/authentication/SSO/sso-OneLogin.rst b/admin/authentication/SSO/sso-OneLogin.rst index 6fa6a1004..b9ce794d1 100644 --- a/admin/authentication/SSO/sso-OneLogin.rst +++ b/admin/authentication/SSO/sso-OneLogin.rst @@ -61,4 +61,17 @@ Once you have a custom URL configured, your users can continue to log in using t Splunk Observability Cloud generates a password for users you create in OneLogin SSO. If the OneLogin portal is unavailable, Splunk Observability Cloud users can use the reset password link on the Splunk Observability Cloud login page to get native Splunk Observability Cloud credentials. + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/admin/authentication/SSO/sso-PingOne.rst b/admin/authentication/SSO/sso-PingOne.rst index c2d3a0bec..6b34c63fa 100644 --- a/admin/authentication/SSO/sso-PingOne.rst +++ b/admin/authentication/SSO/sso-PingOne.rst @@ -88,4 +88,17 @@ set up the data mapping from PingOne to Splunk Observability Cloud, follow these To learn more about mapping Splunk Observability Cloud data fields to PingOne data fields, see the :ref:`saml-user-information` section in the :ref:`sso-generic` topic. + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/admin/authentication/SSO/sso.rst b/admin/authentication/SSO/sso.rst index b9f26b78f..10e02e8f8 100644 --- a/admin/authentication/SSO/sso.rst +++ b/admin/authentication/SSO/sso.rst @@ -28,8 +28,21 @@ Splunk Observability Cloud supports the following SSO integrations: .. _about-realms: + + +.. raw:: html + +
+ .. include:: /_includes/realm-note.rst +.. raw:: html + +
+ + + + .. _custom-url: .. raw:: html diff --git a/admin/authentication/allow-services.rst b/admin/authentication/allow-services.rst index 553a1bf3c..add9b9cdf 100644 --- a/admin/authentication/allow-services.rst +++ b/admin/authentication/allow-services.rst @@ -153,8 +153,21 @@ Restart the Collector after adding these environment variables to your configura URLs to allow in your network ================================ + + +.. raw:: html + +
+ .. include:: /_includes/realm-note.rst +.. raw:: html + +
+ + + + If your organization's networking security policies require you to individually allow services delivered over the internet, ensure that you allow the following service URLs on your network: .. code:: shell diff --git a/admin/org-metrics.rst b/admin/org-metrics.rst index 063f0b115..48a3bae8a 100644 --- a/admin/org-metrics.rst +++ b/admin/org-metrics.rst @@ -297,4 +297,17 @@ Splunk Observability Cloud provides the following organization metrics: Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/admin/user-management/roles/roles-and-capabilities-table.rst b/admin/user-management/roles/roles-and-capabilities-table.rst index a4791dd8c..e32dd3cb3 100644 --- a/admin/user-management/roles/roles-and-capabilities-table.rst +++ b/admin/user-management/roles/roles-and-capabilities-table.rst @@ -16,51 +16,155 @@ Splunk Observability Cloud lets you restrict access to certain features to speci Metrics pipeline management =============================================================================== + + +.. raw:: html + +
+ .. include:: /_includes/admin/roles_mpm.rst +.. raw:: html + +
+ + + + Log Observer and Log Observer Connect =============================================================================== + + +.. raw:: html + +
+ .. include:: /_includes/admin/roles_log_observer.rst +.. raw:: html + +
+ + + + Alerts and detectors =============================================================================== + + +.. raw:: html + +
+ .. include:: /_includes/admin/roles_alerts_detectors.rst +.. raw:: html + +
+ + + + Infrastructure Monitoring navigators =============================================================================== + + +.. raw:: html + +
+ .. include:: /_includes/admin/roles_navs_dashbds.rst +.. raw:: html + +
+ + + + Infrastructure Monitoring dashboards =============================================================================== + + +.. raw:: html + +
+ .. include:: /_includes/admin/roles_dashbds_only.rst +.. raw:: html + +
+ + + + Splunk Synthetic Monitoring ================================================== + + +.. raw:: html + +
+ .. include:: /_includes/admin/synth-roles-caps.rst +.. raw:: html + +
+ + + + .. .. _rum-rbac: Splunk Real User Monitoring ================================================== + + +.. raw:: html + +
+ .. include:: /_includes/admin/rum-roles-caps.rst +.. raw:: html + +
+ + + + .. apm-rbac: Splunk Application Performance Monitoring ================================================================== + + +.. raw:: html + +
+ .. include:: /_includes/admin/roles_apm.rst +.. raw:: html + +
+ + + + Settings =========================== @@ -69,16 +173,54 @@ General settings .. note:: If :ref:`enhanced team security ` is enabled, some of these permissions may change if a user is also designated as a Team Manager. Team Manager is not part of RBAC; it provides a user with additional permissions for managing a specific team. For details, see :ref:`about-team-roles`. + + +.. raw:: html + +
+ .. include:: /_includes/admin/roles_navigation.rst +.. raw:: html + +
+ + + + Data configuration ---------------------------- + + +.. raw:: html + +
+ .. include:: /_includes/admin/roles_data_configuration.rst +.. raw:: html + +
+ + + + Help and support ---------------------------- -.. include:: /_includes/admin/roles_help_support.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/admin/roles_help_support.rst +.. raw:: html + +
+ + + diff --git a/apm/set-up-apm/environments.rst b/apm/set-up-apm/environments.rst index 6f96209c3..1ec524c74 100644 --- a/apm/set-up-apm/environments.rst +++ b/apm/set-up-apm/environments.rst @@ -28,8 +28,21 @@ On spans where the ``deployment.environment`` tag is not set, Splunk APM assumes For more information about adding span tags to spans, see :ref:`apm-add-context-trace-span`. + + +.. raw:: html + +
+ .. include:: /_includes/tag-decision-support.rst +.. raw:: html + +
+ + + + Set ``deployment.environment`` via auto-instrumentation ----------------------------------------------------------- To learn how to add span tags during auto-instrumentation, see :ref:`instrument-tags`. diff --git a/apm/set-up-apm/sensitive-data-controls.rst b/apm/set-up-apm/sensitive-data-controls.rst index 62400ba29..8b9f35297 100644 --- a/apm/set-up-apm/sensitive-data-controls.rst +++ b/apm/set-up-apm/sensitive-data-controls.rst @@ -117,8 +117,21 @@ JSON payload: "hiddenTags": ["user.email", "credit.card.number"] } + + +.. raw:: html + +
+ .. include:: /_includes/realm-note.rst +.. raw:: html + +
+ + + + Block tags from a particular operation within a service ------------------------------------------------------------------------ diff --git a/apm/span-tags/add-context-trace-span.rst b/apm/span-tags/add-context-trace-span.rst index 66b8044d3..cf869c871 100644 --- a/apm/span-tags/add-context-trace-span.rst +++ b/apm/span-tags/add-context-trace-span.rst @@ -38,8 +38,21 @@ The following sections describe two ways to add tags to your spans: Begin by considering where to add your span tags. + + +.. raw:: html + +
+ .. include:: /_includes/tag-decision-support.rst +.. raw:: html + +
+ + + + The ``deployment.environment`` span tag is particularly useful, as it lets you filter your entire APM experience by deployment environment. To learn more about environments in Splunk APM, see :ref:`apm-environments`. .. _instrument-tags: diff --git a/gdi/get-data-in/application/go/go-otel-requirements.rst b/gdi/get-data-in/application/go/go-otel-requirements.rst index 39d48cd30..cf581bfbc 100644 --- a/gdi/get-data-in/application/go/go-otel-requirements.rst +++ b/gdi/get-data-in/application/go/go-otel-requirements.rst @@ -65,8 +65,21 @@ The following table lists all the instrumentations supported by Splunk. Check th Ensure you are using supported Go versions ============================================================== + + +.. raw:: html + +
+ .. include:: /_includes/requirements/go.rst +.. raw:: html + +
+ + + + .. _go-otel-connector-requirement: diff --git a/gdi/get-data-in/application/go/instrumentation/instrument-go-application.rst b/gdi/get-data-in/application/go/instrumentation/instrument-go-application.rst index 8f0343af4..c2e147cad 100644 --- a/gdi/get-data-in/application/go/instrumentation/instrument-go-application.rst +++ b/gdi/get-data-in/application/go/instrumentation/instrument-go-application.rst @@ -7,7 +7,20 @@ Instrument your Go application for Splunk Observability Cloud .. meta:: :description: The Splunk Distribution of OpenTelemetry Go can instrument your Go application or service. Follow these steps to get started. + + +.. raw:: html + +
+ .. include:: /_includes/zero-code-info.rst + +.. raw:: html + +
+ + + The Splunk Distribution of OpenTelemetry Go can instrument your Go application or service. To get started, use the guided setup or follow the instructions manually. @@ -182,4 +195,17 @@ For more information on the ingest API endpoints, see :new-page:`Send APM traces Specify the source host -------------------------------------------------------------------- + + +.. raw:: html + +
+ .. include:: /_includes/gdi/apm-api-define-host.rst + +.. raw:: html + +
+ + + diff --git a/gdi/get-data-in/application/go/troubleshooting/common-go-troubleshooting.rst b/gdi/get-data-in/application/go/troubleshooting/common-go-troubleshooting.rst index 64970b7f7..68c32b862 100644 --- a/gdi/get-data-in/application/go/troubleshooting/common-go-troubleshooting.rst +++ b/gdi/get-data-in/application/go/troubleshooting/common-go-troubleshooting.rst @@ -129,4 +129,16 @@ To solve this issue, make sure the following conditions are true: #. The target endpoint is correct when providing an alternative value. -.. include:: /_includes/troubleshooting-components.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + diff --git a/gdi/get-data-in/application/istio/istio.rst b/gdi/get-data-in/application/istio/istio.rst index 322fe893c..12d0f2106 100644 --- a/gdi/get-data-in/application/istio/istio.rst +++ b/gdi/get-data-in/application/istio/istio.rst @@ -12,8 +12,21 @@ Istio 1.8 and higher has native support for observability. You can configure you Requirements ============================== + + +.. raw:: html + +
+ .. include:: /_includes/requirements/istio.rst +.. raw:: html + +
+ + + + Install and configure the Splunk OpenTelemetry Collector ============================================================= @@ -139,4 +152,17 @@ For example: For more information on how to configure Istio see the Istio distributed tracing installation documentation. + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/get-data-in/application/java/configuration/java-otel-metrics-attributes.rst b/gdi/get-data-in/application/java/configuration/java-otel-metrics-attributes.rst index 26d4d3fa5..a8c37d063 100644 --- a/gdi/get-data-in/application/java/configuration/java-otel-metrics-attributes.rst +++ b/gdi/get-data-in/application/java/configuration/java-otel-metrics-attributes.rst @@ -270,8 +270,21 @@ For a list of supported application servers, see the :ref:`supported-java-librar New metric names ====================================== + + +.. raw:: html + +
+ .. include:: /_includes/gdi/java-20-metrics-equivalences.rst +.. raw:: html + +
+ + + + Deactivate metrics export ================================== diff --git a/gdi/get-data-in/application/java/instrumentation/instrument-java-application.rst b/gdi/get-data-in/application/java/instrumentation/instrument-java-application.rst index b80d5ddda..9cc936f3e 100644 --- a/gdi/get-data-in/application/java/instrumentation/instrument-java-application.rst +++ b/gdi/get-data-in/application/java/instrumentation/instrument-java-application.rst @@ -9,8 +9,21 @@ Instrument your Java application for Splunk Observability Cloud The Java agent from the Splunk Distribution of OpenTelemetry Java can automatically instrument your Java application by injecting instrumentation to Java classes. To get started, use the guided setup or follow the instructions manually. + + +.. raw:: html + +
+ .. include:: /_includes/zero-code-info.rst +.. raw:: html + +
+ + + + Generate customized instructions using the guided setup ==================================================================== @@ -282,8 +295,21 @@ For more information on the ingest API endpoints, see :new-page:`Send APM traces Set the source host ----------------------------------------------------------- + + +.. raw:: html + +
+ .. include:: /_includes/gdi/apm-api-define-host.rst +.. raw:: html + +
+ + + + .. _instrument_aws_lambda_functions: diff --git a/gdi/get-data-in/application/java/java-otel-requirements.rst b/gdi/get-data-in/application/java/java-otel-requirements.rst index 48e0a074d..86b367a1c 100644 --- a/gdi/get-data-in/application/java/java-otel-requirements.rst +++ b/gdi/get-data-in/application/java/java-otel-requirements.rst @@ -14,8 +14,21 @@ Meet the following requirements to instrument Java applications for Splunk Obser Make sure you are using compatible Java and JVM versions ============================================================== + + +.. raw:: html + +
+ .. include:: /_includes/requirements/java.rst +.. raw:: html + +
+ + + + Dependencies --------------- diff --git a/gdi/get-data-in/application/java/migrate-metrics.rst b/gdi/get-data-in/application/java/migrate-metrics.rst index 4283d2392..505424fce 100644 --- a/gdi/get-data-in/application/java/migrate-metrics.rst +++ b/gdi/get-data-in/application/java/migrate-metrics.rst @@ -58,7 +58,7 @@ The following best practices can help you when initiating the migration process: Use the Data Migration tool ======================================================= -Due to the changes in metric names, upgrading to Java OTel 2.x might break existing dashboards, detectors, and other features. To prevent sudden loss of access to custom reporting elements, use the Data Migration tool, which transforms and duplicates metric data in 1.x to the 2.x formats for a limited period of time at no additional cost. +Due to the changes in metric names, upgrading to Java OTel 2.x might break existing dashboards, detectors, and other features. To prevent sudden loss of access to custom reporting elements, use the Data Migration tool, which transforms and duplicates metric data from the new 2.x semantic conventions into the legacy 1.x format for a limited period of time at no additional cost. .. image:: /_images/gdi/datamigrationtool2.png :width: 90% @@ -100,8 +100,21 @@ To migrate your instrumentation to the version 2.5.0 or higher of the Java agent 2. Turn on OTLP histograms in the Splunk Distribution of OpenTelemetry Collector. + + + .. raw:: html + +
+ .. include:: /_includes/gdi/histograms.rst + .. raw:: html + +
+ + + + 3. Make sure version 2.5.0 or higher of the Splunk Distribution of the Java agent is installed. See :ref:`upgrade-java-instrumentation`. 4. If you defined a custom Collector endpoint for metrics, make sure to update the port and use the correct property: @@ -133,8 +146,21 @@ To migrate your instrumentation to the version 2.5.0 or higher of the Java agent New metric names for version 2.x ====================================== + + +.. raw:: html + +
+ .. include:: /_includes/gdi/java-20-metrics-equivalences.rst +.. raw:: html + +
+ + + + .. _metrics-not-reported-java: Metrics no longer reported @@ -177,4 +203,17 @@ Optionally, you can navigate to the dashboards on your own: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/get-data-in/application/java/performance.rst b/gdi/get-data-in/application/java/performance.rst index 697f65243..1cfa86bc4 100644 --- a/gdi/get-data-in/application/java/performance.rst +++ b/gdi/get-data-in/application/java/performance.rst @@ -21,8 +21,21 @@ The following sections describe the minimum requirements of the Splunk OTel Java Minimum requirements for production deployments ================================================================= + + +.. raw:: html + +
+ .. include:: /_includes/requirements/java.rst +.. raw:: html + +
+ + + + .. _java-overhead-guidelines: @@ -160,4 +173,17 @@ Consider that different stacks, applications, and environments might result in d How to get support ================================================================= + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/get-data-in/application/java/troubleshooting/common-java-troubleshooting.rst b/gdi/get-data-in/application/java/troubleshooting/common-java-troubleshooting.rst index ec5ada709..cef0ed299 100644 --- a/gdi/get-data-in/application/java/troubleshooting/common-java-troubleshooting.rst +++ b/gdi/get-data-in/application/java/troubleshooting/common-java-troubleshooting.rst @@ -292,4 +292,17 @@ To run the Java agent in silent mode, add the following argument: -Dotel.javaagent.logging=none + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/get-data-in/application/nodejs/instrumentation/instrument-nodejs-application.rst b/gdi/get-data-in/application/nodejs/instrumentation/instrument-nodejs-application.rst index 284004aa3..62104936a 100644 --- a/gdi/get-data-in/application/nodejs/instrumentation/instrument-nodejs-application.rst +++ b/gdi/get-data-in/application/nodejs/instrumentation/instrument-nodejs-application.rst @@ -7,7 +7,20 @@ Instrument your Node.js application for Splunk Observability Cloud .. meta:: :description: The Splunk Distribution of OpenTelemetry Node.js can automatically instrument your Node.js application or service. Follow these steps to get started. + + +.. raw:: html + +
+ .. include:: /_includes/zero-code-info.rst + +.. raw:: html + +
+ + + The Splunk Distribution of OpenTelemetry JS can automatically instrument your Node.js application and many of the popular node.js libraries your application uses. @@ -296,8 +309,21 @@ For more information on the ingest API endpoints, see :new-page:`Send APM traces Specify the source host ----------------------------------------------------- + + +.. raw:: html + +
+ .. include:: /_includes/gdi/apm-api-define-host.rst +.. raw:: html + +
+ + + + Instrument Lambda functions ============================================================= diff --git a/gdi/get-data-in/application/nodejs/nodejs-otel-requirements.rst b/gdi/get-data-in/application/nodejs/nodejs-otel-requirements.rst index 1e7f95d04..fd5076d7f 100644 --- a/gdi/get-data-in/application/nodejs/nodejs-otel-requirements.rst +++ b/gdi/get-data-in/application/nodejs/nodejs-otel-requirements.rst @@ -16,8 +16,21 @@ Meet these requirements to instrument Node.js applications for Splunk Observabil Ensure you have supported Node.js and library versions ============================================================== + + +.. raw:: html + +
+ .. include:: /_includes/requirements/nodejs.rst +.. raw:: html + +
+ + + + Dependencies --------------- diff --git a/gdi/get-data-in/application/nodejs/performance.rst b/gdi/get-data-in/application/nodejs/performance.rst index b07ffe3ca..99b7923c9 100644 --- a/gdi/get-data-in/application/nodejs/performance.rst +++ b/gdi/get-data-in/application/nodejs/performance.rst @@ -20,8 +20,21 @@ The following sections describe the minimum requirements of the Splunk OTel Node Minimum requirements for production deployments ================================================================= + + +.. raw:: html + +
+ .. include:: /_includes/requirements/nodejs.rst +.. raw:: html + +
+ + + + .. _nodejs-overhead-guidelines: @@ -188,4 +201,17 @@ You can also compare your results with the official OpenTelemetry JS benchmarks How to get support ================================================================= + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/get-data-in/application/nodejs/troubleshooting/common-nodejs-troubleshooting.rst b/gdi/get-data-in/application/nodejs/troubleshooting/common-nodejs-troubleshooting.rst index 2d1f8d1ca..3481a69c3 100644 --- a/gdi/get-data-in/application/nodejs/troubleshooting/common-nodejs-troubleshooting.rst +++ b/gdi/get-data-in/application/nodejs/troubleshooting/common-nodejs-troubleshooting.rst @@ -190,4 +190,16 @@ The following snippet contains a sample ``profiling`` pipeline: processors: [memory_limiter, batch] exporters: [splunk_hec, splunk_hec/profiling] -.. include:: /_includes/troubleshooting-components.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + diff --git a/gdi/get-data-in/application/otel-dotnet/dotnet-requirements.rst b/gdi/get-data-in/application/otel-dotnet/dotnet-requirements.rst index c4c589a32..be2fb5a75 100644 --- a/gdi/get-data-in/application/otel-dotnet/dotnet-requirements.rst +++ b/gdi/get-data-in/application/otel-dotnet/dotnet-requirements.rst @@ -14,8 +14,21 @@ Meet the following requirements to instrument .NET applications for Splunk Obser Ensure you are using supported .NET versions ============================================================== + + +.. raw:: html + +
+ .. include:: /_includes/requirements/dotnet.rst +.. raw:: html + +
+ + + + Dependencies --------------- diff --git a/gdi/get-data-in/application/otel-dotnet/instrumentation/azure-webapps.rst b/gdi/get-data-in/application/otel-dotnet/instrumentation/azure-webapps.rst index 2fe7efe19..71955fb8d 100644 --- a/gdi/get-data-in/application/otel-dotnet/instrumentation/azure-webapps.rst +++ b/gdi/get-data-in/application/otel-dotnet/instrumentation/azure-webapps.rst @@ -197,4 +197,17 @@ Run your function and search for spans in Splunk APM. See :ref:`span-search` for Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/get-data-in/application/otel-dotnet/instrumentation/azure-webjobs.rst b/gdi/get-data-in/application/otel-dotnet/instrumentation/azure-webjobs.rst index 39ab91f44..7ae2e7917 100644 --- a/gdi/get-data-in/application/otel-dotnet/instrumentation/azure-webjobs.rst +++ b/gdi/get-data-in/application/otel-dotnet/instrumentation/azure-webjobs.rst @@ -220,4 +220,17 @@ Run your function and search for spans in Splunk APM. See :ref:`span-search` for Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/get-data-in/application/otel-dotnet/instrumentation/instrument-dotnet-application.rst b/gdi/get-data-in/application/otel-dotnet/instrumentation/instrument-dotnet-application.rst index b01543db1..e9864efb9 100644 --- a/gdi/get-data-in/application/otel-dotnet/instrumentation/instrument-dotnet-application.rst +++ b/gdi/get-data-in/application/otel-dotnet/instrumentation/instrument-dotnet-application.rst @@ -7,7 +7,20 @@ Instrument your .NET application for Splunk Observability Cloud (OpenTelemetry) .. meta:: :description: The Splunk Distribution of OpenTelemetry .NET automatically instruments .NET applications, Windows services running .NET applications, and ASP.NET applications deployed on IIS. Follow these steps to get started. + + +.. raw:: html + +
+ .. include:: /_includes/zero-code-info.rst + +.. raw:: html + +
+ + + The Splunk Distribution of OpenTelemetry .NET automatically instruments .NET applications, Windows services running .NET applications, and ASP.NET applications deployed on IIS. @@ -417,8 +430,21 @@ To find your Splunk realm, see :ref:`Note about realms `. Specify the source host ---------------------------------------------- + + +.. raw:: html + +
+ .. include:: /_includes/gdi/apm-api-define-host.rst +.. raw:: html + +
+ + + + .. _uninstall-otel-dotnet: Uninstall the .NET instrumentation diff --git a/gdi/get-data-in/application/otel-dotnet/performance.rst b/gdi/get-data-in/application/otel-dotnet/performance.rst index 29da3d166..79bb2aafe 100644 --- a/gdi/get-data-in/application/otel-dotnet/performance.rst +++ b/gdi/get-data-in/application/otel-dotnet/performance.rst @@ -21,8 +21,21 @@ The following sections describe the minimum requirements of the Splunk Distribut Minimum requirements for production deployments ================================================================= + + +.. raw:: html + +
+ .. include:: /_includes/requirements/dotnet.rst +.. raw:: html + +
+ + + + .. _dotnet-overhead-guidelines: @@ -151,4 +164,16 @@ Consider that different stacks, applications, and environments might result in d How to get support ================================================================= -.. include:: /_includes/troubleshooting-components.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + diff --git a/gdi/get-data-in/application/otel-dotnet/sfx/instrumentation/instrument-dotnet-application.rst b/gdi/get-data-in/application/otel-dotnet/sfx/instrumentation/instrument-dotnet-application.rst index 6265b7f8f..b9828394e 100644 --- a/gdi/get-data-in/application/otel-dotnet/sfx/instrumentation/instrument-dotnet-application.rst +++ b/gdi/get-data-in/application/otel-dotnet/sfx/instrumentation/instrument-dotnet-application.rst @@ -388,4 +388,17 @@ For more information on the ingest API endpoints, see :new-page:`Send APM traces Specify the source host -------------------------------------------------------------------- + + +.. raw:: html + +
+ .. include:: /_includes/gdi/apm-api-define-host.rst + +.. raw:: html + +
+ + + diff --git a/gdi/get-data-in/application/otel-dotnet/sfx/troubleshooting/common-dotnet-troubleshooting.rst b/gdi/get-data-in/application/otel-dotnet/sfx/troubleshooting/common-dotnet-troubleshooting.rst index d5f8e18da..60507909c 100644 --- a/gdi/get-data-in/application/otel-dotnet/sfx/troubleshooting/common-dotnet-troubleshooting.rst +++ b/gdi/get-data-in/application/otel-dotnet/sfx/troubleshooting/common-dotnet-troubleshooting.rst @@ -228,4 +228,17 @@ Follow these steps to remove the SignalFx Instrumentation for .NET: #. Remove all environment variables you might have set for the instrumentation. #. Remove ``signalfx-dotnet-tracing`` using your package manager or delete the files from ``/opt/signalfx`` if you installed the instrumentation using the tar file. + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/get-data-in/application/php/instrument-php-application.rst b/gdi/get-data-in/application/php/instrument-php-application.rst index 7ebb98e29..2952f952d 100644 --- a/gdi/get-data-in/application/php/instrument-php-application.rst +++ b/gdi/get-data-in/application/php/instrument-php-application.rst @@ -7,7 +7,20 @@ Instrument your PHP application for Splunk Observability Cloud .. meta:: :description: The OpenTelemetry PHP extensions automatically instruments PHP applications using a PHP extension and available instrumentation libraries. Follow these steps to get started. + + +.. raw:: html + +
+ .. include:: /_includes/zero-code-info.rst + +.. raw:: html + +
+ + + The OpenTelemetry PHP extension automatically instruments PHP applications using a PHP extension and available instrumentation libraries. You can send telemetry to the Splunk Distribution of OpenTelemetry Collector or directly to the Splunk Observability Cloud ingest endpoint. diff --git a/gdi/get-data-in/application/php/php-otel-requirements.rst b/gdi/get-data-in/application/php/php-otel-requirements.rst index 48b807bd3..12944bd1f 100644 --- a/gdi/get-data-in/application/php/php-otel-requirements.rst +++ b/gdi/get-data-in/application/php/php-otel-requirements.rst @@ -7,8 +7,21 @@ OpenTelemetry PHP instrumentation compatibility and requirements .. meta:: :description: This is what you need to instrument PHP applications for Splunk Observability Cloud. + + +.. raw:: html + +
+ .. include:: /_includes/requirements/php.rst +.. raw:: html + +
+ + + + Dependencies --------------- diff --git a/gdi/get-data-in/application/php/sfx/instrumentation/instrument-php-application.rst b/gdi/get-data-in/application/php/sfx/instrumentation/instrument-php-application.rst index 3b4eda277..e7d3aa2e7 100644 --- a/gdi/get-data-in/application/php/sfx/instrumentation/instrument-php-application.rst +++ b/gdi/get-data-in/application/php/sfx/instrumentation/instrument-php-application.rst @@ -220,8 +220,21 @@ To bypass the OTel Collector and send data directly to Splunk Observability Clou export SIGNALFX_ACCESS_TOKEN= export SIGNALFX_ENDPOINT_URL=https://ingest..signalfx.com/v2/trace/signalfxv1 + + +.. raw:: html + +
+ .. include:: /_includes/gdi/apm-api-define-host.rst +.. raw:: html + +
+ + + + To obtain an access token, see :ref:`admin-api-access-tokens`. To find your Splunk realm, see :ref:`Note about realms `. diff --git a/gdi/get-data-in/application/python/instrumentation/instrument-python-application.rst b/gdi/get-data-in/application/python/instrumentation/instrument-python-application.rst index 7ca4c4313..7be9088fb 100644 --- a/gdi/get-data-in/application/python/instrumentation/instrument-python-application.rst +++ b/gdi/get-data-in/application/python/instrumentation/instrument-python-application.rst @@ -7,8 +7,21 @@ Instrument your Python application for Splunk Observability Cloud .. meta:: :description: The Splunk OpenTelemetry Python agent can automatically instrument your Python application or service. Follow these steps to get started. + + +.. raw:: html + +
+ .. include:: /_includes/zero-code-info.rst +.. raw:: html + +
+ + + + The Python agent from the Splunk Distribution of OpenTelemetry Python can automatically instrument your Python application by dynamically patching supported libraries. To get started, use the guided setup or follow the instructions manually. @@ -228,8 +241,21 @@ To find your Splunk realm, see :ref:`Note about realms `. Specify the source host ---------------------------------------------------- + + +.. raw:: html + +
+ .. include:: /_includes/gdi/apm-api-define-host.rst +.. raw:: html + +
+ + + + .. _instrument_aws_python_functions: Instrument Lambda functions diff --git a/gdi/get-data-in/application/python/python-otel-requirements.rst b/gdi/get-data-in/application/python/python-otel-requirements.rst index 792f59729..d4f804eec 100644 --- a/gdi/get-data-in/application/python/python-otel-requirements.rst +++ b/gdi/get-data-in/application/python/python-otel-requirements.rst @@ -21,7 +21,20 @@ The Splunk Distribution of OpenTelemetry Python instruments numerous libraries a Ensure you have supported Python and library versions ============================================================== + + +.. raw:: html + +
+ .. include:: /_includes/requirements/python.rst + +.. raw:: html + +
+ + + .. _python-otel-connector-requirement: diff --git a/gdi/get-data-in/application/python/troubleshooting/common-python-troubleshooting.rst b/gdi/get-data-in/application/python/troubleshooting/common-python-troubleshooting.rst index 95c90affb..7d9714994 100644 --- a/gdi/get-data-in/application/python/troubleshooting/common-python-troubleshooting.rst +++ b/gdi/get-data-in/application/python/troubleshooting/common-python-troubleshooting.rst @@ -125,4 +125,17 @@ If you send traces directly to Splunk Observability Cloud and receive a 401 erro Make sure that you're using a valid Splunk access token when sending data directly to your Splunk platform instance. See :ref:`admin-api-access-tokens`. + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/get-data-in/application/ruby/distro/instrumentation/instrument-ruby-application.rst b/gdi/get-data-in/application/ruby/distro/instrumentation/instrument-ruby-application.rst index d80d2c18a..62a013246 100644 --- a/gdi/get-data-in/application/ruby/distro/instrumentation/instrument-ruby-application.rst +++ b/gdi/get-data-in/application/ruby/distro/instrumentation/instrument-ruby-application.rst @@ -187,8 +187,21 @@ To find your Splunk realm, see :ref:`Note about realms `. Specify the source host --------------------------------------------- + + +.. raw:: html + +
+ .. include:: /_includes/gdi/apm-api-define-host.rst +.. raw:: html + +
+ + + + .. _instrument_aws_ruby_functions: Instrument Lambda functions diff --git a/gdi/get-data-in/application/ruby/distro/troubleshooting/common-ruby-troubleshooting.rst b/gdi/get-data-in/application/ruby/distro/troubleshooting/common-ruby-troubleshooting.rst index f715433a2..c12f59dd6 100644 --- a/gdi/get-data-in/application/ruby/distro/troubleshooting/common-ruby-troubleshooting.rst +++ b/gdi/get-data-in/application/ruby/distro/troubleshooting/common-ruby-troubleshooting.rst @@ -59,4 +59,16 @@ If you send traces directly to Splunk Observability Cloud and receive a 401 erro Make sure that you're using a valid Splunk access token when sending data directly to your Splunk platform instance. See :ref:`admin-api-access-tokens`. -.. include:: /_includes/troubleshooting-components.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + diff --git a/gdi/get-data-in/application/ruby/instrument-ruby.rst b/gdi/get-data-in/application/ruby/instrument-ruby.rst index 04de56003..ebed64e3f 100644 --- a/gdi/get-data-in/application/ruby/instrument-ruby.rst +++ b/gdi/get-data-in/application/ruby/instrument-ruby.rst @@ -7,7 +7,20 @@ Instrument your Ruby application for Splunk Observability Cloud .. meta:: :description: Instrument your Ruby application using the OpenTelemetry instrumentation for Ruby and get your data into Splunk Observability Cloud. + + +.. raw:: html + +
+ .. include:: /_includes/zero-code-info.rst + +.. raw:: html + +
+ + + You can use the OpenTelemetry Collector to send traces from Ruby applications to Splunk APM. diff --git a/gdi/get-data-in/application/ruby/ruby-otel-requirements.rst b/gdi/get-data-in/application/ruby/ruby-otel-requirements.rst index a85764204..32957ac57 100644 --- a/gdi/get-data-in/application/ruby/ruby-otel-requirements.rst +++ b/gdi/get-data-in/application/ruby/ruby-otel-requirements.rst @@ -21,8 +21,21 @@ The OpenTelemetry instrumentation for Ruby instruments numerous libraries and pa Ensure you have supported Ruby and library versions ============================================================== + + +.. raw:: html + +
+ .. include:: /_includes/requirements/ruby.rst +.. raw:: html + +
+ + + + .. _ruby-otel-connector-requirement: diff --git a/gdi/get-data-in/compute/linux.rst b/gdi/get-data-in/compute/linux.rst index fdbd61ef7..58d68d2c5 100644 --- a/gdi/get-data-in/compute/linux.rst +++ b/gdi/get-data-in/compute/linux.rst @@ -12,8 +12,21 @@ The Splunk Distribution of the OpenTelemetry Collector is a package that provide Supported versions ===================== + + +.. raw:: html + +
+ .. include:: /_includes/requirements/collector-linux.rst +.. raw:: html + +
+ + + + Install the Collector for Linux ====================================== diff --git a/gdi/get-data-in/compute/windows.rst b/gdi/get-data-in/compute/windows.rst index 9c1188719..94d1c0fcc 100644 --- a/gdi/get-data-in/compute/windows.rst +++ b/gdi/get-data-in/compute/windows.rst @@ -12,8 +12,21 @@ The Splunk Distribution of the OpenTelemetry Collector is a package that provide Supported versions ===================== + + +.. raw:: html + +
+ .. include:: /_includes/requirements/collector-windows.rst +.. raw:: html + +
+ + + + Install the Collector for Windows ====================================== diff --git a/gdi/get-data-in/connect/aws/get-awstoc.rst b/gdi/get-data-in/connect/aws/get-awstoc.rst index f4835d02a..0fda23b64 100644 --- a/gdi/get-data-in/connect/aws/get-awstoc.rst +++ b/gdi/get-data-in/connect/aws/get-awstoc.rst @@ -112,8 +112,21 @@ You can deactivate this check by setting the ``enableCheckLargeVolume`` field in If you filter data based on tags, your costs for Amazon CloudWatch and Splunk Infrastructure Monitoring might decrease. Read more at :ref:`specify-data-metadata`. + + +.. raw:: html + +
+ .. include:: /_includes/gdi/aws-unsupported-chars.rst +.. raw:: html + +
+ + + + .. raw:: html diff --git a/gdi/get-data-in/connect/azure/azure-metrics.rst b/gdi/get-data-in/connect/azure/azure-metrics.rst index 63a22b5af..296e574e9 100644 --- a/gdi/get-data-in/connect/azure/azure-metrics.rst +++ b/gdi/get-data-in/connect/azure/azure-metrics.rst @@ -7,8 +7,21 @@ Azure metrics in Splunk Observability Cloud .. meta:: :description: These are the metrics available for the Azure integration with Splunk Observability Cloud, grouped according to Azure resource. + + +.. raw:: html + +
+ .. include:: /_includes/gdi/available-azure.rst +.. raw:: html + +
+ + + + Azure services metric information ================================================ diff --git a/gdi/get-data-in/connect/gcp/gcp-metrics.rst b/gdi/get-data-in/connect/gcp/gcp-metrics.rst index ebb699330..e7a794a50 100644 --- a/gdi/get-data-in/connect/gcp/gcp-metrics.rst +++ b/gdi/get-data-in/connect/gcp/gcp-metrics.rst @@ -19,8 +19,21 @@ Although you can configure :new-page:`Cloud Monitoring + .. include:: /_includes/gdi/available-gcp.rst +.. raw:: html + +
+ + + + * For a detailed list of the available Google Cloud Monitoring metrics, including services not supported out-of-the-box, see the official Google documentation at :new-page:`Google Cloud metrics `. * To track and understand your consumption, see :ref:`monitor-imm-billing-usage`. diff --git a/gdi/get-data-in/rum/android/install-rum-android.rst b/gdi/get-data-in/rum/android/install-rum-android.rst index c80770a08..479e71da5 100644 --- a/gdi/get-data-in/rum/android/install-rum-android.rst +++ b/gdi/get-data-in/rum/android/install-rum-android.rst @@ -26,8 +26,21 @@ Latest updates automatically whenever Splunk RUM releases a new version. In pre- Check compatibility and requirements =============================================== + + +.. raw:: html + +
+ .. include:: /_includes/requirements/android.rst +.. raw:: html + +
+ + + + .. _enable-desugaring: Activate desugaring in your application diff --git a/gdi/get-data-in/rum/android/rum-android-data-model.rst b/gdi/get-data-in/rum/android/rum-android-data-model.rst index ef141cff7..bd8310a93 100644 --- a/gdi/get-data-in/rum/android/rum-android-data-model.rst +++ b/gdi/get-data-in/rum/android/rum-android-data-model.rst @@ -12,8 +12,21 @@ The Android agent for Splunk Real User Monitoring (RUM) collects the following t Common data types ============================================== + + +.. raw:: html + +
+ .. include:: /_includes/rum-data-model.rst +.. raw:: html + +
+ + + + .. _android-rum-basic-properties: Basic properties diff --git a/gdi/get-data-in/rum/android/troubleshooting.rst b/gdi/get-data-in/rum/android/troubleshooting.rst index 40f80d1fa..633952a02 100644 --- a/gdi/get-data-in/rum/android/troubleshooting.rst +++ b/gdi/get-data-in/rum/android/troubleshooting.rst @@ -85,4 +85,17 @@ Splunk RUM uses gzip encoding to reduce network bandwidth consumption. The Netwo As a workaround, deactivate Splunk RUM while profiling your app, or deactivate gzip compression when profiling your app. + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/get-data-in/rum/browser/install-rum-browser.rst b/gdi/get-data-in/rum/browser/install-rum-browser.rst index d5802e73e..5eabe5f69 100644 --- a/gdi/get-data-in/rum/browser/install-rum-browser.rst +++ b/gdi/get-data-in/rum/browser/install-rum-browser.rst @@ -16,11 +16,37 @@ To instrument your browser application and get data into Splunk RUM, follow the Check compatibility and requirements ============================================== + + +.. raw:: html + +
+ .. include:: /_includes/requirements/browser.rst +.. raw:: html + +
+ + + + + + + +.. raw:: html + +
.. include:: /_includes/requirements/realm.rst +.. raw:: html + +
+ + + + .. _rum-browser-install: diff --git a/gdi/get-data-in/rum/browser/rum-browser-data-model.rst b/gdi/get-data-in/rum/browser/rum-browser-data-model.rst index a3cba5913..0103670be 100644 --- a/gdi/get-data-in/rum/browser/rum-browser-data-model.rst +++ b/gdi/get-data-in/rum/browser/rum-browser-data-model.rst @@ -12,8 +12,21 @@ The Browser RUM agent collects general RUM telemetry data about your front-end w Common data types ============================================== + + +.. raw:: html + +
+ .. include:: /_includes/rum-data-model.rst +.. raw:: html + +
+ + + + .. _browser-rum-basic-properties: Basic properties diff --git a/gdi/get-data-in/rum/browser/troubleshooting.rst b/gdi/get-data-in/rum/browser/troubleshooting.rst index 70b42e6c7..2717c4f72 100644 --- a/gdi/get-data-in/rum/browser/troubleshooting.rst +++ b/gdi/get-data-in/rum/browser/troubleshooting.rst @@ -128,8 +128,21 @@ If you think Browser RUM might be causing issues in your website or breaking exi xhr: false, } + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + + Browser developer tools display events from Splunk instrumentation ================================================================== diff --git a/gdi/get-data-in/rum/ios/install-rum-ios.rst b/gdi/get-data-in/rum/ios/install-rum-ios.rst index a919d1e83..d79a90472 100644 --- a/gdi/get-data-in/rum/ios/install-rum-ios.rst +++ b/gdi/get-data-in/rum/ios/install-rum-ios.rst @@ -23,8 +23,21 @@ Latest updates automatically whenever Splunk RUM releases a new version. In pre- Check compatibility and requirements =============================================== + + +.. raw:: html + +
+ .. include:: /_includes/requirements/ios.rst +.. raw:: html + +
+ + + + .. _rum-ios-install: diff --git a/gdi/get-data-in/rum/ios/rum-ios-data-model.rst b/gdi/get-data-in/rum/ios/rum-ios-data-model.rst index eb8d87eea..d60217f1b 100644 --- a/gdi/get-data-in/rum/ios/rum-ios-data-model.rst +++ b/gdi/get-data-in/rum/ios/rum-ios-data-model.rst @@ -12,8 +12,21 @@ The iOS RUM library includes a package that collects the following types of data Common data types ============================================== + + +.. raw:: html + +
+ .. include:: /_includes/rum-data-model.rst +.. raw:: html + +
+ + + + .. _rum-ios-metrics: Metrics diff --git a/gdi/get-data-in/rum/ios/troubleshooting.rst b/gdi/get-data-in/rum/ios/troubleshooting.rst index 936664171..ed951b18c 100644 --- a/gdi/get-data-in/rum/ios/troubleshooting.rst +++ b/gdi/get-data-in/rum/ios/troubleshooting.rst @@ -123,4 +123,17 @@ Avoid SQLite redefinition errors If you're using another tool that uses SQLite, like WCDB, try replacing the ``use_frameworks!`` line in your Podfile with ``use_modular_headers!``. + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/get-data-in/rum/react/install-rum-react.rst b/gdi/get-data-in/rum/react/install-rum-react.rst index b2ad8f4e0..5da6eba87 100644 --- a/gdi/get-data-in/rum/react/install-rum-react.rst +++ b/gdi/get-data-in/rum/react/install-rum-react.rst @@ -20,8 +20,21 @@ To instrument your React Native or Expo application and get data into Splunk RUM Check compatibility and requirements =============================================== + + +.. raw:: html + +
+ .. include:: /_includes/requirements/react.rst +.. raw:: html + +
+ + + + .. _rum-react-install: Instrument your React Native application for Splunk RUM diff --git a/gdi/get-data-in/rum/react/rum-react-data-model.rst b/gdi/get-data-in/rum/react/rum-react-data-model.rst index d6c0c581c..f221c41db 100644 --- a/gdi/get-data-in/rum/react/rum-react-data-model.rst +++ b/gdi/get-data-in/rum/react/rum-react-data-model.rst @@ -12,8 +12,21 @@ The React Native RUM agent includes a package that collects the following types Common data types ============================================== + + +.. raw:: html + +
+ .. include:: /_includes/rum-data-model.rst +.. raw:: html + +
+ + + + .. _react-rum-basic-properties: Basic properties diff --git a/gdi/get-data-in/serverless/aws/otel-lambda-layer/instrument-lambda-functions.rst b/gdi/get-data-in/serverless/aws/otel-lambda-layer/instrument-lambda-functions.rst index 2bda9ff28..862c1ee48 100644 --- a/gdi/get-data-in/serverless/aws/otel-lambda-layer/instrument-lambda-functions.rst +++ b/gdi/get-data-in/serverless/aws/otel-lambda-layer/instrument-lambda-functions.rst @@ -53,8 +53,21 @@ If you don't use the guided setup, follow these instructions to manually install

Check compatibility and requirements

+ + +.. raw:: html + +
+ .. include:: /_includes/requirements/lambda.rst +.. raw:: html + +
+ + + + .. raw:: html @@ -84,14 +97,40 @@ Follow these steps to instrument your function using the Splunk OpenTelemetry La .. tab:: Standard x86_64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-apm.md + .. raw:: html + +
+ + + + .. tab:: Graviton2 ARM64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-apm-arm.md + .. raw:: html + +
+ + + + #. Paste the selected ARN in the :guilabel:`Specify an ARN` field and select :guilabel:`Add`. #. Check that the Splunk OpenTelemetry Lambda layer appears in the :guilabel:`Layers` table. @@ -103,13 +142,40 @@ If you don't want to use a local Collector, you must specify the address of a Co .. _set-env-vars-otel-lambda: +Configure the Splunk OpenTelemetry Lambda layer +---------------------------------------------------- + +.. raw:: html + +
+ .. include:: /_includes/gdi/lambda-configuration.rst +.. raw:: html + +
+ + + + .. _send_directly_olly_cloud: + + +.. raw:: html + +
+ .. include:: /_includes/gdi/send-spans-directly-lambda.rst +.. raw:: html + +
+ + + + .. raw:: html diff --git a/gdi/get-data-in/serverless/aws/otel-lambda-layer/instrumentation/lambda-ec2-collector-gateway.rst b/gdi/get-data-in/serverless/aws/otel-lambda-layer/instrumentation/lambda-ec2-collector-gateway.rst index 45490bec7..19556b469 100644 --- a/gdi/get-data-in/serverless/aws/otel-lambda-layer/instrumentation/lambda-ec2-collector-gateway.rst +++ b/gdi/get-data-in/serverless/aws/otel-lambda-layer/instrumentation/lambda-ec2-collector-gateway.rst @@ -15,8 +15,21 @@ Follow these instructions to install the Splunk OpenTelemetry Lambda layer for J Check compatibility and requirements ============================================== + + +.. raw:: html + +
+ .. include:: /_includes/requirements/lambda.rst +.. raw:: html + +
+ + + + Install the AWS Lambda layer for your language ============================================== @@ -33,36 +46,114 @@ Follow these steps to instrument your function using the Splunk OpenTelemetry La .. tab:: Java x86_64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-apm-java.md + .. raw:: html + +
+ + + + .. tab:: Java ARM64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-apm-java-arm.md + .. raw:: html + +
+ + + + .. tab:: Node.js x86_64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-apm-js.md + .. raw:: html + +
+ + + + .. tab:: Node.js ARM64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-apm-js-arm.md + .. raw:: html + +
+ + + + .. tab:: Python x86_64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-apm-python.md + .. raw:: html + +
+ + + + .. note:: For Python functions using the Serverless Framework, see :ref:`serverless-framework-support-aws`. .. tab:: Python ARM64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-apm-python-arm.md + .. raw:: html + +
+ + + + .. note:: For Python functions using the Serverless Framework, see :ref:`serverless-framework-support-aws`. #. Paste the selected ARN in the :guilabel:`Specify an ARN` field and select :guilabel:`Add`. @@ -75,19 +166,59 @@ Follow these steps to instrument your function using the Splunk OpenTelemetry La .. tab:: Standard x86_64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-lambda-metrics.md + .. raw:: html + +
+ + + + .. tab:: Graviton2 ARM64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-lambda-metrics-arm.md + .. raw:: html + +
+ + + + .. note:: You can automate the update of the Lambda layers using the AWS CLI or other automation tools. +Configure the Splunk OpenTelemetry Lambda layer +---------------------------------------------------- + +.. raw:: html + +
+ .. include:: /_includes/gdi/lambda-configuration.rst +.. raw:: html + +
+ + + + .. _ec2-otel-collector-serverless: diff --git a/gdi/get-data-in/serverless/aws/otel-lambda-layer/instrumentation/lambda-language-layers.rst b/gdi/get-data-in/serverless/aws/otel-lambda-layer/instrumentation/lambda-language-layers.rst index 560eaf890..a932182fd 100644 --- a/gdi/get-data-in/serverless/aws/otel-lambda-layer/instrumentation/lambda-language-layers.rst +++ b/gdi/get-data-in/serverless/aws/otel-lambda-layer/instrumentation/lambda-language-layers.rst @@ -15,8 +15,21 @@ Follow these instructions to install the Splunk OpenTelemetry Lambda layer for J Check compatibility and requirements ============================================== + + +.. raw:: html + +
+ .. include:: /_includes/requirements/lambda.rst +.. raw:: html + +
+ + + + Considerations on sizing and scaling ============================================== @@ -39,36 +52,114 @@ Follow these steps to instrument your function using the Splunk OpenTelemetry La .. tab:: Java x86_64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-apm-java.md + .. raw:: html + +
+ + + + .. tab:: Java ARM64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-apm-java-arm.md + .. raw:: html + +
+ + + + .. tab:: Node.js x86_64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-apm-js.md + .. raw:: html + +
+ + + + .. tab:: Node.js ARM64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-apm-js-arm.md + .. raw:: html + +
+ + + + .. tab:: Python x86_64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-apm-python.md + .. raw:: html + +
+ + + + .. note:: For Python functions using the Serverless Framework, see :ref:`serverless-framework-support-aws`. .. tab:: Python ARM64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-apm-python-arm.md + .. raw:: html + +
+ + + + .. note:: For Python functions using the Serverless Framework, see :ref:`serverless-framework-support-aws`. #. Paste the selected ARN in the :guilabel:`Specify an ARN` field and select :guilabel:`Add`. @@ -81,37 +172,116 @@ Follow these steps to instrument your function using the Splunk OpenTelemetry La .. tab:: Standard x86_64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-apm-collector.md + .. raw:: html + +
+ + + + .. tab:: Graviton2 ARM64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-apm-collector-arm.md + .. raw:: html + +
+ + + + #. (Optional) Repeat the previous steps to install AWS Lambda metrics extension layer for Splunk Infrastructure Monitoring. .. tabs:: .. tab:: Standard x86_64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-lambda-metrics.md + .. raw:: html + +
+ + + + .. tab:: Graviton2 ARM64 + + + .. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/lambda-layer-versions/main/splunk-apm/splunk-lambda-metrics-arm.md + .. raw:: html + +
+ + + + .. note:: You can automate the update of the AWS Lambda layers using the AWS CLI or other automation tools. +Configure the Splunk OpenTelemetry Lambda layer +---------------------------------------------------- + +.. raw:: html + +
+ .. include:: /_includes/gdi/lambda-configuration.rst +.. raw:: html + +
+ + + + + + + +.. raw:: html + +
.. include:: /_includes/gdi/send-spans-directly-lambda.rst +.. raw:: html + +
+ + + + Check that data appears in Splunk Observability Cloud ===================================================================== diff --git a/gdi/get-data-in/serverless/azure/instrument-azure-functions-dotnet.rst b/gdi/get-data-in/serverless/azure/instrument-azure-functions-dotnet.rst index 884c30808..fcc6af549 100644 --- a/gdi/get-data-in/serverless/azure/instrument-azure-functions-dotnet.rst +++ b/gdi/get-data-in/serverless/azure/instrument-azure-functions-dotnet.rst @@ -405,4 +405,17 @@ Run your function and search for its spans in Splunk APM. See :ref:`span-search` Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/get-data-in/serverless/azure/instrument-azure-functions-nodejs.rst b/gdi/get-data-in/serverless/azure/instrument-azure-functions-nodejs.rst index 5bcb693ca..80160ec18 100644 --- a/gdi/get-data-in/serverless/azure/instrument-azure-functions-nodejs.rst +++ b/gdi/get-data-in/serverless/azure/instrument-azure-functions-nodejs.rst @@ -117,4 +117,17 @@ Run your function and search for its spans in Splunk APM. See :ref:`span-search` Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/integrations-list.rst b/gdi/integrations-list.rst index 13e2ac245..5b5da20d1 100644 --- a/gdi/integrations-list.rst +++ b/gdi/integrations-list.rst @@ -120,8 +120,21 @@ For more information, see :ref:`get-started-rum`. You can monitor your applications and services with the Collector and the following native :ref:`OpenTelemetry receivers `: + + +.. raw:: html + +
+ .. include:: /_includes/gdi/otel-receivers-table.rst +.. raw:: html + +
+ + + + .. raw:: html @@ -141,8 +154,21 @@ You can also send data to Splunk Observability Cloud with OpenTelemetry with the Smart Agent integrations are available and supported through the Splunk Distribution of the OpenTelemetry Collector. For more information, see :ref:`migration-monitors`. You can use these integrations to send your apps and services' metrics to Splunk Observability Cloud: + + +.. raw:: html + +
+ .. include:: /_includes/gdi/application-receiver-table.rst +.. raw:: html + +
+ + + + Browse the available monitors by category: * :ref:`Applications: Caches and memory ` @@ -167,8 +193,21 @@ Browse the available monitors by category: These Smart Agent integrations are deprecated: + + +.. raw:: html + +
+ .. include:: /_includes/gdi/application-receiver-table-deprecated.rst +.. raw:: html + +
+ + + + .. raw:: html diff --git a/gdi/integrations/cloud-aws.rst b/gdi/integrations/cloud-aws.rst index bc4e8741e..27aba8fa6 100644 --- a/gdi/integrations/cloud-aws.rst +++ b/gdi/integrations/cloud-aws.rst @@ -10,4 +10,17 @@ Available Amazon Web Services integrations To learn about AWS and Splunk Observability Cloud, read :ref:`get-started-aws`. + + +.. raw:: html + +
+ .. include:: /_includes/gdi/available-aws.rst + +.. raw:: html + +
+ + + diff --git a/gdi/integrations/cloud-azure.rst b/gdi/integrations/cloud-azure.rst index e76ca6b2b..877dd1262 100644 --- a/gdi/integrations/cloud-azure.rst +++ b/gdi/integrations/cloud-azure.rst @@ -11,5 +11,18 @@ Available Azure integrations To learn about Azure and Splunk Observability Cloud, read :ref:`get-started-azure`. + + +.. raw:: html + +
+ .. include:: /_includes/gdi/available-azure.rst +.. raw:: html + +
+ + + + diff --git a/gdi/integrations/cloud-gcp.rst b/gdi/integrations/cloud-gcp.rst index f2fded358..73937abb7 100644 --- a/gdi/integrations/cloud-gcp.rst +++ b/gdi/integrations/cloud-gcp.rst @@ -12,4 +12,16 @@ To learn about GCP and Splunk Observability Cloud, read :ref:`get-started-gcp`. Splunk Observability Cloud supports certain services by default, but you can add any other GCP service you need to monitor. See :ref:`Start the integration `. -.. include:: /_includes/gdi/available-gcp.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/gdi/available-gcp.rst +.. raw:: html + +
+ + + diff --git a/gdi/monitors-cache/memcached.rst b/gdi/monitors-cache/memcached.rst index 962dfe2d2..7a3e2366b 100644 --- a/gdi/monitors-cache/memcached.rst +++ b/gdi/monitors-cache/memcached.rst @@ -20,18 +20,57 @@ This integration is only available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -107,9 +146,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-cache/memory.rst b/gdi/monitors-cache/memory.rst index 52569f2fd..ccb277c34 100644 --- a/gdi/monitors-cache/memory.rst +++ b/gdi/monitors-cache/memory.rst @@ -25,18 +25,57 @@ This integration is only available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -73,9 +112,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-cache/opcache.rst b/gdi/monitors-cache/opcache.rst index 4aaab9de2..5a6d379d1 100644 --- a/gdi/monitors-cache/opcache.rst +++ b/gdi/monitors-cache/opcache.rst @@ -13,13 +13,39 @@ This integration is available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + PHP setup ~~~~~~~~~ @@ -70,8 +96,21 @@ the following command: Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -190,9 +229,35 @@ Metrics Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-cloud/heroku.rst b/gdi/monitors-cloud/heroku.rst index ea8c5c3e1..a4f04e718 100644 --- a/gdi/monitors-cloud/heroku.rst +++ b/gdi/monitors-cloud/heroku.rst @@ -170,4 +170,17 @@ buildpack. Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-cloud/kong.rst b/gdi/monitors-cloud/kong.rst index 099ca1bae..10c53240f 100644 --- a/gdi/monitors-cloud/kong.rst +++ b/gdi/monitors-cloud/kong.rst @@ -37,13 +37,39 @@ To learn more: Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Kong installation ~~~~~~~~~~~~~~~~~ @@ -79,9 +105,35 @@ For the complete list of metrics provided by the integration, refer to :new-page Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-cloud/openstack.rst b/gdi/monitors-cloud/openstack.rst index bbcc2e681..9385d7518 100644 --- a/gdi/monitors-cloud/openstack.rst +++ b/gdi/monitors-cloud/openstack.rst @@ -20,18 +20,57 @@ This integration is available on Linux and Kubernetes. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -143,9 +182,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-cloudfoundry/cloudfoundry-firehose-nozzle.rst b/gdi/monitors-cloudfoundry/cloudfoundry-firehose-nozzle.rst index 05f331f34..108a948b4 100644 --- a/gdi/monitors-cloudfoundry/cloudfoundry-firehose-nozzle.rst +++ b/gdi/monitors-cloudfoundry/cloudfoundry-firehose-nozzle.rst @@ -19,18 +19,57 @@ The following applies: Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux-only.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -171,8 +210,34 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + ## Troubleshooting + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-conviva/conviva.rst b/gdi/monitors-conviva/conviva.rst index f7d9e7b4b..c8605ebb6 100644 --- a/gdi/monitors-conviva/conviva.rst +++ b/gdi/monitors-conviva/conviva.rst @@ -26,18 +26,57 @@ MetricLens dimension entities. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -171,9 +210,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-databases/apache-couchdb.rst b/gdi/monitors-databases/apache-couchdb.rst index f26bcd048..36d7b03ac 100644 --- a/gdi/monitors-databases/apache-couchdb.rst +++ b/gdi/monitors-databases/apache-couchdb.rst @@ -15,8 +15,21 @@ This integration is only available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ @@ -46,8 +59,21 @@ Installation Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -170,9 +196,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-databases/apache-spark.rst b/gdi/monitors-databases/apache-spark.rst index 546de3f19..5566b4da8 100644 --- a/gdi/monitors-databases/apache-spark.rst +++ b/gdi/monitors-databases/apache-spark.rst @@ -24,18 +24,57 @@ This integration is only available on Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -160,9 +199,35 @@ These are the metrics available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-databases/cassandra.rst b/gdi/monitors-databases/cassandra.rst index a43f7d93a..af59463d7 100644 --- a/gdi/monitors-databases/cassandra.rst +++ b/gdi/monitors-databases/cassandra.rst @@ -14,18 +14,57 @@ This integration is only available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -293,9 +332,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-databases/consul.rst b/gdi/monitors-databases/consul.rst index 36fade8a9..a9ff96c46 100644 --- a/gdi/monitors-databases/consul.rst +++ b/gdi/monitors-databases/consul.rst @@ -33,18 +33,57 @@ This integration works with Consul 0.7.0 and higher. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -202,9 +241,35 @@ These metrics are available for this integration. Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-databases/exec-input.rst b/gdi/monitors-databases/exec-input.rst index 135fdcb1b..e1b4c60be 100644 --- a/gdi/monitors-databases/exec-input.rst +++ b/gdi/monitors-databases/exec-input.rst @@ -17,18 +17,57 @@ The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent rece Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -406,4 +445,17 @@ Cloud, use one of the following options: Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-databases/hadoop.rst b/gdi/monitors-databases/hadoop.rst index 69bf270d0..e7073daa3 100644 --- a/gdi/monitors-databases/hadoop.rst +++ b/gdi/monitors-databases/hadoop.rst @@ -24,18 +24,57 @@ This integration is only available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -116,9 +155,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-databases/hadoopjmx.rst b/gdi/monitors-databases/hadoopjmx.rst index 7c4ef65b5..0e1f3e182 100644 --- a/gdi/monitors-databases/hadoopjmx.rst +++ b/gdi/monitors-databases/hadoopjmx.rst @@ -27,8 +27,21 @@ This integration is only available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Requirements ------------ @@ -52,13 +65,39 @@ options to hadoop-env.sh and yarn-env.sh: Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -373,9 +412,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-databases/logparser.rst b/gdi/monitors-databases/logparser.rst index 6fca7e7ac..8de21e814 100644 --- a/gdi/monitors-databases/logparser.rst +++ b/gdi/monitors-databases/logparser.rst @@ -17,18 +17,57 @@ emitted metrics have the plugin dimension set to ``telegraf-logparser``. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -164,4 +203,17 @@ built-in filtering of metrics coming out of this monitor type. Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-databases/logstash.rst b/gdi/monitors-databases/logstash.rst index 5b7d05639..71969c5db 100644 --- a/gdi/monitors-databases/logstash.rst +++ b/gdi/monitors-databases/logstash.rst @@ -11,13 +11,39 @@ The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent rece Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -98,9 +124,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-databases/microsoft-sql-server.rst b/gdi/monitors-databases/microsoft-sql-server.rst index 7f6a4eae5..f7b8858f5 100644 --- a/gdi/monitors-databases/microsoft-sql-server.rst +++ b/gdi/monitors-databases/microsoft-sql-server.rst @@ -16,13 +16,39 @@ Server instances. Benefits ================= + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ===================== + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Authentication ----------------------------- @@ -57,8 +83,21 @@ Microsoft SQL Server host. To create this login, follow these steps: Configuration =================== + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ------------- @@ -191,13 +230,39 @@ This integration provides a set of metrics. Note that some metrics might depend Notes --------------- + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting ======================= + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + + TCP/IP is deactivated ----------------------------- diff --git a/gdi/monitors-databases/mongodb-atlas.rst b/gdi/monitors-databases/mongodb-atlas.rst index b8082de8a..b0d112c40 100644 --- a/gdi/monitors-databases/mongodb-atlas.rst +++ b/gdi/monitors-databases/mongodb-atlas.rst @@ -111,9 +111,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-databases/mongodb.rst b/gdi/monitors-databases/mongodb.rst index 4ab006c72..ab16cc897 100644 --- a/gdi/monitors-databases/mongodb.rst +++ b/gdi/monitors-databases/mongodb.rst @@ -35,13 +35,39 @@ The following applies: Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Authentication ~~~~~~~~~~~~~~ @@ -61,8 +87,21 @@ with minimal read-only roles, as follows: Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -198,4 +237,17 @@ monitor: Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-databases/mysql.rst b/gdi/monitors-databases/mysql.rst index e9b5b712a..14d772722 100644 --- a/gdi/monitors-databases/mysql.rst +++ b/gdi/monitors-databases/mysql.rst @@ -28,13 +28,39 @@ This integration is only available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Creating a MySQL user for this monitor ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -70,8 +96,21 @@ of ``127.0.0.1``, or the IP address or name of the local server. Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -232,9 +271,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-databases/postgresql.rst b/gdi/monitors-databases/postgresql.rst index e52bdbf4a..1226fa0c3 100644 --- a/gdi/monitors-databases/postgresql.rst +++ b/gdi/monitors-databases/postgresql.rst @@ -101,4 +101,17 @@ The following table shows the configuration options for the Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-databases/redis.rst b/gdi/monitors-databases/redis.rst index 586feb9cd..33a8032ec 100644 --- a/gdi/monitors-databases/redis.rst +++ b/gdi/monitors-databases/redis.rst @@ -29,18 +29,57 @@ Redis 2.8 and higher. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -201,13 +240,39 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + + Database Query Performance ~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/gdi/monitors-databases/sap-hana.rst b/gdi/monitors-databases/sap-hana.rst index 6af040da4..1581bffc5 100644 --- a/gdi/monitors-databases/sap-hana.rst +++ b/gdi/monitors-databases/sap-hana.rst @@ -14,8 +14,21 @@ This integration is available on Kubernetes, Linux, and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Prequisites ----------- @@ -60,13 +73,39 @@ A monitoring user requires SELECT access to the relevant monitoring views. Befor Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -151,9 +190,35 @@ These are the metrics and dimensions available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-databases/sql.rst b/gdi/monitors-databases/sql.rst index 219079bcc..3ce2d1b7f 100644 --- a/gdi/monitors-databases/sql.rst +++ b/gdi/monitors-databases/sql.rst @@ -13,8 +13,21 @@ The SQL monitor gathers database usage metrics from SQL queries on your database Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -379,4 +392,17 @@ This integration doesn't produce any metrics. Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-gitlab/gitlab.rst b/gdi/monitors-gitlab/gitlab.rst index 779c03d88..12857eac4 100644 --- a/gdi/monitors-gitlab/gitlab.rst +++ b/gdi/monitors-gitlab/gitlab.rst @@ -36,13 +36,39 @@ GitLab version 9.3 or higher. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configure GitLab to monitor Prometheus endpoints -------------------------------------------------------- @@ -182,8 +208,21 @@ The ``/etc/gitlab-runner/config.toml`` file configures GitLab Runner. To configu Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -350,9 +389,35 @@ The following metrics are available for this integration. Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/amazon-ecs-metadata.rst b/gdi/monitors-hosts/amazon-ecs-metadata.rst index 315f600bc..496390ab3 100644 --- a/gdi/monitors-hosts/amazon-ecs-metadata.rst +++ b/gdi/monitors-hosts/amazon-ecs-metadata.rst @@ -15,18 +15,57 @@ This integration is only available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -63,9 +102,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/apache-httpserver.rst b/gdi/monitors-hosts/apache-httpserver.rst index f59d8678e..4b89560d7 100644 --- a/gdi/monitors-hosts/apache-httpserver.rst +++ b/gdi/monitors-hosts/apache-httpserver.rst @@ -65,18 +65,57 @@ This integration is only available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~~~~~~~~~~~~~~~ @@ -201,9 +240,35 @@ These metrics are available for this integration. Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting -------------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/apache-tomcat.rst b/gdi/monitors-hosts/apache-tomcat.rst index 47f9bb8b0..ec3b0e22b 100644 --- a/gdi/monitors-hosts/apache-tomcat.rst +++ b/gdi/monitors-hosts/apache-tomcat.rst @@ -13,18 +13,57 @@ This integration is only available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -286,9 +325,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/apache-zookeeper.rst b/gdi/monitors-hosts/apache-zookeeper.rst index a63c75228..8fe15390b 100644 --- a/gdi/monitors-hosts/apache-zookeeper.rst +++ b/gdi/monitors-hosts/apache-zookeeper.rst @@ -17,18 +17,57 @@ The plugin supports Zookeeper 3.4.0 and higher. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -111,8 +150,21 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Group leader metrics ~~~~~~~~~~~~~~~~~~~~ @@ -126,4 +178,17 @@ activate them, add ``leader`` to the ``extraGroups`` setting: Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/chrony.rst b/gdi/monitors-hosts/chrony.rst index 38a3a2bee..8e9eed436 100644 --- a/gdi/monitors-hosts/chrony.rst +++ b/gdi/monitors-hosts/chrony.rst @@ -18,18 +18,57 @@ This integration is only available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -98,4 +137,17 @@ The Splunk Distribution of OpenTelemetry Collector does not do any built-in filtering of metrics coming out of this integration. ## Troubleshooting + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/collectd-df.rst b/gdi/monitors-hosts/collectd-df.rst index b772b2c89..ab5bb8c4b 100644 --- a/gdi/monitors-hosts/collectd-df.rst +++ b/gdi/monitors-hosts/collectd-df.rst @@ -20,18 +20,57 @@ system. This might be an issue when running the agent in a container. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux-only.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -128,4 +167,17 @@ monitor: Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/collectd-plugin.rst b/gdi/monitors-hosts/collectd-plugin.rst index 58d26297e..400faff55 100644 --- a/gdi/monitors-hosts/collectd-plugin.rst +++ b/gdi/monitors-hosts/collectd-plugin.rst @@ -13,18 +13,57 @@ This integration is only available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~~~~~~~~~~~~~~~~ @@ -132,4 +171,17 @@ built-in filtering of metrics coming out of this integration. Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/collectd-uptime.rst b/gdi/monitors-hosts/collectd-uptime.rst index 81ccc5958..dff084929 100644 --- a/gdi/monitors-hosts/collectd-uptime.rst +++ b/gdi/monitors-hosts/collectd-uptime.rst @@ -13,18 +13,57 @@ This integration is only available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -61,9 +100,35 @@ The following metrics are available for this integration. Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/coredns.rst b/gdi/monitors-hosts/coredns.rst index cf736276d..0a8dab18c 100644 --- a/gdi/monitors-hosts/coredns.rst +++ b/gdi/monitors-hosts/coredns.rst @@ -15,18 +15,57 @@ The default port for these metrics are exposed on port 9153, at the ``/metrics`` Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -190,9 +229,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/couchbase.rst b/gdi/monitors-hosts/couchbase.rst index 7333727cb..2a0c4a5ec 100644 --- a/gdi/monitors-hosts/couchbase.rst +++ b/gdi/monitors-hosts/couchbase.rst @@ -14,18 +14,57 @@ This integration is only available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Configuration options ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -138,9 +177,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/cpu.rst b/gdi/monitors-hosts/cpu.rst index 774864aa3..f138157de 100644 --- a/gdi/monitors-hosts/cpu.rst +++ b/gdi/monitors-hosts/cpu.rst @@ -48,9 +48,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/cpufreq.rst b/gdi/monitors-hosts/cpufreq.rst index aeb67ed8c..fa4aad9b2 100644 --- a/gdi/monitors-hosts/cpufreq.rst +++ b/gdi/monitors-hosts/cpufreq.rst @@ -15,18 +15,57 @@ This integration is only available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + ### Example To activate this integration, add the following to your Collector @@ -62,9 +101,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/disk.rst b/gdi/monitors-hosts/disk.rst index b5d7c1758..621c0fe4c 100644 --- a/gdi/monitors-hosts/disk.rst +++ b/gdi/monitors-hosts/disk.rst @@ -38,4 +38,17 @@ The following table shows the configuration options for this monitor: Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/docker.rst b/gdi/monitors-hosts/docker.rst index ce0f3841d..029767b7b 100644 --- a/gdi/monitors-hosts/docker.rst +++ b/gdi/monitors-hosts/docker.rst @@ -13,18 +13,57 @@ This integration is available for Kubernetes, Linux, and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + If you're using this integration with the default Docker daemon domain socket, you might need to add the ``splunk-otel-collector`` user to the ``docker`` group to have permission to access the Docker API. @@ -164,13 +203,39 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + + Protocol not available error ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/gdi/monitors-hosts/elasticsearch-query.rst b/gdi/monitors-hosts/elasticsearch-query.rst index 35c14f0a7..ffc960265 100644 --- a/gdi/monitors-hosts/elasticsearch-query.rst +++ b/gdi/monitors-hosts/elasticsearch-query.rst @@ -17,8 +17,21 @@ aggregation names. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Data model transformation ------------------------- @@ -220,13 +233,39 @@ The dimensions are derived in the same manner as the previous example. Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -381,4 +420,17 @@ built-in filtering of metrics for this receiver. Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/elasticsearch.rst b/gdi/monitors-hosts/elasticsearch.rst index 12a51b277..f56201321 100644 --- a/gdi/monitors-hosts/elasticsearch.rst +++ b/gdi/monitors-hosts/elasticsearch.rst @@ -13,18 +13,57 @@ By default, this integration only collects cluster-level and index-level stats f Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -473,9 +512,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/filesystems.rst b/gdi/monitors-hosts/filesystems.rst index 199fc7832..1386f79ae 100644 --- a/gdi/monitors-hosts/filesystems.rst +++ b/gdi/monitors-hosts/filesystems.rst @@ -16,18 +16,57 @@ This integration is available on Linux and Windows. On Linux, this monitor relie Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -140,9 +179,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/haproxy.rst b/gdi/monitors-hosts/haproxy.rst index 81b8e9835..8e80386c0 100644 --- a/gdi/monitors-hosts/haproxy.rst +++ b/gdi/monitors-hosts/haproxy.rst @@ -15,8 +15,21 @@ requires HAProxy 1.5+. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Set up ------ @@ -103,13 +116,39 @@ install the policy package: Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -201,9 +240,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/host-metadata.rst b/gdi/monitors-hosts/host-metadata.rst index e40f8a4c5..a366d5699 100644 --- a/gdi/monitors-hosts/host-metadata.rst +++ b/gdi/monitors-hosts/host-metadata.rst @@ -21,8 +21,21 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Non-default metrics (version 4.7.0+) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -38,4 +51,17 @@ agent instance. Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/host-processes.rst b/gdi/monitors-hosts/host-processes.rst index 3763c19c0..989516765 100644 --- a/gdi/monitors-hosts/host-processes.rst +++ b/gdi/monitors-hosts/host-processes.rst @@ -72,9 +72,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/host-processlist.rst b/gdi/monitors-hosts/host-processlist.rst index d2ec20a39..a8c406d12 100644 --- a/gdi/monitors-hosts/host-processlist.rst +++ b/gdi/monitors-hosts/host-processlist.rst @@ -17,20 +17,59 @@ This integration is available on Linux and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + .. note:: Instrumentation adds overhead and can cause increases in response time. To learn more, see :new-page:`How to think about instrumentation overhead `. Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -67,4 +106,17 @@ built-in filtering of metrics for this monitor. Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/host-processload.rst b/gdi/monitors-hosts/host-processload.rst index df45b4ab5..a7f7dd6ba 100644 --- a/gdi/monitors-hosts/host-processload.rst +++ b/gdi/monitors-hosts/host-processload.rst @@ -33,4 +33,17 @@ type: Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/http.rst b/gdi/monitors-hosts/http.rst index 55bdcbb81..6a447ae3b 100644 --- a/gdi/monitors-hosts/http.rst +++ b/gdi/monitors-hosts/http.rst @@ -20,8 +20,21 @@ configured. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Setup ----- @@ -93,13 +106,39 @@ information with an HTTP request or response: Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -318,9 +357,35 @@ These are the metrics available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/interface.rst b/gdi/monitors-hosts/interface.rst index d75478307..66f9779a4 100644 --- a/gdi/monitors-hosts/interface.rst +++ b/gdi/monitors-hosts/interface.rst @@ -43,4 +43,17 @@ The following table shows the configuration options for this monitor: Trobleshooting -------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/jenkins.rst b/gdi/monitors-hosts/jenkins.rst index c500fe06c..c1b7c300a 100644 --- a/gdi/monitors-hosts/jenkins.rst +++ b/gdi/monitors-hosts/jenkins.rst @@ -18,18 +18,57 @@ This integration is only available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -211,9 +250,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/kafka-consumer.rst b/gdi/monitors-hosts/kafka-consumer.rst index 63f125907..a014df658 100644 --- a/gdi/monitors-hosts/kafka-consumer.rst +++ b/gdi/monitors-hosts/kafka-consumer.rst @@ -19,18 +19,57 @@ Per-topic metrics are not available through the new consumer API in version 0.9. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -296,9 +335,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/kafka-producer.rst b/gdi/monitors-hosts/kafka-producer.rst index f73b59e0b..7a38ad4a7 100644 --- a/gdi/monitors-hosts/kafka-producer.rst +++ b/gdi/monitors-hosts/kafka-producer.rst @@ -17,18 +17,57 @@ This integration is only available on Kubernetes and Linux, and requires Kafka v Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -294,9 +333,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/microsoft-windows-iis.rst b/gdi/monitors-hosts/microsoft-windows-iis.rst index f8101c22e..bfe83bfe8 100644 --- a/gdi/monitors-hosts/microsoft-windows-iis.rst +++ b/gdi/monitors-hosts/microsoft-windows-iis.rst @@ -23,18 +23,57 @@ This integration is only available on Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-windows.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -103,9 +142,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/nginx.rst b/gdi/monitors-hosts/nginx.rst index e8a06c498..b50ed49db 100644 --- a/gdi/monitors-hosts/nginx.rst +++ b/gdi/monitors-hosts/nginx.rst @@ -15,18 +15,57 @@ This integration is available on Linux and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -152,9 +191,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/ntpq.rst b/gdi/monitors-hosts/ntpq.rst index d5a21d219..631beecc8 100644 --- a/gdi/monitors-hosts/ntpq.rst +++ b/gdi/monitors-hosts/ntpq.rst @@ -13,18 +13,57 @@ This monitor is available on Kubernetes, Linux, and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -93,9 +132,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/php-fpm.rst b/gdi/monitors-hosts/php-fpm.rst index ba5e0a1b3..2eaa67cc0 100644 --- a/gdi/monitors-hosts/php-fpm.rst +++ b/gdi/monitors-hosts/php-fpm.rst @@ -15,13 +15,39 @@ This integration is only available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Install PHP ~~~~~~~~~~~ @@ -52,8 +78,21 @@ which this plugin requires. Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -162,9 +201,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/procstat.rst b/gdi/monitors-hosts/procstat.rst index 4e0a2f17b..313695cdb 100644 --- a/gdi/monitors-hosts/procstat.rst +++ b/gdi/monitors-hosts/procstat.rst @@ -16,18 +16,57 @@ This integration is available for Kubernetes, Linux, and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -152,9 +191,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/solr.rst b/gdi/monitors-hosts/solr.rst index 5370c221c..ef2a8eb4a 100644 --- a/gdi/monitors-hosts/solr.rst +++ b/gdi/monitors-hosts/solr.rst @@ -15,18 +15,57 @@ This integration is available for Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -126,9 +165,35 @@ These metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/supervisor.rst b/gdi/monitors-hosts/supervisor.rst index 8297a8fc3..e5a72e189 100644 --- a/gdi/monitors-hosts/supervisor.rst +++ b/gdi/monitors-hosts/supervisor.rst @@ -13,18 +13,57 @@ This integration is available for Kubernetes, Windows, and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -116,9 +155,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/systemd.rst b/gdi/monitors-hosts/systemd.rst index 4ec62a568..338bcdf46 100644 --- a/gdi/monitors-hosts/systemd.rst +++ b/gdi/monitors-hosts/systemd.rst @@ -13,8 +13,21 @@ This integration is available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Requirements ------------ @@ -34,13 +47,39 @@ shows an excerpt of the ``docker run`` command: Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -158,9 +197,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/varnish.rst b/gdi/monitors-hosts/varnish.rst index 1eb33cdd9..282b2dd50 100644 --- a/gdi/monitors-hosts/varnish.rst +++ b/gdi/monitors-hosts/varnish.rst @@ -13,8 +13,21 @@ This integration is available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Requirements ------------ @@ -31,13 +44,39 @@ Run the following command to activate the Smart Agent to run the Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -118,9 +157,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/vsphere.rst b/gdi/monitors-hosts/vsphere.rst index 276f1ab9f..022adf912 100644 --- a/gdi/monitors-hosts/vsphere.rst +++ b/gdi/monitors-hosts/vsphere.rst @@ -23,18 +23,57 @@ vCenter 6.5, 6.7, and 7.0. While this monitor might work with vCenter Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -206,9 +245,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-hosts/win-services.rst b/gdi/monitors-hosts/win-services.rst index 5dceedb21..16ee3b7fb 100644 --- a/gdi/monitors-hosts/win-services.rst +++ b/gdi/monitors-hosts/win-services.rst @@ -15,18 +15,57 @@ services. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-windows.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -95,9 +134,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-languages/asp-dot-net.rst b/gdi/monitors-languages/asp-dot-net.rst index a134e5d6b..8191fe628 100644 --- a/gdi/monitors-languages/asp-dot-net.rst +++ b/gdi/monitors-languages/asp-dot-net.rst @@ -31,18 +31,57 @@ This integration is only available on Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-windows.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -111,9 +150,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-languages/expvar.rst b/gdi/monitors-languages/expvar.rst index d97436d14..0870ab10a 100644 --- a/gdi/monitors-languages/expvar.rst +++ b/gdi/monitors-languages/expvar.rst @@ -13,18 +13,57 @@ The integration uses configured paths to get metric and dimension values from fe Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -203,9 +242,35 @@ available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-languages/genericjmx.rst b/gdi/monitors-languages/genericjmx.rst index c6e801cd2..2661cdcef 100644 --- a/gdi/monitors-languages/genericjmx.rst +++ b/gdi/monitors-languages/genericjmx.rst @@ -16,18 +16,57 @@ This integration is only available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -305,13 +344,39 @@ Metrics Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + + Exposed ports ~~~~~~~~~~~~~ diff --git a/gdi/monitors-languages/java-monitor.rst b/gdi/monitors-languages/java-monitor.rst index 62d8d293e..ba4d8fdf7 100644 --- a/gdi/monitors-languages/java-monitor.rst +++ b/gdi/monitors-languages/java-monitor.rst @@ -19,18 +19,57 @@ This integration is available on Linux and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -132,9 +171,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-languages/jmx.rst b/gdi/monitors-languages/jmx.rst index 1b8c3b310..563c72eee 100644 --- a/gdi/monitors-languages/jmx.rst +++ b/gdi/monitors-languages/jmx.rst @@ -55,18 +55,57 @@ data to Splunk Observability Cloud. It contains the following methods: Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ---------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~~~~~~~~~~~~~~~~ @@ -279,4 +318,17 @@ There are no metrics available for this integration. Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-languages/microsoft-dotnet.rst b/gdi/monitors-languages/microsoft-dotnet.rst index b9759c0b0..4f5c1da1f 100644 --- a/gdi/monitors-languages/microsoft-dotnet.rst +++ b/gdi/monitors-languages/microsoft-dotnet.rst @@ -41,18 +41,57 @@ The following is a list of the most critical .NET performance counters: Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-windows.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -123,9 +162,35 @@ as custom metrics. See the notes for more details. Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-messaging/apache-activemq.rst b/gdi/monitors-messaging/apache-activemq.rst index b920452e5..5e06f0c2f 100644 --- a/gdi/monitors-messaging/apache-activemq.rst +++ b/gdi/monitors-messaging/apache-activemq.rst @@ -21,18 +21,57 @@ This integration works with ActiveMQ 5.8.0 and higher. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -297,9 +336,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-messaging/apache-kafka.rst b/gdi/monitors-messaging/apache-kafka.rst index fae847f23..7b88dd9c3 100644 --- a/gdi/monitors-messaging/apache-kafka.rst +++ b/gdi/monitors-messaging/apache-kafka.rst @@ -23,18 +23,57 @@ For Kafka v1.x.x and higher monitor the following: Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~~~~~~~~ @@ -79,9 +118,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-messaging/rabbitmq.rst b/gdi/monitors-messaging/rabbitmq.rst index 38fae4fa0..0c10d9ada 100644 --- a/gdi/monitors-messaging/rabbitmq.rst +++ b/gdi/monitors-messaging/rabbitmq.rst @@ -20,18 +20,57 @@ RabbitMQ 3.0 and higher. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -207,9 +246,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-monitoring/cadvisor.rst b/gdi/monitors-monitoring/cadvisor.rst index d603c87ff..a5b0b587d 100644 --- a/gdi/monitors-monitoring/cadvisor.rst +++ b/gdi/monitors-monitoring/cadvisor.rst @@ -28,18 +28,57 @@ This integration is available on Kubernetes, Linux, and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -98,9 +137,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-monitoring/cgroups.rst b/gdi/monitors-monitoring/cgroups.rst index f8da93d48..486769c6c 100644 --- a/gdi/monitors-monitoring/cgroups.rst +++ b/gdi/monitors-monitoring/cgroups.rst @@ -33,18 +33,57 @@ the Red Hat guides: Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -122,9 +161,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-monitoring/jaeger-grpc.rst b/gdi/monitors-monitoring/jaeger-grpc.rst index dc3b737f6..7594019de 100644 --- a/gdi/monitors-monitoring/jaeger-grpc.rst +++ b/gdi/monitors-monitoring/jaeger-grpc.rst @@ -18,18 +18,57 @@ can be configured to anything. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + ### Example To activate this integration, add the following to your Collector @@ -115,4 +154,17 @@ built-in filtering of metrics for this monitor. Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-monitoring/nagios.rst b/gdi/monitors-monitoring/nagios.rst index 4421d9467..09f57eb6e 100644 --- a/gdi/monitors-monitoring/nagios.rst +++ b/gdi/monitors-monitoring/nagios.rst @@ -44,18 +44,57 @@ This integration is available on Kubernetes, Linux, and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -85,8 +124,21 @@ section of your configuration file: Event-sending functionality ~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/event-sending-functionality.rst +.. raw:: html + +
+ + + + Configuration settings ~~~~~~~~~~~~~~~~~~~~~~ @@ -151,9 +203,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-monitoring/signalfx-forwarder.rst b/gdi/monitors-monitoring/signalfx-forwarder.rst index c3ebaf8e6..420a35069 100644 --- a/gdi/monitors-monitoring/signalfx-forwarder.rst +++ b/gdi/monitors-monitoring/signalfx-forwarder.rst @@ -19,18 +19,57 @@ This integration is available on Linux and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -111,4 +150,17 @@ There are no metrics available for this integration. Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-monitoring/win_perf_counters.rst b/gdi/monitors-monitoring/win_perf_counters.rst index 1699e2b9b..67e6a4707 100644 --- a/gdi/monitors-monitoring/win_perf_counters.rst +++ b/gdi/monitors-monitoring/win_perf_counters.rst @@ -19,18 +19,57 @@ This monitor is available on Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-windows.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -195,4 +234,17 @@ The Splunk Distribution of the OpenTelemetry Collector doesn't filter metrics fo Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-network/aws-appmesh.rst b/gdi/monitors-network/aws-appmesh.rst index f9d8759ea..ca0240b8f 100644 --- a/gdi/monitors-network/aws-appmesh.rst +++ b/gdi/monitors-network/aws-appmesh.rst @@ -18,18 +18,57 @@ This integration is available on Kubernetes, Linux, and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -129,9 +168,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-network/dns.rst b/gdi/monitors-network/dns.rst index 0136fa670..15d1ee14d 100644 --- a/gdi/monitors-network/dns.rst +++ b/gdi/monitors-network/dns.rst @@ -13,18 +13,57 @@ You can use the Splunk Distribution of the OpenTelemetry Collector's Smart Agent Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -121,9 +160,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-network/logstash-tcp.rst b/gdi/monitors-network/logstash-tcp.rst index ebc5b8a4e..0633bcc11 100644 --- a/gdi/monitors-network/logstash-tcp.rst +++ b/gdi/monitors-network/logstash-tcp.rst @@ -21,18 +21,57 @@ This receiver is available on Linux and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + ### Example To activate this integration, add the following to your Collector @@ -203,4 +242,17 @@ There are no metrics available for this integration. Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-network/net-io.rst b/gdi/monitors-network/net-io.rst index 3a77c2d87..590c9eda3 100644 --- a/gdi/monitors-network/net-io.rst +++ b/gdi/monitors-network/net-io.rst @@ -12,18 +12,57 @@ The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -89,9 +128,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-network/network-protocols.rst b/gdi/monitors-network/network-protocols.rst index 17ba92d26..a0058cd52 100644 --- a/gdi/monitors-network/network-protocols.rst +++ b/gdi/monitors-network/network-protocols.rst @@ -15,18 +15,57 @@ This integration is available on Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -62,9 +101,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-network/ntp.rst b/gdi/monitors-network/ntp.rst index b18d6ef11..aeddb7016 100644 --- a/gdi/monitors-network/ntp.rst +++ b/gdi/monitors-network/ntp.rst @@ -15,18 +15,57 @@ This receiver is available on Kubernetes, Linux, and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -104,9 +143,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-network/snmp.rst b/gdi/monitors-network/snmp.rst index aad1ad94c..bd477823a 100644 --- a/gdi/monitors-network/snmp.rst +++ b/gdi/monitors-network/snmp.rst @@ -18,18 +18,57 @@ This integration is available for Kubernetes, Windows, and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -391,4 +430,17 @@ All metrics are custom. Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-network/statsd.rst b/gdi/monitors-network/statsd.rst index c933a4972..8b29d6a1c 100644 --- a/gdi/monitors-network/statsd.rst +++ b/gdi/monitors-network/statsd.rst @@ -51,13 +51,39 @@ This integration is available for Kubernetes and Linux. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Verify the installation ~~~~~~~~~~~~~~~~~~~~~~~ @@ -76,8 +102,21 @@ address of the node where the pod is running. Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -231,4 +270,17 @@ on the monitor configuration. Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-network/traefik.rst b/gdi/monitors-network/traefik.rst index faee7ea29..6bb25cb54 100644 --- a/gdi/monitors-network/traefik.rst +++ b/gdi/monitors-network/traefik.rst @@ -13,18 +13,57 @@ This monitor is available on Kubernetes, Linux, and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -206,9 +245,35 @@ integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-orchestration/kubernetes-apiserver.rst b/gdi/monitors-orchestration/kubernetes-apiserver.rst index 100c19ac4..458e0bee7 100644 --- a/gdi/monitors-orchestration/kubernetes-apiserver.rst +++ b/gdi/monitors-orchestration/kubernetes-apiserver.rst @@ -21,18 +21,57 @@ cases. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -244,15 +283,80 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/bind_address_error_msg.rst +.. raw:: html + +
+ + + + + + +.. raw:: html + +
+ .. include:: /_includes/missing_pipeline_configuration.rst +.. raw:: html + +
+ + + + + + +.. raw:: html + +
+ .. include:: /_includes/out_of_memory_error.rst +.. raw:: html + +
+ + + + + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-orchestration/kubernetes-cluster.rst b/gdi/monitors-orchestration/kubernetes-cluster.rst index edb28e762..cd669c482 100644 --- a/gdi/monitors-orchestration/kubernetes-cluster.rst +++ b/gdi/monitors-orchestration/kubernetes-cluster.rst @@ -129,9 +129,35 @@ integration. Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-orchestration/kubernetes-controller-manager.rst b/gdi/monitors-orchestration/kubernetes-controller-manager.rst index b026ba171..03c030752 100644 --- a/gdi/monitors-orchestration/kubernetes-controller-manager.rst +++ b/gdi/monitors-orchestration/kubernetes-controller-manager.rst @@ -142,9 +142,35 @@ custom and are only emitted if specified explicitly. Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-orchestration/kubernetes-events.rst b/gdi/monitors-orchestration/kubernetes-events.rst index cb571d943..b128418b7 100644 --- a/gdi/monitors-orchestration/kubernetes-events.rst +++ b/gdi/monitors-orchestration/kubernetes-events.rst @@ -24,13 +24,39 @@ This monitor type is available on Kubernetes, Linux, and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits-events.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Deploy with Helm ~~~~~~~~~~~~~~~~ @@ -76,8 +102,21 @@ To deploy without Helm, include the following in the OTel configuration: Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -245,4 +284,17 @@ Example YAML configuration: Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-orchestration/kubernetes-network-stats.rst b/gdi/monitors-orchestration/kubernetes-network-stats.rst index 5e081e3d1..c61e5aa9c 100644 --- a/gdi/monitors-orchestration/kubernetes-network-stats.rst +++ b/gdi/monitors-orchestration/kubernetes-network-stats.rst @@ -107,9 +107,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-orchestration/kubernetes-proxy.rst b/gdi/monitors-orchestration/kubernetes-proxy.rst index b7d9f49f9..56a73fcd3 100644 --- a/gdi/monitors-orchestration/kubernetes-proxy.rst +++ b/gdi/monitors-orchestration/kubernetes-proxy.rst @@ -20,18 +20,57 @@ This monitor type is available on Kubernetes, Linux, and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -286,8 +325,21 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Non-default metrics (version 4.7.0+) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -303,4 +355,17 @@ agent instance. Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-orchestration/kubernetes-scheduler.rst b/gdi/monitors-orchestration/kubernetes-scheduler.rst index e26283bb9..096b8faa5 100644 --- a/gdi/monitors-orchestration/kubernetes-scheduler.rst +++ b/gdi/monitors-orchestration/kubernetes-scheduler.rst @@ -15,18 +15,57 @@ This monitor type is available on Kubernetes, Linux, and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -183,8 +222,21 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Non-default metrics (version 4.7.0+) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -200,4 +252,17 @@ agent instance. Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-orchestration/openshift-cluster.rst b/gdi/monitors-orchestration/openshift-cluster.rst index 8ae42b0d7..35e9ae91d 100644 --- a/gdi/monitors-orchestration/openshift-cluster.rst +++ b/gdi/monitors-orchestration/openshift-cluster.rst @@ -35,8 +35,21 @@ leader agent election by setting the ``alwaysClusterReporter`` option to Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ---------------- @@ -73,8 +86,21 @@ Follow these steps to deploy this integration: Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Configuration options ~~~~~~~~~~~~~~~~~~~~~ @@ -186,9 +212,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-prometheus/prometheus-exporter.rst b/gdi/monitors-prometheus/prometheus-exporter.rst index 8649c54f6..2e9c45eeb 100644 --- a/gdi/monitors-prometheus/prometheus-exporter.rst +++ b/gdi/monitors-prometheus/prometheus-exporter.rst @@ -18,18 +18,57 @@ This monitor is available on Kubernetes, Linux, and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -261,4 +300,17 @@ running with has the necessary permissions. Get help ~~~~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-prometheus/prometheus-go.rst b/gdi/monitors-prometheus/prometheus-go.rst index ef816d5e5..aa23a3b8c 100644 --- a/gdi/monitors-prometheus/prometheus-go.rst +++ b/gdi/monitors-prometheus/prometheus-go.rst @@ -16,18 +16,57 @@ This integration is available on Linux and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -180,8 +219,21 @@ The following metrics are available for this integration. Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Non-default metrics (version 4.7.0+) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -197,4 +249,17 @@ agent instance. Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-prometheus/prometheus-nginx-ingress.rst b/gdi/monitors-prometheus/prometheus-nginx-ingress.rst index e8bef0fc3..1bf16a4e6 100644 --- a/gdi/monitors-prometheus/prometheus-nginx-ingress.rst +++ b/gdi/monitors-prometheus/prometheus-nginx-ingress.rst @@ -20,18 +20,57 @@ This integration is available on Linux and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -191,9 +230,35 @@ The following metrics are available for this integration. Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-prometheus/prometheus-nginx-vts.rst b/gdi/monitors-prometheus/prometheus-nginx-vts.rst index b5ecd757d..b6910f536 100644 --- a/gdi/monitors-prometheus/prometheus-nginx-vts.rst +++ b/gdi/monitors-prometheus/prometheus-nginx-vts.rst @@ -19,18 +19,57 @@ This integration is available on Linux and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation-linux.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -182,9 +221,35 @@ The following metrics are available for this integration. Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-prometheus/prometheus-node.rst b/gdi/monitors-prometheus/prometheus-node.rst index 5adc868af..aedf0dda2 100644 --- a/gdi/monitors-prometheus/prometheus-node.rst +++ b/gdi/monitors-prometheus/prometheus-node.rst @@ -18,18 +18,57 @@ This integration is available for Kubernetes, Linux, and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -180,9 +219,35 @@ The following metrics are available for this integration. All metrics are custom Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/monitors-prometheus/prometheus-velero.rst b/gdi/monitors-prometheus/prometheus-velero.rst index 47362ae74..2a8626f29 100644 --- a/gdi/monitors-prometheus/prometheus-velero.rst +++ b/gdi/monitors-prometheus/prometheus-velero.rst @@ -13,18 +13,57 @@ This integration is available on Kubernetes, Linux, and Windows. Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Installation ------------ + + +.. raw:: html + +
+ .. include:: /_includes/collector-installation.rst +.. raw:: html + +
+ + + + Configuration ------------- + + +.. raw:: html + +
+ .. include:: /_includes/configuration.rst +.. raw:: html + +
+ + + + Example ~~~~~~~ @@ -185,9 +224,35 @@ The following metrics are available for this integration: Notes ~~~~~ + + +.. raw:: html + +
+ .. include:: /_includes/metric-defs.rst +.. raw:: html + +
+ + + + Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/automatic-discovery/discovery-kubernetes.rst b/gdi/opentelemetry/automatic-discovery/discovery-kubernetes.rst index 8b94ec6a9..76a2c3df6 100644 --- a/gdi/opentelemetry/automatic-discovery/discovery-kubernetes.rst +++ b/gdi/opentelemetry/automatic-discovery/discovery-kubernetes.rst @@ -15,8 +15,21 @@ Automatic discovery for Kubernetes Advanced customization k8s/k8s-java-traces-tutorial/about-k8s-java-traces-tutorial + + +.. raw:: html + +
+ .. include:: /_includes/gdi/auto-discovery-intro.rst +.. raw:: html + +
+ + + + .. raw:: html

Get started

diff --git a/gdi/opentelemetry/automatic-discovery/discovery-linux.rst b/gdi/opentelemetry/automatic-discovery/discovery-linux.rst index f48e9ed3d..30751c64f 100644 --- a/gdi/opentelemetry/automatic-discovery/discovery-linux.rst +++ b/gdi/opentelemetry/automatic-discovery/discovery-linux.rst @@ -14,8 +14,21 @@ Automatic discovery for Linux Third-party applications Advanced customization + + +.. raw:: html + +
+ .. include:: /_includes/gdi/auto-discovery-intro.rst +.. raw:: html + +
+ + + + .. raw:: html

Get started

diff --git a/gdi/opentelemetry/automatic-discovery/discovery-windows.rst b/gdi/opentelemetry/automatic-discovery/discovery-windows.rst index 92df4f8b6..7522c6676 100644 --- a/gdi/opentelemetry/automatic-discovery/discovery-windows.rst +++ b/gdi/opentelemetry/automatic-discovery/discovery-windows.rst @@ -12,8 +12,21 @@ Automatic discovery for Windows Language runtimes + + +.. raw:: html + +
+ .. include:: /_includes/gdi/auto-discovery-intro.rst +.. raw:: html + +
+ + + + .. raw:: html

Get started

diff --git a/gdi/opentelemetry/automatic-discovery/k8s/k8s-backend.rst b/gdi/opentelemetry/automatic-discovery/k8s/k8s-backend.rst index 053e47e35..25c993482 100644 --- a/gdi/opentelemetry/automatic-discovery/k8s/k8s-backend.rst +++ b/gdi/opentelemetry/automatic-discovery/k8s/k8s-backend.rst @@ -612,8 +612,21 @@ See :ref:`k8s-advanced-auto-discovery-config` for more information. .. _troubleshooting-k8s-auto-discovery: + + +.. raw:: html + +
+ .. include:: /_includes/gdi/troubleshoot-zeroconfig-k8s.rst +.. raw:: html + +
+ + + + To troubleshoot common errors that occur when instrumenting applications, see the following guides: * Java: :ref:`common-java-troubleshooting` diff --git a/gdi/opentelemetry/automatic-discovery/linux/linux-third-party.rst b/gdi/opentelemetry/automatic-discovery/linux/linux-third-party.rst index 0068b2e20..e671ed86d 100644 --- a/gdi/opentelemetry/automatic-discovery/linux/linux-third-party.rst +++ b/gdi/opentelemetry/automatic-discovery/linux/linux-third-party.rst @@ -152,4 +152,17 @@ If it isn't, use the following command line flag to indicate so: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/automatic-discovery/windows/windows-backend.rst b/gdi/opentelemetry/automatic-discovery/windows/windows-backend.rst index 9dc0919a6..b23408877 100644 --- a/gdi/opentelemetry/automatic-discovery/windows/windows-backend.rst +++ b/gdi/opentelemetry/automatic-discovery/windows/windows-backend.rst @@ -60,4 +60,16 @@ You can upgrade the package by installing a new version of the Splunk Distributi Troubleshooting =========================== -.. include:: /_includes/troubleshooting-components.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/collector-common-config.rst b/gdi/opentelemetry/collector-common-config.rst index 80dd56b30..10a5ec4de 100644 --- a/gdi/opentelemetry/collector-common-config.rst +++ b/gdi/opentelemetry/collector-common-config.rst @@ -20,4 +20,16 @@ Common configuration options .. note:: The following list might not contain all the latest additions and updates. For a complete list of Collector common settings see the ``opentelemetry`` repository in GitHub. -.. include:: /_includes/gdi/collector-common-options.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/gdi/collector-common-options.rst +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/collector-kubernetes/collector-kubernetes-intro.rst b/gdi/opentelemetry/collector-kubernetes/collector-kubernetes-intro.rst index 644e2921a..6e6429e6c 100644 --- a/gdi/opentelemetry/collector-kubernetes/collector-kubernetes-intro.rst +++ b/gdi/opentelemetry/collector-kubernetes/collector-kubernetes-intro.rst @@ -66,8 +66,21 @@ To configure the Collector see: * :ref:`kubernetes-config-logs` * :ref:`otel-kubernetes-config-advanced` + + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-common-options.rst +.. raw:: html + +
+ + + + .. raw:: html diff --git a/gdi/opentelemetry/collector-kubernetes/install-k8s-manifests.rst b/gdi/opentelemetry/collector-kubernetes/install-k8s-manifests.rst index 4c3862e7c..aff2de371 100644 --- a/gdi/opentelemetry/collector-kubernetes/install-k8s-manifests.rst +++ b/gdi/opentelemetry/collector-kubernetes/install-k8s-manifests.rst @@ -74,9 +74,22 @@ Manifest examples ================================== See the following manifest to set security constraints: + + +.. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/splunk-otel-collector-chart/main/examples/distribution-openshift/rendered_manifests/securityContextConstraints.yaml +.. raw:: html + +
+ + + + Next steps ================================== diff --git a/gdi/opentelemetry/collector-kubernetes/kubernetes-upgrade.rst b/gdi/opentelemetry/collector-kubernetes/kubernetes-upgrade.rst index fe6ac1108..affcf4cc0 100644 --- a/gdi/opentelemetry/collector-kubernetes/kubernetes-upgrade.rst +++ b/gdi/opentelemetry/collector-kubernetes/kubernetes-upgrade.rst @@ -8,8 +8,21 @@ Upgrade the Collector for Kubernetes and other updates .. meta:: :description: Upgrade the Splunk Distribution of OpenTelemetry Collector for Kubernetes. + + +.. raw:: html + +
+ .. include:: /_includes/collector-upgrade.rst +.. raw:: html + +
+ + + + .. _otel-upgrade-k8s: Upgrade the Collector for Kubernetes diff --git a/gdi/opentelemetry/collector-linux/collector-linux-intro.rst b/gdi/opentelemetry/collector-linux/collector-linux-intro.rst index 46d371137..f996de39e 100644 --- a/gdi/opentelemetry/collector-linux/collector-linux-intro.rst +++ b/gdi/opentelemetry/collector-linux/collector-linux-intro.rst @@ -52,8 +52,21 @@ See the default settings and configuration options at: * :ref:`otel-linux-config` * :ref:`linux-config-logs` + + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-common-options.rst +.. raw:: html + +
+ + + + .. raw:: html diff --git a/gdi/opentelemetry/collector-linux/deployments-linux-ansible.rst b/gdi/opentelemetry/collector-linux/deployments-linux-ansible.rst index 801102a1a..5468c9ff5 100644 --- a/gdi/opentelemetry/collector-linux/deployments-linux-ansible.rst +++ b/gdi/opentelemetry/collector-linux/deployments-linux-ansible.rst @@ -171,4 +171,17 @@ The following table shows the variables that you can configure for this Ansible Next steps ================================== + + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-linux-next-steps.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/collector-linux/deployments-linux-chef.rst b/gdi/opentelemetry/collector-linux/deployments-linux-chef.rst index c1876bdd0..a406dd2e1 100644 --- a/gdi/opentelemetry/collector-linux/deployments-linux-chef.rst +++ b/gdi/opentelemetry/collector-linux/deployments-linux-chef.rst @@ -191,4 +191,17 @@ The following table shows the variables that can be configured with this Chef co Next steps ================================== + + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-linux-next-steps.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/collector-linux/deployments-linux-puppet.rst b/gdi/opentelemetry/collector-linux/deployments-linux-puppet.rst index 6aa20b773..e48caa270 100644 --- a/gdi/opentelemetry/collector-linux/deployments-linux-puppet.rst +++ b/gdi/opentelemetry/collector-linux/deployments-linux-puppet.rst @@ -180,4 +180,17 @@ The following table shows the variables that you can configure for this Puppet m Next steps ================================== + + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-linux-next-steps.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/collector-linux/deployments-linux-salt.rst b/gdi/opentelemetry/collector-linux/deployments-linux-salt.rst index e2e06ff2d..9fd071bee 100644 --- a/gdi/opentelemetry/collector-linux/deployments-linux-salt.rst +++ b/gdi/opentelemetry/collector-linux/deployments-linux-salt.rst @@ -189,4 +189,17 @@ The following table shows the variables that can be configured for this Salt mod Next steps ================================== + + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-linux-next-steps.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/collector-linux/install-linux-manual.rst b/gdi/opentelemetry/collector-linux/install-linux-manual.rst index b9e173ec5..d889464e7 100644 --- a/gdi/opentelemetry/collector-linux/install-linux-manual.rst +++ b/gdi/opentelemetry/collector-linux/install-linux-manual.rst @@ -479,4 +479,17 @@ If you're running the Collector from a non-default location, the Smart Agent rec Next steps ================================== + + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-linux-next-steps.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/collector-linux/install-linux-tools.rst b/gdi/opentelemetry/collector-linux/install-linux-tools.rst index 75e056cba..f81ed8193 100644 --- a/gdi/opentelemetry/collector-linux/install-linux-tools.rst +++ b/gdi/opentelemetry/collector-linux/install-linux-tools.rst @@ -37,8 +37,21 @@ Alternatively, you can also install the Collector for Linux:

Prerequisites

+ + +.. raw:: html + +
+ .. include:: /_includes/requirements/collector-linux.rst +.. raw:: html + +
+ + + + .. _linux-deployments: .. raw:: html @@ -96,8 +109,21 @@ The following deployment and configuration management tools for the Splunk Distr

Next steps

+ + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-linux-next-steps.rst +.. raw:: html + +
+ + + + diff --git a/gdi/opentelemetry/collector-linux/install-linux.rst b/gdi/opentelemetry/collector-linux/install-linux.rst index 30c3403a3..2d2305996 100644 --- a/gdi/opentelemetry/collector-linux/install-linux.rst +++ b/gdi/opentelemetry/collector-linux/install-linux.rst @@ -20,8 +20,21 @@ Install the package using one of these methods: Supported versions ================================= + + +.. raw:: html + +
+ .. include:: /_includes/requirements/collector-linux.rst +.. raw:: html + +
+ + + + Included packages ========================== @@ -290,4 +303,17 @@ Fluentd Next steps ================================== + + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-linux-next-steps.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/collector-linux/linux-config-ootb.rst b/gdi/opentelemetry/collector-linux/linux-config-ootb.rst index 3aa9fd667..89864a53f 100644 --- a/gdi/opentelemetry/collector-linux/linux-config-ootb.rst +++ b/gdi/opentelemetry/collector-linux/linux-config-ootb.rst @@ -9,8 +9,21 @@ Collector for Linux default configuration .. meta:: :description: Configure the Splunk Distribution of OpenTelemetry Collector. There are a variety of default configuration files available, as well additional components that can be configured. + + +.. raw:: html + +
+ .. include:: /_includes/collector-components.rst +.. raw:: html + +
+ + + + The Collector configuration is stored in a :new-page:`YAML file ` and specifies the behavior of the different components and services. See an overview of the elements and pipelines in the default configuration in the following sections. See :ref:`about-collector-configuration-tutorial` to learn how to configure the Collector. @@ -20,14 +33,40 @@ Default configuration This is the default configuration file for the Linux (Debian/RPM) Installer collector packages: + + +.. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/splunk-otel-collector/main/cmd/otelcol/config/collector/agent_config.yaml +.. raw:: html + +
+ + + + Default pipelines ======================================================== + + +.. raw:: html + +
+ .. include:: /_includes/collector-config-ootb.rst +.. raw:: html + +
+ + + + Learn more ======================================================== diff --git a/gdi/opentelemetry/collector-linux/linux-upgrade.rst b/gdi/opentelemetry/collector-linux/linux-upgrade.rst index 64c0bc08e..e27434dc5 100644 --- a/gdi/opentelemetry/collector-linux/linux-upgrade.rst +++ b/gdi/opentelemetry/collector-linux/linux-upgrade.rst @@ -8,8 +8,21 @@ Upgrade the Collector for Linux .. meta:: :description: Upgrade the Splunk Distribution of OpenTelemetry Collector for Linux. + + +.. raw:: html + +
+ .. include:: /_includes/collector-upgrade.rst +.. raw:: html + +
+ + + + Upgrade the Collector for Linux ======================================= diff --git a/gdi/opentelemetry/collector-windows/collector-windows-intro.rst b/gdi/opentelemetry/collector-windows/collector-windows-intro.rst index 6456ff263..8c99b3d84 100644 --- a/gdi/opentelemetry/collector-windows/collector-windows-intro.rst +++ b/gdi/opentelemetry/collector-windows/collector-windows-intro.rst @@ -37,8 +37,21 @@ See the default settings and configuration options at: * :ref:`otel-windows-config` * :ref:`windows-config-logs` + + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-common-options.rst +.. raw:: html + +
+ + + + To automatically find services and applications running in your Windows environment and send data from them to Splunk Observability Cloud refer to :ref:`discovery-windows`. To upgrade or uninstall, see: diff --git a/gdi/opentelemetry/collector-windows/deployments-windows-ansible.rst b/gdi/opentelemetry/collector-windows/deployments-windows-ansible.rst index 40f957a11..85d85f396 100644 --- a/gdi/opentelemetry/collector-windows/deployments-windows-ansible.rst +++ b/gdi/opentelemetry/collector-windows/deployments-windows-ansible.rst @@ -120,4 +120,16 @@ The following table describes the variables that can be configured for this role Next steps ================================== -.. include:: /_includes/gdi/collector-windows-next-steps.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/gdi/collector-windows-next-steps.rst +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/collector-windows/deployments-windows-chef.rst b/gdi/opentelemetry/collector-windows/deployments-windows-chef.rst index fb61d558e..cb4c23951 100644 --- a/gdi/opentelemetry/collector-windows/deployments-windows-chef.rst +++ b/gdi/opentelemetry/collector-windows/deployments-windows-chef.rst @@ -110,4 +110,16 @@ On Windows, the variables/values will be added to the Environment value under th Next steps ================================== -.. include:: /_includes/gdi/collector-windows-next-steps.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/gdi/collector-windows-next-steps.rst +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/collector-windows/deployments-windows-puppet.rst b/gdi/opentelemetry/collector-windows/deployments-windows-puppet.rst index 5bb347ab5..1c745fe2c 100644 --- a/gdi/opentelemetry/collector-windows/deployments-windows-puppet.rst +++ b/gdi/opentelemetry/collector-windows/deployments-windows-puppet.rst @@ -95,4 +95,16 @@ The class accepts the parameters described in the following table: Next steps ================================== -.. include:: /_includes/gdi/collector-windows-next-steps.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/gdi/collector-windows-next-steps.rst +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/collector-windows/install-windows-manual.rst b/gdi/opentelemetry/collector-windows/install-windows-manual.rst index f0061f373..9075c231d 100644 --- a/gdi/opentelemetry/collector-windows/install-windows-manual.rst +++ b/gdi/opentelemetry/collector-windows/install-windows-manual.rst @@ -31,8 +31,21 @@ Alternatively, you can also install the Collector for Windows: Prerequisites ========================== + + +.. raw:: html + +
+ .. include:: /_includes/requirements/collector-windows.rst +.. raw:: html + +
+ + + + .. _windows-docker: Install the Collector for Windows using Docker @@ -119,4 +132,17 @@ Example with ``--config`` Next steps ================================== + + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-windows-next-steps.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/collector-windows/install-windows-msi.rst b/gdi/opentelemetry/collector-windows/install-windows-msi.rst index be27cddf7..720e125d7 100644 --- a/gdi/opentelemetry/collector-windows/install-windows-msi.rst +++ b/gdi/opentelemetry/collector-windows/install-windows-msi.rst @@ -31,8 +31,21 @@ Alternatively, you can also install the Collector for Windows: Prerequisites ========================== + + +.. raw:: html + +
+ .. include:: /_includes/requirements/collector-windows.rst +.. raw:: html + +
+ + + + .. _windows-installer: Install the Collector using the Windows installer file (MSI) @@ -216,4 +229,16 @@ A :new-page:`Chocolatey package + +.. include:: /_includes/gdi/collector-windows-next-steps.rst +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/collector-windows/install-windows-tools.rst b/gdi/opentelemetry/collector-windows/install-windows-tools.rst index f49e688f9..c348f1971 100644 --- a/gdi/opentelemetry/collector-windows/install-windows-tools.rst +++ b/gdi/opentelemetry/collector-windows/install-windows-tools.rst @@ -39,8 +39,21 @@ Alternatively, you can also install the Collector for Windows:

Prerequisites

+ + +.. raw:: html + +
+ .. include:: /_includes/requirements/collector-windows.rst +.. raw:: html + +
+ + + + .. raw:: html @@ -61,8 +74,21 @@ The following deployment tools to install the Splunk Distribution of the OpenTel

Next steps

+ + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-windows-next-steps.rst +.. raw:: html + +
+ + + + diff --git a/gdi/opentelemetry/collector-windows/install-windows.rst b/gdi/opentelemetry/collector-windows/install-windows.rst index 98d27162c..fd76c30da 100644 --- a/gdi/opentelemetry/collector-windows/install-windows.rst +++ b/gdi/opentelemetry/collector-windows/install-windows.rst @@ -32,8 +32,21 @@ Alternatively, you can also install the Collector for Windows: Prerequisites ========================== + + +.. raw:: html + +
+ .. include:: /_includes/requirements/collector-windows.rst +.. raw:: html + +
+ + + + .. _windows-otel-packages: Included packages @@ -170,8 +183,21 @@ The Windows installer script supports the following options: Next steps ================================== + + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-windows-next-steps.rst +.. raw:: html + +
+ + + + diff --git a/gdi/opentelemetry/collector-windows/windows-config-ootb.rst b/gdi/opentelemetry/collector-windows/windows-config-ootb.rst index bc5662878..edd4d74fc 100644 --- a/gdi/opentelemetry/collector-windows/windows-config-ootb.rst +++ b/gdi/opentelemetry/collector-windows/windows-config-ootb.rst @@ -7,8 +7,21 @@ Collector for Windows default configuration .. meta:: :description: Configure the Splunk Distribution of OpenTelemetry Collector. There are a variety of default configuration files available, as well additional components that can be configured. + + +.. raw:: html + +
+ .. include:: /_includes/collector-components.rst +.. raw:: html + +
+ + + + The Collector configuration is a :new-page:`YAML file ` which specifies the behavior of the different components and services. By default, it's stored in ``\ProgramData\Splunk\OpenTelemetry Collector\agent_config.yaml``. Find an overview of the elements and pipelines in the default configuration in the following sections. @@ -18,14 +31,40 @@ Default configuration This is the default configuration file for the Windows Installer collector package: + + +.. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/splunk-otel-collector/main/cmd/otelcol/config/collector/agent_config.yaml +.. raw:: html + +
+ + + + Default pipelines ======================================================== + + +.. raw:: html + +
+ .. include:: /_includes/collector-config-ootb.rst +.. raw:: html + +
+ + + + Learn more ======================================================== diff --git a/gdi/opentelemetry/collector-windows/windows-config.rst b/gdi/opentelemetry/collector-windows/windows-config.rst index ef2705e0a..324add14a 100644 --- a/gdi/opentelemetry/collector-windows/windows-config.rst +++ b/gdi/opentelemetry/collector-windows/windows-config.rst @@ -16,8 +16,21 @@ Change the default configuration file for the Collector for Windows All installation methods offer default configurations using environment variables. Before starting the ``splunk-otel-collector`` service, replace the variables in the default configuration file with the appropriate values for your environment. + + +.. raw:: html + +
+ .. include:: /_includes/collector-env-vars.rst +.. raw:: html + +
+ + + + .. note:: When configuring additional settings, use service, process, or terminal scopes. Based on the specified installation parameters, the environment variables are saved to the ``HKLM:\SYSTEM\CurrentControlSet\Services\splunk-otel-collector`` registry key and set on the ``Environment`` entry. diff --git a/gdi/opentelemetry/collector-windows/windows-upgrade.rst b/gdi/opentelemetry/collector-windows/windows-upgrade.rst index 38a0e1cdb..c943fe488 100644 --- a/gdi/opentelemetry/collector-windows/windows-upgrade.rst +++ b/gdi/opentelemetry/collector-windows/windows-upgrade.rst @@ -8,8 +8,21 @@ Upgrade the Collector for Windows .. meta:: :description: Upgrade the Splunk Distribution of OpenTelemetry Collector. + + +.. raw:: html + +
+ .. include:: /_includes/collector-upgrade.rst +.. raw:: html + +
+ + + + Upgrade the Collector for Windows ======================================= diff --git a/gdi/opentelemetry/components/a-components-receivers.rst b/gdi/opentelemetry/components/a-components-receivers.rst index a6141772a..163f2c414 100644 --- a/gdi/opentelemetry/components/a-components-receivers.rst +++ b/gdi/opentelemetry/components/a-components-receivers.rst @@ -69,6 +69,19 @@ Collector components: Receivers The following receivers are available: + + +.. raw:: html + +
+ .. include:: /_includes/gdi/otel-receivers-table.rst +.. raw:: html + +
+ + + + To see other components, refer to :ref:`otel-components`. \ No newline at end of file diff --git a/gdi/opentelemetry/components/apache-receiver.rst b/gdi/opentelemetry/components/apache-receiver.rst index bd5d09cdf..809d53542 100644 --- a/gdi/opentelemetry/components/apache-receiver.rst +++ b/gdi/opentelemetry/components/apache-receiver.rst @@ -62,10 +62,36 @@ The following settings are required: The following settings are optional: + + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-settings-collectioninterval.rst +.. raw:: html + +
+ + + + + + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-settings-initialdelay.rst +.. raw:: html + +
+ + + + Settings ====================== @@ -86,9 +112,35 @@ The following metrics, resource attributes, and attributes are available.
+ + +.. raw:: html + +
+ .. include:: /_includes/activate-deactivate-native-metrics.rst +.. raw:: html + +
+ + + + Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/apache-spark-receiver.rst b/gdi/opentelemetry/components/apache-spark-receiver.rst index da5bb4076..3f43c20f7 100644 --- a/gdi/opentelemetry/components/apache-spark-receiver.rst +++ b/gdi/opentelemetry/components/apache-spark-receiver.rst @@ -89,9 +89,35 @@ The following metrics, resource attributes, and attributes are available.
+ + +.. raw:: html + +
+ .. include:: /_includes/activate-deactivate-native-metrics.rst +.. raw:: html + +
+ + + + Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/attributes-processor.rst b/gdi/opentelemetry/components/attributes-processor.rst index 6792bf3ef..883724e1b 100644 --- a/gdi/opentelemetry/components/attributes-processor.rst +++ b/gdi/opentelemetry/components/attributes-processor.rst @@ -214,4 +214,17 @@ The following table shows the configuration options for the attributes processor Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/basic-auth-extension.rst b/gdi/opentelemetry/components/basic-auth-extension.rst index f72a3c739..911aeb00b 100644 --- a/gdi/opentelemetry/components/basic-auth-extension.rst +++ b/gdi/opentelemetry/components/basic-auth-extension.rst @@ -134,4 +134,17 @@ You can either authenticate servers or clients with the extension. If you config Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/batch-processor.rst b/gdi/opentelemetry/components/batch-processor.rst index b7a8eb290..0916cbf72 100644 --- a/gdi/opentelemetry/components/batch-processor.rst +++ b/gdi/opentelemetry/components/batch-processor.rst @@ -99,4 +99,17 @@ The following table shows the configuration options for the batch processor: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/chrony-receiver.rst b/gdi/opentelemetry/components/chrony-receiver.rst index 8a607da1d..a7dbea2ff 100644 --- a/gdi/opentelemetry/components/chrony-receiver.rst +++ b/gdi/opentelemetry/components/chrony-receiver.rst @@ -111,9 +111,35 @@ The following metrics, resource attributes, and attributes, are available. See also the :new-page:`metric documentation in GitHub `. + + +.. raw:: html + +
+ .. include:: /_includes/activate-deactivate-native-metrics.rst +.. raw:: html + +
+ + + + Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/cloudfoundry-receiver.rst b/gdi/opentelemetry/components/cloudfoundry-receiver.rst index 5229e7fa5..2ac96f5d7 100644 --- a/gdi/opentelemetry/components/cloudfoundry-receiver.rst +++ b/gdi/opentelemetry/components/cloudfoundry-receiver.rst @@ -179,5 +179,18 @@ More attributes might be available since the receiver passes on whatever attribu Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + + diff --git a/gdi/opentelemetry/components/cumulative-to-delta-processor.rst b/gdi/opentelemetry/components/cumulative-to-delta-processor.rst index 461c2c9d0..ba3af730c 100644 --- a/gdi/opentelemetry/components/cumulative-to-delta-processor.rst +++ b/gdi/opentelemetry/components/cumulative-to-delta-processor.rst @@ -86,4 +86,17 @@ The following table shows the configuration options for the cumulative to delta Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/elasticsearch-receiver.rst b/gdi/opentelemetry/components/elasticsearch-receiver.rst index 12b86c47d..1a1b46ccd 100644 --- a/gdi/opentelemetry/components/elasticsearch-receiver.rst +++ b/gdi/opentelemetry/components/elasticsearch-receiver.rst @@ -129,8 +129,21 @@ The following metrics, resource attributes, and attributes, are available.
+ + +.. raw:: html + +
+ .. include:: /_includes/activate-deactivate-native-metrics.rst +.. raw:: html + +
+ + + + Metrics with versions ----------------------------------------------- @@ -144,4 +157,17 @@ The following metric are available with versions: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/filelog-receiver.rst b/gdi/opentelemetry/components/filelog-receiver.rst index a84aed24f..ca5911294 100644 --- a/gdi/opentelemetry/components/filelog-receiver.rst +++ b/gdi/opentelemetry/components/filelog-receiver.rst @@ -232,33 +232,85 @@ Send truncated logs to Splunk Enterprise Use the following configuration to truncate logs and send them to Splunk Enterprise: + + +.. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/splunk-otel-collector/main/examples/otel-logs-truncate-splunk/otel-collector-config.yml +.. raw:: html + +
+ + + + Send sanitized logs to Splunk Enterprise -------------------------------------------- Use the following configuration to sanitize logs and send them to Splunk Enterprise. + + +.. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/splunk-otel-collector/main/examples/otel-logs-sanitization-splunk/otel-collector-config.yml +.. raw:: html + +
+ + + + Route logs to different indexes -------------------------------------------- Use the following configuration to route logs to different Splunk indexes. + + +.. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/splunk-otel-collector/main/examples/otel-logs-processor-splunk/otel-collector-config.yml +.. raw:: html + +
+ + + + Associate log sources with source types -------------------------------------------- This example showcases how the Collector collects data from files and sends it to Splunk Enterprise, associating each source with a different source type. The source type is a default field that identifies the structure of an event, and determines how Splunk Enterprise formats the data during the indexing process. + + +.. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/splunk-otel-collector/main/examples/otel-logs-with-sourcetypes-splunk/otel-collector-config.yml +.. raw:: html + +
+ + + + Settings ====================== @@ -273,4 +325,17 @@ The following table shows the configuration options for the Filelog receiver: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/filter-processor.rst b/gdi/opentelemetry/components/filter-processor.rst index a0016028a..4af342917 100644 --- a/gdi/opentelemetry/components/filter-processor.rst +++ b/gdi/opentelemetry/components/filter-processor.rst @@ -407,4 +407,17 @@ The following table shows the configuration options for the filter processor: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/groupbyattrs-processor.rst b/gdi/opentelemetry/components/groupbyattrs-processor.rst index ea0a198ea..00edef02d 100644 --- a/gdi/opentelemetry/components/groupbyattrs-processor.rst +++ b/gdi/opentelemetry/components/groupbyattrs-processor.rst @@ -270,4 +270,17 @@ The ``groupbyattrs`` processor records the following internal metrics: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/haproxy-receiver.rst b/gdi/opentelemetry/components/haproxy-receiver.rst index ae56465ff..5195ac85b 100644 --- a/gdi/opentelemetry/components/haproxy-receiver.rst +++ b/gdi/opentelemetry/components/haproxy-receiver.rst @@ -78,9 +78,35 @@ The following metrics, resource attributes, and attributes are available.
+ + +.. raw:: html + +
+ .. include:: /_includes/activate-deactivate-native-metrics.rst +.. raw:: html + +
+ + + + Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/health-check-extension.rst b/gdi/opentelemetry/components/health-check-extension.rst index af91d8b36..b7e47230d 100644 --- a/gdi/opentelemetry/components/health-check-extension.rst +++ b/gdi/opentelemetry/components/health-check-extension.rst @@ -130,4 +130,17 @@ The following table shows the configuration options for the ``health_check`` ext Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/host-metrics-receiver.rst b/gdi/opentelemetry/components/host-metrics-receiver.rst index 74cb7d08a..b95579334 100644 --- a/gdi/opentelemetry/components/host-metrics-receiver.rst +++ b/gdi/opentelemetry/components/host-metrics-receiver.rst @@ -356,8 +356,21 @@ processes scraper For more information, see the :new-page:`processes scraper documentation ` in GitHub. + + +.. raw:: html + +
+ .. include:: /_includes/gdi/default-translation-metrics.rst +.. raw:: html + +
+ + + + Resource attributes -------------------------- @@ -370,8 +383,21 @@ To set resource attributes, provide them using the ``OTEL_RESOURCE_ATTRIBUTES`` export OTEL_RESOURCE_ATTRIBUTES="service.name=,service.version=" + + +.. raw:: html + +
+ .. include:: /_includes/activate-deactivate-native-metrics.rst +.. raw:: html + +
+ + + + Settings ====================== @@ -384,4 +410,17 @@ The following table shows the configuration options for the host metrics receive Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/http-check-receiver.rst b/gdi/opentelemetry/components/http-check-receiver.rst index ff5d3e0c2..a9dc76806 100644 --- a/gdi/opentelemetry/components/http-check-receiver.rst +++ b/gdi/opentelemetry/components/http-check-receiver.rst @@ -97,8 +97,21 @@ The following metrics, resource attributes, and attributes are available.
+ + +.. raw:: html + +
+ .. include:: /_includes/activate-deactivate-native-metrics.rst +.. raw:: html + +
+ + + + .. _http-check-receiver-settings: Settings @@ -113,4 +126,17 @@ The following table shows the configuration options for the HTTP check receiver: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/jaeger-receiver.rst b/gdi/opentelemetry/components/jaeger-receiver.rst index fd9feb787..b494b5832 100644 --- a/gdi/opentelemetry/components/jaeger-receiver.rst +++ b/gdi/opentelemetry/components/jaeger-receiver.rst @@ -110,4 +110,17 @@ The following table shows the configuration options for the Jaeger receiver: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/jmx-receiver.rst b/gdi/opentelemetry/components/jmx-receiver.rst index 1a42f243e..c14cea2e6 100644 --- a/gdi/opentelemetry/components/jmx-receiver.rst +++ b/gdi/opentelemetry/components/jmx-receiver.rst @@ -130,4 +130,17 @@ The following table shows the configuration options for the JMX receiver: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/kafka-receiver.rst b/gdi/opentelemetry/components/kafka-receiver.rst index e93770d9a..b0ad86cc5 100644 --- a/gdi/opentelemetry/components/kafka-receiver.rst +++ b/gdi/opentelemetry/components/kafka-receiver.rst @@ -240,4 +240,17 @@ The following table shows the configuration options for the Kafka receiver: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/kafkametrics-receiver.rst b/gdi/opentelemetry/components/kafkametrics-receiver.rst index d73178f13..203770738 100644 --- a/gdi/opentelemetry/components/kafkametrics-receiver.rst +++ b/gdi/opentelemetry/components/kafkametrics-receiver.rst @@ -158,12 +158,38 @@ The following metrics, resource attributes, and attributes are available.
+ + +.. raw:: html + +
+ .. include:: /_includes/activate-deactivate-native-metrics.rst +.. raw:: html + +
+ + + + Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + + diff --git a/gdi/opentelemetry/components/kubelet-stats-receiver.rst b/gdi/opentelemetry/components/kubelet-stats-receiver.rst index ebc112bd5..f849b56a0 100644 --- a/gdi/opentelemetry/components/kubelet-stats-receiver.rst +++ b/gdi/opentelemetry/components/kubelet-stats-receiver.rst @@ -231,9 +231,35 @@ The following metrics, resource attributes, and attributes are available.
+ + +.. raw:: html + +
+ .. include:: /_includes/activate-deactivate-native-metrics.rst +.. raw:: html + +
+ + + + Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/kubernetes-attributes-processor.rst b/gdi/opentelemetry/components/kubernetes-attributes-processor.rst index 94d1d9637..d8ae333ae 100644 --- a/gdi/opentelemetry/components/kubernetes-attributes-processor.rst +++ b/gdi/opentelemetry/components/kubernetes-attributes-processor.rst @@ -343,8 +343,21 @@ The following metrics, resource attributes, and attributes are available.
+ + +.. raw:: html + +
+ .. include:: /_includes/activate-deactivate-native-metrics.rst +.. raw:: html + +
+ + + + Known limitations ======================= @@ -363,4 +376,17 @@ The processor can't detect containers from the same pods when running as a sidec Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/kubernetes-cluster-receiver.rst b/gdi/opentelemetry/components/kubernetes-cluster-receiver.rst index f897dafce..57a66630a 100644 --- a/gdi/opentelemetry/components/kubernetes-cluster-receiver.rst +++ b/gdi/opentelemetry/components/kubernetes-cluster-receiver.rst @@ -110,9 +110,35 @@ The following metrics, resource attributes, and attributes are available.
+ + +.. raw:: html + +
+ .. include:: /_includes/activate-deactivate-native-metrics.rst +.. raw:: html + +
+ + + + Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/kubernetes-objects-receiver.rst b/gdi/opentelemetry/components/kubernetes-objects-receiver.rst index 1fd311d41..e378a7861 100644 --- a/gdi/opentelemetry/components/kubernetes-objects-receiver.rst +++ b/gdi/opentelemetry/components/kubernetes-objects-receiver.rst @@ -279,6 +279,19 @@ If the receiver returns an error similar to the one below, make sure that ``reso General troubleshooting ----------------------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + + diff --git a/gdi/opentelemetry/components/loadbalancing-exporter.rst b/gdi/opentelemetry/components/loadbalancing-exporter.rst index 3d8f826e2..a21f6b50d 100644 --- a/gdi/opentelemetry/components/loadbalancing-exporter.rst +++ b/gdi/opentelemetry/components/loadbalancing-exporter.rst @@ -170,4 +170,17 @@ The following table shows the configuration options for the load balancing expor Troubleshooting ============================ + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/logging-exporter.rst b/gdi/opentelemetry/components/logging-exporter.rst index 3ab0f1ed6..e64b4c0a6 100644 --- a/gdi/opentelemetry/components/logging-exporter.rst +++ b/gdi/opentelemetry/components/logging-exporter.rst @@ -110,4 +110,17 @@ The following table shows the configuration options for the logging exporter: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/memory-ballast-extension.rst b/gdi/opentelemetry/components/memory-ballast-extension.rst index a5b84a3e4..6d824f764 100644 --- a/gdi/opentelemetry/components/memory-ballast-extension.rst +++ b/gdi/opentelemetry/components/memory-ballast-extension.rst @@ -10,8 +10,21 @@ Memory Ballast extension (deprecated) .. caution:: The ``memory_ballast`` extension is deprecated and has been removed starting in Collector version 0.97.0. If you're using this extension, read on to learn how to update your configuration. + + +.. raw:: html + +
+ .. include:: /_includes/collector-upgrade-memory-ballast.rst +.. raw:: html + +
+ + + + Get started ====================== @@ -108,4 +121,17 @@ The following table shows the configuration options for the Memory Ballast exten Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/memory-limiter-processor.rst b/gdi/opentelemetry/components/memory-limiter-processor.rst index cec550c6b..f64a7be56 100644 --- a/gdi/opentelemetry/components/memory-limiter-processor.rst +++ b/gdi/opentelemetry/components/memory-limiter-processor.rst @@ -127,4 +127,17 @@ The following table shows the configuration options for the ``memory_limiter`` p Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/metrics-transform-processor.rst b/gdi/opentelemetry/components/metrics-transform-processor.rst index 524e0ec9d..58eb336e8 100644 --- a/gdi/opentelemetry/components/metrics-transform-processor.rst +++ b/gdi/opentelemetry/components/metrics-transform-processor.rst @@ -480,6 +480,19 @@ The following table shows the configuration options for the ``metricstransform`` Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + + diff --git a/gdi/opentelemetry/components/mongodb-atlas-receiver.rst b/gdi/opentelemetry/components/mongodb-atlas-receiver.rst index 962369a93..d300c6291 100644 --- a/gdi/opentelemetry/components/mongodb-atlas-receiver.rst +++ b/gdi/opentelemetry/components/mongodb-atlas-receiver.rst @@ -92,9 +92,34 @@ The following metrics, resource attributes, and attributes are available.
+ + +.. raw:: html + +
+ .. include:: /_includes/activate-deactivate-native-metrics.rst +.. raw:: html + +
+ + + + Troubleshooting ====================== -.. include:: /_includes/troubleshooting-components.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/mongodb-receiver.rst b/gdi/opentelemetry/components/mongodb-receiver.rst index 9e0c14c61..bf38b1732 100644 --- a/gdi/opentelemetry/components/mongodb-receiver.rst +++ b/gdi/opentelemetry/components/mongodb-receiver.rst @@ -115,9 +115,35 @@ The following metrics, resource attributes, and attributes are available. * ``mongodb.extent.count`` is available for versions under 4.4 with mmapv1 storage engine. + + +.. raw:: html + +
+ .. include:: /_includes/activate-deactivate-native-metrics.rst +.. raw:: html + +
+ + + + Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/mssql-server-receiver.rst b/gdi/opentelemetry/components/mssql-server-receiver.rst index 33693d8ed..b01602c0e 100644 --- a/gdi/opentelemetry/components/mssql-server-receiver.rst +++ b/gdi/opentelemetry/components/mssql-server-receiver.rst @@ -153,9 +153,35 @@ The following metrics, resource attributes, and attributes, are available.
+ + +.. raw:: html + +
+ .. include:: /_includes/activate-deactivate-native-metrics.rst +.. raw:: html + +
+ + + + Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/mysql-receiver.rst b/gdi/opentelemetry/components/mysql-receiver.rst index 432fe5ec6..e665f0606 100644 --- a/gdi/opentelemetry/components/mysql-receiver.rst +++ b/gdi/opentelemetry/components/mysql-receiver.rst @@ -91,10 +91,36 @@ The following settings are optional: * ``database``. The database name. If unspecified, metrics are collected for all databases. + + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-settings-collectioninterval.rst +.. raw:: html + +
+ + + + + + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-settings-initialdelay.rst +.. raw:: html + +
+ + + + * ``transport``. ``tcp`` by default. Defines the network to use to connect to the server. * ``statement_events``. Additional configuration for the queries that build ``mysql.statement_events.count`` and ``mysql.statement_events.wait.time`` metrics: @@ -127,9 +153,34 @@ The following metrics, resource attributes, and attributes, are available.
+ + +.. raw:: html + +
+ .. include:: /_includes/activate-deactivate-native-metrics.rst +.. raw:: html + +
+ + + + Troubleshooting ====================== -.. include:: /_includes/troubleshooting-components.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/nginx-receiver.rst b/gdi/opentelemetry/components/nginx-receiver.rst index 4884efd8c..5662f1271 100644 --- a/gdi/opentelemetry/components/nginx-receiver.rst +++ b/gdi/opentelemetry/components/nginx-receiver.rst @@ -55,10 +55,36 @@ The following settings are available: * ``endpoint``. :strong:`Required`. ``http://localhost:80/status`` by default. The URL of the NGINX status endpoint. + + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-settings-collectioninterval.rst +.. raw:: html + +
+ + + + + + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-settings-initialdelay.rst +.. raw:: html + +
+ + + + Settings ====================== @@ -77,9 +103,35 @@ The following metrics, resource attributes, and attributes are available.
+ + +.. raw:: html + +
+ .. include:: /_includes/activate-deactivate-native-metrics.rst +.. raw:: html + +
+ + + + Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/oauth2client-extension.rst b/gdi/opentelemetry/components/oauth2client-extension.rst index 7dd94ac19..ee1d5758a 100644 --- a/gdi/opentelemetry/components/oauth2client-extension.rst +++ b/gdi/opentelemetry/components/oauth2client-extension.rst @@ -146,4 +146,17 @@ The following table shows the configuration options for the ``oauth2client`` ext Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/oracledb-receiver.rst b/gdi/opentelemetry/components/oracledb-receiver.rst index c38d51a7a..33e9666af 100644 --- a/gdi/opentelemetry/components/oracledb-receiver.rst +++ b/gdi/opentelemetry/components/oracledb-receiver.rst @@ -111,9 +111,35 @@ The following metrics, resource attributes, and attributes, are available.
+ + +.. raw:: html + +
+ .. include:: /_includes/activate-deactivate-native-metrics.rst +.. raw:: html + +
+ + + + Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/otlp-exporter.rst b/gdi/opentelemetry/components/otlp-exporter.rst index 36b83bd97..73734f849 100644 --- a/gdi/opentelemetry/components/otlp-exporter.rst +++ b/gdi/opentelemetry/components/otlp-exporter.rst @@ -119,4 +119,17 @@ The following table shows the configuration options for the OTLP exporter: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/otlp-receiver.rst b/gdi/opentelemetry/components/otlp-receiver.rst index 41dd4624c..bea2f79f0 100644 --- a/gdi/opentelemetry/components/otlp-receiver.rst +++ b/gdi/opentelemetry/components/otlp-receiver.rst @@ -146,4 +146,17 @@ The following table shows the configuration options for the OTLP receiver: Troubleshooting ================================================= + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/otlphttp-exporter.rst b/gdi/opentelemetry/components/otlphttp-exporter.rst index 70125c44f..5dfc3d127 100644 --- a/gdi/opentelemetry/components/otlphttp-exporter.rst +++ b/gdi/opentelemetry/components/otlphttp-exporter.rst @@ -153,4 +153,17 @@ The following table shows the configuration options for the OTLP/HTTP exporter: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/postgresql-receiver.rst b/gdi/opentelemetry/components/postgresql-receiver.rst index fb335f833..44660c32a 100644 --- a/gdi/opentelemetry/components/postgresql-receiver.rst +++ b/gdi/opentelemetry/components/postgresql-receiver.rst @@ -86,9 +86,35 @@ The following metrics, resource attributes, and attributes are available.
+ + +.. raw:: html + +
+ .. include:: /_includes/activate-deactivate-native-metrics.rst +.. raw:: html + +
+ + + + Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/probabilistic-sampler-processor.rst b/gdi/opentelemetry/components/probabilistic-sampler-processor.rst index 1107cc7a7..ddf5b31ff 100644 --- a/gdi/opentelemetry/components/probabilistic-sampler-processor.rst +++ b/gdi/opentelemetry/components/probabilistic-sampler-processor.rst @@ -180,4 +180,17 @@ The following table shows the configuration options for the ``probabilistic_samp Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/prometheus-receiver.rst b/gdi/opentelemetry/components/prometheus-receiver.rst index bbcdcafa4..034c445e3 100644 --- a/gdi/opentelemetry/components/prometheus-receiver.rst +++ b/gdi/opentelemetry/components/prometheus-receiver.rst @@ -176,4 +176,16 @@ For more information on histogram support, see :ref:`enable-histograms-export`. Troubleshooting ====================== -.. include:: /_includes/troubleshooting-components.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/rabbitmq-receiver.rst b/gdi/opentelemetry/components/rabbitmq-receiver.rst index 7605af7da..0b3ac721c 100644 --- a/gdi/opentelemetry/components/rabbitmq-receiver.rst +++ b/gdi/opentelemetry/components/rabbitmq-receiver.rst @@ -96,4 +96,17 @@ The following metrics, resource attributes, and attributes are available. Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/receiver-creator-receiver.rst b/gdi/opentelemetry/components/receiver-creator-receiver.rst index 109bc8468..91bd08894 100644 --- a/gdi/opentelemetry/components/receiver-creator-receiver.rst +++ b/gdi/opentelemetry/components/receiver-creator-receiver.rst @@ -161,4 +161,17 @@ The following table shows the configuration options for the receiver creator rec Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/redaction-processor.rst b/gdi/opentelemetry/components/redaction-processor.rst index dbbb73df8..c1b261bd0 100644 --- a/gdi/opentelemetry/components/redaction-processor.rst +++ b/gdi/opentelemetry/components/redaction-processor.rst @@ -139,4 +139,17 @@ The following table shows the configuration options for the redaction processor: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/redis-receiver.rst b/gdi/opentelemetry/components/redis-receiver.rst index 0f083ae2d..0c045cd1e 100644 --- a/gdi/opentelemetry/components/redis-receiver.rst +++ b/gdi/opentelemetry/components/redis-receiver.rst @@ -124,4 +124,17 @@ The following metrics, resource attributes, and attributes are available. Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/resource-processor.rst b/gdi/opentelemetry/components/resource-processor.rst index c1c246178..709fe57b9 100644 --- a/gdi/opentelemetry/components/resource-processor.rst +++ b/gdi/opentelemetry/components/resource-processor.rst @@ -101,4 +101,17 @@ The following table shows the configuration options for the resource processor: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/resourcedetection-processor.rst b/gdi/opentelemetry/components/resourcedetection-processor.rst index 9cc1b0c70..7fbf1f4da 100644 --- a/gdi/opentelemetry/components/resourcedetection-processor.rst +++ b/gdi/opentelemetry/components/resourcedetection-processor.rst @@ -470,4 +470,17 @@ The following table shows the configuration options for the resource detection p Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/signalfx-exporter.rst b/gdi/opentelemetry/components/signalfx-exporter.rst index 5409155d2..bf230818c 100644 --- a/gdi/opentelemetry/components/signalfx-exporter.rst +++ b/gdi/opentelemetry/components/signalfx-exporter.rst @@ -63,8 +63,21 @@ Send histogram metrics in OTLP format The Splunk Distribution of OpenTelemetry Collector supports OTLP histogram metrics starting from version 0.98 and higher. See :ref:`explicit-bucket-histograms` for more information. + + +.. raw:: html + +
+ .. include:: /_includes/gdi/histograms.rst +.. raw:: html + +
+ + + + .. _sfx-exporter-default-metric-filter: Default metric filters @@ -291,8 +304,21 @@ Translation rules currently allow the following actions: .. _default-translation-rules-sfx-exporter: + + +.. raw:: html + +
+ .. include:: /_includes/gdi/default-translation-metrics.rst +.. raw:: html + +
+ + + + .. _drop-histogram-metrics: Drop histogram metrics @@ -318,4 +344,17 @@ The following table shows the configuration options for the SignalFx exporter: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/signalfx-gateway-prometheus-remote-write-receiver.rst b/gdi/opentelemetry/components/signalfx-gateway-prometheus-remote-write-receiver.rst index bc6d57fdd..c30c6622b 100644 --- a/gdi/opentelemetry/components/signalfx-gateway-prometheus-remote-write-receiver.rst +++ b/gdi/opentelemetry/components/signalfx-gateway-prometheus-remote-write-receiver.rst @@ -95,4 +95,16 @@ The following behavior from SignalFx Gateway is not supported: Troubleshooting ====================== -.. include:: /_includes/troubleshooting-components.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/signalfx-receiver.rst b/gdi/opentelemetry/components/signalfx-receiver.rst index 64e4cbeb9..cb905c853 100644 --- a/gdi/opentelemetry/components/signalfx-receiver.rst +++ b/gdi/opentelemetry/components/signalfx-receiver.rst @@ -99,4 +99,16 @@ The following table shows the configuration options for the SignalFx receiver: Troubleshooting ====================== -.. include:: /_includes/troubleshooting-components.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/simple-prometheus-receiver.rst b/gdi/opentelemetry/components/simple-prometheus-receiver.rst index 1d8543d37..5762a329c 100644 --- a/gdi/opentelemetry/components/simple-prometheus-receiver.rst +++ b/gdi/opentelemetry/components/simple-prometheus-receiver.rst @@ -94,4 +94,17 @@ The Simple Prometheus receiver converts Prometheus metrics to OpenTelemetry metr Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/smartagent-receiver.rst b/gdi/opentelemetry/components/smartagent-receiver.rst index d8f855cc9..763467d14 100644 --- a/gdi/opentelemetry/components/smartagent-receiver.rst +++ b/gdi/opentelemetry/components/smartagent-receiver.rst @@ -48,8 +48,21 @@ Native Smart Agent monitors are grouped into three types: The following matrices list support for each monitor in each architecture. + + +.. raw:: html + +
+ .. include:: /_includes/gdi/processor-architecture-native.rst +.. raw:: html + +
+ + + + .. _subprocess-monitors-support-matrices: Subprocess Smart Agent monitors @@ -65,8 +78,21 @@ Subprocess monitor types are those that initiate the creation and management of These types derive from integrations that produce metrics in the Smart Agent and are not reflective of the current ability to run arbitrary Python or Java applications. + + +.. raw:: html + +
+ .. include:: /_includes/gdi/processor-architecture-subprocess.rst +.. raw:: html + +
+ + + + Benefits ================================= @@ -141,4 +167,17 @@ To configure Smart Agent monitors, see the documentation on each monitor type in Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/span-metrics-connector.rst b/gdi/opentelemetry/components/span-metrics-connector.rst index ca71b3b6b..3c9aa64df 100644 --- a/gdi/opentelemetry/components/span-metrics-connector.rst +++ b/gdi/opentelemetry/components/span-metrics-connector.rst @@ -257,6 +257,19 @@ The following table shows the configuration options for the ``spanmetrics`` conn Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + + diff --git a/gdi/opentelemetry/components/span-processor.rst b/gdi/opentelemetry/components/span-processor.rst index 0fc9629e8..d5a5f8fab 100644 --- a/gdi/opentelemetry/components/span-processor.rst +++ b/gdi/opentelemetry/components/span-processor.rst @@ -180,4 +180,17 @@ The following table shows the configuration options for the span processor: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/splunk-apm-exporter.rst b/gdi/opentelemetry/components/splunk-apm-exporter.rst index bf9d52af7..2d842f85a 100644 --- a/gdi/opentelemetry/components/splunk-apm-exporter.rst +++ b/gdi/opentelemetry/components/splunk-apm-exporter.rst @@ -112,4 +112,17 @@ The following table shows the configuration options for the SAPM exporter: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/splunk-enterprise-receiver.rst b/gdi/opentelemetry/components/splunk-enterprise-receiver.rst index fa1ce29d2..a6bd0b8fa 100644 --- a/gdi/opentelemetry/components/splunk-enterprise-receiver.rst +++ b/gdi/opentelemetry/components/splunk-enterprise-receiver.rst @@ -123,9 +123,35 @@ The following metrics, resource attributes, and attributes are available.
+ + +.. raw:: html + +
+ .. include:: /_includes/activate-deactivate-native-metrics.rst +.. raw:: html + +
+ + + + Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/splunk-hec-exporter.rst b/gdi/opentelemetry/components/splunk-hec-exporter.rst index 0af80027b..36715fb6e 100644 --- a/gdi/opentelemetry/components/splunk-hec-exporter.rst +++ b/gdi/opentelemetry/components/splunk-hec-exporter.rst @@ -321,4 +321,17 @@ The following table shows the configuration options for the Splunk HEC exporter. Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/splunk-hec-receiver.rst b/gdi/opentelemetry/components/splunk-hec-receiver.rst index e54459acf..9dcd44cee 100644 --- a/gdi/opentelemetry/components/splunk-hec-receiver.rst +++ b/gdi/opentelemetry/components/splunk-hec-receiver.rst @@ -103,4 +103,17 @@ The following table shows the configuration options for the Splunk HEC receiver: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/sqlquery-receiver.rst b/gdi/opentelemetry/components/sqlquery-receiver.rst index cc9635432..b1f39c1b0 100644 --- a/gdi/opentelemetry/components/sqlquery-receiver.rst +++ b/gdi/opentelemetry/components/sqlquery-receiver.rst @@ -267,4 +267,16 @@ The following table shows the configuration options for the SQL Query receiver: Troubleshooting ================================================= -.. include:: /_includes/troubleshooting-components.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/syslog-receiver.rst b/gdi/opentelemetry/components/syslog-receiver.rst index 4ee3228c9..540a2f366 100644 --- a/gdi/opentelemetry/components/syslog-receiver.rst +++ b/gdi/opentelemetry/components/syslog-receiver.rst @@ -156,4 +156,17 @@ The following table shows the configuration options for the Syslog receiver: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/tcp-receiver.rst b/gdi/opentelemetry/components/tcp-receiver.rst index 36538e106..e723366cd 100644 --- a/gdi/opentelemetry/components/tcp-receiver.rst +++ b/gdi/opentelemetry/components/tcp-receiver.rst @@ -153,4 +153,16 @@ The following table shows the configuration options for the TCP receiver: Troubleshooting ================================================= -.. include:: /_includes/troubleshooting-components.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/transform-processor.rst b/gdi/opentelemetry/components/transform-processor.rst index d5d45884b..ae4bb4b41 100644 --- a/gdi/opentelemetry/components/transform-processor.rst +++ b/gdi/opentelemetry/components/transform-processor.rst @@ -192,4 +192,17 @@ You can apply the following functions to metric contexts: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/udp-receiver.rst b/gdi/opentelemetry/components/udp-receiver.rst index 727066180..57759741b 100644 --- a/gdi/opentelemetry/components/udp-receiver.rst +++ b/gdi/opentelemetry/components/udp-receiver.rst @@ -154,4 +154,17 @@ The following table shows the configuration options for the UDP receiver: Troubleshooting ================================================= + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/vcenter-receiver.rst b/gdi/opentelemetry/components/vcenter-receiver.rst index 90c6521dd..992cc76e6 100644 --- a/gdi/opentelemetry/components/vcenter-receiver.rst +++ b/gdi/opentelemetry/components/vcenter-receiver.rst @@ -111,4 +111,17 @@ The following metrics, resource attributes, and attributes are available. Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/windowsperfcounters-receiver.rst b/gdi/opentelemetry/components/windowsperfcounters-receiver.rst index 9b6de2d1d..5b4855f4b 100644 --- a/gdi/opentelemetry/components/windowsperfcounters-receiver.rst +++ b/gdi/opentelemetry/components/windowsperfcounters-receiver.rst @@ -371,4 +371,17 @@ The following table shows the configuration options for the Windows Performance Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/zipkin-receiver.rst b/gdi/opentelemetry/components/zipkin-receiver.rst index d9f3d1448..1c7d1fce0 100644 --- a/gdi/opentelemetry/components/zipkin-receiver.rst +++ b/gdi/opentelemetry/components/zipkin-receiver.rst @@ -76,4 +76,17 @@ The following table shows the configuration options for the Zipkin receiver: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/components/zpages-extension.rst b/gdi/opentelemetry/components/zpages-extension.rst index 09abc9230..62f1da48c 100644 --- a/gdi/opentelemetry/components/zpages-extension.rst +++ b/gdi/opentelemetry/components/zpages-extension.rst @@ -120,4 +120,17 @@ The following table shows the configuration options for the zPages extension: Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/discovery-mode.rst b/gdi/opentelemetry/discovery-mode.rst index ad67b1ba8..d491989c0 100644 --- a/gdi/opentelemetry/discovery-mode.rst +++ b/gdi/opentelemetry/discovery-mode.rst @@ -33,8 +33,21 @@ The following diagram shows how automatic discovery finds data sources: X --> Y --> Z + + +.. raw:: html + +
+ .. include:: /_includes/gdi/auto-discovery-intro.rst +.. raw:: html + +
+ + + + .. raw:: html

Supported host services and applications for automatic discovery

diff --git a/gdi/opentelemetry/environment-variables.rst b/gdi/opentelemetry/environment-variables.rst index 7857a576a..0030b68cd 100644 --- a/gdi/opentelemetry/environment-variables.rst +++ b/gdi/opentelemetry/environment-variables.rst @@ -19,4 +19,16 @@ For a detailed list of the upstream environment variables, refer to OpenTelemetr Splunk-specific environment variables ========================================== -.. include:: /_includes/collector-env-vars.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/collector-env-vars.rst +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/install-the-collector.rst b/gdi/opentelemetry/install-the-collector.rst index be6f6ae53..cfb360c8b 100644 --- a/gdi/opentelemetry/install-the-collector.rst +++ b/gdi/opentelemetry/install-the-collector.rst @@ -117,8 +117,21 @@ Use these configurations to change the default settings in each Collector packag * :ref:`otel-linux-config` * :ref:`otel-windows-config` + + +.. raw:: html + +
+ .. include:: /_includes/gdi/collector-common-options.rst +.. raw:: html + +
+ + + + .. raw:: html @@ -194,8 +207,21 @@ Common sources such as filelog, journald, and Windows Event Viewer are included

Use the Collector

+ + +.. raw:: html + +
+ .. include:: /_includes/collector-works.rst +.. raw:: html + +
+ + + + See also the following documents to understand how the Collector works, and how to use it: * :ref:`otel-tags` @@ -208,8 +234,21 @@ See also the following documents to understand how the Collector works, and how

Components and services of the Collector

+ + +.. raw:: html + +
+ .. include:: /_includes/collector-components.rst +.. raw:: html + +
+ + + + .. raw:: html diff --git a/gdi/opentelemetry/opentelemetry.rst b/gdi/opentelemetry/opentelemetry.rst index 501d90500..40e92f951 100644 --- a/gdi/opentelemetry/opentelemetry.rst +++ b/gdi/opentelemetry/opentelemetry.rst @@ -35,8 +35,21 @@ Learn more about the Splunk Observability Cloud data model at :ref:`data-model`.

How does the OpenTelemetry Collector work?

+ + +.. raw:: html + +
+ .. include:: /_includes/collector-works.rst +.. raw:: html + +
+ + + + .. raw:: html diff --git a/gdi/opentelemetry/otel-other/prometheus-generic.rst b/gdi/opentelemetry/otel-other/prometheus-generic.rst index d32453f21..013a6d993 100644 --- a/gdi/opentelemetry/otel-other/prometheus-generic.rst +++ b/gdi/opentelemetry/otel-other/prometheus-generic.rst @@ -93,4 +93,16 @@ You can now see your Apache Flink metrics in Splunk Observability Cloud. Troubleshooting ====================== -.. include:: /_includes/troubleshooting-components.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/troubleshooting-components.rst +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/otel-other/telegraf.rst b/gdi/opentelemetry/otel-other/telegraf.rst index 89bb9962c..3f466b0a0 100644 --- a/gdi/opentelemetry/otel-other/telegraf.rst +++ b/gdi/opentelemetry/otel-other/telegraf.rst @@ -14,8 +14,21 @@ To monitor your service with Telegraf using native OpenTelemetry in Splunk Obser Benefits -------- + + +.. raw:: html + +
+ .. include:: /_includes/benefits.rst +.. raw:: html + +
+ + + + Configuration ---------------------------------- @@ -119,4 +132,17 @@ Add the following configuration to the OTel Collector to retrieve metrics from t Troubleshooting --------------- + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/opentelemetry/otel-requirements.rst b/gdi/opentelemetry/otel-requirements.rst index fb1b8409d..abe85c989 100644 --- a/gdi/opentelemetry/otel-requirements.rst +++ b/gdi/opentelemetry/otel-requirements.rst @@ -21,12 +21,38 @@ The Splunk Distribution of OpenTelemetry Collector supports the following operat :strong:`Linux` + + +.. raw:: html + +
+ .. include:: /_includes/requirements/collector-linux.rst +.. raw:: html + +
+ + + + :strong:`Windows` + + +.. raw:: html + +
+ .. include:: /_includes/requirements/collector-windows.rst +.. raw:: html + +
+ + + + Keep in mind the following pre-requisites, requirements, and general considerations when using the Collector: * :ref:`otel-security` diff --git a/gdi/opentelemetry/smart-agent/smart-agent-migration-process.rst b/gdi/opentelemetry/smart-agent/smart-agent-migration-process.rst index f2840c8da..bce70ff8d 100644 --- a/gdi/opentelemetry/smart-agent/smart-agent-migration-process.rst +++ b/gdi/opentelemetry/smart-agent/smart-agent-migration-process.rst @@ -360,4 +360,17 @@ After uninstalling the Smart Agent, :ref:`deploy the Collector to a production h After verifying with one host, deploy the Collector with the same configuration to the rest of the hosts. + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/other-ingestion-methods/upstream-collector.rst b/gdi/other-ingestion-methods/upstream-collector.rst index b6c8d1903..30eaf9dd5 100644 --- a/gdi/other-ingestion-methods/upstream-collector.rst +++ b/gdi/other-ingestion-methods/upstream-collector.rst @@ -81,9 +81,22 @@ Sample configuration for Splunk Observability Cloud The following example shows how to configure the upstream Collector to send metrics and traces to Splunk Observability Cloud: + + +.. raw:: html + +
+ .. github:: yaml :url: https://raw.githubusercontent.com/signalfx/splunk-otel-collector/main/cmd/otelcol/config/collector/upstream_agent_config.yaml +.. raw:: html + +
+ + + + .. _migrate-otel-upstream: Migrate to the Splunk Distribution of OpenTelemetry Collector @@ -106,4 +119,17 @@ To migrate from the Collector Contrib to the Splunk OTel Collector, follow these Troubleshooting ================================================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/gdi/private-connectivity/aws-privatelink.rst b/gdi/private-connectivity/aws-privatelink.rst index 0ce0d4c10..8ca7cfab7 100644 --- a/gdi/private-connectivity/aws-privatelink.rst +++ b/gdi/private-connectivity/aws-privatelink.rst @@ -356,4 +356,17 @@ Learn more about VPC Peering in the AWS documentation at :new-page:`Two VPCs pee .. _aws-privatelink-support: + + +.. raw:: html + +
+ .. include:: /_includes/report-issue.rst + +.. raw:: html + +
+ + + diff --git a/gdi/requirements.rst b/gdi/requirements.rst index c8d960e26..c2eaf1e6c 100644 --- a/gdi/requirements.rst +++ b/gdi/requirements.rst @@ -32,8 +32,21 @@ See :ref:`get-started-linux` for more information. Windows ------------------------------------------------------------ + + +.. raw:: html + +
+ .. include:: /_includes/requirements/collector-windows.rst +.. raw:: html + +
+ + + + See :ref:`get-started-windows` for more information. @@ -42,8 +55,21 @@ Available host and application monitors The following host and application monitors are available. Refer to each service for detailed compatibility and requirements information. + + +.. raw:: html + +
+ .. include:: /_includes/gdi/application-receiver-table.rst +.. raw:: html + +
+ + + + Processor architecture ------------------------------------------------------------- @@ -59,16 +85,42 @@ The Splunk distributions of OpenTelemetry instrumentation supports the following Java ------------------------------------------ + + +.. raw:: html + +
+ .. include:: /_includes/requirements/java.rst +.. raw:: html + +
+ + + + See :ref:`java-otel-requirements` for more information. Node ------------------------------------------- + + +.. raw:: html + +
+ .. include:: /_includes/requirements/nodejs.rst +.. raw:: html + +
+ + + + See :ref:`nodejs-otel-requirements` for more information. @@ -76,32 +128,84 @@ See :ref:`nodejs-otel-requirements` for more information. .NET --------------------------------------------- + + +.. raw:: html + +
+ .. include:: /_includes/requirements/dotnet.rst +.. raw:: html + +
+ + + + See :ref:`dotnet-otel-requirements` for more information. Go ---------------------------------------------- + + +.. raw:: html + +
+ .. include:: /_includes/requirements/go.rst +.. raw:: html + +
+ + + + See :ref:`go-otel-requirements` for more information. Python ---------------------------------------------- + + +.. raw:: html + +
+ .. include:: /_includes/requirements/python.rst +.. raw:: html + +
+ + + + See :ref:`python-otel-requirements` for more information. Ruby ---------------------------------------------- + + +.. raw:: html + +
+ .. include:: /_includes/requirements/ruby.rst +.. raw:: html + +
+ + + + See :ref:`ruby-otel-requirements` for more information. @@ -109,16 +213,42 @@ See :ref:`ruby-otel-requirements` for more information. PHP ---------------------------------------------- + + +.. raw:: html + +
+ .. include:: /_includes/requirements/php.rst +.. raw:: html + +
+ + + + See :ref:`php-otel-requirements` for more information. AWS Lambda functions ------------------------------------------ + + +.. raw:: html + +
+ .. include:: /_includes/requirements/lambda.rst +.. raw:: html + +
+ + + + See :ref:`instrument-aws-lambda-functions` for more information. @@ -132,8 +262,21 @@ The Splunk distributions of OpenTelemetry instrumentation supports the following Android ------------------------------------------ + + +.. raw:: html + +
+ .. include:: /_includes/requirements/android.rst +.. raw:: html + +
+ + + + See :ref:`android-rum-install` for more information. @@ -141,8 +284,21 @@ See :ref:`android-rum-install` for more information. iOS ------------------------------------------ + + +.. raw:: html + +
+ .. include:: /_includes/requirements/ios.rst +.. raw:: html + +
+ + + + See :ref:`ios-rum-install` for more information. @@ -150,20 +306,59 @@ See :ref:`ios-rum-install` for more information. Web applications ------------------------------------------ + + +.. raw:: html + +
+ .. include:: /_includes/requirements/browser.rst +.. raw:: html + +
+ + + + See :ref:`browser-rum-install` for more information. React Native ------------------------------------------ + + +.. raw:: html + +
+ .. include:: /_includes/requirements/react.rst +.. raw:: html + +
+ + + + See :ref:`react-rum-install` for more information. Support ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/infrastructure/metrics-pipeline/metrics-usage-report.rst b/infrastructure/metrics-pipeline/metrics-usage-report.rst index b9d309a89..8bf86e08f 100644 --- a/infrastructure/metrics-pipeline/metrics-usage-report.rst +++ b/infrastructure/metrics-pipeline/metrics-usage-report.rst @@ -42,8 +42,21 @@ Metric identifiers The following table has an overview of metric category types. To learn more about metric categories, see :ref:`metrics-category`. + + +.. raw:: html + +
+ .. include:: /_includes/metric-classes.rst +.. raw:: html + +
+ + + + Usage statistics -------------------------------- diff --git a/infrastructure/monitor/aws-infra-import.rst b/infrastructure/monitor/aws-infra-import.rst index e49b58e29..f72101f98 100644 --- a/infrastructure/monitor/aws-infra-import.rst +++ b/infrastructure/monitor/aws-infra-import.rst @@ -188,8 +188,21 @@ See how to filter data at :ref:`aws-control-example`. Unsupported characters for tags ++++++++++++++++++++++++++++++++++++++++++++++++++++++ + + +.. raw:: html + +
+ .. include:: /_includes/gdi/aws-unsupported-chars.rst +.. raw:: html + +
+ + + + .. _api-filters: Advanced filtering using the API diff --git a/logs/intro-logconnect.rst b/logs/intro-logconnect.rst index 927d52d4c..b3121323c 100644 --- a/logs/intro-logconnect.rst +++ b/logs/intro-logconnect.rst @@ -15,8 +15,21 @@ Splunk Log Observer Connect is an integration that allows you to query your Splu Region and version availability ============================================================== + + +.. raw:: html + +
+ .. include:: /_includes/logs/loc-availability.rst +.. raw:: html + +
+ + + + .. _LogObserverFeatures: What can I do with Log Observer Connect? diff --git a/logs/keyword.rst b/logs/keyword.rst index 1e521804d..88fabe076 100644 --- a/logs/keyword.rst +++ b/logs/keyword.rst @@ -12,6 +12,19 @@ In Log Observer Connect, you can search Splunk platform logs that your Splunk pl You can search for keywords, field names, or field values. To search your logs, follow these steps: + + +.. raw:: html + +
+ .. include:: /_includes/logs/query-logs.rst +.. raw:: html + +
+ + + + When you add keywords, field names, or field values to the filters, Log Observer Connect narrows the results in the Timeline and the Logs table so that only records containing the selected fields and values appear. To learn how you can reuse a productive search in the future, see :ref:`logs-save-share`. diff --git a/logs/open-logs-splunk.rst b/logs/open-logs-splunk.rst index 665403240..e4a567ba5 100644 --- a/logs/open-logs-splunk.rst +++ b/logs/open-logs-splunk.rst @@ -13,6 +13,19 @@ You can search Splunk Observability Cloud logs if your Splunk Observability Clou To open your logs in Splunk platform, follow these steps: + + +.. raw:: html + +
+ .. include:: /_includes/logs/query-logs.rst +.. raw:: html + +
+ + + + When you add keywords, field names, or field values to the filters, Log Observer narrows the results in the Timeline and the Logs table so that only records containing the selected fields and values appear. To learn how you can use a productive search in the future, see :ref:`logs-save-share`. diff --git a/logs/scp.rst b/logs/scp.rst index 4cdf2356e..c24f8ca91 100644 --- a/logs/scp.rst +++ b/logs/scp.rst @@ -16,8 +16,21 @@ When you set up Log Observer Connect, your logs remain in your Splunk Cloud Plat Region and version availability ============================================================== + + +.. raw:: html + +
+ .. include:: /_includes/logs/loc-availability.rst +.. raw:: html + +
+ + + + .. _logs-scp-prereqs: Prerequisites diff --git a/logs/set-up-logconnect.rst b/logs/set-up-logconnect.rst index df1b76fbb..9208c3a00 100644 --- a/logs/set-up-logconnect.rst +++ b/logs/set-up-logconnect.rst @@ -18,8 +18,21 @@ When you set up Log Observer Connect, your Splunk Enterprise logs data remains i Region and version compatibility ============================================================== + + +.. raw:: html + +
+ .. include:: /_includes/logs/loc-availability.rst +.. raw:: html + +
+ + + + Prerequisites ============================================================== diff --git a/metrics-and-metadata/histograms-gdi.rst b/metrics-and-metadata/histograms-gdi.rst index da6146205..71a084fe2 100644 --- a/metrics-and-metadata/histograms-gdi.rst +++ b/metrics-and-metadata/histograms-gdi.rst @@ -11,8 +11,21 @@ You can collect histogram data using a variety of receivers, including the Prome The Splunk Distribution of OpenTelemetry Collector supports explicit-bucket histogram metrics. You can send histogram metric using the OTLP exporter or, starting from version 0.98, through the :ref:`signalfx-exporter`. + + +.. raw:: html + +
+ .. include:: /_includes/gdi/histograms.rst +.. raw:: html + +
+ + + + You can collect histogram data using a variety of receivers, including the :ref:`Prometheus receiver `. .. _bucket-histograms-best-practices: @@ -69,4 +82,17 @@ To migrate your existing dashboards, functions, charts, and detectors to histogr Troubleshooting ====================== + + +.. raw:: html + +
+ .. include:: /_includes/troubleshooting-components.rst + +.. raw:: html + +
+ + + diff --git a/metrics-and-metadata/metric-categories.rst b/metrics-and-metadata/metric-categories.rst index d20d5c504..f7c58c32f 100644 --- a/metrics-and-metadata/metric-categories.rst +++ b/metrics-and-metadata/metric-categories.rst @@ -10,8 +10,21 @@ Metric categories These are the available categories for metrics in Splunk Observability Cloud: + + +.. raw:: html + +
+ .. include:: /_includes/metric-classes.rst +.. raw:: html + +
+ + + + .. note:: Usage analytics doesn't support APM Monitoring MetricSets, RUM Monitoring MetricSets, or default/bundles APM metrics, so you can't view these metrics in usage analytics. To learn more about usage analytics, see :ref:`metrics-usage-analytics-intro`. Identify and track the category of a metric diff --git a/metrics-and-metadata/relatedcontent.rst b/metrics-and-metadata/relatedcontent.rst index 5485a3245..28cf06250 100644 --- a/metrics-and-metadata/relatedcontent.rst +++ b/metrics-and-metadata/relatedcontent.rst @@ -186,8 +186,21 @@ To ensure full functionality of both Log Observer and Related Content, verify th If the key names in the preceding list use different names in your log fields, remap them to the key names listed here. For example, if you don't see values for :strong:`host.name` in the Log Observer UI, check to see whether your logs use a different field name, such as :strong:`host_name`. If your logs do not contain the default field names exactly as they appear in the preceding list, remap your logs using one of the methods in the following section. + + +.. raw:: html + +
+ .. include:: /_includes/log-observer-transition.rst +.. raw:: html + +
+ + + + Kubernetes log fields ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/private-preview/rbac/roles-and-capabilities-table.rst b/private-preview/rbac/roles-and-capabilities-table.rst index 3b115902e..2e37eadff 100644 --- a/private-preview/rbac/roles-and-capabilities-table.rst +++ b/private-preview/rbac/roles-and-capabilities-table.rst @@ -11,7 +11,20 @@ Splunk Observability Cloud roles and capabilities + + +.. raw:: html + +
+ .. include:: /_includes/private-preview.rst + +.. raw:: html + +
+ + + |hr| @@ -26,60 +39,189 @@ Splunk Observability Cloud lets you restrict access to certain features to speci Metrics pipeline management =============================================================================== + + +.. raw:: html + +
+ .. include:: /_includes/admin/roles_mpm.rst +.. raw:: html + +
+ + + + Log Observer and Log Observer Connect =============================================================================== + + +.. raw:: html + +
+ .. include:: /_includes/admin/roles_log_observer.rst +.. raw:: html + +
+ + + + Alerts and detectors roles and capabilities =============================================================================== + + +.. raw:: html + +
+ .. include:: /_includes/admin/roles_alerts_detectors.rst +.. raw:: html + +
+ + + + Infrastructure Monitoring navigators =============================================================================== + + +.. raw:: html + +
+ .. include:: /_includes/admin/roles_navs_dashbds.rst +.. raw:: html + +
+ + + + Splunk Synthetic Monitoring ================================================== + + +.. raw:: html + +
+ .. include:: /_includes/admin/synth-roles-caps.rst +.. raw:: html + +
+ + + + .. _rum-rbac: Splunk Real User Monitoring ================================================== + + +.. raw:: html + +
+ .. include:: /_includes/admin/rum-roles-caps.rst +.. raw:: html + +
+ + + + .. apm-rbac: Splunk Application Performance Monitoring ================================================================== + + +.. raw:: html + +
+ .. include:: /_includes/admin/roles_apm.rst +.. raw:: html + +
+ + + + Settings =========================== General settings ---------------------------- + + +.. raw:: html + +
+ .. include:: /_includes/admin/roles_navigation.rst +.. raw:: html + +
+ + + + Data configuration ---------------------------- + + +.. raw:: html + +
+ .. include:: /_includes/admin/roles_data_configuration.rst +.. raw:: html + +
+ + + + Help and support ---------------------------- -.. include:: /_includes/admin/roles_help_support.rst \ No newline at end of file + + +.. raw:: html + +
+ +.. include:: /_includes/admin/roles_help_support.rst +.. raw:: html + +
+ + + diff --git a/rum/rum-custom-indexed-tags.rst b/rum/rum-custom-indexed-tags.rst index a0507130f..1673a967d 100644 --- a/rum/rum-custom-indexed-tags.rst +++ b/rum/rum-custom-indexed-tags.rst @@ -16,8 +16,21 @@ Key concepts ================== How span tags, indexed span tags, and MetricSets relate to each other. + + +.. raw:: html + +
+ .. include:: /_includes/synthetics/metricset-def.rst +.. raw:: html + +
+ + + + Example: track custom processes ================================= diff --git a/synthetics/api-test/set-up-api-test.rst b/synthetics/api-test/set-up-api-test.rst index 4a5538cea..fc0a2530e 100644 --- a/synthetics/api-test/set-up-api-test.rst +++ b/synthetics/api-test/set-up-api-test.rst @@ -67,8 +67,21 @@ Follow these steps to add requests to your API test: #. Repeat until you have added as many requests as you'd like to include in your API test. #. Select :guilabel:`Save steps & return to test` to finish creating your test. + + +.. raw:: html + +
+ .. include:: /_includes/synthetics/configure-test.rst +.. raw:: html + +
+ + + + Example ================== For an example, see :ref:`api-test-scenario`. \ No newline at end of file diff --git a/synthetics/browser-test/set-up-browser-test.rst b/synthetics/browser-test/set-up-browser-test.rst index a33dee426..857234e10 100644 --- a/synthetics/browser-test/set-up-browser-test.rst +++ b/synthetics/browser-test/set-up-browser-test.rst @@ -45,8 +45,21 @@ Follow these steps to set up a Browser test: #. Save your test. + + +.. raw:: html + +
+ .. include:: /_includes/synthetics/configure-test.rst +.. raw:: html + +
+ + + + Import a JSON file generated from Google Chrome Recorder ============================================================ @@ -520,8 +533,21 @@ Note: Global variables are incompatible with Chrome flags. These are the flags available: + + +.. raw:: html + +
+ .. include:: /_includes/synthetics/chrome-flags.rst +.. raw:: html + +
+ + + + .. _browser-custom-props: diff --git a/synthetics/test-config/global-variables.rst b/synthetics/test-config/global-variables.rst index cea7f4f59..ff92d4b04 100644 --- a/synthetics/test-config/global-variables.rst +++ b/synthetics/test-config/global-variables.rst @@ -7,24 +7,20 @@ Create and use global variables .. meta:: :description: Define a variable that you can use in multiple browser and API tests in Splunk Synthetic Monitoring. -Define a global variable once, and then you can use the variable across all of your browser and API tests. +Define a global variable once, and then use it across all of your browser and API tests. How can you use a global variable? =================================== -Global variables are stored securely in Splunk Synthetic Monitoring, but the keys and values of all global variables in your account are visible to all users. +Use global variables to store non-sensitive information for your browser and API tests. Splunk Synthetic Monitoring saves your global variables, but note that their values are visible to all users in your account. -To preserve your account's security, don't use production credentials, real credit card information, or other sensitive data in global variables for your tests. Instead, use placeholder credentials to test workflows that require you to enter information. - -To use information such as login credentials, API keys, or other test data, you can permanently conceal the value of a global variable from all users of your account. +To preserve your account's security, don't use global variables to store sensitive information such as login credentials, API keys, or credit card information. Instead, either use placeholder values or permanently conceal the global variables that contain sensitive information. .. _concealed-gv: What happens when you conceal a global variable? ================================================== -When you conceal a global variable, its value is permanently concealed from all users of the account. This lets you create and save variables such as test login credentials, API keys, and other sensitive information to use in browser and API tests. - -To preserve security, the value of a concealed global variable is never revealed to any user of the account after it has been created and saved. The value is scrubbed from the Splunk Synthetic Monitoring UI, from test results, and from alert messages. +When you conceal a global variable, Splunk Synthetic Monitoring permanently hides its value from all users of your account. Concealed values are never revealed; they are scrubbed from the Splunk Synthetic Monitoring UI, from test results, and from alert messages. However, if you send a concealed value to a test endpoint, that endpoint receives its unconcealed value. Create a global variable diff --git a/synthetics/uptime-test/set-up-uptime-test.rst b/synthetics/uptime-test/set-up-uptime-test.rst index 43121376f..a399d96bd 100644 --- a/synthetics/uptime-test/set-up-uptime-test.rst +++ b/synthetics/uptime-test/set-up-uptime-test.rst @@ -43,8 +43,21 @@ Follow these steps to set up a Port Uptime test: #. In the :guilabel:`Name` field, enter a name for your test. You will use this name to identify data from the test in your alerts and reports. #. In the :guilabel:`Address` field, use the drop-down list to indicate whether the port you are monitoring follows TCP or UDP protocol. Enter the host and port addresses. + + +.. raw:: html + +
+ .. include:: /_includes/synthetics/configure-test.rst +.. raw:: html + +
+ + + + View your Uptime test ======================