From 8d9dffe92b193112601189f3143ee7e8d7601390 Mon Sep 17 00:00:00 2001 From: ada Date: Wed, 5 Mar 2025 10:07:57 -0800 Subject: [PATCH 01/46] [O11YDOCS-7073] Update copyright dates --- _templates/404.html | 2 +- _templates/layout.html | 2 +- _templates/search.html | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) 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.

From 21a5e04802f0e2f859e37675418e288dabcbb32b Mon Sep 17 00:00:00 2001 From: Tracey Carter Date: Thu, 6 Mar 2025 09:17:10 -0800 Subject: [PATCH 02/46] removed mention of GCP region --- splunkplatform/unified-id/unified-identity.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 From 3686facaf4637a42ffe9dc03876caf47b37ec0fd Mon Sep 17 00:00:00 2001 From: Brianne Hillmer Date: Thu, 6 Mar 2025 11:56:58 -0700 Subject: [PATCH 03/46] fixes from conversion --- sp-oncall/admin/get-started/team-dashboard.rst | 6 +++--- sp-oncall/incidents/incident-pane.rst | 2 +- sp-oncall/notifications/call-notification-numbers.rst | 2 +- sp-oncall/reports/post-incident-review.rst | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/sp-oncall/admin/get-started/team-dashboard.rst b/sp-oncall/admin/get-started/team-dashboard.rst index 2252475cf..09640f8b9 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,9 +9,9 @@ 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. 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 From a8426fb3004eac4179651031b83bc616878dc401 Mon Sep 17 00:00:00 2001 From: Brianne Hillmer Date: Thu, 6 Mar 2025 12:22:34 -0700 Subject: [PATCH 04/46] more changes from conversion --- .../admin/get-started/team-dashboard.rst | 6 ++-- sp-oncall/admin/sso/sp-sso-adfs.rst | 29 ++++--------------- sp-oncall/admin/sso/sp-sso-google.rst | 2 +- sp-oncall/admin/sso/sp-sso-okta.rst | 17 ++--------- sp-oncall/alerts/team-escalation-policy.rst | 2 +- 5 files changed, 13 insertions(+), 43 deletions(-) diff --git a/sp-oncall/admin/get-started/team-dashboard.rst b/sp-oncall/admin/get-started/team-dashboard.rst index 09640f8b9..8b766fbf8 100644 --- a/sp-oncall/admin/get-started/team-dashboard.rst +++ b/sp-oncall/admin/get-started/team-dashboard.rst @@ -17,7 +17,7 @@ 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`. From 416f46c6e3ef0ea7c915ec76b939af4d3f2d8f27 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 6 Mar 2025 16:44:48 -0800 Subject: [PATCH 05/46] Removed a stray space. --- gdi/get-data-in/connect/aws/aws-connect-polling.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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. From b48a71f014d7bf56c35514ec01d72c2d0cfde042 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 6 Mar 2025 16:55:17 -0800 Subject: [PATCH 06/46] Changed the indent by one space for a toctree directive, so that :hidden:and the entries are direclty under the toctree directive. --- gdi/get-data-in/connect/aws/get-awstoc.rst | 42 +++++++++++----------- 1 file changed, 21 insertions(+), 21 deletions(-) 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. From e06e20277928daa283bd18f0211a26b34aecd45f Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 6 Mar 2025 17:03:18 -0800 Subject: [PATCH 07/46] Replaced the link to aws-connect-polling with the file name as there are two anchors for that file, and the second one is _aws-connect-polling. --- gdi/get-data-in/connect/aws/get-awstoc.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gdi/get-data-in/connect/aws/get-awstoc.rst b/gdi/get-data-in/connect/aws/get-awstoc.rst index 8fd1e9489..2a7a9a9b7 100644 --- a/gdi/get-data-in/connect/aws/get-awstoc.rst +++ b/gdi/get-data-in/connect/aws/get-awstoc.rst @@ -14,7 +14,7 @@ Connect AWS to Splunk Observability Cloud AWS authentication, permissions and regions Supported Amazon services Compare connection options - Connect via polling + aws-connect-polling.rst Connect with Splunk-managed Metrics Streams Connect with AWS-managed Metric Streams Connect to AWS using the Splunk API From a4bb930dadb11a8290a653c51223a6b22aebf07d Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 6 Mar 2025 17:47:39 -0800 Subject: [PATCH 08/46] Returning the TOC to the original state since using the file name didn't help. --- gdi/get-data-in/connect/aws/get-awstoc.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gdi/get-data-in/connect/aws/get-awstoc.rst b/gdi/get-data-in/connect/aws/get-awstoc.rst index 2a7a9a9b7..8fd1e9489 100644 --- a/gdi/get-data-in/connect/aws/get-awstoc.rst +++ b/gdi/get-data-in/connect/aws/get-awstoc.rst @@ -14,7 +14,7 @@ Connect AWS to Splunk Observability Cloud AWS authentication, permissions and regions Supported Amazon services Compare connection options - aws-connect-polling.rst + Connect via polling Connect with Splunk-managed Metrics Streams Connect with AWS-managed Metric Streams Connect to AWS using the Splunk API From 3d05cb4f19c0a0365420618119b377178d08b170 Mon Sep 17 00:00:00 2001 From: puribe-splunk Date: Fri, 7 Mar 2025 09:51:19 -0800 Subject: [PATCH 09/46] Adding an exception --- conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/conf.py b/conf.py index 689b75827..55b6e2cc1 100644 --- a/conf.py +++ b/conf.py @@ -47,7 +47,7 @@ release = '' language = 'en' -exclude_patterns = ['_build', 'venv/lib/*/site-packages', '**/site-packages', 'Thumbs.db', '.DS_Store','z_cheat-sheets', 'README.md', 'CONTRIBUTING.md', '.github/pull_request_template.md', 'gdi/couchdb/couchdb.md', 'apm/find-root-cause.rst'] +exclude_patterns = ['_build', 'venv/lib/*/site-packages', '**/site-packages', 'Thumbs.db', '.DS_Store','z_cheat-sheets', 'README.md', 'CONTRIBUTING.md', '.github/pull_request_template.md', 'gdi/couchdb/couchdb.md', 'apm/find-root-cause.rst', '.git'] # THEME CONFIGURATION ####################### From 1f8076a887377ad7a7b607bb6a694192530e7a42 Mon Sep 17 00:00:00 2001 From: ada Date: Fri, 7 Mar 2025 09:51:29 -0800 Subject: [PATCH 10/46] [DOCGUILD-28608] Update note about SOAP support --- synthetics/api-test/api-test.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/synthetics/api-test/api-test.rst b/synthetics/api-test/api-test.rst index 6e0e204d6..0593df200 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 From ff5aae9d9a80c8b0b34c7f210ad34bf8007d98a4 Mon Sep 17 00:00:00 2001 From: ada Date: Fri, 7 Mar 2025 09:51:29 -0800 Subject: [PATCH 11/46] [DOCGUILD-28608] Update note about SOAP support --- synthetics/api-test/api-test.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/synthetics/api-test/api-test.rst b/synthetics/api-test/api-test.rst index 6e0e204d6..0593df200 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 From 0da24d8bb97625b94952ae4582568cc040d1de50 Mon Sep 17 00:00:00 2001 From: sheilattran8 <123210881+sheilattran8@users.noreply.github.com> Date: Tue, 11 Mar 2025 11:21:06 -0700 Subject: [PATCH 12/46] add-recently-used-filter-content --- infrastructure/monitor/k8s-nav.rst | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) 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: From 4f9efa4cdad1f371fbbf052cc1a6dabbce3fafd8 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Wed, 12 Mar 2025 10:27:29 -0700 Subject: [PATCH 13/46] Fixed a rST link syntax. --- .../instrumentation/manual-dotnet-instrumentation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 b5d0d4062..5a169c0c8 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 @@ -82,4 +82,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. From 77f780b05232c52a0926cf4d0aa9adf1e12b6517 Mon Sep 17 00:00:00 2001 From: Tracey Carter Date: Fri, 14 Mar 2025 11:29:39 -0700 Subject: [PATCH 14/46] removed skynet line --- splunkplatform/centralized-rbac.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/splunkplatform/centralized-rbac.rst b/splunkplatform/centralized-rbac.rst index 2301fad60..90d401078 100644 --- a/splunkplatform/centralized-rbac.rst +++ b/splunkplatform/centralized-rbac.rst @@ -150,8 +150,6 @@ Next, confirm that the user with login problems has both of the following roles * one of the ``o11y_*`` roles (See the complete step 3 in the previous section.) -Lastly, check the signalboost-rest skynet logs, searching for errors containing the keyword ``SplunkCloudPlatformAuthManager``. - Multiple errors issue ------------------------------------------------------------------------------------------------- After an administrator has set up centralized user and role management, the user sees errors across the UI after logging in. From ac2c256d1216dcb3f3eb87511a521684db65a5c1 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Mon, 17 Mar 2025 15:31:00 -0700 Subject: [PATCH 15/46] Adding a workflow action to send a reminder on PRs to update Heretto files. --- .github/workflows/heretto-reminder.yml | 80 ++++++++++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 .github/workflows/heretto-reminder.yml diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml new file mode 100644 index 000000000..f7675c9a8 --- /dev/null +++ b/.github/workflows/heretto-reminder.yml @@ -0,0 +1,80 @@ +name: Pull Request Reminder + +on: + schedule: + - cron: '0 9 * * *' # Runs every day at 9:00 AM UTC. Adjust as needed. + pull_request: + types: [opened, synchronize, reopened] + +jobs: + reminder: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Get Pull Request Info + id: pr_info + uses: actions/github-script@v7 + with: + 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; + const createdAt = new Date(pr.data.created_at); + const now = new Date(); + const diffInDays = Math.floor((now - createdAt) / (1000 * 60 * 60 * 24)); + const labels = pr.data.labels.map(label => label.name); + + return { author, diffInDays, number, labels }; + + - name: Check if Reminder Needed + id: check_reminder + uses: actions/github-script@v7 + with: + script: | + const { diffInDays, labels } = ${{ steps.pr_info.outputs }}; + const reminderLabel = 'reminder sent'; + const daysThreshold = 1; // Number of days before sending reminder. Adjust as needed. + + if (labels.includes(reminderLabel)) { + return { sendReminder: false }; + } + + if (diffInDays >= daysThreshold) { + return { sendReminder: true }; + } else { + return { sendReminder: false }; + } + + - name: Send Reminder Comment + if: ${{ steps.check_reminder.outputs.sendReminder == 'true' }} + uses: actions/github-script@v7 + with: + script: | + const { owner, repo, number, author } = ${{ steps.pr_info.outputs }}; + const message = `@${author}, please make sure that you update the files in Heretto and post the Heretto share link in this PR.`; + await github.rest.issues.createComment({ + owner, + repo, + issue_number: number, + body: message, + }); + + - name: Add Reminder Label + if: ${{ steps.check_reminder.outputs.sendReminder == 'true' }} + uses: actions/github-script@v7 + with: + script: | + const { owner, repo, number } = ${{ steps.pr_info.outputs }}; + await github.rest.issues.addLabels({ + owner, + repo, + issue_number: number, + labels: ['reminder sent'], + }); From 6593700f471745666c9d8e9d39e0995c63cc7308 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Mon, 17 Mar 2025 16:27:08 -0700 Subject: [PATCH 16/46] Added permission to the workflow to avoid the error 'Resource not accessible'. --- .github/workflows/heretto-reminder.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index f7675c9a8..18736d560 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -9,6 +9,10 @@ on: jobs: reminder: runs-on: ubuntu-latest + permissions: + contents: read + actions: read + checks: write steps: - name: Checkout code uses: actions/checkout@v4 From 6b2115102875b08157971db8b87536717a40172d Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Mon, 17 Mar 2025 16:31:07 -0700 Subject: [PATCH 17/46] Added permission to the workflow to avoid the error 'Resource not accessible'. --- .github/workflows/heretto-reminder.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index 18736d560..4c4621cc0 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -10,9 +10,12 @@ jobs: reminder: runs-on: ubuntu-latest permissions: + id-token: write contents: read actions: read + issues: write checks: write + pull-requests: write steps: - name: Checkout code uses: actions/checkout@v4 From dfb96f2b6028fd27bef52cc5617326aa718b4ec1 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Mon, 17 Mar 2025 16:37:17 -0700 Subject: [PATCH 18/46] Added permission to the workflow to avoid the error 'Resource not accessible'. --- .github/workflows/heretto-reminder.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index 4c4621cc0..f691c7d9e 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -49,6 +49,9 @@ jobs: const reminderLabel = 'reminder sent'; const daysThreshold = 1; // Number of days before sending reminder. Adjust as needed. + if (!labels) { // Check if labels is undefined or null + return { sendReminder: diffInDays >= daysThreshold }; // send reminder if the time threshold is passed, even without labels. + } if (labels.includes(reminderLabel)) { return { sendReminder: false }; } From d8a2e78f90eb08e87a825639548505f60fc5542e Mon Sep 17 00:00:00 2001 From: Brianne Hillmer Date: Tue, 18 Mar 2025 10:25:38 -0600 Subject: [PATCH 19/46] fixes from conversion --- infrastructure/metrics-pipeline/use-case-archive.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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. From eb6ef3a0dd87d2aeba601c7757afe2e2e7968c7d Mon Sep 17 00:00:00 2001 From: ada Date: Tue, 18 Mar 2025 14:35:47 -0700 Subject: [PATCH 20/46] [DOCGUILD-28818] Bugfix --- .../rum/browser/configure-rum-browser-instrumentation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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(), }, }); From 3e445341cc118bc49583495e7d1be28c0b364fe2 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Tue, 18 Mar 2025 15:26:03 -0700 Subject: [PATCH 21/46] Updated the workflow based on feedback from Pedro so that the reminder is posted immediately. --- .github/workflows/heretto-reminder.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index f691c7d9e..04467a19c 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -1,8 +1,6 @@ name: Pull Request Reminder on: - schedule: - - cron: '0 9 * * *' # Runs every day at 9:00 AM UTC. Adjust as needed. pull_request: types: [opened, synchronize, reopened] From 3bec34ebbfafb38245c2f91f58eca00099ac9329 Mon Sep 17 00:00:00 2001 From: ada Date: Tue, 18 Mar 2025 15:41:04 -0700 Subject: [PATCH 22/46] [DOCGUILD-28570] JavaScript support limitations --- synthetics/api-test/api-test.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/synthetics/api-test/api-test.rst b/synthetics/api-test/api-test.rst index 0593df200..28daf601a 100644 --- a/synthetics/api-test/api-test.rst +++ b/synthetics/api-test/api-test.rst @@ -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 runtime. This means that it doesn't support node features like file system access using ``fs``, HTTP modules using ``http``, event loops using ``setTimeout`` and similar functions, module systems such as ``require`` or ``module.exports``, and so on. From 15b58b33dd1eb91326d743a149de0255c2125a0d Mon Sep 17 00:00:00 2001 From: ada Date: Tue, 18 Mar 2025 15:48:38 -0700 Subject: [PATCH 23/46] [DOCGUILD-28570] JavaScript support limitations --- synthetics/api-test/api-test.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/synthetics/api-test/api-test.rst b/synthetics/api-test/api-test.rst index 28daf601a..746059b47 100644 --- a/synthetics/api-test/api-test.rst +++ b/synthetics/api-test/api-test.rst @@ -123,4 +123,4 @@ The following table presents the types of validation steps you can create: Synthetics support for JavaScript =============================================== -Splunk Synthetics only provides the V8 engine for script execution. It doesn't provide a node runtime. This means that it doesn't support node features like file system access using ``fs``, HTTP modules using ``http``, event loops using ``setTimeout`` and similar functions, module systems such as ``require`` or ``module.exports``, and so on. +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. From fc10c970bb656526031aff77426793a3180b7875 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 16:35:41 -0700 Subject: [PATCH 24/46] Adding a new line to test the reminder workflow. --- index.rst | 1 + 1 file changed, 1 insertion(+) 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 + From c520985c3b05d11b8624278dc5a0e0ff4f139d72 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 16:48:12 -0700 Subject: [PATCH 25/46] Updating workflow to send reminder and removing time dependency. --- .github/workflows/heretto-reminder.yml | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index 04467a19c..c5e107ca7 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -31,35 +31,25 @@ jobs: }); const author = pr.data.user.login; - const createdAt = new Date(pr.data.created_at); - const now = new Date(); - const diffInDays = Math.floor((now - createdAt) / (1000 * 60 * 60 * 24)); const labels = pr.data.labels.map(label => label.name); - return { author, diffInDays, number, labels }; + return { author, number, labels }; - name: Check if Reminder Needed id: check_reminder uses: actions/github-script@v7 with: script: | - const { diffInDays, labels } = ${{ steps.pr_info.outputs }}; + const { labels } = ${{ steps.pr_info.outputs }}; const reminderLabel = 'reminder sent'; - const daysThreshold = 1; // Number of days before sending reminder. Adjust as needed. if (!labels) { // Check if labels is undefined or null - return { sendReminder: diffInDays >= daysThreshold }; // send reminder if the time threshold is passed, even without labels. + return { sendReminder: true }; // send reminder if the time threshold is passed, even without labels. } if (labels.includes(reminderLabel)) { return { sendReminder: false }; } - if (diffInDays >= daysThreshold) { - return { sendReminder: true }; - } else { - return { sendReminder: false }; - } - - name: Send Reminder Comment if: ${{ steps.check_reminder.outputs.sendReminder == 'true' }} uses: actions/github-script@v7 From d0b3cfff530bfd61dbe3bb0919f6dab5f4ffaa44 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 17:01:18 -0700 Subject: [PATCH 26/46] Updating workflow to send reminder and removing time dependency. --- .github/workflows/heretto-reminder.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index c5e107ca7..5175693f8 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -43,7 +43,7 @@ jobs: const { labels } = ${{ steps.pr_info.outputs }}; const reminderLabel = 'reminder sent'; - if (!labels) { // Check if labels is undefined or null + if (!labels || labels.length === 0) { return { sendReminder: true }; // send reminder if the time threshold is passed, even without labels. } if (labels.includes(reminderLabel)) { From 98198df2b125ccfe2a4755af4999e6e75782e1a2 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 17:05:09 -0700 Subject: [PATCH 27/46] Updating workflow to send reminder and removing time dependency. --- .github/workflows/heretto-reminder.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index 5175693f8..c83d0160e 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -51,7 +51,7 @@ jobs: } - name: Send Reminder Comment - if: ${{ steps.check_reminder.outputs.sendReminder == 'true' }} + if: ${{ steps.check_reminder.outputs.sendReminder == true }} uses: actions/github-script@v7 with: script: | From 7dbe7c3f0eb8e69a1b7d40732debf21125eab55c Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 17:14:40 -0700 Subject: [PATCH 28/46] Updating workflow to send reminder and removing time dependency. --- .github/workflows/heretto-reminder.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index c83d0160e..46609316d 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -65,7 +65,7 @@ jobs: }); - name: Add Reminder Label - if: ${{ steps.check_reminder.outputs.sendReminder == 'true' }} + if: ${{ steps.check_reminder.outputs.sendReminder == true }} uses: actions/github-script@v7 with: script: | From a507cf3735a585734ec1bca2f4e43abb1edb24df Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 17:17:25 -0700 Subject: [PATCH 29/46] Updating workflow to send reminder and removing time dependency. --- .github/workflows/heretto-reminder.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index 46609316d..9f6764211 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -35,6 +35,8 @@ jobs: return { author, number, labels }; + - name: Debug Output + run: echo "sendReminder: ${{ steps.check_reminder.outputs.sendReminder }}" - name: Check if Reminder Needed id: check_reminder uses: actions/github-script@v7 From e89ac1bd6c61d83b1941cb020d7c96f1eb94fc8e Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 17:18:52 -0700 Subject: [PATCH 30/46] Updating workflow to send reminder and removing time dependency. --- .github/workflows/heretto-reminder.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index 9f6764211..6e7f3f3cd 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -37,6 +37,8 @@ jobs: - name: Debug Output run: echo "sendReminder: ${{ steps.check_reminder.outputs.sendReminder }}" + - name: Debug PR Info + run: echo "labels: ${{ steps.pr_info.outputs.labels }}" - name: Check if Reminder Needed id: check_reminder uses: actions/github-script@v7 From 0de75228d7d84d95e8db40ea3401be428583120f Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 17:21:32 -0700 Subject: [PATCH 31/46] Updating workflow to send reminder and removing time dependency. --- .github/workflows/heretto-reminder.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index 6e7f3f3cd..bd928aced 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -37,8 +37,10 @@ jobs: - name: Debug Output run: echo "sendReminder: ${{ steps.check_reminder.outputs.sendReminder }}" + - name: Debug PR Info run: echo "labels: ${{ steps.pr_info.outputs.labels }}" + - name: Check if Reminder Needed id: check_reminder uses: actions/github-script@v7 From 2122f1926bb2b3c9e70164aceabbbbbe61967138 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 17:24:34 -0700 Subject: [PATCH 32/46] Updating workflow to send reminder and removing time dependency. --- .github/workflows/heretto-reminder.yml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index bd928aced..46609316d 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -35,12 +35,6 @@ jobs: return { author, number, labels }; - - name: Debug Output - run: echo "sendReminder: ${{ steps.check_reminder.outputs.sendReminder }}" - - - name: Debug PR Info - run: echo "labels: ${{ steps.pr_info.outputs.labels }}" - - name: Check if Reminder Needed id: check_reminder uses: actions/github-script@v7 From 743c30384c08addc9d573fcb4d6ab634b4510a67 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 17:26:09 -0700 Subject: [PATCH 33/46] Updating workflow to send reminder and removing time dependency. --- .github/workflows/heretto-reminder.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index 46609316d..adeaf46fb 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -50,6 +50,12 @@ jobs: return { sendReminder: false }; } + - name: Debug Output + run: echo "sendReminder: ${{ steps.check_reminder.outputs.sendReminder }}" + + - name: Debug PR Info + run: echo "labels: ${{ steps.pr_info.outputs.labels }}" + - name: Send Reminder Comment if: ${{ steps.check_reminder.outputs.sendReminder == true }} uses: actions/github-script@v7 From 17ec555d2e30580dd17c517e14a3cce06e11ca57 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 17:27:42 -0700 Subject: [PATCH 34/46] Updating workflow to send reminder and removing time dependency. --- .github/workflows/heretto-reminder.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index adeaf46fb..58d2564c8 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -51,10 +51,10 @@ jobs: } - name: Debug Output - run: echo "sendReminder: ${{ steps.check_reminder.outputs.sendReminder }}" + run: echo "Debug Output Step Running" - name: Debug PR Info - run: echo "labels: ${{ steps.pr_info.outputs.labels }}" + run: echo "Debug PR Info Step Running" - name: Send Reminder Comment if: ${{ steps.check_reminder.outputs.sendReminder == true }} From e2321383e4737f9f0be8afc8e0bc382f49c30d24 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 17:29:26 -0700 Subject: [PATCH 35/46] Updating workflow to send reminder and removing time dependency. --- .github/workflows/heretto-reminder.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index 58d2564c8..0dcb4a220 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -51,10 +51,10 @@ jobs: } - name: Debug Output - run: echo "Debug Output Step Running" + run: echo "check_reminder.outputs: ${{ toJSON(steps.check_reminder.outputs) }}" - name: Debug PR Info - run: echo "Debug PR Info Step Running" + run: echo "pr_info.outputs: ${{ toJSON(steps.pr_info.outputs) }}" - name: Send Reminder Comment if: ${{ steps.check_reminder.outputs.sendReminder == true }} From 2ed9801486d27593a7aa30749e338f34d60c4d47 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 17:31:40 -0700 Subject: [PATCH 36/46] Updating workflow to send reminder and removing time dependency. --- .github/workflows/heretto-reminder.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index 0dcb4a220..5ec1dfa4c 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -44,11 +44,13 @@ jobs: const reminderLabel = 'reminder sent'; if (!labels || labels.length === 0) { - return { sendReminder: true }; // send reminder if the time threshold is passed, even without labels. + sendReminder = true; // send reminder if the time threshold is passed, even without labels. } if (labels.includes(reminderLabel)) { - return { sendReminder: false }; + sendReminder = false; } + console.log("sendReminder value:", sendReminder); // Added debug log + return { sendReminder: sendReminder }; - name: Debug Output run: echo "check_reminder.outputs: ${{ toJSON(steps.check_reminder.outputs) }}" From a4a357bb64e5fa23ee2e68a5c644273596bd2a75 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 17:32:56 -0700 Subject: [PATCH 37/46] Updating workflow to send reminder and removing time dependency. --- .github/workflows/heretto-reminder.yml | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index 5ec1dfa4c..c9032e528 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -32,7 +32,7 @@ jobs: const author = pr.data.user.login; const labels = pr.data.labels.map(label => label.name); - + console.log("Labels from PR Info:", labels); // Added debug log return { author, number, labels }; - name: Check if Reminder Needed @@ -52,12 +52,6 @@ jobs: console.log("sendReminder value:", sendReminder); // Added debug log return { sendReminder: sendReminder }; - - name: Debug Output - run: echo "check_reminder.outputs: ${{ toJSON(steps.check_reminder.outputs) }}" - - - name: Debug PR Info - run: echo "pr_info.outputs: ${{ toJSON(steps.pr_info.outputs) }}" - - name: Send Reminder Comment if: ${{ steps.check_reminder.outputs.sendReminder == true }} uses: actions/github-script@v7 From df8f72cd2fea9659c0a5a64a1f2334c9e529271d Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 17:36:50 -0700 Subject: [PATCH 38/46] Updating workflow to send reminder and removing time dependency. --- .github/workflows/heretto-reminder.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index c9032e528..f79e6979e 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -42,12 +42,12 @@ jobs: script: | const { labels } = ${{ steps.pr_info.outputs }}; const reminderLabel = 'reminder sent'; - - if (!labels || labels.length === 0) { - sendReminder = true; // send reminder if the time threshold is passed, even without labels. - } - if (labels.includes(reminderLabel)) { - sendReminder = false; + if (!Array.isArray(labels) || labels.length === 0) { + return { sendReminder: true }; + } else if (labels.includes(reminderLabel)) { + return { sendReminder: false }; + } else { + return { sendReminder: true }; } console.log("sendReminder value:", sendReminder); // Added debug log return { sendReminder: sendReminder }; From 3f8caccbff5cedf13844bd1d6774c10080190897 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 17:46:46 -0700 Subject: [PATCH 39/46] Updating workflow to send reminder and removing time dependency. --- .github/workflows/heretto-reminder.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index f79e6979e..aedc41b0b 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -53,7 +53,7 @@ jobs: return { sendReminder: sendReminder }; - name: Send Reminder Comment - if: ${{ steps.check_reminder.outputs.sendReminder == true }} + if: ${{ (steps.check_reminder.outputs.sendReminder == true) && (runner.log('sendReminder: ' + steps.check_reminder.outputs.sendReminder)) }} uses: actions/github-script@v7 with: script: | @@ -67,7 +67,7 @@ jobs: }); - name: Add Reminder Label - if: ${{ steps.check_reminder.outputs.sendReminder == true }} + if: ${{ (steps.check_reminder.outputs.sendReminder == true) && (runner.log('sendReminder: ' + steps.check_reminder.outputs.sendReminder)) }} uses: actions/github-script@v7 with: script: | From f65a8d8b5cb6165211992aa2f23e574c55fef511 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 17:48:40 -0700 Subject: [PATCH 40/46] Updating workflow to send reminder and removing time dependency. --- .github/workflows/heretto-reminder.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index aedc41b0b..9da367930 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -53,7 +53,7 @@ jobs: return { sendReminder: sendReminder }; - name: Send Reminder Comment - if: ${{ (steps.check_reminder.outputs.sendReminder == true) && (runner.log('sendReminder: ' + steps.check_reminder.outputs.sendReminder)) }} + if: ${{ (steps.check_reminder.outputs.sendReminder == true) && (toJSON(steps.check_reminder.outputs)) }} uses: actions/github-script@v7 with: script: | @@ -67,7 +67,7 @@ jobs: }); - name: Add Reminder Label - if: ${{ (steps.check_reminder.outputs.sendReminder == true) && (runner.log('sendReminder: ' + steps.check_reminder.outputs.sendReminder)) }} + if: ${{ (steps.check_reminder.outputs.sendReminder == true) && (toJSON(steps.check_reminder.outputs)) }} uses: actions/github-script@v7 with: script: | From 3b8e3f46f54d18fe3fce9af0a7aa739dfc40b17b Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 17:53:46 -0700 Subject: [PATCH 41/46] Updating workflow to send reminder and removing time dependency. --- .github/workflows/heretto-reminder.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index 9da367930..fa1a6b9bb 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -41,7 +41,8 @@ jobs: with: script: | const { labels } = ${{ steps.pr_info.outputs }}; - const reminderLabel = 'reminder sent'; + const reminderLabel = 'reminder sent'; + let sendReminder = false; if (!Array.isArray(labels) || labels.length === 0) { return { sendReminder: true }; } else if (labels.includes(reminderLabel)) { From b952c00e8fb15afce3cadef37afc21fc9f0a77d0 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 21:00:20 -0700 Subject: [PATCH 42/46] Updating workflow to send reminder and removing time dependency. --- .github/workflows/heretto-reminder.yml | 71 ++++---------------------- 1 file changed, 9 insertions(+), 62 deletions(-) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index fa1a6b9bb..10f76fa5f 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -2,7 +2,7 @@ name: Pull Request Reminder on: pull_request: - types: [opened, synchronize, reopened] + types: [opened, synchronize] jobs: reminder: @@ -15,67 +15,14 @@ jobs: checks: write pull-requests: write steps: - - name: Checkout code - uses: actions/checkout@v4 - - - name: Get Pull Request Info - id: pr_info - uses: actions/github-script@v7 - with: - 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; - const labels = pr.data.labels.map(label => label.name); - console.log("Labels from PR Info:", labels); // Added debug log - return { author, number, labels }; - - - name: Check if Reminder Needed - id: check_reminder - uses: actions/github-script@v7 + - name: Add PR Comment + uses: actions/github-script@v6 with: + github-token: ${{ secrets.MY_TOKEN }} script: | - const { labels } = ${{ steps.pr_info.outputs }}; - const reminderLabel = 'reminder sent'; - let sendReminder = false; - if (!Array.isArray(labels) || labels.length === 0) { - return { sendReminder: true }; - } else if (labels.includes(reminderLabel)) { - return { sendReminder: false }; - } else { - return { sendReminder: true }; - } - console.log("sendReminder value:", sendReminder); // Added debug log - return { sendReminder: sendReminder }; - - - name: Send Reminder Comment - if: ${{ (steps.check_reminder.outputs.sendReminder == true) && (toJSON(steps.check_reminder.outputs)) }} - uses: actions/github-script@v7 - with: - script: | - const { owner, repo, number, author } = ${{ steps.pr_info.outputs }}; - const message = `@${author}, please make sure that you update the files in Heretto and post the Heretto share link in this PR.`; await github.rest.issues.createComment({ - owner, - repo, - issue_number: number, - body: message, - }); - - - name: Add Reminder Label - if: ${{ (steps.check_reminder.outputs.sendReminder == true) && (toJSON(steps.check_reminder.outputs)) }} - uses: actions/github-script@v7 - with: - script: | - const { owner, repo, number } = ${{ steps.pr_info.outputs }}; - await github.rest.issues.addLabels({ - owner, - repo, - issue_number: number, - labels: ['reminder sent'], - }); + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: context.payload.pull_request.number, + body: "`@${owner}, please make sure that you update the files in Heretto and post the Heretto share link in this PR.`" + }) From 8069ae74fc26b7c3da1ec1bdc451eae321f751a0 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 21:03:31 -0700 Subject: [PATCH 43/46] Updating workflow with Paul's suggestion and added owner's name and left my original message. --- .github/workflows/heretto-reminder.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index 10f76fa5f..b6ae8363f 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -24,5 +24,5 @@ jobs: owner: context.repo.owner, repo: context.repo.repo, issue_number: context.payload.pull_request.number, - body: "`@${owner}, please make sure that you update the files in Heretto and post the Heretto share link in this PR.`" + body: `@${owner}, please make sure that you update the files in Heretto and post the Heretto share link in this PR.` }) From eba7503e26d4a81631a0542ca780ab5748623349 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 21:05:45 -0700 Subject: [PATCH 44/46] Fixed the syntax to interpolate the variable in the message string. --- .github/workflows/heretto-reminder.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index b6ae8363f..7efb5a882 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -24,5 +24,5 @@ jobs: owner: context.repo.owner, repo: context.repo.repo, issue_number: context.payload.pull_request.number, - body: `@${owner}, please make sure that you update the files in Heretto and post the Heretto share link in this PR.` + body: `@${context.repo.owner}, please make sure that you update the files in Heretto and post the Heretto share link in this PR.` }) From 93594631615a1fc6552cd52c3c6cdd2cdc13ff6e Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 21:08:27 -0700 Subject: [PATCH 45/46] Trying to use the author's name and not the repo owner's. --- .github/workflows/heretto-reminder.yml | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index 7efb5a882..87169df5f 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -1,9 +1,3 @@ -name: Pull Request Reminder - -on: - pull_request: - types: [opened, synchronize] - jobs: reminder: runs-on: ubuntu-latest @@ -20,9 +14,18 @@ jobs: 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: context.repo.owner, - repo: context.repo.repo, - issue_number: context.payload.pull_request.number, - body: `@${context.repo.owner}, please make sure that you update the files in Heretto and post the Heretto share link in this PR.` + 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.` }) From 82abdd669d074b593ed038df6403c6e119241478 Mon Sep 17 00:00:00 2001 From: Joe Catera Date: Thu, 20 Mar 2025 21:13:49 -0700 Subject: [PATCH 46/46] Adding the trigger. --- .github/workflows/heretto-reminder.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.github/workflows/heretto-reminder.yml b/.github/workflows/heretto-reminder.yml index 87169df5f..9b201e80f 100644 --- a/.github/workflows/heretto-reminder.yml +++ b/.github/workflows/heretto-reminder.yml @@ -1,3 +1,9 @@ +name: Heretto Update Reminder + +on: + pull_request: + types: [opened, synchronize] + jobs: reminder: runs-on: ubuntu-latest @@ -8,6 +14,8 @@ jobs: issues: write checks: write pull-requests: write + + steps: - name: Add PR Comment uses: actions/github-script@v6