Skip to content

Commit

Permalink
Correct o11y cloud naming
Browse files Browse the repository at this point in the history
  • Loading branch information
theletterf committed May 28, 2024
1 parent 1e4168a commit 3139365
Show file tree
Hide file tree
Showing 134 changed files with 483 additions and 483 deletions.
2 changes: 1 addition & 1 deletion _includes/chart-mts-count.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Maximum number of metric time series processed in a signal
*****************************************************************

To maximize responsiveness when processing incoming metric data, Splunk Observability Cloud limits the number of :term:`metric time series` (MTS) processed in a signal
(single plot line) on a chart or detector. If the total number of time series for the metric specified in your signal exceeds this limit, Observability Cloud displays
(single plot line) on a chart or detector. If the total number of time series for the metric specified in your signal exceeds this limit, Splunk Observability Cloud displays
an orange border around the MTS number. This border notifies you that the processed data reflects only a subset of the time series in the data.

To ensure that your charts and detectors are processing all the time series in the data, apply as many filters as necessary to make the MTS number less than the maximum.
Expand Down
4 changes: 2 additions & 2 deletions _includes/event-sending-functionality.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
This monitor includes event-sending functionality to let you post your
own custom events to Observability Cloud. For example, you can send your
own custom events to Splunk Observability Cloud. For example, you can send your
own custom event when you deploy a new version of your software or
update other parts of your infrastructure. You can then view these
events in the Observability Cloud user interface (UI).
events in the Splunk Observability Cloud user interface (UI).

Make monitors with event-sending functionality members of a logs
pipeline that uses a SignalFx exporter to make the event submission
Expand Down
2 changes: 1 addition & 1 deletion _includes/logs/query-logs.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#. Navigate to :guilabel:`Log Observer`. In the content control bar, enter a time range in the time picker if you know it.
#. Select :guilabel:`Index` next to :guilabel:`Saved Queries`, then select the indexes you want to query. If you want to search your Splunk platform (Splunk Cloud Platform or Splunk Enterprise) data, select the integration for the appropriate Splunk platform instance first, then select which index you want to query in Log Observer. You can only query indexes from one Splunk platform instance or Observability Cloud instance at a time. You can only query Splunk platform indexes if you have the appropriate role and permissions in the Splunk platform instance. Select :guilabel:`Apply`.
#. Select :guilabel:`Index` next to :guilabel:`Saved Queries`, then select the indexes you want to query. If you want to search your Splunk platform (Splunk Cloud Platform or Splunk Enterprise) data, select the integration for the appropriate Splunk platform instance first, then select which index you want to query in Log Observer. You can only query indexes from one Splunk platform instance or Splunk Observability Cloud instance at a time. You can only query Splunk platform indexes if you have the appropriate role and permissions in the Splunk platform instance. Select :guilabel:`Apply`.
#. In the content control bar next to the index picker, select :guilabel:`Add Filter`.
#. To search on a keyword, select the :guilabel:`Keyword` tab, type the keyword or phrase you want to search on, then press Enter. If you want to search on a field, select the :guilabel:`Fields` tab, enter the field name, then press Enter.
#. To continue adding keywords or fields to the search, select :guilabel:`Add Filter`.
Expand Down
2 changes: 1 addition & 1 deletion _includes/metric-categories.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

* - 3
- | Custom
| Metrics reported to Observability Cloud outside of those reported by default, such as host, container, or bundled metrics. Custom metrics might result in increased data ingest costs.
| Metrics reported to Splunk Observability Cloud outside of those reported by default, such as host, container, or bundled metrics. Custom metrics might result in increased data ingest costs.
* - 4
- Hi-resolution
Expand Down
4 changes: 2 additions & 2 deletions _includes/metric-defs.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
- To learn more about the available in Observability Cloud see
- To learn more about the available in Splunk Observability Cloud see
:ref:`metric-types`
- In host-based subscription plans, default metrics are those metrics
included in host-based subscriptions in Observability Cloud, such as
included in host-based subscriptions in Splunk Observability Cloud, such as
host, container, or bundled metrics. Custom metrics are not provided
by default and might be subject to charges. See
:ref:`metric-categories` for more information.
Expand Down
8 changes: 4 additions & 4 deletions admin/admin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ Set up and administer Splunk Observability Cloud
********************************************************************************

.. meta::
:description: Overview of the Observability Cloud admin tasks and links to the documentation.
:description: Overview of the Splunk Observability Cloud admin tasks and links to the documentation.

One of the first steps in getting started with Observability Cloud is setting up your organization. In Observability Cloud, an organization, or account, is the highest-level security grouping. For example, other organizations and their users can't access the data in your organization.
One of the first steps in getting started with Splunk Observability Cloud is setting up your organization. In Splunk Observability Cloud, an organization, or account, is the highest-level security grouping. For example, other organizations and their users can't access the data in your organization.

To set up your organization, create and carry out a plan for addressing the tasks described in this topic. Many of these tasks require administrator access, and you might need to perform some administrative tasks on a regular basis after your initial setup.


Set up and administer your organization
==============================================================
The following table shows you aspects of your Observability Cloud organization that you can plan for and set up:
The following table shows you aspects of your Splunk Observability Cloud organization that you can plan for and set up:

.. list-table::
:header-rows: 1
Expand Down Expand Up @@ -66,6 +66,6 @@ The following table shows you aspects of your Observability Cloud organization t

For information about Infrastructure Monitoring subscription usage, see :ref:`monitor-imm-billing-usage`.

For information about usage metrics for Observability Cloud, see :ref:`org-metrics`.
For information about usage metrics for Splunk Observability Cloud, see :ref:`org-metrics`.
- admin, usage

26 changes: 13 additions & 13 deletions admin/authentication/SSO/sso-ADSF.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Configure an ADFS SSO integration
*********************************************************************

.. meta::
:description: Configure the Active Directory Federation Services (ADFS) SSO integration to let your users log in to Observability Cloud using your Microsoft ADFS portal.
:description: Configure the Active Directory Federation Services (ADFS) SSO integration to let your users log in to Splunk Observability Cloud using your Microsoft ADFS portal.

The Microsoft Active Directory Federation Services (ADFS) SSO integration lets your users log in to Observability Cloud using your Microsoft ADFS portal.
The Microsoft Active Directory Federation Services (ADFS) SSO integration lets your users log in to Splunk Observability Cloud using your Microsoft ADFS portal.

Before you begin configuring the ADFS integration, ensure you have completed the steps in :ref:`sso-label`, including the section :ref:`Name an SSO integration<naming-note-sso>` to learn about naming your integrations.

Expand Down Expand Up @@ -42,10 +42,10 @@ After support activates the integration, users can authenticate using ADFS SSO.

.. _create-adfs-imm-integration:

Create a new ADFS SSO integration in Observability Cloud
Create a new ADFS SSO integration in Splunk Observability Cloud
------------------------------------------------------------------------

To create a new ADFS integration in Observability Cloud:
To create a new ADFS integration in Splunk Observability Cloud:

#. Log in to Splunk Observability Cloud.
#. Open the :new-page:`ADFS guided setup <https://login.signalfx.com/#/integrations/adfs/description>`. Optionally, you can navigate to the guided setup on your own:
Expand Down Expand Up @@ -100,7 +100,7 @@ Add Splunk Observability Cloud as a relying party in ADFS:

#. Select :guilabel:`Add`, then select :guilabel:`Next`.
#. The next step in the guided setup lets you configure multifactor authentication.
Because Observability Cloud doesn't require this option, select :guilabel:`Next`.
Because Splunk Observability Cloud doesn't require this option, select :guilabel:`Next`.
#. On the :guilabel:`Choose access control policy` page, do the following:

#. Select :menuselection:`Permit everyone`.
Expand All @@ -120,7 +120,7 @@ Add Splunk Observability Cloud as a relying party in ADFS:
* From the :guilabel:`Endpoint type` list, select :guilabel:`SAML Assertion Consumer`.
* From the :guilabel:`Binding` list, select :guilabel:`POST`.
* Select :guilabel:`Set the trusted URL as default`.
* For :guilabel:`Trusted URL`, enter the URL, replacing ``<INTEGRATION_ID>`` with the integration ID you copied in step 3 of the section :ref:`Create a new ADFS SSO integration in Observability Cloud<create-adfs-imm-integration>`:
* For :guilabel:`Trusted URL`, enter the URL, replacing ``<INTEGRATION_ID>`` with the integration ID you copied in step 3 of the section :ref:`Create a new ADFS SSO integration in Splunk Observability Cloud<create-adfs-imm-integration>`:

* If your organization is in realm ``us0``, enter the following:

Expand Down Expand Up @@ -176,44 +176,44 @@ Obtain an ADFS certificate to install to Splunk Observability Cloud:

