grafana/docs/sources/packages_api/data/logsparser.md

+++

-----------------------------------------------------------------------

Do not edit this file. It is automatically generated by API Documenter.

-----------------------------------------------------------------------

title = "LogsParser" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" +++

LogsParser interface

Signature

export interface LogsParser 

Import

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

Properties

Property	Type	Description
buildMatcher	(label: string) => RegExp	Value-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) => string	Gets the label name from a parsable substring of a line
getValueFromField	(field: string) => string	Gets the label value from a parsable substring of a line
test	(line: string) => any	Function to verify if this is a valid parser for the given line. The parser accepts the line unless it returns undefined.

buildMatcher property

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

Signature

buildMatcher: (label: string) => RegExp;

getFields property

Returns all parsable substrings from a line, used for highlighting

Signature

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

getLabelFromField property

Gets the label name from a parsable substring of a line

Signature

getLabelFromField: (field: string) => string;

getValueFromField property

Gets the label value from a parsable substring of a line

Signature

getValueFromField: (field: string) => string;

test property

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

Signature

test: (line: string) => any;