mirror of
https://github.com/grafana/grafana.git
synced 2025-08-02 04:31:36 +08:00
6bc369629d
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
82 lines
2.4 KiB
Markdown
82 lines
2.4 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "LogsParser"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## LogsParser interface
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface LogsParser
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { LogsParser } from '@grafana/data';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [buildMatcher](#buildmatcher-property) | <code>(label: string) => RegExp</code> | Value-agnostic matcher for a field label. Used to filter rows, and first capture group contains the value. |
|
|
| [getFields](#getfields-property) | <code>(line: string) => string[]</code> | Returns all parsable substrings from a line, used for highlighting |
|
|
| [getLabelFromField](#getlabelfromfield-property) | <code>(field: string) => string</code> | Gets the label name from a parsable substring of a line |
|
|
| [getValueFromField](#getvaluefromfield-property) | <code>(field: string) => string</code> | Gets the label value from a parsable substring of a line |
|
|
| [test](#test-property) | <code>(line: string) => any</code> | 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.
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
buildMatcher: (label: string) => RegExp;
|
|
```
|
|
|
|
### getFields property
|
|
|
|
Returns all parsable substrings from a line, used for highlighting
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
getFields: (line: string) => string[];
|
|
```
|
|
|
|
### getLabelFromField property
|
|
|
|
Gets the label name from a parsable substring of a line
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
getLabelFromField: (field: string) => string;
|
|
```
|
|
|
|
### getValueFromField property
|
|
|
|
Gets the label value from a parsable substring of a line
|
|
|
|
<b>Signature</b>
|
|
|
|
```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.
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
test: (line: string) => any;
|
|
```
|