Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentationbreadcrumb arrow Grafana documentationbreadcrumb arrow API Referencebreadcrumb arrow @grafana/databreadcrumb arrow LogsParser
Enterprise Open source

LogsParser interface

Signature

typescript 
export interface LogsParser

Import

typescript 
import { LogsParser } from '@grafana/data';

Properties

PropertyTypeDescription
buildMatcher(label: string) => RegExpValue-agnostic matcher for a field label. Used to filter rows, and first capture group contains the value.
getFields(line: string) => string[]Returns all parsable substrings from a line, used for highlighting
getLabelFromField(field: string) => stringGets the label name from a parsable substring of a line
getValueFromField(field: string) => stringGets the label value from a parsable substring of a line
test(line: string) => booleanFunction to verify if this is a valid parser for the given line. The parser accepts the line if it returns true.

buildMatcher property

Value-agnostic matcher for a field label. Used to filter rows, and first capture group contains the value.

Signature

typescript 
buildMatcher: (label: string) => RegExp;

getFields property

Returns all parsable substrings from a line, used for highlighting

Signature

typescript 
getFields: (line: string) => string[];

getLabelFromField property

Gets the label name from a parsable substring of a line

Signature

typescript 
getLabelFromField: (field: string) => string;

getValueFromField property

Gets the label value from a parsable substring of a line

Signature

typescript 
getValueFromField: (field: string) => string;

test property

Function to verify if this is a valid parser for the given line. The parser accepts the line if it returns true.

Signature

typescript 
test: (line: string) => boolean;