Topics

| pdf version

Splunk > The IT Search Company

  • Search and navigate IT data from applications, servers and network devices in real-time.
  • Download Splunk

Localized Splunk documentation

Looking for Splunk documentation in other languages?

Translate Splunk

This documentation applies to the following versions of Splunk: 4.0 , 4.0.1 , 4.0.2 , 4.0.3 , 4.0.4 , 4.0.5 , 4.0.6

Translate Splunk

To translate Splunk, follow these directions:

1. First, you'll need a PO editor. We recommend Poedit, a free, cross-platform PO editor.

2. Next, make a new directory for the locale you're creating. For example, we'll create the fictional locale mz by creating the directory
$SPLUNK_HOME/lib/python2.6/site-packages/splunk/appserver/mrsparkle/locale/mz_MZ/LC_MESSAGES/

3. Now, create the messages.po and messages.mo files in your locale subdirectory.

4. Use your PO editor to translate any strings you wish to your locale.

5. Restart Splunk. There are no other configuration files to edit; the new language will be detected automatically.

Translate Apps

Apps can also be translated using the above steps. However, most Apps must be translated in their own locale subdirectory. Apps that ship with Splunk (Search, Launcher, Unix) are automatically extracted and their text is included in the core messages.pot file; there's no need to handle them separately.

To extract the strings from an installed application, ready to be translated in your PO editor, run the following command from Splunk's command line:

  • splunk extract i18n -app <appname>

This creates a locale/ subdirectory in the App's root directory and populates it with a messages.pot file. Then, follow the steps above to translate the strings within the App.

Locale-specific resources

Static resources such as images, CSS files, and other media are stored in subdirectories within
$SPLUNK_HOME/share/splunk/search_mrsparkle/exposed/
When serving these resources, Splunk checks to see whether a locale-specific version of the resource is available before falling back to the default resource. For example, if your local is set to fr_FR, Splunk look in the following order for the logo image file:
  • exposed/img/skins/default/logo-mrsparkle-fr_FR.gif
  • exposed/img/skins/default/logo-mrsparkle-fr.gif
  • exposed/img/skins/default/logo-mrsparkle.gif

Splunk follows the same path to load HTML templates (including any views) that define each page in the UI. This can be useful for languages that require a modified layout that CSS alone can't accommodate (right to left text for example).

Revision: 207 | Contact | Privacy Policy | Terms of Use | Community content licensed under Creative Commons