Splunk Cloud

Splunk Cloud Admin Manual

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Use the License Usage dashboards

The dashboards accessed from the Cloud Monitoring Console > License Usage tab enable Splunk Cloud administrators to monitor their Splunk Cloud subscription entitlement and ensure they don't exceed their license limits.

If your organization has an ingest-based subscription that measures by the amount of data ingested, see the Volume Licensing dashboard.

If your organization has an workload-based (also called workload pricing) subscription that measures by Splunk Virtual Compute (SVC) units, see the Workload Pricing dashboard.

This topic provides general information about the Splunk Cloud subscription types. For more detailed information about the different subscription types, see the Splunk Cloud Service Description. Be sure to choose the correct service description version for your Splunk Cloud deployment from the Version drop-down menu.

For more information about your organization's particular subscription entitlement, or to convert from an ingest-based subscription to a workload-based subscription, contact your Splunk account representative.

A blue progress bar might appear above a panel, indicating that the Splunk platform is still generating data. Wait for the bar to disappear before reviewing the panel.

Do not modify any Cloud Monitoring Console (CMC) dashboard. Changing any of the search criteria, formatting, or layouts may cause inaccurate results and also override the automatic update process.

Monitor current volume usage of your ingestion-based subscription

If your Splunk Cloud subscription plan measures the search workload consumption by the amount of data ingested, Splunk Cloud administrators use the Volume Licensing dashboard on the CMC to monitor usage and stay within their subscription entitlement.

Workload-based subscriptions use Splunk Virtual Compute (SVC) as a unit of measure. To understand the potential SVC equivalent for your ingest-based subscription, see the section about performance considerations in the Splunk Cloud Service Description. Be sure to view the correct service description version for your Splunk Cloud deployment version. To convert from an ingest-based subscription to a workload-based subscription, contact your Splunk account representative.

About the Volume Licensing dashboard

The Volume Licensing dashboard contains two panels visible to Splunk Cloud administrators that show data ingestion in GB over a 30-day time range: Daily License Usage and Average and Peak Daily Volume. Both panels derive information from your organization's license manager and present data in a bar chart. For information about your organization's specific license limit, contact your Splunk account representative.

The Split by drop-down list lets you split the displayed results by Host, Index, Source, or Source Type. The default is No Split.

These panels use daily totals event data collected from license_usage.log when you choose No Split. When you choose a Split by option, the panels use event data collected from the _internal index. If the license manager is down at its local midnight, it won't generate the events for that day, and you won't see that day's data in the panels.

Review the Volume Licensing dashboard

To investigate your panels, go to Cloud Monitoring Console > License Usage > Volume Licensing.

Chart series values are color-coded. See the key on the side of a panel for the specific values included in a chart.

Filter option Description
No Split The panels show license volume and usage data for all data pools.
Split by value Select a Split by option of Source Type, Host, Source, or Index. The panels may show the following behavior:
  • Daily License Usage: Shows up to 11 color-coded series of the selected option. This includes the top 10 series and OTHER, a summary category that includes series not in the top 10.
  • Average and Peak Daily Volume: Shows the average and peak daily values for the top five series of the selected option.

Data may display as SQUASHED when you split by host or source. This is because every license peer periodically reports to the license manager its stats for the data indexed, broken down by source, source type, host, and index. If the number of distinct tuples (host, source, source type, index) grows beyond a configurable threshold, Splunk software squashes the host and source values and only reports a breakdown by source type and index. This is done to conserve internal resources.

Because of squashing on the other fields, only the split-by source type and index guarantee full reporting. Split by source and host do not guarantee full reporting if those two fields represent many distinct values. The panels show the entire quantity indexed, but not the names. This means that you don't know who consumed a particular amount, but you know what the amount consumed is.

Interpret volume usage results

The series in a bar chart are individually color coded so you can analyze usage patterns and take any appropriate action. For example:

  • You set Split by to Index and see that a certain index shows an unusually high spike in usage. Investigate the cause of the spike and determine if it requires remediation.
  • You see that your daily usage and average and peak volumes are consistently close to or exceeding your license limit. Contact your Splunk account representative to upgrade your subscription.

Click any bar in the chart to view the underlying data for the bar. Be sure to not modify the underlying data in any way.

You can also set up an alert action (for example, send an email) to be performed when a platform alert is triggered. Go to Settings > Searches, Reports, and Alerts and click New Alert to define a new alert action. See also the Determine retention usage and set an alert section in Interpret index and storage capacity results in the Splunk Cloud Admin Manual.

