Content Pack for Splunk Observability Cloud

Content Pack for Splunk Observability Cloud

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Install and configure the Content Pack for Splunk Observability Cloud

Follow these high-level steps to configure the Content Pack for Splunk Observability Cloud`:

  1. Install and configure the Splunk Infrastructure Monitoring and Splunk Synthetic Monitoring Add-ons. Note, these add-ons have to be installed on search heads in a distributed deployment.
  2. Create modular inputs for Splunk Infrastructure Monitoring and Splunk Application Performance Monitoring.
  3. Install the Content Pack for Splunk Observability Cloud.
  4. Enable your Splunk Observability Cloud entity searches.
  5. Configure KPI thresholds.
  6. (Optional) Configure navigation suggestions for custom subdomains.

Prerequisites

Install and configure the Splunk Infrastructure Monitoring Add-on

This content pack depends on data collected in the Splunk Infrastructure Monitoring Add-on. You can safely install add-ons on all tiers of a distributed Splunk platform deployment, including heavy forwarders, indexers, or search heads. Note that this add-on has to be installed on search heads in a distributed deployment. Download the latest version of the Splunk Infrastructure Monitoring Add-on from Splunkbase.

Create or clone sample modular inputs

After you have configured the Splunk Infrastructure Monitoring and Splunk Synthetic Monitoring Add-ons, you need to create or clone sample modular inputs for the data for this content pack. You create or clone sample modular inputs for the following:

  • Splunk Infrastructure Monitoring
  • Splunk Application Performance Monitoring
  • Splunk Synthetics

Clone sample inputs

The Splunk Infrastructure Monitoring Add-on includes the following sample modular input queries for use with this content pack. See Sample programs in the Splunk® Infrastructure Monitoring Add-on manual for steps to clone these sample inputs.

  • SAMPLE_AWS_EC2 input stream
  • SAMPLE_AWS_Lambda input stream
  • SAMPLE_Azure input stream
  • SAMPLE_Containers input stream
  • SAMPLE_GCP input stream
  • SAMPLE_Kubernetes input stream
  • SAMPLE_OS_Hosts input stream

Create APM inputs

Inputs for APM have to be manually created. Follow these steps to create a modular input for each APM data input you want to set up:

  1. Go to Settings > Data inputs.
  2. Locate the Splunk Infrastructure Monitoring Data Streams.
  3. Select +Add new.
  4. Enter a name for the input. Avoid using "SAMPLE_" in the program name. Programs with a "SAMPLE_" prefix won't run unless manually enabled.
  5. Enter an Organization ID. This is the ID of the organization used to authenticate and fetch data from Splunk Infrastructure Monitoring. You can find your Organization ID on the Account Settings page in Splunk Observability Cloud or the Configuration page in the Splunk Infrastructure Monitoring Add-on.
  6. In the SignalFlow Program field, enter modular input query from the list of modular input queries that follows these steps.
  7. Adjust the Metric Resolution and Additional Metadata Flag for your needs.
  8. Set Interval to 300.
  9. Set sourcetype to Manual.
  10. Enter stash for Source type.
  11. Enter $decideOnStartup for Host.
  12. Select sim_metrics for Index.

Repeat these steps for each data input you want to set up.

Modular input queries

Splunk Application Performance Monitoring (APM) Errors

"error_durations_p99 = data('service.request' + '.duration.ns.' + 'p99', filter=filter('sf_environment', '*') and filter('sf_service', '*') and filter('sf_error','*') and not filter('sf_dimensionalized', '*') and filter('sf_error', 'true'), rollup='max').mean(by=['sf_service', 'sf_environment', 'sf_error'], allow_missing=['sf_httpMethod']).publish(label='error_durations_p99') ; non_error_durations_p99 = data('service.request' + '.duration.ns.' + 'p99', filter=filter('sf_environment', '*') and filter('sf_service', '*') and filter('sf_error','*') and not filter('sf_dimensionalized', '*') and filter('sf_error', 'false'), rollup='max').mean(by=['sf_service', 'sf_environment', 'sf_error'], allow_missing=['sf_httpMethod']).publish(label='non_error_durations_p99') ; error_durations = data('service.request' + '.duration.ns.' + 'median', filter=filter('sf_environment', '*') and filter('sf_service', '*') and filter('sf_error','*') and not filter('sf_dimensionalized', '*') and filter('sf_error', 'true'), rollup='max').mean(by=['sf_service', 'sf_environment', 'sf_error'], allow_missing=['sf_httpMethod']).publish(label='error_durations') ; non_error_durations = data('service.request' + '.duration.ns.' + 'median', filter=filter('sf_environment', '*') and filter('sf_service', '*') and filter('sf_error','*') and not filter('sf_dimensionalized', '*') and filter('sf_error', 'false'), rollup='max').mean(by=['sf_service', 'sf_environment', 'sf_error'], allow_missing=['sf_httpMethod']).publish(label='non_error_durations') ; error_counts = data('service.request' + '.count', filter=filter('sf_environment', '*') and filter('sf_service', '*') and filter('sf_error','*') and not filter('sf_dimensionalized', '*') and filter('sf_error', 'true'), rollup='sum').sum(by=['sf_service', 'sf_environment', 'sf_error'], allow_missing=['sf_httpMethod']).publish(label='error_counts') ; non_error_counts = data('service.request' + '.count', filter=filter('sf_environment', '*') and filter('sf_service', '*') and filter('sf_error','*') and not filter('sf_dimensionalized', '*') and filter('sf_error', 'false'), rollup='sum').sum(by=['sf_service', 'sf_environment', 'sf_error'], allow_missing=['sf_httpMethod']).publish(label='non_error_counts')"

Splunk Application Performance Monitoring (APM) Rate (Throughput)

"thruput_avg_rate = data('service.request.count', filter=filter('sf_environment', '*') and filter('sf_service', '*') and (not filter('sf_dimensionalized', '*')), rollup='rate').sum(by=['sf_service', 'sf_environment']).publish(label='thruput_avg_rate')"

Splunk Real User Monitoring (RUM) Inputs

"data('rum.page_view.count').publish(label='rum_page_view'); data('rum.client_error.count').publish(label='rum_client_error'); data('rum.page_view.time.ns.p75').scale(0.000001).publish(label='rum_page_view_time'); data('rum.resource_request.count').publish(label='rum_resource_request'); data('rum.resource_request.time.ns.p75').scale(0.000001).publish(label='rum_resource_request_time'); data('rum.crash.count').publish(label='rum_crash_count'); data('rum.app_error.count').publish(label='rum_app_error_count'); data('rum.cold_start.time.ns.p75').scale(0.000001).publish(label='rum_cold_start_time'); data('rum.cold_start.count').publish(label='rum_cold_start_count'); data('rum.webvitals_lcp.time.ns.p75').scale(0.000001).publish(label='rum_webvitals_lcp'); data('rum.webvitals_cls.score.p75').publish(label='rum_webvitals_cls'); data('rum.webvitals_fid.time.ns.p75').scale(0.000001).publish(label='rum_webvitals_fid')"

Install the Content Pack for Splunk Observability Cloud

The Content Pack for Splunk Observability Cloud is automatically available for installation once you have installed the Splunk App for Content Packs on the search head with ITSI 4.9.4 or 4.11.x or higher or IT Essentials Work 4.9.4 or 4.11x. or higher. For steps to install the Splunk App for Content Packs, see Install the Splunk App for Content Packs. After you install the Splunk App for Content Packs, you can follow these steps install the content pack:

  1. From the ITSI main menu, click Configuration > Data Integrations.
  2. Select Add content packs or Add structure to your data depending on your version of ITSI or ITE Work.
  3. Select the Splunk Observability Cloud content pack.
  4. Review what's included in the content pack and then click Proceed.
    Installation for CP v2
  5. Configure the settings:
    • Choose which objects to install: For a first-time installation, select the items you want to install and deselect any you're not interested in. For an upgrade, the installer identifies which objects from the content pack are new and which ones already exist in your environment from a previous installation. You can selectively choose which objects to install from the new version or install all objects.
    • Choose a conflict resolution rule for the objects you install: For upgrades or subsequent installs, decide what happens to duplicate objects introduced from the content pack. Choose from these options:
      • Install as new: Any existing identical objects in your environment remain intact.
      • Replace existing: Existing identical objects are replaced with those from the new installation. Any changes you previously made to these objects are overwritten.
    • Import as enabled: Select whether to install objects as enabled or leave them in their original state. We recommend that you import objects as disabled to ensure your environment doesn't break from the addition of new content. This setting only applies to services, correlation searches, and aggregation policies. All other objects such as KPI base searches and saved searches are installed in their original state regardless of the option you choose.
    • Add a prefix to your new objects: Optionally, append a custom prefix to each object installed from the content pack. For example, you might prefix your objects with CP- to indicate they came from a content pack. This option can help you locate and manage the objects after installation.
    • Backfill service KPIs: Optionally backfill your ITSI environment with the previous seven days of KPI data. Consider enabling backfill if you want to configure adaptive thresholding and predictive analytics for the new services. This setting only applies to KPIs, not service health scores.
  6. When you've made your selections, click Install selected.
  7. Click Install to confirm the installation. When the installation completes you can view all objects that were installed in your environment. A green checkmark on the Data Integrations page indicates which content packs you've already installed.

(Optional) Update the index search macro with custom index

Following the initial content pack installation steps, you can use custom index to update the index search macro.

Prerequisites

  • You should have the itoa_admin role to update the index search macro.
  • You have to know the indexes your organization uses to send data from the Add-on to your Splunk platform deployment.

Steps

1. From Splunk Web, select Settings > Advanced Search > Search Macros.

2. Configure the custom index as per requirements as outlined in the following table:

Macro Name Index Type Default Macro Definition Macro Definition with Custom Index
itsi-cp-observability-indexes Metrics index=sim_metrics All of the indexes that you're using for data collection from add-ons combined with OR operators.


For example:
index=sim_metrics OR index=<index-name>

3. Select Save.

Enable your Splunk Observability Cloud entity searches

There are 12 entity discovery searches included with this content pack. They are disabled by default. When you ready to get your data in, follow these steps to enable the entity discover searches for Splunk Observability Cloud.

  1. In Splunk Enterprise go to Settings > Searches, reports, and alerts.
  2. In the Type dropdown, select All.
  3. In the App dropdown, select Content Pack for Splunk Observability Cloud (DA-ITSI-CP-splunk-observability).
  4. In the Owner dropdown, select All.
  5. Depending on the searches you selected to install, these entity discovery searches are available to enable:
    • ITSI Import Objects - Get_OS_Hosts
    • ITSI Import Objects - Get_RUM_Apps
    • ITSI Import Objects - Get_RUM_Browser
    • ITSI Import Objects - Get_RUM_Synthetics
    • ITSI Import Objects - Get_SIM_AWS_EC2
    • ITSI Import Objects - Get_SIM_AWS_Lambdas
    • ITSI Import Objects - Get_SIM_Azure_Functions
    • ITSI Import Objects - Get_SIM_Azure_VM
    • ITSI Import Objects - Get_SIM_GCP_Compute
    • ITSI Import Objects - Get_SIM_GCP_Functions
    • ITSI Import Objects - SSM_get_entities_api
    • ITSI Import Objects - SSM_get_entities_browser
    • ITSI Import Objects - SSM_get_entities_http
    • ITSI Import Objects - Splunk-APM Application Entity Search
  6. Select Edit > Enable for each search you want to enable.

When you've finished enabling the entity searches to import your entities, go to the Service Analyzer > Default Analyzer to see your services and KPIs light up.

Content pack objects are disabled by default on import. If you didn't toggle the option to import the content pack objects as enabled you have to enable them under Configuration > Services. Once you have enabled the services the Service Analyzer will light up.

Configure KPI thresholds

Some KPIs in this content pack have predetermined aggregate and per-entity thresholds configured. Go through the KPIs in each service and configure the aggregate and per-entity thresholds values to reasonable defaults based on your use case. For steps to configure KPI thresholds, see Configure KPI thresholds in ITSI in the Service Insights manual.

For a full list of the KPIs in this content pack, see the KPI reference for the Content Pack for Splunk Observability Cloud.

KPI alerting

Because acceptable application performance varies widely per use case, KPI alerting isn't enabled by default in this content pack. To receive alerts for KPIs when aggregate KPI threshold values change, see Receive alerts when KPI severity changes in ITSI. ITSI generates notable events on the Episode Review page based on the alerting rules you configure.

(Optional) Configure navigation suggestions for custom subdomains

If your Observability Cloud instance uses a custom subdomain, the navigation suggestion links for the SplunkAPM and Splunk Infrastructure Monitoring entity types have to be updated with your custom subdomain. Follow these steps for both the SplunkAPM and Splunk Infrastructure Monitoring entity types.

  1. Go to Configuration > Entities from the ITSI menu.
  2. Go to the Entity Types tab.
  3. Follow these steps to update the navigation suggestions for both the SplunkAPM and Splunk Infrastructure Monitoring entity types.
    1. Edit the entity type.
    2. Expand the Navigations section.
    3. Edit the navigation.
    4. Change the app.{sf_realm}.signalfx.com portion of the URL to {custom-subdomain}.signalfx.com.
    5. Click Save navigation.
    6. Repeat these steps for each navigation.
  4. Select Save to save the entity type when you are finished update each navigation.

Next steps

Now that you have installed and configured the Content Pack for Splunk Observability Cloud, you can start using the dashboards and visualizations in the content pack to monitor your web applications. For instructions for using the content pack, see Use the Content Pack for Splunk Observability Cloud.

Last modified on 29 November, 2022
PREVIOUS
Release notes for the Content Pack for Splunk Observability Cloud
  NEXT
Use the Content Pack for Splunk Observability Cloud

This documentation applies to the following versions of Content Pack for Splunk Observability Cloud: 3.0.0


Was this documentation topic helpful?


You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters