Custom Numeric Field Formatter

kumpelblase · November 15, 2017, 11:36am

Hi there, is it possible to create a custom field format in Kibana 5.6 or 6. I tried my luck with the instructions here: https://www.elastic.co/blog/kibana-custom-field-formatters. But unfortunately the blog post isn't up-to-date anymore. I want a formatter which takes a number and returns a corresponding string. It would be no problem for me to write my own formatter in JS, as the existing formatters are, located in ~/kibana/src/ui/public/stringify/types/.

Bargs · November 15, 2017, 10:12pm

The location of the field formatters was changed in 6.0. You can find all the types here and the registration happens here.

The preferred way to add a custom field formatter is via a plugin, but there's currently a bug preventing plugins from registering them. We're working on a fix, but until then it should still be possible to modify the Kibana source if you really need to.

kumpelblase · November 16, 2017, 7:26am

Thanks, it's easy for me to understand how the individual scripts work and I think it's possible for me to crerate my own. However I can't figure out how the registration happens. A bit of explanation would be great.

Bargs · November 16, 2017, 4:09pm

I'm sorry, I totally used the wrong link for where registration happens. Had too many tabs open!

This is the correct link:

github.com

elastic/kibana/blob/c9c135ea14bc9b024c41d950225a7cc37c9e9106/src/core_plugins/kibana/public/field_formats/register.js

import { RegistryFieldFormatsProvider } from 'ui/registry/field_formats';
import { UrlFormat } from '../../common/field_formats/types/url';
import { BytesFormat } from '../../common/field_formats/types/bytes';
import { DateFormat } from '../../common/field_formats/types/date';
import { RelativeDateFormat } from '../../common/field_formats/types/relative_date';
import { DurationFormat } from '../../common/field_formats/types/duration';
import { IpFormat } from '../../common/field_formats/types/ip';
import { NumberFormat } from '../../common/field_formats/types/number';
import { PercentFormat } from '../../common/field_formats/types/percent';
import { StringFormat } from '../../common/field_formats/types/string';
import { SourceFormat } from '../../common/field_formats/types/source';
import { ColorFormat } from '../../common/field_formats/types/color';
import { TruncateFormat } from '../../common/field_formats/types/truncate';
import { BoolFormat } from '../../common/field_formats/types/boolean';

RegistryFieldFormatsProvider.register(() => UrlFormat);
RegistryFieldFormatsProvider.register(() => BytesFormat);
RegistryFieldFormatsProvider.register(() => DateFormat);
RegistryFieldFormatsProvider.register(() => RelativeDateFormat);
RegistryFieldFormatsProvider.register(() => DurationFormat);

This file has been truncated. show original

That one should be fairly self explanatory, but let me know if you have any other questions!

kumpelblase · November 17, 2017, 7:04am

Yeah thanks, this file is much more understandable.

Bargs · November 17, 2017, 5:23pm

Pull request to track for fixing the plugin issue, if you decide you're interested in writing a field formatter plugin later https://github.com/elastic/kibana/pull/14984

system · December 15, 2017, 5:24pm

This topic was automatically closed 28 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
How to create a custom field formatter plugin in 7.9.x? Kibana kibana-plugin-development	3	559	February 28, 2021
Template support or similar for numeric field formatters Kibana	3	445	November 27, 2018
FieldFormat plugin for Kibana 7.6 Kibana	6	701	April 13, 2020
Register FieldFormat plugin in v. 7.6.2 Kibana	1	481	August 5, 2020
Anyone had luck creating a formatFields plugin for Kibana 5.x? Kibana	4	838	April 14, 2017

Custom Numeric Field Formatter

Related topics