Skip to content

Commit

Permalink
Merge pull request #1057 from splunk/repo-sync
Browse files Browse the repository at this point in the history
Pulling refs/heads/main into main
  • Loading branch information
gschatz-splunk authored Nov 14, 2023
2 parents 23bbf57 + 64b1d31 commit 163d576
Show file tree
Hide file tree
Showing 5 changed files with 64 additions and 16 deletions.
29 changes: 14 additions & 15 deletions infrastructure/manage-navigator-dashbds.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,12 @@ Customize dashboards in Splunk Infrastructure Monitoring navigators
.. note:: You must be an admin user to perform the tasks described in this topic.

Apart from modifying parameters for the data that you view and monitor in a navigator as explained in :ref:`customize-navigator`, you can also
use navigator customization to modify the number and scope of the dashboards associated with a navigator. Dashboard customization persists
use navigator customization to modify the set of dashboards associated with a navigator. Dashboard customization persists
across sessions and applies to all users viewing the involved navigator.

You can apply custom dashboard settings to both the aggregate view of all navigators for a specific techhology, or the more focused instance view of
navigators for a representative example, as for example, monitoring all active EC2 hosts in an aggregate view vs. monitoring one active EC2 host in an instance view.
A label next to the title of the Navigator settings page identifies whether you're working with an aggregate
view or an instance view. Fewer dashboards display for instance views than for aggregate views, but you can customize either view.
You can apply custom dashboard settings to both the aggregate view of all navigators for a specific techhology, and the more focused instance view of
navigators that focuses on one navigator at a time. A label next to the title of the Navigator settings page identifies whether you're working with an aggregate
view or an instance view. For example, if you have an EC2 environment, you'd monitor all active EC2 hosts using aggregate view, and a particular host using instance view.

Use :guilabel:`Manage navigator dashboards` to find dashboards that you can add to the set associated with a navigator.

Expand All @@ -31,31 +30,31 @@ dashboards are listed in a table that displays them by name.

To add one or more dashboards to the default dashboard set for a navigator, do the following from the Navigator settings page:

#. Click on **+Add dashboard**.
#. Click on :guilabel:`+Add dashboard`.

#. Scroll through the list of dashboards, using the Prev and Next buttons to navigate through multiple pages as desired. All available dashboards are displayed bydefault, so the dashboard list can be extensive.
#. Scroll through the list of dashboards, using the Prev and Next buttons to navigate through multiple pages as desired. All available dashboards are displayed in alphabetical order, so the dashboard list might be extensive.

#. (Optional) In the search field of the :guilabel:`Select a dashboard`` window, enter the name of the dashboard you want to find. If dashboards in different groups have the same name, as they might in the case of a common function like "Service endpoint," then search displays the relevant part of the dashboard list where the dashboards appear in alphabetical order.
#. (Optional) In the search field of the :guilabel:`Select a dashboard` window, enter the name of the dashboard you want to find. If dashboards in different groups have the same name, as they might for a common function like "Service endpoint," then search displays the part of the dashboard list where similar names are grouped.

#. (Optional) Use the buttons next to the search field to apply either of the following search filters:
#. (Optional) Use the buttons next to the search field to apply either of the following filters:

* Created by me
* Favorites

#. Click on the name of the dashboard you want to link to the navigator.
#. Click on the name of the dashboard you want to add to the navigator.

#. Click :guilabel:`Select` at the bottom right of the dashboard listing.
#. Click :guilabel:`Select` at the bottom right of the listing window.

#. (Optional) Repeat steps 2 through 5 to link additional dashboards to the navigator.
#. (Optional) Repeat steps 2 through 5 to add additional dashboards to the navigator.

#. (Optional) To change the dashboard display order on the home page for the navigator, click on a dashboard name and drag it up or down in the dashboard list.
#. (Optional) To change the dashboard display order on the navigator's home page, drag a dashboard name up or down in the dashboard list.

#. Click :guilabel:`Save changes` to confirm and apply your choices.

