Splunk® Supported Add-ons

Splunk Add-on for MySQL

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Install the Splunk Add-on for MySQL

Installation instructions

See Installing add-ons in Splunk Add-Ons for detailed instructions describing how to install a Splunk add-on in the following deployment scenarios:

Where to install this add-on

Unless otherwise noted, all supported add-ons can be safely installed to all tiers of a distributed Splunk platform deployment. See Where to install Splunk add-ons in Splunk Add-ons for more information.

This table provides a reference for installing this specific add-on to a distributed deployment of Splunk Enterprise.


Splunk instance type Supported Required Comments
Search Heads Yes Yes Install this add-on to all search heads where MySQL knowledge management is required.
Indexers Yes Conditional Not required if you use heavy forwarders to monitor MySQL log files directly on MySQL machines. This is required if you use universal or light forwarders for monitor inputs.
Heavy Forwarders Yes Supported for monitor inputs only. Forwarder needs to be installed directly on the MySQL server for file monitoring of local logs. The forwarder doing the data collection needs to be installed directly on the MySQL server for file monitoring of local logs.
Universal Forwarders Yes No Supported for monitor inputs only. Forwarder needs to be installed directly on the MySQL server for file monitoring of local logs.
Light Forwarders No No This add-on does not support light forwarders because Splunk recommends using the Splunk Web user interface to perform the setup and authentication with MySQL.

Distributed deployment feature compatibility

This table provides a quick reference for the compatibility of this add-on with Splunk distributed deployment features.

Distributed deployment feature Supported Comments
Search Head Clusters Yes
Indexer Clusters Yes
Deployment Server Conditional Supported for deploying the configured add-on to multiple forwarders for local data collection using file monitoring. Not supported for DB Connect inputs.

Installation walkthroughs

The Splunk Add-Ons manual includes an Installing add-ons guide that helps you successfully install any Splunk-supported add-on to your Splunk platform.

For a walkthrough of the installation procedure, follow the link that matches your deployment scenario:


Migrate Splunk add-on for MySQL version 2.0.2 to 3.0.0

The Splunk Add-on for MySQL version 3.0.0 no longer supports automation for input creation in DB Connect. This only affects the automation for new servers, but all currently created inputs (whether they were created by automation or otherwise) in DB Connect will remain. If you want to use the file monitoring feature, see how to Monitor Files and Directories with Splunk Web.

We no longer support these source types:

  • mysql:errorLog:mysqld_safe
  • mysql:file_summary_by_instance
  • mysql:file_summary_by_event_name
  • mysql:hostSummary
  • mysql:events_waits_summary_global_by_event_name
  • mysql:events_waits_summary_by_user_by_event_name
  • mysql:events_statements_summary_by_user_by_event_name
  • mysql:events_statements_summary_by_host_by_event_name
  • mysql:events_statements_summary_by_digest
  • mysql:statementsWithRuntimesIn95Percentile
  • mysql:ioByThreadByLatency
  • mysql:userSummary
  • mysql:table_io_waits_summary_by_index_usage
  • mysql:schemaTableStatsBuffer
  • mysql:tableStatsBuffer
  • mysql:diskUsage
  • mysql:binLog


Inputs from previous versions of the Splunk add-on for MySQL will continue work, but CIM mapping and extraction may stop working or be incorrect. Splunk best practice is to add the new inputs as they will be properly extracted.

Last modified on 19 August, 2021
PREVIOUS
Installation overview for the Splunk Add-on for MySQL
  NEXT
Configure inputs for the Splunk Add-on for MySQL

This documentation applies to the following versions of Splunk® Supported Add-ons: released


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