Numeral Formatting

Numeral formatting in Kibana is done through a pattern-based syntax. These patterns express common number formats in a concise way, similar to date formatting. While these patterns are originally based on Numeral.js, they are now maintained by Kibana.

Numeral formatting patterns are used in multiple places in Kibana, including:

• Advanced settings
• Index pattern formatters
• TSVB
• Canvas

The simplest pattern format is 0, and the default Kibana pattern is 0,0.[000]. The numeral pattern syntax expresses:

Number of decimal places

The . character turns on the option to show decimal places using a locale-specific decimal separator, most often . or ,. To add trailing zeroes such as 5.00, use a pattern like 0.00. To have optional zeroes, use the [] characters.

Thousands separator

The thousands separator , turns on the option to group thousands using a locale-specific separator. The separator is most often , or ., and sometimes ` `.

Accounting notation

Putting parentheses around your format like (0.00) will use accounting notation to show negative numbers.

The display of these patterns is affected by the advanced setting format:number:defaultLocale. The default locale is en, but some examples will specify that they are using an alternate locale.

Most basic examples:

Percentages

By adding the % symbol to any of the previous patterns, the value is multiplied by 100 and the % symbol is added in the place indicated.

The default percentage formatter in Kibana is 0,0.[000]%, which shows up to three decimal places.

Bytes and bits

The bytes and bits formatters will shorten the input by adding a suffix like GB or TB. Bytes and bits formatters include the following suffixes:

b

Bytes with binary values and suffixes. 1024 = 1KB

bb

Bytes with binary values and binary suffixes. 1024 = 1KiB

bd

Bytes with decimal values and suffixes. 1000 = 1kB

bitb

Bits with binary values and suffixes. 1024 = 1Kibit

bitd

Bits with decimal values and suffixes. 1000 = 1kbit

Suffixes are not localized with this formatter.

Currency

Currency formatting is limited in Kibana due to the limitations of the pattern syntax. To enable currency formatting, use the symbol $ in the pattern syntax. The number formatting locale will affect the result.

Duration formatting

Converts a value in seconds to display hours, minutes, and seconds.

Displaying abbreviated numbers

The a pattern will look for the shortest abbreviation for your number, and use a locale-specific display for it. The abbreviations aK, aM, aB, and aT can indicate that the number should be abbreviated to a specific order of magnitude.

Ordinal numbers

The o pattern will display a locale-specific positional value like 1st or 2nd. This pattern has limited support for localization, especially in languages with multiple forms, such as German.

Complete number pattern reference

These number formats, combined with the previously described patterns, produce the complete set of options for numeral formatting. The output here is all for the en locale.

Most Popular

• Get Started with Elasticsearch: Video
• Intro to Kibana: Video
• ELK for Logs & Metrics: Video