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.

Documentation Grafana documentation API Reference @grafana/data LogsParser

LogsParser interface

Signature

typescript Copy

export interface LogsParser 

Import

typescript Copy

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

Properties

buildMatcher property

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

Signature

typescript Copy

buildMatcher: (label: string) => RegExp;

getFields property

Returns all parsable substrings from a line, used for highlighting

Signature

typescript Copy

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

getLabelFromField property

Gets the label name from a parsable substring of a line

Signature

typescript Copy

getLabelFromField: (field: string) => string;

getValueFromField property

Gets the label value from a parsable substring of a line

Signature

typescript Copy

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 Copy

test: (line: string) => boolean;