Monitor current SVC usage of your workload-based subscription

If your Splunk Cloud subscription plan measures the search workload consumption by Splunk Virtual Compute (SVC) units, Splunk Cloud administrators use the Workload Pricing dashboard on the CMC to monitor usage and stay within their subscription entitlement. For more information about the SVC entitlement for your workload-based subscription, see the section about performance considerations in the Splunk Cloud Service Description. Be sure to view the correct service description version for your Splunk Cloud deployment version.

Review the Workload Pricing dashboard

The Workload Pricing dashboard contains panels visible to Splunk Cloud administrators that show SVC entitlement and usage for either ingest-based or workload-based subscriptions over a specific time range.

The SVC Usage, Searchable Index Storage, and Current Searchable Index Storage are overview panels that display your data utilization against your subscription entitlement limits. If your utilization consistently meets or exceeds your subscription entitlement limits, contact your Splunk representative to increase the number of SVCs allocated to your stack.

The following three detail panels help pinpoint where you need to optimize to reduce your organization's SVC consumption:

  • Top 10 SVC Users
  • Top 10 SVC Consumers
  • SVC Usage by Search Type

To investigate your panels, go to Cloud Monitoring Console > License Usage >  Workload Pricing. Use the following table to understand the dashboard interface.

Panel Description
SVC Usage Shows your organization's SVC usage against the license limit. The blue bars indicate the peak SVC utilization and the green line indicates the license limit. The displayed data excludes the last 24 hours of SVC usage. This exclusion is to ensure the correct calculation of your organization's ingested data.


For best performance, utilization should be at 60-70% of the license limit. If it exceeds 70%, look at the detail panels and take action to optimize the high consumers of SVC. When your utilization is 80-90% of your license limit, there is a risk of performance impact if you don't proactively manage your consumption. You can do this by reviewing the high SVC consumers or by increasing your license entitlement. Contact your Splunk account representative to discuss allocating more SVCs to your stack.

SVC Entitlement Shows the number of SVCs assigned to your organization's subscription per your license entitlement.

This panel displays a 0 for the following scenarios:

  • Subscription status: Your organization has a new workload-based subscription and Splunk is still processing your SVC entitlement. Once this process is complete, your entitlement will appear.
  • Subscription type: Your organization uses ingest-based licensing. Contact your Splunk account representative to convert your subscription type from ingest-based to workload-based.
Searchable Index Storage Shows a table of the indexes in your deployment and the current searchable amount in GB for each actively searchable index. The searchable indexes of your deployment only include those in a hot or warm bucket. The GB value that displays for each index is calculated when you load this dashboard.

Use this information to determine which indexes are high consumers of storage, and also understand general usage patterns and trends.

Current Searchable Index Storage Shows your organization's current searchable index storage total in GB. This value includes only actively searched storage and is calculated when you load this dashboard. Though this value will generally correspond to the total of the individual index values displayed in the Searchable Index Storage table, there may be differences due to the time the queries are performed, data aging out of indexes, and similar reasons.

Use this information to compare your current storage consumption against your subscription entitlement and data retention limits.

Top 10 SVC Users Lists the top SVC users and their respective SVC consumption. These users may be human or virtual administrators.

With this data, you can contact high consumers of SVC and discuss ways to optimize their consumption, such as improving their search queries. The Learn more link accesses a topic about writing better searches that you can share with your users.

Top 10 SVC Consumers Shows the maximum percentage of total SVC usage split by index, source, or source type. With this data, you can identify which resource consumers need optimization or other remediation.

Select an option from the drop-down list to populate the graph, and note the following:

  • When you select Indexes, the graph displays 7 days of data. The standard Splunk stack configuration allocates 25% of CPU for indexing, resulting in a maximum of 25% of SVC usage due to indexing.
  • When you select Source or Source Types, the graph displays only a day's worth of data. Because your deployment may have many indexes that require analysis, this limitation is to minimize long running queries that consume resources.

For more information on maintaining indexes, see Manage Splunk Cloud indexes in the Splunk Cloud User Manual. For source and source type, see the Defining host, source, and sourcetype and Source vs sourcetype in the Getting Data In manual.

SVC Usage by Search Type Shows which searches utilize the greatest SVC as a percentage of the total consumption.

Search types are grouped into the following categories: Acceleration, Ad hoc, Other, Scheduled, and Summarization. Understanding SVC usage by search type can help you understand spikes in ad hoc searches, or clustering of scheduled searches. See also Set limits for concurrent searches in the Splunk Cloud Admin Manual.

