diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml new file mode 100644 index 000000000..9b201e80f --- /dev/null +++ b/.github/workflows/heretto-reminder.yml @@ -0,0 +1,39 @@ +name: Heretto Update Reminder + +on: + pull_request: + types: [opened, synchronize] + +jobs: + reminder: + runs-on: ubuntu-latest + permissions: + id-token: write + contents: read + actions: read + issues: write + checks: write + pull-requests: write + + + steps: + - name: Add PR Comment + uses: actions/github-script@v6 + with: + github-token: ${{ secrets.MY_TOKEN }} + script: | + const { owner, repo, number } = context.issue; + const pr = await github.rest.pulls.get({ + owner, + repo, + pull_number: number, + }); + + const author = pr.data.user.login; + + await github.rest.issues.createComment({ + owner, + repo, + issue_number: number, + body: `@${author}, please make sure that you update the files in Heretto and post the Heretto share link in this PR.` + }) diff --git a/_templates/404.html b/_templates/404.html index 6c248975b..754d4cc9d 100644 --- a/_templates/404.html +++ b/_templates/404.html @@ -204,7 +204,7 @@

Was this Privacy | Terms | Export Control | - © 2005 - 2023 Splunk LLC All rights reserved. + © 2005 - 2025 Splunk LLC All rights reserved.
Splunk, Splunk>, Turn Data Into Doing, and Data-to-Everything are trademarks or registered trademarks of Splunk LLC in the United States and other countries. All other brand names, product names, or trademarks belong to their respective owners.
diff --git a/_templates/layout.html b/_templates/layout.html index 4ed4dd382..1cd1b6373 100644 --- a/_templates/layout.html +++ b/_templates/layout.html @@ -208,7 +208,7 @@

Was this Privacy | Terms | Export Control | - © 2005 - 2023 Splunk LLC All rights reserved. + © 2005 - 2025 Splunk LLC All rights reserved.
Splunk, Splunk>, Turn Data Into Doing, and Data-to-Everything are trademarks or registered trademarks of Splunk LLC in the United States and other countries. All other brand names, product names, or trademarks belong to their respective owners.

diff --git a/_templates/search.html b/_templates/search.html index 348395afa..966167729 100644 --- a/_templates/search.html +++ b/_templates/search.html @@ -268,7 +268,7 @@

Was this Privacy | Terms | Export Control | - © 2005 - 2023 Splunk LLC All rights reserved. + © 2005 - 2025 Splunk LLC All rights reserved.
Splunk, Splunk>, Turn Data Into Doing, and Data-to-Everything are trademarks or registered trademarks of Splunk LLC in the United States and other countries. All other brand names, product names, or trademarks belong to their respective owners.

diff --git a/gdi/get-data-in/application/otel-dotnet/instrumentation/manual-dotnet-instrumentation.rst b/gdi/get-data-in/application/otel-dotnet/instrumentation/manual-dotnet-instrumentation.rst index 786918b26..e0ae5a9ac 100644 --- a/gdi/get-data-in/application/otel-dotnet/instrumentation/manual-dotnet-instrumentation.rst +++ b/gdi/get-data-in/application/otel-dotnet/instrumentation/manual-dotnet-instrumentation.rst @@ -90,4 +90,4 @@ To create custom metrics, follow these steps: OTEL_DOTNET_AUTO_METRICS_ADDITIONAL_SOURCES=My.Application -See the :new-page:`OpenTelemetry official documentation ` for additional information and examples. diff --git a/gdi/get-data-in/connect/aws/aws-connect-polling.rst b/gdi/get-data-in/connect/aws/aws-connect-polling.rst index b892ba143..d9056dc96 100644 --- a/gdi/get-data-in/connect/aws/aws-connect-polling.rst +++ b/gdi/get-data-in/connect/aws/aws-connect-polling.rst @@ -54,7 +54,7 @@ In this step you need to choose the following connection options: * Metadata. * Cost and usage metrics. - * CloudWatch metrics. + * CloudWatch metrics. In the CloudWatch Metrics option, select :guilabel:`Polling` as the ingestion method, and set up the polling rate at which you want Splunk Observability Cloud to poll CloudWatch for metric data. diff --git a/gdi/get-data-in/connect/aws/get-awstoc.rst b/gdi/get-data-in/connect/aws/get-awstoc.rst index 7b4a00e53..8fd1e9489 100644 --- a/gdi/get-data-in/connect/aws/get-awstoc.rst +++ b/gdi/get-data-in/connect/aws/get-awstoc.rst @@ -8,27 +8,27 @@ Connect AWS to Splunk Observability Cloud :description: Connection planning information and links to the different ways to connect AWS to Splunk Observability Cloud. .. toctree:: - :hidden: - :maxdepth: 5 - - AWS authentication, permissions and regions - Supported Amazon services - Compare connection options - Connect via polling - Connect with Splunk-managed Metrics Streams - Connect with AWS-managed Metric Streams - Connect to AWS using the Splunk API - Connect to AWS with Terraform - CloudFormation and Terraform templates - Send AWS logs to Splunk Platform - Next steps - Troubleshoot your AWS integration - Troubleshoot AWS CloudWatch polling - Troubleshoot Splunk-managed Metric Streams - Troubleshoot AWS-managed Metric Streams - aws-recommended-stats.rst - GetMetricStatistics API deprecation notice - aws-tutorial/about-aws-tutorial.rst + :hidden: + :maxdepth: 5 + + AWS authentication, permissions and regions + Supported Amazon services + Compare connection options + Connect via polling + Connect with Splunk-managed Metrics Streams + Connect with AWS-managed Metric Streams + Connect to AWS using the Splunk API + Connect to AWS with Terraform + CloudFormation and Terraform templates + Send AWS logs to Splunk Platform + Next steps + Troubleshoot your AWS integration + Troubleshoot AWS CloudWatch polling + Troubleshoot Splunk-managed Metric Streams + Troubleshoot AWS-managed Metric Streams + aws-recommended-stats.rst + GetMetricStatistics API deprecation notice + aws-tutorial/about-aws-tutorial.rst Splunk Observability Cloud offers you several data ingestion and connection methods to monitor your Amazon Web Services (AWS) data. diff --git a/gdi/get-data-in/rum/browser/configure-rum-browser-instrumentation.rst b/gdi/get-data-in/rum/browser/configure-rum-browser-instrumentation.rst index 58ec28ced..079c720b5 100644 --- a/gdi/get-data-in/rum/browser/configure-rum-browser-instrumentation.rst +++ b/gdi/get-data-in/rum/browser/configure-rum-browser-instrumentation.rst @@ -200,7 +200,7 @@ The following example shows how to restrict sampling to logged in users: rumAccessToken: '', applicationName: '', tracer: { - sampler: shouldTrace ? new AlwaysOnSampler() : new SplunkRum.AlwaysOffSampler(), + sampler: shouldTrace ? new SplunkRum.AlwaysOnSampler() : new SplunkRum.AlwaysOffSampler(), }, }); diff --git a/index.rst b/index.rst index 7a4b19af8..90206dfe6 100644 --- a/index.rst +++ b/index.rst @@ -861,3 +861,4 @@ To keep up to date with changes in the products, see the Splunk Observability Cl :maxdepth: 3 Contribute to our documentation + diff --git a/infrastructure/metrics-pipeline/use-case-archive.rst b/infrastructure/metrics-pipeline/use-case-archive.rst index e0a33909c..e7fdf7d92 100644 --- a/infrastructure/metrics-pipeline/use-case-archive.rst +++ b/infrastructure/metrics-pipeline/use-case-archive.rst @@ -41,7 +41,7 @@ Actions Kai decides to use Archived Metrics to control how Splunk Observability Cloud stores their team's data. -#. In Splunk Observability Cloud, Kai goes to :guilabel:` Settings > Metrics Management`. In the :guilabel:`Pipeline Management` tab Kai searches for the metric ``service.latency`` and configures the ingestion route to Archived Metrics. Kai can now see all the MTS as Archived MTS. +#. In Splunk Observability Cloud, Kai goes to :guilabel:`Settings` then :guilabel:`Metrics Management`. In the :guilabel:`Pipeline Management` tab Kai searches for the metric ``service.latency`` and configures the ingestion route to Archived Metrics. Kai can now see all the MTS as Archived MTS. #. Kai creates a route exception rule and specifies a filter where ``data_center_region = Europe``. This gives them the estimate of 2,497 Real-Time MTS. Kai also restores the previous hour data to make sure they don't have gaps. #. Now, Kai views the list of charts and detectors that use ``service.latency``. To learn more about viewing or downloading the list, see :ref:`metrics-usage-report`. #. Kai already had a filter set up on the charts and detectors for ``data_center_region = Europe``. Kai verifies the data is visible in one of the charts. diff --git a/infrastructure/monitor/k8s-nav.rst b/infrastructure/monitor/k8s-nav.rst index b3e65ab4e..4befb5420 100644 --- a/infrastructure/monitor/k8s-nav.rst +++ b/infrastructure/monitor/k8s-nav.rst @@ -64,8 +64,8 @@ The following table describes the Kubernetes navigators: .. _k8s-nav-hierarchy-map: -Hierarchy map -====================== +Investigate instances with the hierarchy map +=============================================== .. note:: The hierarchy map is only available on the Kubernetes nodes, pods, and containers navigators. @@ -84,8 +84,10 @@ Nodes, pods, and containers are colored by health and status, as reported by Kub * Pods are colored by phase: ``Running``, ``Pending``, ``Succeeded``, ``Failed``, and ``Unknown`` * Containers are colored by status: ``Ready``, ``Not Ready``, and ``Unknown`` -Investigate instances in the hierarchy map ---------------------------------------------- +Hierarchy map features +------------------------ + +To investigate instances with the hierarchy map, use the following features: * Breadcrumb navigation: Switch to different instances and jump across entity levels using the breadcrumb navigation bar. * Hover: Get more information about an instance, including its status or phase, by hovering over that instance. @@ -94,15 +96,15 @@ Investigate instances in the hierarchy map .. _k8s-nav-left-nav: -Left navigation panel -============================ +Refine your view with the left navigation panel +================================================== -Use the left navigation panel in the table or heat map view to quickly switch between Kubernetes entity types, search for filters, and access predefined filters. +Use the left navigation panel in the table or heat map view to quickly switch between Kubernetes entity types, search for filters, use predefined filters, and view or use recently used filters. -To use the left navigation panel: +To refine your view with the left navigation panel, use the following features: * :guilabel:`Select entity type`: Use this drop-down menu to switch between Kubernetes entity types. -* :guilabel:`Refine by`: Use this panel to search for filters or access a list of predefined filters. The list of predefined filters is searchable and organized by :guilabel:`Relationship` and :guilabel:`Attribute`. +* :guilabel:`Refine by`: Use this panel to search for filters, use predefined filters, or view and use recently used filters. The list of predefined filters is searchable and organized by :guilabel:`Relationship` and :guilabel:`Attribute`. .. _k8s-nav-analyzer-overview: diff --git a/sp-oncall/admin/get-started/team-dashboard.rst b/sp-oncall/admin/get-started/team-dashboard.rst index 2252475cf..8b766fbf8 100644 --- a/sp-oncall/admin/get-started/team-dashboard.rst +++ b/sp-oncall/admin/get-started/team-dashboard.rst @@ -1,7 +1,7 @@ .. _team-dashboard: ************************************************************************ -Splunk On-Call +Splunk On-Call team dashboard ************************************************************************ .. meta:: @@ -9,15 +9,15 @@ Splunk On-Call -The Splunk On-Call provides a comprehensive overview of incidents. This view automatically defaults to the teams that you are a member of and allows teams to dive into the details and understand the status of alerts or incidents. +The Splunk On-Call provides a comprehensive overview of incidents. This view automatically defaults to the teams that you are a member of and allows teams to dive into the details and understand the status of alerts or incidents. -All incidents derived from integrated monitoring tools in the incident table include their respective logos to help you rapidly identify the source of an alert. Manually created incidents, along with incidents originating from the Email Endpoint or the REST API integrations, will remain logo free. +All incidents derived from integrated monitoring tools in the incident table include their respective logos to help you rapidly identify the source of an alert. Manually created incidents, along with incidents originating from the Email Endpoint or the REST API integrations, will remain logo free. Information Alerts can still be found on the Timeline Page. .. image:: /_images/spoc/team-dashboard.png :width: 100% - :alt: An image of the . On-Call individuals listed on the left; Team incidents are shown in the main pane. + :alt: An image of the team dashboard On-Call individuals listed on the left; Team incidents are shown in the main pane. Filters @@ -44,12 +44,12 @@ Quickly identify responsible parties during a firefight by easily seeing which p Manual Incident Creation ---------------------------- -You can create a manual incident from the by selecting :guilabel:`Create Incident` in the top right corner. For instructions, see :ref:`manual-incident`. +You can create a manual incident from the team dashboard by selecting :guilabel:`Create Incident` in the top right corner. For instructions, see :ref:`manual-incident`. Incident War Rooms ---------------------------- -Access Incident Details directly from the by selecting the incident number link. This will expand the incident and its event history in the :ref:`Incident War Room `. +Access Incident Details directly from the team dashboard by selecting the incident number link. This will expand the incident and its event history in the :ref:`Incident War Room `. People Table ================== diff --git a/sp-oncall/admin/sso/sp-sso-adfs.rst b/sp-oncall/admin/sso/sp-sso-adfs.rst index f25f2e788..955f60248 100644 --- a/sp-oncall/admin/sso/sp-sso-adfs.rst +++ b/sp-oncall/admin/sso/sp-sso-adfs.rst @@ -7,9 +7,6 @@ Configure Active Directory Federation Services Single Sign-On for Splunk On-Call .. meta:: :description: Enable Splunk On-Call SSO for Active Directory Federation Services (ADFS) your organization. - - - Requirements ================== @@ -17,35 +14,21 @@ This integration is compatible with the following versions of Splunk On-Call: - Full-Stack -To enable single sign-on (SSO) for your organization, you will need to provide an updated metadata file and your IDP. If you are -interested in setting up SSO, please contact :ref:`Splunk On-Call Support `. - - +To enable single sign-on (SSO) for your organization, you will need to provide an updated metadata file and your IDP. If you are interested in setting up SSO, please contact :ref:`Splunk On-Call Support `. -Configure Single Sign On (SSO) between your Identity Provider (IDP) and Splunk On-Call. Our standard SSO setup uses SAML 2.0 protocol. As long as your IDP can use SAML 2.0 protocol, it can integrate with Splunk On-Call. The exact steps differ depending on which IDP you use, but the process typically involves exporting a .XML metadata file and sending it to our Support team. Once you have sent the .xml file, a Splunk On-Call support specialist will +Our standard SSO setup uses SAML 2.0 protocol. As long as your IDP can use SAML 2.0 protocol, it can integrate with Splunk On-Call. The exact steps differ depending on which IDP you use, but the process typically involves exporting a .XML metadata file and sending it to our Support team. Once you have sent the .xml file, a Splunk On-Call support specialist will complete the setup on the back-end and respond with confirmation. If your IDP does not have SAML capability, please contact Splunk On-Call Support to explore what alternative options may be available. For details on how to contact Splunk On-Call Support, see :ref:`spoc-support`. - -Administrator Setup -========================== - -Instructions to complete the SSO configuration with Splunk On-Call and your IDP are provided for: - -- :ref:`sso-okta-spoc` -- :ref:`sso-google-spoc` -- :ref:`sso-onelogin-spoc` -- :ref:`sso-adfs-ac-spoc` - - .. _sso-adfs-ac-spoc: +Configure SSO for Active Directory Federation Services (ADFS) +============================================================== -Active Directory Federation Services (ADFS) -=========================================================== +To configure SSO for Splunk On-Call using ADFS complete the following steps. -Once you have sent over your Metadata file, and the Splunk On-Call Support team has completed the configuration, you will receive an updated metadata file to complete the configuration on your side. +#. Once you have sent over your Metadata file and the Splunk On-Call Support team has completed the configuration, you will receive an updated metadata file to complete the configuration on your side. #. In the ADFS Management console, navigate to :guilabel:`Trust Relationships`, then :guilabel:`Relying Party Trusts` and select :guilabel:`Add Relying Party Trust` in the :menuselection:`Actions` pane. diff --git a/sp-oncall/admin/sso/sp-sso-google.rst b/sp-oncall/admin/sso/sp-sso-google.rst index ad2c392a7..630e790a1 100644 --- a/sp-oncall/admin/sso/sp-sso-google.rst +++ b/sp-oncall/admin/sso/sp-sso-google.rst @@ -7,7 +7,7 @@ Configure Single Sign-On for Splunk On-Call using Google Apps .. meta:: :description: Enable Splunk On-Call SSO for your organization. -To configure SSO for Splunk On-Call using Google Apps: +To configure SSO for Splunk On-Call using Google Apps complete the following steps. #. Access the Admin portal for Google Apps and navigate to :guilabel:`Apps` then :guilabel:`SAML Apps`. diff --git a/sp-oncall/admin/sso/sp-sso-okta.rst b/sp-oncall/admin/sso/sp-sso-okta.rst index a12db7f46..e6f68e195 100644 --- a/sp-oncall/admin/sso/sp-sso-okta.rst +++ b/sp-oncall/admin/sso/sp-sso-okta.rst @@ -7,9 +7,6 @@ Configure Single Sign-On for Okta and Splunk On-Call .. meta:: :description: Enable Splunk On-Call SSO for your organization. - - - Requirements ================== @@ -20,20 +17,10 @@ This integration is compatible with the following versions of Splunk On-Call: To enable single sign-on (SSO) for your organization, you will need to provide an updated metadata file and your IDP. If you are interested in setting up SSO, please contact :ref:`Splunk On-Call Support `. - -Administrator Setup +Configure SSO for Okta ========================== -Instructions to complete the SSO configuration with Splunk On-Call and your IDP are provided for: - -- :ref:`sso-okta-spoc-setup` -- :ref:`sso-google-spoc` -- - -.. _sso-okta-spoc-setup: - -Okta -========== +To configure SSO for Okta complete the following steps. #. From the Okta user homepage, select :guilabel:`Admin` to access the Okta Admin dashboard. diff --git a/sp-oncall/alerts/team-escalation-policy.rst b/sp-oncall/alerts/team-escalation-policy.rst index d09c76dab..de743ceae 100644 --- a/sp-oncall/alerts/team-escalation-policy.rst +++ b/sp-oncall/alerts/team-escalation-policy.rst @@ -11,7 +11,7 @@ Escalation policies determine set who is actually on-call for a given team and a Some things to note: -- Only Team and Global Admins are able to make changes to Escalation Policies +- Only Team and Global Admins are able to make changes to Escalation Policies. - Only users specified in the first step of an Escalation Policy will receive Timeline and Push notifications that they are on-call and will log hours in the on-call report as being on-call. If you would like users in subsequent steps of an escalation policy to receive these notifications and log these hours, see :ref:`multi-escalation-policies`. - When an Escalation Policy is executed and a user is being notified, the user's personal paging policy determines how they will be contacted. See :ref:`custom-paging-policy`. diff --git a/sp-oncall/incidents/incident-pane.rst b/sp-oncall/incidents/incident-pane.rst index 64816ac78..27b408f35 100644 --- a/sp-oncall/incidents/incident-pane.rst +++ b/sp-oncall/incidents/incident-pane.rst @@ -5,7 +5,7 @@ Incident Pane ************************************************************************ .. meta:: - :description: About the Incident pane in Splunk On-Call which displays incoming alerts. + :description: About the incident pane in Splunk On-Call which displays incoming alerts. .. toctree:: :hidden: diff --git a/sp-oncall/notifications/call-notification-numbers.rst b/sp-oncall/notifications/call-notification-numbers.rst index ce215fc1d..732805fcc 100644 --- a/sp-oncall/notifications/call-notification-numbers.rst +++ b/sp-oncall/notifications/call-notification-numbers.rst @@ -7,7 +7,7 @@ Splunk On-Call notification phone numbers .. meta:: :description: Splunk On-Call contacts you for triggered incidents using the following phone numbers and short code. -Splunk On-Call contacts you for triggered incidents using the following phone numbers and short code. To add these numbers to your contacts in the Splunk On-Call mobile app, go to :guilabel:`Settings` then :guilabel:`Help and Support` then :guilabel:`Add VictorOps to Your Contacts`. For more information about the Splunk On-Call mobile app, see :ref:`spoc-mobile-main` +Splunk On-Call contacts you for triggered incidents using the following phone numbers and short code. To add these numbers to your contacts in the Splunk On-Call mobile app, go to :guilabel:`Settings` then :guilabel:`Help and Support` then :guilabel:`Add VictorOps to Your Contacts`. For more information about the Splunk On-Call mobile app, see :ref:`spoc-mobile-main`. .. image:: /_images/spoc/Add-Contacts-Android-1.png diff --git a/sp-oncall/reports/post-incident-review.rst b/sp-oncall/reports/post-incident-review.rst index 2c0663e06..e8dfc5ae8 100644 --- a/sp-oncall/reports/post-incident-review.rst +++ b/sp-oncall/reports/post-incident-review.rst @@ -13,7 +13,7 @@ To create a Post-Incident Review Report, access the Splunk On-Call web portal, a Select the :guilabel:`Post-Incident Reviews` option and select :guilabel:`New Report`. Enter a title and select :guilabel:`Create Report`. -Configuring post-incident eeview reports +Configuring post-incident review reports --------------------------------------------- Once you've created a New Report, you'll enter the main report configuration page where you'll be able to provide and define context diff --git a/splunkplatform/unified-id/unified-identity.rst b/splunkplatform/unified-id/unified-identity.rst index 9e90d1406..e300a61c3 100644 --- a/splunkplatform/unified-id/unified-identity.rst +++ b/splunkplatform/unified-id/unified-identity.rst @@ -21,7 +21,7 @@ When you integrate your Splunk Cloud Platform and Splunk Observability Cloud ins Who can access Single Sign On (SSO) and the benefits of Unified Identity? ========================================================================================== -All customers who have both Splunk Cloud Platform and Splunk Observability Cloud can access Unified Identity. Users must be on Splunk Cloud Platform version 9.x and higher. The AWS or GCP region for your Splunk Cloud Platform instance must map to your Splunk Observability Cloud instance realm as shown in the following table: +All customers who have both Splunk Cloud Platform and Splunk Observability Cloud can access Unified Identity. Users must be on Splunk Cloud Platform version 9.x and higher. The AWS region for your Splunk Cloud Platform instance must map to your Splunk Observability Cloud instance realm as shown in the following table: .. list-table:: :header-rows: 1 diff --git a/synthetics/api-test/api-test.rst b/synthetics/api-test/api-test.rst index 6e0e204d6..746059b47 100644 --- a/synthetics/api-test/api-test.rst +++ b/synthetics/api-test/api-test.rst @@ -19,7 +19,7 @@ An API test provides a flexible way to check the functionality and performance o The ongoing shift toward API-first development has magnified the necessity of monitoring the back-end services that provide your core front-end functionality. Whether you're interested in testing multi-step API interactions or you want to gain visibility into the performance of your endpoints, an API test can help you accomplish your goals. -.. note:: Splunk Synthetic Monitoring API tests support REST APIs only. SOAP APIs are not supported. +.. note:: Splunk Synthetic Monitoring API tests support REST APIs only. Although the API tests may allow certain SOAP interactions (such as sending SOAP messages over HTTP/S), SOAP is not officially supported. .. raw:: html @@ -75,7 +75,7 @@ The following table presents the types of setup steps you can create: - Extract a variable from formatted data (JSON, XML, or HTML) * - JavaScript - - Run custom JavaScript code + - Run custom JavaScript code. Splunk Synthetics only supports some JavaScript functions. For details, see :ref:`api-test-javascript`. .. raw:: html @@ -115,5 +115,12 @@ The following table presents the types of validation steps you can create: - Extract a variable from formatted data (JSON, XML, or HTML) * - JavaScript - - Run custom JavaScript code + - Run custom JavaScript code. Splunk Synthetics only supports some JavaScript functions. For details, see :ref:`api-test-javascript`. + +.. _api-test-javascript: + +Synthetics support for JavaScript +=============================================== + +Splunk Synthetics only provides the V8 engine for script execution. It doesn't provide a Node.js runtime environment. This means that it doesn't support Node.js features. For example, there is no support for file system access using ``fs``, HTTP requests using ``http``, event loops using ``setTimeout`` or similar functions, modules such as ``require`` or ``module.exports``, and so on.