``openssl x509 -inform der -in certificate.cer -out certificate.pem``

In a following step, you upload this file to Observability Cloud.
In a following step, you upload this file to Splunk Observability Cloud.

.. _obtain-adfs-metadata:

Obtain federation metadata file to install to Splunk Observability Cloud
---------------------------------------------------------------------------------

Obtain a federation metadata file to install to Observability Cloud:
Obtain a federation metadata file to install to Splunk Observability Cloud:

#. In the ADFS management console, navigate to :guilabel:`Endpoints`.
#. Locate the :guilabel:`Federation Metadata` endpoint and copy the URL that appears. It's similar to the following:

``https://<YOUR_SERVER_IP>/FederationMetadata/2007-06/FederationMetadata.xml``.
#. Open a new browser window or tab, then navigate to the URL you copied. This opens a file download dialog box.
#. Save the file FederationMetadata.xml. In a following step, you upload this file to Observability Cloud.
#. Save the file FederationMetadata.xml. In a following step, you upload this file to Splunk Observability Cloud.

.. note:: URLs must belong to ADFS in order to validate. Accepted domains include ``windows.net`` and ``windows-ppe.net``.

.. _upload-adfs-cert-metadata-im:

Upload the ADFS certificate and federation metadata to Observability Cloud
Upload the ADFS certificate and federation metadata to Splunk Observability Cloud
------------------------------------------------------------------------------------------

In Observability Cloud, do the following:
In Splunk Observability Cloud, do the following:

#. Find the ADFS page you opened in a previous step.
#. Select the :strong:`Upload File` link in the :guilabel:`Certificate` field and upload the ``certificate.pem`` file.
#. Select the :strong:`Upload File` link in the :guilabel:`Metadata` field and upload the ``FederationMetadata.xml`` file.
#. Select :guilabel:`Save`.

The ADFS SSO integration is now available to users in your ADFS organization.
When users log in to Observability Cloud from ADFS for the first time,
When users log in to Splunk Observability Cloud from ADFS for the first time,
they receive an email containing a link that they must open in order to authenticate.
This only occurs the first time the user signs in. Subsequent login attempts don't
require validation.

If you want to turn off the email authentication feature, contact :ref:`support`.

.. note:: The ADFS portal is the only way that your users can log in to Observability Cloud.
.. note:: The ADFS portal is the only way that your users can log in to Splunk Observability Cloud.

.. include:: /_includes/troubleshooting-components.rst
6 changes: 3 additions & 3 deletions admin/authentication/SSO/sso-AzureAD.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ Configure a Microsoft Entra ID (formerly Azure Active Directory) SSO integration
**************************************************************************************

.. meta::
:description: Configure the Microsoft Entra ID (formerly Azure Active Directory) integration to let users log in to Observability Cloud using their Entra ID account.
:description: Configure the Microsoft Entra ID (formerly Azure Active Directory) integration to let users log in to Splunk Observability Cloud using their Entra ID account.

The Microsoft Entra ID (formerly Azure Active Directory) integration lets users log in to Observability Cloud using their Microsoft Entra ID account.
The Microsoft Entra ID (formerly Azure Active Directory) integration lets users log in to Splunk Observability Cloud using their Microsoft Entra ID account.

Before you begin configuring this integration, ensure you have completed the steps in :new-page-ref:`sso-label`, including the section :ref:`Name an SSO integration<naming-note-sso>` to learn about naming your integrations.

Expand Down Expand Up @@ -44,6 +44,6 @@ signs in. Subsequent login attempts don't require validation.

If you want to turn off the email authentication feature, contact :ref:`support`.

Once you have a custom URL configured, your users can continue to log in using their existing username/password pair, or they can use their Microsoft Entra ID credentials instead. Microsoft Entra ID SSO authentication and Observability Cloud username/password authentication are independent.
Once you have a custom URL configured, your users can continue to log in using their existing username/password pair, or they can use their Microsoft Entra ID credentials instead. Microsoft Entra ID SSO authentication and Splunk Observability Cloud username/password authentication are independent.

.. include:: /_includes/troubleshooting-components.rst
12 changes: 6 additions & 6 deletions admin/authentication/SSO/sso-GeneralSAML.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Configure SSO using a generic SAML SSO integration
.. meta::
:description: Prerequisites and installation steps to configure SSO using a generic SAML SSO integration.

