diff --git a/admin/authentication/authentication-tokens/org-tokens.rst b/admin/authentication/authentication-tokens/org-tokens.rst index 54c253971..d0c9e4e34 100644 --- a/admin/authentication/authentication-tokens/org-tokens.rst +++ b/admin/authentication/authentication-tokens/org-tokens.rst @@ -22,9 +22,9 @@ Power users who have access to tokens in an organization see a banner, but only Token expiry ================ -Access tokens expire one year after the creation date. For access tokens created prior to February 28, 2022, the expiration date remains 5 years from the creation date. You can rotate a token before it expires using the Splunk Observability Cloud API. For details, see :ref:`access-token-rotate`. +You can view the expiration dates of your tokens through the access token page. To view this page, select :guilabel:`Settings` and select :guilabel:`Access tokens`. By default, access tokens expire 18 years after the creation date. You can rotate a token before it expires. For details, see :ref:`access-token-rotate`. -Every organization admin will receive an email 30 days before a token in their org expires. The email includes a link to Splunk Observability Cloud that displays a list of expiring tokens. You cannot customize the token expiration email. +By default, every organization admin receives an email 30 days before a token in their org expires. The email includes a link to Splunk Observability Cloud that displays a list of expiring tokens. To change the expiration reminder date, see :ref:`create-access-token-date`. The default access token =========================== @@ -36,48 +36,60 @@ By default, every organization has one organization-level access token. If you d Manage access tokens ======================= -To manage your access (org) tokens: +To manage your access (org) tokens, follow these steps: #. Open the :guilabel:`Settings` menu. -#. Select :menuselection:`Access Tokens`. -#. To find the access token in a large list, start entering its name in the search box. Splunk Observability Cloud returns matching results. -#. To look at the details for an access token, select the expand icon next to the token name. +#. Select :guilabel:`Access Tokens`. +#. Find your token by using the :guilabel:`Status` and :guilabel:`Scope` filters or enter the token name in the search bar. +#. Select the expand icon next to the token name. This displays details about the token. For information about the access token permissions allowed by the :guilabel:`Authorization Scopes` field value, see the permissions step in :ref:`create-access-token`. -#. If you're an organization administrator, the actions menu (|more| icon) appears to the right side of the token listing. You can select token actions from this menu. +#. (Optional) If you're an organization administrator, the actions menu (|verticaldots|) appears to the right side of the token listing. You can select token actions from this menu. -#. To change the token visibility, follow these steps: +#. See :ref:`change-token-permissions` and :ref:`change-token-expiration` to modify token permissions and token expiration settings, respectively. - #. To display the available permissions, select the right arrow in the :guilabel:`Access Token Permissions` box. The following - permission options appear: +.. _change-token-permissions: + +Change token permissions +------------------------------------- + +If you're an organization administrator, you can change token permissions for other users and teams. + +To change the token permissions, follow these steps: + +#. Select the :guilabel:`Access Token Permissions` box. Choose from the following permission options: * :menuselection:`Only Admins can Read`: Only admin users can view or read the new token. The token isn't visible to other users. * :menuselection:`Admins and Select Users or Teams can Read`: Admin users and users or teams you select can view or read the new token. The token isn't visible to anyone else. * :menuselection:`Everyone can Read`: Every user and team in the organization can view and read the token. - #. To add permissions, select the left arrow below :guilabel:`Access Token Permissions`. - #. If you selected :guilabel:`Admins and Select Users or Teams can Read`, select the users or teams to whom you want to give access: - #. Select :guilabel:`Add Team or User`. Splunk Observability Cloud displays a list of teams and users in your organization. - #. To find the team or username in a large list, start entering the name in the search box. Splunk Observability Cloud returns matching results. - Select the user or team. - #. If you need to add more teams or users, select :guilabel:`Add Team or User` again. +#. To add permissions, select the left arrow below :guilabel:`Access Token Permissions`. +#. If you selected :guilabel:`Admins and Select Users or Teams can Read`, select the users or teams to whom you want to give access. +#. To remove a team or user, select the delete icon (:strong:`X`) next to the team or username. +#. To update the token, select :guilabel:`Update`. - .. note:: +.. _change-token-expiration: - You might see the following message in the middle of the dialog: +Change token expiration date and expiration alerts +------------------------------------------------------- - You are currently giving permissions to a team with Restrict Access deactivated. This means any user can join this team and is able to access this Access Token. +To change the token expiration date and expiration alerts, follow these steps: - This message means that all users are able to join the team and then view or read the access token. +#. In the token actions menu (|verticaldots|), select :guilabel:`Expiration date`. +#. In the :guilabel:`Expiration date` box, select a new expiration date for the token. +#. To change the visibility of the expiration alert, select from the following options: - #. To remove a team or user, select the delete icon (:strong:`X`) next to the team or username. - #. To update the token, select :guilabel:`Update`. + * :menuselection:`Admins and users or teams with token permissions can receive alert`: Admins and anyone with token permissions receive an alert when the token is close to expiring. + * :menuselection:`Only admins can receive alert`: Only admins receive an alert when the token is close to expiring. +#. Configure the type of alert that your recipients receive. +#. Change the time at which recipients receive an alert. For example, a value of ``7d`` means recipients receive an alert 7 days before the token expires. +#. Select :guilabel:`Update`. -View and copy access tokens -============================== +View and copy access token secrets +==================================== -To view the value of an access token, select the token name and then select :guilabel:`Show Token`. +To view the token secret, select the token name and then select :guilabel:`Show Token`. To copy the token value, select :guilabel:`Copy`. You don't need to be an administrator to view or copy an access token. @@ -87,53 +99,77 @@ To copy the token value, select :guilabel:`Copy`. You don't need to be an admini Create an access token ========================== +To get started with creating an access token, follow these steps: + +#. Open the Splunk Observability Cloud main menu. +#. Select :menuselection:`Settings` and select :menuselection:`Access Tokens`. +#. Select :guilabel:`New Token`. + +Next, complete each step in the access token creation guided setup: + +* :ref:`create-access-token-name`. +* :ref:`create-access-token-permissions`. +* :ref:`create-access-token-date`. + .. note:: - To do the following tasks, you must be an organization administrator. + You must be an organization administrator to create access tokens. -To create an access token: +.. _create-access-token-name: + +Name the token and select the authorization scope +------------------------------------------------------------------------- + +To get started with creating the token, enter a name and scope for the token. Complete the following steps: -#. Open the Splunk Observability Cloud main menu. -#. Select :menuselection:`Settings` and select :menuselection:`Access Tokens`. -#. Select :guilabel:`New Token`. If your organization has a long list of access tokens, you might need to scroll down to the bottom of the list to access this button. #. Enter a unique token name. If you enter a token name that is already in use, even if the token is inactive, Splunk Observability Cloud doesn't accept the name. -#. Select an authorization scope for the token from 1 of the following values: - - .. note:: Assign only 1 authorization scope to each token. Applying both the :strong:`API` and :strong:`Ingest` authorization scopes to the same token might raise a security concern. +#. Select an authorization scope. See the following table for information about the authorization scopes: + + .. list-table:: + :header-rows: 1 + + * - Authorization scope + - Description + * - RUM token + - Use this scope to authenticate with RUM ingest endpoints. These endpoints use the following base URL: ``https://rum-ingest..signalfx.com/v1/rum``. + * - Ingest token + - Use this scope to authenticate with data ingestion endpoints and when using the Splunk Distribution of OpenTelemetry Collector. These endpoints use the following base URLs: + + * POST :code:`https://ingest..signalfx.com/v2/datapoint` + * POST :code:`https://ingest..signalfx.com/v2/datapoint/otlp` + * POST :code:`https://ingest..signalfx.com/v2/event` + * POST :code:`https://ingest..signalfx.com/v1/trace` - - :strong:`RUM Token`: Select this authorization scope to use the token to authenticate with RUM ingest endpoints. These endpoints use the following base URL: :code:`https://rum-ingest..signalfx.com/v1/rum`. - - .. caution:: - RUM displays the RUM token in URIs that are visible in a browser. To preserve security, you can't assign the :strong:`Ingest` or :strong:`API` authorization scope to a RUM token. + For information about these endpoints, see :new-page:`Sending data points `. + * - API token + - Use this scope to authenticate with Splunk Observability Cloud API endpoints. These endpoints use the following base URLs: - - :strong:`Ingest Token`: Select this authorization scope to use the token to authenticate with data ingestion endpoints. These endpoints use the following base URLs: + * :code:`https://api..signalfx.com` + * :code:`wss://stream..signalfx.com` - - POST :code:`https://ingest..signalfx.com/v2/datapoint` - - POST :code:`https://ingest..signalfx.com/v2/datapoint/otlp` - - POST :code:`https://ingest..signalfx.com/v2/event` - - POST :code:`https://ingest..signalfx.com/v1/trace` + When you create an access token with API authentication scope, select at least one Splunk Observability Cloud role to associate with the token. You can select from ``power``, ``usage``, or ``read_only``. To learn more about Splunk Observability Cloud roles, see :ref:`roles-and-capabilities`. - For information about these endpoints, see :new-page:`Sending data points `. + For information about these endpoints, see :new-page:`Summary of Splunk Observability Cloud API Endpoints `. - .. note:: Use the ingest autorization scope for the Splunk Distribution of the OpenTelemetry Collector. See :ref:`otel-intro`. - - :strong:`API Token`: Select this authorization scope to use the token to authenticate with Splunk Observability Cloud endpoints. Example use cases are Terraform, programmatic usage of the API for business objects, and so on. These endpoints use the following base URLs: - - - :code:`https://api..signalfx.com` - - :code:`wss://stream..signalfx.com` +#. (Optional) Add a description for the token. +#. Select :guilabel:`Next` to continue to the next step. - When you create an access token with API authentication scope, select at least one Splunk Observability Cloud role to associate with the token. You can select from ``power``, ``usage``, or ``read_only``. To learn more about Splunk Observability Cloud roles, see :ref:`roles-and-capabilities`. +.. _create-access-token-permissions: - For information about these endpoints, see :new-page:`Summary of Splunk Observability Cloud API Endpoints `. +Determine who can view and use the token +-------------------------------------------------------- -#. Edit the visibility permissions: +Next, configure token permissions so your organization's users and teams can use the token. Complete the following steps: - #. To display the available permissions, select the right arrow in the :guilabel:`Access Token Permissions` box. The following - permission options appear: +#. Edit the visibility permissions. To display the available permissions, select the :guilabel:`Access Token Permissions` box. The following + permission options appear: * :menuselection:`Only Admins can Read`: Only admin users can view or read the new token. The token isn't visible to other users. * :menuselection:`Admins and Select Users or Teams can Read`: Admin users and users or teams you select can view or read the new token. The token isn't visible to anyone else. * :menuselection:`Everyone can Read`: Every user and team in the organization can view and read the token. - #. To add permissions, select the arrow below :guilabel:`Access Token Permissions`. + + To add permissions, select the arrow below :guilabel:`Access Token Permissions`. + #. If you selected :guilabel:`Admins and Select Users or Teams can Read`, select the users or teams to whom you want to give access: #. Select :guilabel:`Add Team or User`. Splunk Observability Cloud displays a list of teams and users in your organization. @@ -150,21 +186,54 @@ To create an access token: This message means that all users are able to join the team and then view or read the access token. #. To remove a team or user, select the delete icon (:strong:`X`) next to the team or username. -#. To create the new token, select :guilabel:`Create`. +#. Select :guilabel:`Next` to continue to the final step. + +.. _create-access-token-date: + +Configure an expiration date +----------------------------------------------- + +To finish creating the token, select an expiration date for the token. + +#. In the :guilabel:`Expiration date` box, select a date at which the token will expire. The date can't be over 5 years from the token creation date. +#. In the :guilabel:`Expiration alert` box, select from one of the following options: + + * :menuselection:`Only admins can receive alert`: Only admins receive an alert when the token is close to its expiration date. + * :menuselection:`Admins and users or teams with token permissions can receive alert`: Admins and any users with token permissions receive an alert when the token is close to its expiration date. + +#. (Optional) Set a time for when Splunk Observability Cloud sends an expiration alert. For example, a value of 7 days means Splunk Observability Cloud will send an alert 7 days before the token expires. +#. Select :guilabel:`Create` to finish creating the new token. .. _access-token-rotate: Rotate an access token ============================== -You can rotate an access token using the Splunk Observability Cloud API. This creates a new secret for the token and deactivates the token's previous secret. Optionally, you can provide a grace period before the previous token secret expires. +You can rotate an access token using the access token menu or the Splunk Observability Cloud API. This creates a new secret for the token and deactivates the token's previous secret. Optionally, you can provide a grace period before the previous token secret expires. You can't rotate tokens after they expire. If you don't rotate a token before it expires, you must create a new token to replace it. .. note:: You must be a Splunk Observability Cloud admin to rotate a token. -To rotate an access token, use the ``POST /token/{name}/rotate`` endpoint in the Splunk Observability Cloud API. An API call to rotate a token looks like this: +Rotate access tokens using the token menu +------------------------------------------------------------------- + +To rotate a token using the access token menu, follow these steps: + +#. In Splunk Observability Cloud, select :guilabel:`Settings`. +#. Select :guilabel:`Access tokens`. +#. In the access tokens menu, select the token you want to rotate. +#. Select :guilabel:`Rotate token`. +#. Enter an expiration date for the new token secret, and optionally, a grace period for the current token secret. +#. Select :guilabel:`Rotate`. + +After you're finished rotating the token, update any of your OpenTelemetry Collector configurations with the new token secret before the grace period ends. + +Rotate access tokens using the Splunk Observability Cloud API +------------------------------------------------------------------- + +To rotate an access token with the API, use the ``POST /token/{name}/rotate`` endpoint in the Splunk Observability Cloud API. An API call to rotate a token looks like this: .. code-block:: bash @@ -197,11 +266,11 @@ Rename an access token To rename a token: -#. Select :menuselection:`Edit Token` from the token's actions menu (|more|). +#. Select :menuselection:`Edit Token` from the token's actions menu (|verticaldots|). #. Enter a new name for the token. #. Select :guilabel:`OK`. -Renaming a token does not affect the value of the token. +Renaming a token does not affect the token's secret. .. note:: @@ -214,11 +283,19 @@ Deactivate or activate an access token You can't delete tokens. You can only deactivate them. -To deactivate a token, select :menuselection:`Disable` from the token's actions menu (|more| icon). -The line that displays the token has a shaded background, which indicates that the -token is inactive. The UI displays deactivated tokens at the end of the tokens list, -after the activated tokens. +To deactivate a token, select :menuselection:`Deactivate` from the token's actions menu (|verticaldots|). + +To activate a deactivated token, select :menuselection:`Activate` from the deactivated token's actions menu (|verticaldots|). + +You can search for activated or deactivated tokens using the :guilabel:`Status` filter in the access tokens page. + +Manage token limits +========================================= + +To change limits for your access tokens, including host and container limits, follow these steps: + +#. Select the token that you want to edit. This opens the token detail page. +#. Select the token actions menu (|verticaldots|), and select :guilabel:`Manage limits`. +#. In the :guilabel:`Manage limits` menu, add the new token limits. -To activate a deactivated token, select :menuselection:`Enable` from the deactivated -token's actions menu (|more| icon). The line that displays the token has a light background, -which indicates that the token is inactive. +To learn more about token limits, see :ref:`admin-manage-usage`. \ No newline at end of file diff --git a/admin/notif-services/servicenow.rst b/admin/notif-services/servicenow.rst index 8b29d70cd..29d2116da 100644 --- a/admin/notif-services/servicenow.rst +++ b/admin/notif-services/servicenow.rst @@ -44,7 +44,7 @@ Before you set up the integration, choose a ServiceNow issue type from the follo - ``user_admin``, ``itil`` - ``/api/now/v2/table/incident`` * - Event - - None + - ``evt_mgmt_integration``, only if :guilabel:`Requires ACL authorization` is selected for :strong:`Inbound Event Default Bulk Endpoint` in :strong:`Scripted Rest APIs`. To learn more, see the :new-page:`ServiceNow support article on events `. - ``/api/global/em/jsonv2`` Make note of the role and receiving endpoint that corresponds to your issue type before proceeding with :ref:`servicenow2`. @@ -112,9 +112,9 @@ To create a ServiceNow integration in Splunk Observability Cloud: To troubleshoot potential blind server-side request forgeries (SSRF), Splunk Observability Cloud has included ``\*.service-now.com`` on an allow list. As a result, if you enter a domain name that is rejected by Splunk Observability Cloud, contact :ref:`support` to update the allow list of domain names. -#. Select :strong:`Incident`, :strong:`Problem`, or :strong:`Event` to indicate the issue type you want the integration to create in ServiceNow. If necessary, you can create a second integration using the other issue type. This lets you create an incident issue for one detector rule and a problem issue for another detector rule. The following table shows the roles required to create each issue type: +#. Select :strong:`Incident`, :strong:`Problem`, or :strong:`Event` to indicate the issue type you want the integration to create in ServiceNow. If necessary, you can create a second integration using another issue type. This lets you create an incident issue for one detector rule and a problem issue for another detector rule. -#. :strong:`Save`. +#. Select :strong:`Save`. #. If Splunk Observability Cloud can validate the ServiceNow username, password, and instance name combination, a :strong:`Validated!` success message displays. If an error displays instead, make sure that the values you entered match the values in ServiceNow. diff --git a/index.rst b/index.rst index 95e9fc165..972aebdea 100644 --- a/index.rst +++ b/index.rst @@ -843,7 +843,18 @@ To keep up to date with changes in the products, see the Splunk Observability Cl .. toctree:: :maxdepth: 3 - Configure your tests TOGGLE + Advanced test configurations TOGGLE + +.. toctree:: + :maxdepth: 3 + + Troubleshoot tests TOGGLE + + +.. toctree:: + :maxdepth: 3 + + Troubleshoot tests .. toctree:: :caption: Splunk On-Call diff --git a/release-notes/2024-10-01-rn.rst b/release-notes/2024-10-01-rn.rst index d502ccdf2..a4ff1c1c5 100644 --- a/release-notes/2024-10-01-rn.rst +++ b/release-notes/2024-10-01-rn.rst @@ -66,4 +66,19 @@ Service level objective (SLO) * - New feature or enhancement - Description * - SignalFlow editor for custom metrics SLO - - You can use SignalFlow to define metrics and filters when creating a custom metric SLO. For more information, see :ref:`create-slo`. The feature released on October 2, 2024. \ No newline at end of file + - You can use SignalFlow to define metrics and filters when creating a custom metric SLO. For more information, see :ref:`create-slo`. The feature released on October 2, 2024. + +.. _auth-2024-10-01: + +Authentication +============== + +.. list-table:: + :header-rows: 1 + :widths: 1 2 + :width: 100% + + * - New feature or enhancement + - Description + * - Token management improvements + - Admin and power users have a new token management interface that includes long-lived tokens, improved token visibility and rotation, and a design that is aligned with Splunk Cloud Platform. For more information, see :ref:`admin-org-tokens`. The feature released on October 23, 2024. \ No newline at end of file diff --git a/release-notes/release-notes-overview.rst b/release-notes/release-notes-overview.rst index 954d85540..c978e825b 100644 --- a/release-notes/release-notes-overview.rst +++ b/release-notes/release-notes-overview.rst @@ -32,6 +32,7 @@ Each release date includes new features and enhancements for SaaS and versioned * :ref:`Data ingest ` * :ref:`Data management ` * :ref:`Service level objective ` + * :ref:`Token management improvements ` .. _changelogs: diff --git a/synthetics/api-test/api-test.rst b/synthetics/api-test/api-test.rst index 274bb8507..97a7c0f12 100644 --- a/synthetics/api-test/api-test.rst +++ b/synthetics/api-test/api-test.rst @@ -1,7 +1,7 @@ .. _api-test: ************************************ -Use an API Test to test an endpoint +API Tests for endpoint ************************************ .. meta:: diff --git a/synthetics/browser-test/browser-test-results.rst b/synthetics/browser-test/browser-test-results.rst index 8988cfd59..64492fb8f 100644 --- a/synthetics/browser-test/browser-test-results.rst +++ b/synthetics/browser-test/browser-test-results.rst @@ -1,7 +1,7 @@ .. _browser-test-results: *********************************************** -Interpret Browser Test results +Interpret Browser test results *********************************************** .. meta:: diff --git a/synthetics/browser-test/browser-test.rst b/synthetics/browser-test/browser-test.rst index a349f953b..51b2ec22a 100644 --- a/synthetics/browser-test/browser-test.rst +++ b/synthetics/browser-test/browser-test.rst @@ -1,7 +1,7 @@ .. _browser-test: **************************************** -Use a Browser test to test a webpage +Browser tests for webpages **************************************** .. meta:: @@ -21,7 +21,7 @@ You can configure tests on a schedule so you're continually monitoring your site .. raw:: html -

