-
Notifications
You must be signed in to change notification settings - Fork 8.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Generate core API docs from TSDoc comments #32148
Merged
Merged
Changes from 40 commits
Commits
Show all changes
46 commits
Select commit
Hold shift + click to select a range
a3c0b59
Generate core API docs from TSDoc comments
rudolf ee431ce
Flesh out API docs a little bit
rudolf 70e25d7
Ignore snake_case check for api-extractor.json
rudolf 8bcc4a2
Ignore api-extractor's review file from pre-commit check
rudolf 4cc5f34
Try to fix build failing by using masters yarn.lock
rudolf 9926ab4
I'm being stupid
rudolf 8a0db42
Found a better home for ignoring common/core_api_review/kibana.api.ts
rudolf 57f56a3
Node script for detecting core API changes
rudolf a286fca
Fix tslint precommit hook ignore condition
rudolf 5d536cd
Write tsdoc-metadata.json into ./build
rudolf 02cc3ee
Add LogMeta and ElasticSearch to exported types & docs
rudolf 3e26615
Merge branch 'master' into rm-core-api-docs
rudolf c343f80
Suppress logging when running api-extractor from script
rudolf 720c729
Improve check_core_api_changes script and run as test
rudolf c7f45a9
Inline api-extractor.json config
rudolf d45d289
Merge branch 'master' into rm-core-api-docs
rudolf 20384da
Fix check_core_api_changes --help flag
rudolf 1797e1e
LogMeta TSDoc comments
rudolf dcefd8d
check_core_api_changes: fail if api-extractor produces warnings or er…
rudolf a738bc9
Merge branch 'master' into rm-core-api-docs
rudolf e397c9a
Move ignored ts files list into dev/file
rudolf f19380a
Merge branch 'master' into rm-core-api-docs
rudolf e73167d
Merge branch 'master' into rm-core-api-docs
rudolf a487c16
Add back build:types since api-exporter cannot operate on source files
rudolf 77f0cb0
Upgrade api-exporter/documenter
rudolf 2352343
api-extractor: independantly analyze core/public and core/server
rudolf 969e2e3
Build types as part of build task
rudolf cb5ff8f
Include types in typescript browser compilation
rudolf 0ad507e
Force inclusion of core/public for building types
rudolf 9490881
Merge remote-tracking branch 'upstream/master' into rm-core-api-docs
rudolf 5f6c583
Fix api review filename in api-exporter errors
rudolf 463d13c
Update docs and API review files
rudolf d3665d8
Fix api-extractor warnings
rudolf 0e15328
Merge branch 'master' into rm-core-api-docs
rudolf 3df7d6b
chore(NA): merge and solve conflicts with last master.
mistic 304e533
Remove ts file ignored list since it's no longer necessary
rudolf 51b8bc1
Rename exported api package name
rudolf e6660ab
Review comments
rudolf c325a56
Export other missing types
rudolf 21f5abf
Upgrade api-documenter to latest beta
rudolf c69c601
Export more missing types
rudolf 74bc082
Fix warnings and add api-exporter to Jenkins tests
rudolf 979c57a
Merge remote-tracking branch 'upstream/master' into rm-core-api-docs
rudolf 0615c25
Correctly handle runBuildTypes() exceptions
rudolf f64751c
Fix another swallowed exception
rudolf cfcfb4e
Fix api-extractor warnings after master merge
rudolf File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
9 changes: 9 additions & 0 deletions
9
docs/development/core/public/kibana-plugin-public.coresetup.basepath.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) > [basePath](./kibana-plugin-public.coresetup.basepath.md) | ||
|
||
## CoreSetup.basePath property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
basePath: BasePathSetup; | ||
``` |
9 changes: 9 additions & 0 deletions
9
docs/development/core/public/kibana-plugin-public.coresetup.chrome.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) > [chrome](./kibana-plugin-public.coresetup.chrome.md) | ||
|
||
## CoreSetup.chrome property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
chrome: ChromeSetup; | ||
``` |
9 changes: 9 additions & 0 deletions
9
docs/development/core/public/kibana-plugin-public.coresetup.fatalerrors.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) > [fatalErrors](./kibana-plugin-public.coresetup.fatalerrors.md) | ||
|
||
## CoreSetup.fatalErrors property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
fatalErrors: FatalErrorsSetup; | ||
``` |
9 changes: 9 additions & 0 deletions
9
docs/development/core/public/kibana-plugin-public.coresetup.http.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) > [http](./kibana-plugin-public.coresetup.http.md) | ||
|
||
## CoreSetup.http property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
http: HttpSetup; | ||
``` |
9 changes: 9 additions & 0 deletions
9
docs/development/core/public/kibana-plugin-public.coresetup.i18n.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) > [i18n](./kibana-plugin-public.coresetup.i18n.md) | ||
|
||
## CoreSetup.i18n property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
i18n: I18nSetup; | ||
``` |
9 changes: 9 additions & 0 deletions
9
docs/development/core/public/kibana-plugin-public.coresetup.injectedmetadata.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) > [injectedMetadata](./kibana-plugin-public.coresetup.injectedmetadata.md) | ||
|
||
## CoreSetup.injectedMetadata property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
injectedMetadata: InjectedMetadataSetup; | ||
``` |
25 changes: 25 additions & 0 deletions
25
docs/development/core/public/kibana-plugin-public.coresetup.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) | ||
|
||
## CoreSetup interface | ||
|
||
Core services exposed to the start lifecycle | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface CoreSetup | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [basePath](./kibana-plugin-public.coresetup.basepath.md) | <code>BasePathSetup</code> | | | ||
| [chrome](./kibana-plugin-public.coresetup.chrome.md) | <code>ChromeSetup</code> | | | ||
| [fatalErrors](./kibana-plugin-public.coresetup.fatalerrors.md) | <code>FatalErrorsSetup</code> | | | ||
| [http](./kibana-plugin-public.coresetup.http.md) | <code>HttpSetup</code> | | | ||
| [i18n](./kibana-plugin-public.coresetup.i18n.md) | <code>I18nSetup</code> | | | ||
| [injectedMetadata](./kibana-plugin-public.coresetup.injectedmetadata.md) | <code>InjectedMetadataSetup</code> | | | ||
| [notifications](./kibana-plugin-public.coresetup.notifications.md) | <code>NotificationsSetup</code> | | | ||
| [uiSettings](./kibana-plugin-public.coresetup.uisettings.md) | <code>UiSettingsSetup</code> | | | ||
|
9 changes: 9 additions & 0 deletions
9
docs/development/core/public/kibana-plugin-public.coresetup.notifications.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) > [notifications](./kibana-plugin-public.coresetup.notifications.md) | ||
|
||
## CoreSetup.notifications property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
notifications: NotificationsSetup; | ||
``` |
9 changes: 9 additions & 0 deletions
9
docs/development/core/public/kibana-plugin-public.coresetup.uisettings.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) > [uiSettings](./kibana-plugin-public.coresetup.uisettings.md) | ||
|
||
## CoreSetup.uiSettings property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
uiSettings: UiSettingsSetup; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) | ||
|
||
## kibana-plugin-public package | ||
|
||
## Interfaces | ||
|
||
| Interface | Description | | ||
| --- | --- | | ||
| [CoreSetup](./kibana-plugin-public.coresetup.md) | Core services exposed to the start lifecycle | | ||
|
10 changes: 10 additions & 0 deletions
10
docs/development/core/server/kibana-plugin-server.apicaller.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [APICaller](./kibana-plugin-server.apicaller.md) | ||
|
||
## APICaller type | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare type APICaller = (endpoint: string, clientParams: Record<string, unknown>, options?: CallAPIOptions) => Promise<unknown>; | ||
``` |
18 changes: 18 additions & 0 deletions
18
docs/development/core/server/kibana-plugin-server.callapioptions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [CallAPIOptions](./kibana-plugin-server.callapioptions.md) | ||
|
||
## CallAPIOptions interface | ||
|
||
The set of options that defines how API call should be made and result be processed. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface CallAPIOptions | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [wrap401Errors](./kibana-plugin-server.callapioptions.wrap401errors.md) | <code>boolean</code> | Indicates whether <code>401 Unauthorized</code> errors returned from the Elasticsearch API should be wrapped into <code>Boom</code> error instances with properly set <code>WWW-Authenticate</code> header that could have been returned by the API itself. If API didn't specify that then <code>Basic realm="Authorization Required"</code> is used as <code>WWW-Authenticate</code>. | | ||
|
11 changes: 11 additions & 0 deletions
11
docs/development/core/server/kibana-plugin-server.callapioptions.wrap401errors.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [CallAPIOptions](./kibana-plugin-server.callapioptions.md) > [wrap401Errors](./kibana-plugin-server.callapioptions.wrap401errors.md) | ||
|
||
## CallAPIOptions.wrap401Errors property | ||
|
||
Indicates whether `401 Unauthorized` errors returned from the Elasticsearch API should be wrapped into `Boom` error instances with properly set `WWW-Authenticate` header that could have been returned by the API itself. If API didn't specify that then `Basic realm="Authorization Required"` is used as `WWW-Authenticate`<!-- -->. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
wrap401Errors: boolean; | ||
``` |
24 changes: 24 additions & 0 deletions
24
docs/development/core/server/kibana-plugin-server.clusterclient.asscoped.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [ClusterClient](./kibana-plugin-server.clusterclient.md) > [asScoped](./kibana-plugin-server.clusterclient.asscoped.md) | ||
|
||
## ClusterClient.asScoped() method | ||
|
||
Creates an instance of `ScopedClusterClient` based on the configuration the current cluster client that exposes additional `callAsCurrentUser` method scoped to the provided req. Consumers shouldn't worry about closing scoped client instances, these will be automatically closed as soon as the original cluster client isn't needed anymore and closed. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
asScoped(req?: { | ||
headers?: Headers; | ||
}): ScopedClusterClient; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| req | <code>{`<p/>` headers?: Headers;`<p/>` }</code> | Request the <code>ScopedClusterClient</code> instance will be scoped to. | | ||
|
||
<b>Returns:</b> | ||
|
||
`ScopedClusterClient` | ||
|
11 changes: 11 additions & 0 deletions
11
...evelopment/core/server/kibana-plugin-server.clusterclient.callasinternaluser.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [ClusterClient](./kibana-plugin-server.clusterclient.md) > [callAsInternalUser](./kibana-plugin-server.clusterclient.callasinternaluser.md) | ||
|
||
## ClusterClient.callAsInternalUser property | ||
|
||
Calls specified endpoint with provided clientParams on behalf of the Kibana internal user. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
callAsInternalUser: (endpoint: string, clientParams?: Record<string, unknown>, options?: CallAPIOptions | undefined) => Promise<any>; | ||
``` |
15 changes: 15 additions & 0 deletions
15
docs/development/core/server/kibana-plugin-server.clusterclient.close.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [ClusterClient](./kibana-plugin-server.clusterclient.md) > [close](./kibana-plugin-server.clusterclient.close.md) | ||
|
||
## ClusterClient.close() method | ||
|
||
Closes the cluster client. After that client cannot be used and one should create a new client instance to be able to interact with Elasticsearch API. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
close(): void; | ||
``` | ||
<b>Returns:</b> | ||
|
||
`void` | ||
|
25 changes: 25 additions & 0 deletions
25
docs/development/core/server/kibana-plugin-server.clusterclient.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [ClusterClient](./kibana-plugin-server.clusterclient.md) | ||
|
||
## ClusterClient class | ||
|
||
Represents an Elasticsearch cluster API client and allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers (via `asScoped(...)`<!-- -->). | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare class ClusterClient | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Modifiers | Type | Description | | ||
| --- | --- | --- | --- | | ||
| [callAsInternalUser](./kibana-plugin-server.clusterclient.callasinternaluser.md) | | <code>(endpoint: string, clientParams?: Record<string, unknown>, options?: CallAPIOptions | undefined) => Promise<any></code> | Calls specified endpoint with provided clientParams on behalf of the Kibana internal user. | | ||
|
||
## Methods | ||
|
||
| Method | Modifiers | Description | | ||
| --- | --- | --- | | ||
| [asScoped(req)](./kibana-plugin-server.clusterclient.asscoped.md) | | Creates an instance of <code>ScopedClusterClient</code> based on the configuration the current cluster client that exposes additional <code>callAsCurrentUser</code> method scoped to the provided req. Consumers shouldn't worry about closing scoped client instances, these will be automatically closed as soon as the original cluster client isn't needed anymore and closed. | | ||
| [close()](./kibana-plugin-server.clusterclient.close.md) | | Closes the cluster client. After that client cannot be used and one should create a new client instance to be able to interact with Elasticsearch API. | | ||
|
10 changes: 10 additions & 0 deletions
10
docs/development/core/server/kibana-plugin-server.headers.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [Headers](./kibana-plugin-server.headers.md) | ||
|
||
## Headers type | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare type Headers = Record<string, string | string[] | undefined>; | ||
``` |
23 changes: 23 additions & 0 deletions
23
docs/development/core/server/kibana-plugin-server.logger.debug.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [Logger](./kibana-plugin-server.logger.md) > [debug](./kibana-plugin-server.logger.debug.md) | ||
|
||
## Logger.debug() method | ||
|
||
Log messages useful for debugging and interactive investigation | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
debug(message: string, meta?: LogMeta): void; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| message | <code>string</code> | The log message | | ||
| meta | <code>LogMeta</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`void` | ||
|
23 changes: 23 additions & 0 deletions
23
docs/development/core/server/kibana-plugin-server.logger.error.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [Logger](./kibana-plugin-server.logger.md) > [error](./kibana-plugin-server.logger.error.md) | ||
|
||
## Logger.error() method | ||
|
||
Logs abnormal or unexpected errors or messages that caused a failure in the application flow | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
error(errorOrMessage: string | Error, meta?: LogMeta): void; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| errorOrMessage | <code>string | Error</code> | An Error object or message string to log | | ||
| meta | <code>LogMeta</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`void` | ||
|
23 changes: 23 additions & 0 deletions
23
docs/development/core/server/kibana-plugin-server.logger.fatal.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [Logger](./kibana-plugin-server.logger.md) > [fatal](./kibana-plugin-server.logger.fatal.md) | ||
|
||
## Logger.fatal() method | ||
|
||
Logs abnormal or unexpected errors or messages that caused an unrecoverable failure | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
fatal(errorOrMessage: string | Error, meta?: LogMeta): void; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| errorOrMessage | <code>string | Error</code> | An Error object or message string to log | | ||
| meta | <code>LogMeta</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`void` | ||
|
23 changes: 23 additions & 0 deletions
23
docs/development/core/server/kibana-plugin-server.logger.info.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [Logger](./kibana-plugin-server.logger.md) > [info](./kibana-plugin-server.logger.info.md) | ||
|
||
## Logger.info() method | ||
|
||
Logs messages related to general application flow | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
info(message: string, meta?: LogMeta): void; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| message | <code>string</code> | The log message | | ||
| meta | <code>LogMeta</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`void` | ||
|
23 changes: 23 additions & 0 deletions
23
docs/development/core/server/kibana-plugin-server.logger.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [Logger](./kibana-plugin-server.logger.md) | ||
|
||
## Logger interface | ||
|
||
Logger exposes all the necessary methods to log any type of information and this is the interface used by the logging consumers including plugins. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface Logger | ||
``` | ||
|
||
## Methods | ||
|
||
| Method | Description | | ||
| --- | --- | | ||
| [debug(message, meta)](./kibana-plugin-server.logger.debug.md) | Log messages useful for debugging and interactive investigation | | ||
| [error(errorOrMessage, meta)](./kibana-plugin-server.logger.error.md) | Logs abnormal or unexpected errors or messages that caused a failure in the application flow | | ||
| [fatal(errorOrMessage, meta)](./kibana-plugin-server.logger.fatal.md) | Logs abnormal or unexpected errors or messages that caused an unrecoverable failure | | ||
| [info(message, meta)](./kibana-plugin-server.logger.info.md) | Logs messages related to general application flow | | ||
| [trace(message, meta)](./kibana-plugin-server.logger.trace.md) | Log messages at the most detailed log level | | ||
| [warn(errorOrMessage, meta)](./kibana-plugin-server.logger.warn.md) | Logs abnormal or unexpected errors or messages | | ||
|
23 changes: 23 additions & 0 deletions
23
docs/development/core/server/kibana-plugin-server.logger.trace.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [Logger](./kibana-plugin-server.logger.md) > [trace](./kibana-plugin-server.logger.trace.md) | ||
|
||
## Logger.trace() method | ||
|
||
Log messages at the most detailed log level | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
trace(message: string, meta?: LogMeta): void; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| message | <code>string</code> | The log message | | ||
| meta | <code>LogMeta</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`void` | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does
Modifiers
mean? Do we need to render it if the column is empty?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems to be things like
@sealed
,@virtual
&@override
.