.. caution:: This integration can send credential information to unverified destinations. Although you can use generic SAML SSO integrations to authenticate users, Observability Cloud doesn't support these integrations as your primary authentication mechanism. The Observability Cloud support team can't help you diagnose or repair problems you encounter while trying to authenticate users using generic SSO integrations, aside from ensuring that the integration itself is working.
.. caution:: This integration can send credential information to unverified destinations. Although you can use generic SAML SSO integrations to authenticate users, Splunk Observability Cloud doesn't support these integrations as your primary authentication mechanism. The Splunk Observability Cloud support team can't help you diagnose or repair problems you encounter while trying to authenticate users using generic SSO integrations, aside from ensuring that the integration itself is working.

If you use an SSO login service other than the ones listed in :ref:`sso-label`, you can create a generic SAML SSO integration for your organization.

Expand All @@ -22,7 +22,7 @@ If you already have a SAML SSO integration for your organization, follow the ste
Generic SAML SSO integrations
-------------------------------------------------------

Splunk Observability Cloud provides integrations for specific SAML SSO providers. If your provider isn't in the list of supported integrations, your organization administrator can request a generic integration from Observability Cloud. You can use this integration to test and develop a SAML SSO provider. Using this integration, administrators can direct Observability Cloud
Splunk Observability Cloud provides integrations for specific SAML SSO providers. If your provider isn't in the list of supported integrations, your organization administrator can request a generic integration from Splunk Observability Cloud. You can use this integration to test and develop a SAML SSO provider. Using this integration, administrators can direct Splunk Observability Cloud
to use any publicly-available SSO endpoint to authenticate users.

Be prepared to provide the domain for the ID/email address that your users provide when they log in. The domain is the part of the user ID/email address string that follows the ``@`` sign.
Expand Down Expand Up @@ -61,15 +61,15 @@ The URL has one of the following formats:

* If you have multiple organizations that you want to integrate with a single IdP, do the following:
#. Select :guilabel:`Integration-specific Entity ID`. Next to the option, the integration-specific entity ID appears in the form of a URI.
#. Copy the entity ID and provide it when you configure the login service to communicate with Observability Cloud.
#. Copy the entity ID and provide it when you configure the login service to communicate with Splunk Observability Cloud.

:strong:`Assertion Signature`

The SSO provider must put the assertion signature in the assertion message, not in the request itself. The assertion must be signed with the SHA256 algorithm or better.

:strong:`RelayState`

Observability Cloud sends a dynamic RelayState, so the SSO provider must accept and pass back the dynamic RelayState. RelayState is part of SAML specifications. In the Splunk Observability Cloud system it is part of message context in the AuthN request that is sent to the identity provider. The message context also contains a token that can be verified on the service provider side later. The Relay State is set by the Splunk Observability Cloud system and sent with the request to the IDP. The IDP is expected to send the relay state back to the service provider with the same value that was received after a successful authentication on the IDP side.
Splunk Observability Cloud sends a dynamic RelayState, so the SSO provider must accept and pass back the dynamic RelayState. RelayState is part of SAML specifications. In the Splunk Observability Cloud system it is part of message context in the AuthN request that is sent to the identity provider. The message context also contains a token that can be verified on the service provider side later. The Relay State is set by the Splunk Observability Cloud system and sent with the request to the IDP. The IDP is expected to send the relay state back to the service provider with the same value that was received after a successful authentication on the IDP side.

.. _saml-install:

Expand Down Expand Up @@ -120,8 +120,8 @@ time the user signs in. Subsequent login attempts don't require validation.

If you want to turn off email authentication, contact :ref:`support`.

Once you have a custom URL configured, your users can continue to log in using their existing username/password pair, or they can use their generic SAML SSO credentials instead. Generic SAML SSO authentication and Observability Cloud username/password authentication are independent.
Once you have a custom URL configured, your users can continue to log in using their existing username/password pair, or they can use their generic SAML SSO credentials instead. Generic SAML SSO authentication and Splunk Observability Cloud username/password authentication are independent.

Observability Cloud generates a password for users you create in generic SAML SSO. If the generic SAML login portal is unavailable, Observability Cloud users can use the reset password link on the Observability Cloud login page to get native Observability Cloud credentials.
Splunk Observability Cloud generates a password for users you create in generic SAML SSO. If the generic SAML login portal is unavailable, Splunk Observability Cloud users can use the reset password link on the Splunk Observability Cloud login page to get native Splunk Observability Cloud credentials.


Loading

0 comments on commit 3139365

Please sign in to comment.