If you select :guilabel:`Reset to built-in dashboards` rather than :guilabel:`Save changes`, then your system resets to the original state
of the navigator without any customization.

To hide a dashboard from view temporarily without actually disassociating it from a navigator, open the Dashboards list and click on the eye symbol shown to the right of the dashboard namew. When a dashboard is hidden, the eye symbol has a slash through it and the dashboard name displays with its name grayed out.
To hide a dashboard from view without disassociating it from a navigator, open the Dashboards list and click on the eye symbol shown to the right of the dashboard namew. When a dashboard is hidden, the eye symbol has a slash through it and the dashboard name displays with its name grayed out.


Built-in dashboards
Expand All @@ -67,5 +66,5 @@ A dashboard with a :guilabel:`Limited access` label is associated with an access
Custom dashboards
-----------------------------

Custom dashboards are monitoring tools that you add to the built-in dashboard set when you modify navigators to more closely match the needs
Custom dashboards are monitoring tools that you add to the built-in dashboard set when you modify (customize) navigators to more closely match the needs
of your end-to-end computing environment.
6 changes: 6 additions & 0 deletions infrastructure/use-navigators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,12 @@ List available navigators

For a list of all the navigators available, see :ref:`navigators-list-imm`.

Customize navigators
-------------------------------

For instructions on how to customize navigators by adding to or removing from the group of built-in dashboards associated with them, see :ref:`manage-dashboards-imm`.


.. toctree::
:hidden:

Expand Down
16 changes: 15 additions & 1 deletion synthetics/api-test/set-up-api-test.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,20 @@ Follow these steps to set up an API test:

.. _api-test-steps:


Custom properties
--------------------
Custom properties are key-value pairs you can assign to dimensions of existing MTSes after ingest. Custom properties are single-valued and don’t support multiple values, like ``region:northamerica`` or ``environment:prod``.

Key requirements:

* Keys must start with an uppercase or lowercase letter. Keys can't start with special characters or numbers.
* The remainder of the key can contain letters, numbers, underscores and hyphens.
* Keys can’t be named test_id or test.
* Key size can't exceed 128 characters.

See, :ref:`custom-properties`.

Add requests to your API test
------------------------------------

Expand All @@ -42,4 +56,4 @@ Follow these steps to add requests to your API test:

Example
==================
For an example, see :ref:`api-test-scenario`.
For an example, see :ref:`api-test-scenario`.
15 changes: 15 additions & 0 deletions synthetics/browser-test/set-up-browser-test.rst
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,21 @@ There are many reasons why you might want to configure advanced settings for you
* Running a test on a pre-production site that has a self-signed certificate.
Custom properties
--------------------
Custom properties are key-value pairs you can assign to dimensions of existing MTSes after ingest. Custom properties are single-valued and don’t support multiple values, like ``region:northamerica`` or ``environment:prod``.
Key requirements:
* Keys must start with an uppercase or lowercase letter. Keys can't start with special characters or numbers.
* The remainder of the key can contain letters, numbers, underscores and hyphens.
* Keys can’t be named test_id or test.
* Key size can't exceed 128 characters.
See, :ref:`custom-properties`.
.. _browser-cookies:
Set cookies
Expand Down
14 changes: 14 additions & 0 deletions synthetics/uptime-test/set-up-uptime-test.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,20 @@ There are many reasons why you might want to configure advanced settings for you
* Filtering out requests from analytics on the back end by sending a specific header in the requests.
* Running a test on a pre-production site that has a self-signed certificate.

Custom properties
--------------------
Custom properties are key-value pairs you can assign to dimensions of existing MTSes after ingest. Custom properties are single-valued and don’t support multiple values, like ``region:northamerica`` or ``environment:prod``.

Key requirements:

* Keys must start with an uppercase or lowercase letter. Keys can't start with special characters or numbers.
* The remainder of the key can contain letters, numbers, underscores and hyphens.
* Keys can’t be named test_id or test.
* Key size can't exceed 128 characters.


See, :ref:`custom-properties`.


.. _uptime-request-time:

Expand Down

0 comments on commit 163d576

Please sign in to comment.