Menu
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.
Enterprise
Open source
LogsParser interface
Signature
typescript
export interface LogsParser
Import
typescript
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
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 unless it returns undefined.
Signature
typescript
test: (line: string) => any;
Was this page helpful?
Related resources from Grafana Labs
Additional helpful documentation, links, and articles:
Video
Getting started with the Grafana LGTM Stack
In this webinar, we’ll demo how to get started using the LGTM Stack: Loki for logs, Grafana for visualization, Tempo for traces, and Mimir for metrics.
Video
Getting started with Grafana dashboard design
In this webinar, you'll learn how to design stylish and easily accessible Grafana dashboards that tell a story.
Video
Building advanced Grafana dashboards
In this webinar, we’ll demo how to build and format Grafana dashboards.