What happens during a Browser test?

+

What does a Browser test monitor?

During a Browser test, Splunk Synthetic Monitoring continuously collects performance data including metrics, network data, and custom user timings. All requests and responses that occur in the test are captured in a HAR file, which is represented visually in a waterfall chart that illustrates the latency of specific resources on the page. See :ref:`waterfall-chart` to learn more about the waterfall chart, and see :ref:`browser-metrics` to learn about the metrics in a Browser test. diff --git a/synthetics/set-up-synthetics/set-up-synthetics.rst b/synthetics/set-up-synthetics/set-up-synthetics.rst index 5ba829a2d..5f5521428 100644 --- a/synthetics/set-up-synthetics/set-up-synthetics.rst +++ b/synthetics/set-up-synthetics/set-up-synthetics.rst @@ -11,6 +11,30 @@ Set up Splunk Synthetic Monitoring Monitor the performance of your web pages and applications by running synthetic Browser, Uptime, and API tests. These tests let you proactively alert the relevant teams when a site or user flow they manage becomes unavailable, as well as report on the performance of a site or user flow over time. Splunk Synthetic Monitoring does not require extensive installation and setup: you can get started by creating your first test directly in the Splunk Synthetic Monitoring user interface. +.. _synth-configure-app: + +Get your site ready to run synthetic tests +============================================ + +.. meta:: + :description: Information about the settings you need to configure for your application or site in order to receive traffic from Splunk Synthetic Monitoring. + +There are a couple of settings you might need to add to your application or webpage to receive traffic from Splunk Synthetic Monitoring. + + +Allow Splunk Synthetic Monitoring IP addresses +------------------------------------------------- + +Splunk Synthetic Monitoring runs synthetic tests from a set of dedicated IP addresses. To ensure your internal network or web application firewall (WAF) does not block this traffic, place these IP addresses on your browser or site's allow list. + +See :ref:`public-locations` for the list of Splunk Synthetic Monitoring IP addresses, and then refer to your internal network's documentation for instructions on how to add them to your allow list. + +Exclude Splunk Synthetic Monitoring from analytics +---------------------------------------------------- +If you use a web analytics tool to monitor traffic on your website or application, you might want to exclude Splunk Synthetic Monitoring IP addresses from being counted as traffic. + +To do so, filter Splunk Synthetic Monitoring IP addresses in the settings of your web analytics tool. See :ref:`public-locations` for the list of IP addresses, and then refers to your analytics tool's documentation for instructions on how to filter them. + Choose a test ============================================================ @@ -116,12 +140,6 @@ For more examples on Java instrumentation, see :ref:`server-trace-information-ja Integrate with Splunk RUM so that you can automatically measure Web Vital metrics against your run results. Web vitals capture key metrics that affect user experience and assess the overall performance of your site. For more, see :ref:`rum-synth`. -(Optional) Configure your application ------------------------------------------------------------------------- - - -If you use Splunk Synthetic Monitoring to monitor an application or website with allow/block lists or a web analytics tool, you might want to adjust the settings to accommodate traffic from Splunk Synthetic Monitoring. See :ref:`synth-configure-app` for detailed instructions. - Continue learning ============================== diff --git a/synthetics/syn-troubleshoot/syn-missing-alerts.rst b/synthetics/syn-troubleshoot/syn-missing-alerts.rst new file mode 100644 index 000000000..0dbf7eee3 --- /dev/null +++ b/synthetics/syn-troubleshoot/syn-missing-alerts.rst @@ -0,0 +1,10 @@ +.. _syn-missing-alerts: + +********************************************************* +Troubleshoot missing alerts +********************************************************* + +.. meta:: + :description: Troubleshoot broken tests + +Troubleshoot missing alerts in Synthetic tests. diff --git a/synthetics/syn-troubleshoot/syn-troubleshoot.rst b/synthetics/syn-troubleshoot/syn-troubleshoot.rst new file mode 100644 index 000000000..e78aef97e --- /dev/null +++ b/synthetics/syn-troubleshoot/syn-troubleshoot.rst @@ -0,0 +1,38 @@ +.. _syn-troubleshoot: + +**************************************** +Troubleshoot broken tests +**************************************** + +.. meta:: + :description: Troubleshoot broken tests + + + +There are a number of reasons why your tests might fail like issues with test validation or application unresponsiveness. For example, + +* API endpoint was unreachable +* URL was unreachable +* UI element wasn't found +* Default wait time of 10 seconds is too short for step assertions to complete. A test might fail because it takes longer than 10 seconds for a website to load. + +Troubleshoot test validation +=============================== + +Follow these guidelines to troubleshoot a broken test. + +#. (Optional) Make a copy of the test so that you can check various solutions before fixing the original test. +#. Open the test page and see when the test started to fail. Consider the following questions: + + * When did the check fail? Is there a pattern among other failed runs? + * Does the check fail consistently on the same step, or intermittently? + * Is this the first time the check has failed on this step? Did you make a recent change to the test? + * Was the failure tied to a specific location or across all locations? + +#. Open the run results view of a failed test, find the step that is failing and go to the link. +#. Open inspect element. +#. Duplicate the step and repeat the steps in your test until you find the broken step. +#. Verify that there is one instance only of the selector you want to use in your test. If the selector appears more than once your test might break again in the future. Unique selectors provide optimal test performance. +#. Update your tests with your findings. + + diff --git a/synthetics/test-config/synth-configure-app.rst b/synthetics/test-config/synth-configure-app.rst deleted file mode 100644 index 861645624..000000000 --- a/synthetics/test-config/synth-configure-app.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. _synth-configure-app: - -******************************************************************************* -Configure your site to accommodate synthetic tests -******************************************************************************* - -.. meta:: - :description: Information about the settings you need to configure for your application or site in order to receive traffic from Splunk Synthetic Monitoring. - -There are a couple of configurations you might need to set up for your application or webpage to receive traffic from Splunk Synthetic Monitoring. - -Allow Splunk Synthetic Monitoring IP addresses -================================================ - -Splunk Synthetic Monitoring runs synthetic tests from a set of dedicated IP addresses. To ensure your internal network or web application firewall (WAF) does not block this traffic, place these IP addresses on your browser or site's allow list. - -See :ref:`public-locations` for the list of Splunk Synthetic Monitoring IP addresses, and then refer to your internal network's documentation for instructions on how to add them to your allow list. - -Exclude Splunk Synthetic Monitoring from analytics -=================================================== -If you use a web analytics tool to monitor traffic on your website or application, you might want to exclude Splunk Synthetic Monitoring IP addresses from being counted as traffic. - -To do so, filter Splunk Synthetic Monitoring IP addresses in the settings of your web analytics tool. See :ref:`public-locations` for the list of IP addresses, and then refer to your analytics tool's documentation for instructions on how to filter them. - diff --git a/synthetics/test-config/test-config.rst b/synthetics/test-config/test-config.rst index 8b0958705..e4a8e0089 100644 --- a/synthetics/test-config/test-config.rst +++ b/synthetics/test-config/test-config.rst @@ -1,7 +1,7 @@ .. _test-config: *************************************************** -Manage synthetic tests +Advanced test configurations *************************************************** .. meta:: @@ -9,7 +9,6 @@ Manage synthetic tests .. toctree:: - synth-configure-app synth-alerts built-in-variables global-variables @@ -110,24 +109,13 @@ Choosing informative names for your tests and alerts helps organize content. Her :alt: This image shows two Browser tests with the prefix [ButtercupGames]. -======================================================================================== -Troubleshoot broken tests -======================================================================================== -Follow these guidelines to troubleshoot a broken test. +================================ +Troubleshoot broken tests +================================ -#. (Optional) Make a copy of the test so that you can check various solutions before fixing the original test. -#. Open the test page and see when the test started to fail. Consider the following questions: +See, :ref:`syn-troubleshoot`. - * When did the check fail? Is there a pattern among other failed runs? - * Does the check fail consistently on the same step, or intermittently? - * Is this the first time the check has failed on this step? Did you make a recent change to the test? - * Was the failure tied to a specific location or across all locations? -#. Open the run results view of a failed test, find the step that is failing and go to the link. -#. Open inspect element. -#. Duplicate the step and repeat the steps in your test until you find the broken step. -#. Verify that there is one instance only of the selector you want to use in your test. If the selector appears more than once your test might break again in the future. Unique selectors provide optimal test performance. -#. Update your tests with your findings. ======================================================================================== Filter tests diff --git a/synthetics/uptime-test/uptime-test.rst b/synthetics/uptime-test/uptime-test.rst index 2872863e9..afa21464b 100644 --- a/synthetics/uptime-test/uptime-test.rst +++ b/synthetics/uptime-test/uptime-test.rst @@ -2,7 +2,7 @@ .. _uptime-test: ************************************************** -Use an Uptime Test to test port or HTTP uptime +Uptime Tests for port and HTTP ************************************************** .. meta::