Indexer CPU Utilization Shows which indexers are high consumers of SVC for CPU utilization, graded as follows:
  • Low: 0-65
  • Intermediate: 65-80
  • High: 80-100

Use this graph to determine which indexers are high consumers and require remediation. For more information on maintaining indexes, see Manage Splunk Cloud indexes in the Splunk Cloud User Manual, especially the "Manage data retention settings" section.

Interpret SVC usage results

See the table in Review the Workload pricing dashboard in this topic for information on keeping your SVC usage within license limits.

You can also set up an alert action (for example, send an email) to be performed when a platform alert is triggered. Go to Settings > Searches, Reports, and Alerts and click New Alert to define a new alert action. See also the Determine retention usage and set an alert section in Interpret index and storage capacity results in the Splunk Cloud Admin Manual.

Use the Data Archive and Restoration Summary panel

For Splunk Cloud administrators, the Data Archive and Restoration Summary panel in the Cloud Monitoring Console (CMC) app shows information about your archived data for indexes that are enabled with Dynamic Data Active Archive (DDAA). Review the information to ensure that you are staying within your subscribed limits for data ingestion and retention. The displayed data updates every time you access or refresh the panel in the CMC app.

Your organization must have enabled DDAA as part of its Splunk Cloud subscription to see data in this panel.

If you exceed your storage requirements by ingesting more data than your initial estimate, Splunk Cloud service elastically expands the amount of storage to retain your data per your retention settings. Periodically, Splunk will review and charge your account for any overages. For more information and to understand storage requirements based on your subscription type, see the Storage section of the Splunk Cloud Platform Service Description.

See also

For more information about See
Managing your aged ingested data with DDAA Store expired Splunk Cloud data to a Splunk-managed archive
Managing indexes Manage Splunk Cloud indexes in the Splunk Cloud User Manual

Archive Summary

In the CMC navigation bar, click License Usage > Data Archive and Restoration Summary, then click the Archive Summary tab.

The summary information in this tab shows data on the usage, entitlement, and 90-day growth and expiration in GB for all of your deployment's indexes enabled with DDAA.

The Archived Data Details table lists the following information:

  • Archived index name
  • Current size (GB)
  • Timestamps for the earliest and latest archived events
  • 90-day data growth and expiration data in GB

The amounts for the summarized and detailed growth and expiration data are for uncompressed (raw) data.

Interpret these results

Compare the usage against the entitlement and the growth against the expiration. If the usage and the growth consistently exceed the entitlement and the expiration, this indicates the following:

  • You must re-evaluate your index ingestion and retention settings. See the topics listed in the See also section on how to manage indexes and DDAA settings.
  • You may need to upgrade your subscription to better handle your true data ingest and retention rates. Contact your Splunk account representative for help.

Restoration Summary

In the CMC navigation bar, click License Usage > Data Archive and Restoration Summary, then click the Restoration Summary tab.

The information in this tab shows the restoration activity for all of your deployment's indexes that are enabled with the DDAA feature. These totals in GB show the amount of uncompressed (raw) data in the following categories:

  • Restored: Copied archive data that has been temporarily restored to an index. Restored data expires from searchable storage after 30 days.
  • Cleared: Restored data that has been manually removed from an index. This data has a Jobstatus of Cleared.
  • Expired: Data that has been automatically removed from searchable storage as it has passed the 30-day retention period. This data has a Jobstatus of Expired.

The displayed totals depend on the data you have selected to restore or clear and also the conditions and limitations of the restoration process, as follows:

  • The archival and restoration process is complete.
  • The data doesn't overlap with other data.
  • The data size doesn't cause performance issues.

For more information, see the following in the the Splunk Cloud Admin Manual:

Interpret these results

Review these totals and determine if the amount of data restored, cleared, and expired in your deployment meets or exceeds your organization's actual requirements. For example, a high total for restored data or low total for cleared or expired data may indicate the need to re-evaluate your index management policies and procedures. Ensure that you are restoring and retaining only the data that your organization truly needs.

Last modified on 27 April, 2021
PREVIOUS
Use the Usage dashboards
  NEXT
Use the Forwarder dashboards

This documentation applies to the following versions of Splunk Cloud: 7.2.9, 7.2.10, 8.0.2006, 8.0.2007, 8.1.2008, 8.1.2009, 8.1.2011, 8.1.2012 (latest FedRAMP release), 8.1.2101, 8.1.2103, 8.2.2104


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