LoggerFactory
interface is to define a way to retrieve a context-based logger instance. |
| [LogMeta](./kibana-plugin-server.logmeta.md) | Contextual metadata |
+| [MetricsServiceSetup](./kibana-plugin-server.metricsservicesetup.md) | APIs to retrieves metrics gathered and exposed by the core platform. |
| [OnPostAuthToolkit](./kibana-plugin-server.onpostauthtoolkit.md) | A tool set defining an outcome of OnPostAuth interceptor for incoming request. |
| [OnPreAuthToolkit](./kibana-plugin-server.onpreauthtoolkit.md) | A tool set defining an outcome of OnPreAuth interceptor for incoming request. |
| [OnPreResponseExtensions](./kibana-plugin-server.onpreresponseextensions.md) | Additional data to extend a response. |
| [OnPreResponseInfo](./kibana-plugin-server.onpreresponseinfo.md) | Response status code. |
| [OnPreResponseToolkit](./kibana-plugin-server.onpreresponsetoolkit.md) | A tool set defining an outcome of OnPreAuth interceptor for incoming request. |
+| [OpsMetrics](./kibana-plugin-server.opsmetrics.md) | Regroups metrics gathered by all the collectors. This contains metrics about the os/runtime, the kibana process and the http server. |
+| [OpsOsMetrics](./kibana-plugin-server.opsosmetrics.md) | OS related metrics |
+| [OpsProcessMetrics](./kibana-plugin-server.opsprocessmetrics.md) | Process related metrics |
+| [OpsServerMetrics](./kibana-plugin-server.opsservermetrics.md) | server related metrics |
| [PackageInfo](./kibana-plugin-server.packageinfo.md) | |
| [Plugin](./kibana-plugin-server.plugin.md) | The interface that should be returned by a PluginInitializer
. |
| [PluginConfigDescriptor](./kibana-plugin-server.pluginconfigdescriptor.md) | Describes a plugin configuration properties. |
diff --git a/docs/development/core/server/kibana-plugin-server.metricsservicesetup.getopsmetrics_.md b/docs/development/core/server/kibana-plugin-server.metricsservicesetup.getopsmetrics_.md
new file mode 100644
index 0000000000000..454b8c905451e
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.metricsservicesetup.getopsmetrics_.md
@@ -0,0 +1,24 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [MetricsServiceSetup](./kibana-plugin-server.metricsservicesetup.md) > [getOpsMetrics$](./kibana-plugin-server.metricsservicesetup.getopsmetrics_.md)
+
+## MetricsServiceSetup.getOpsMetrics$ property
+
+Retrieve an observable emitting the [OpsMetrics](./kibana-plugin-server.opsmetrics.md) gathered. The observable will emit an initial value during core's `start` phase, and a new value every fixed interval of time, based on the `opts.interval` configuration property.
+
+Signature:
+
+```typescript
+getOpsMetrics$: () => Observable() => Observable<OpsMetrics>
| Retrieve an observable emitting the [OpsMetrics](./kibana-plugin-server.opsmetrics.md) gathered. The observable will emit an initial value during core's start
phase, and a new value every fixed interval of time, based on the opts.interval
configuration property. |
+
diff --git a/docs/development/core/server/kibana-plugin-server.opsmetrics.concurrent_connections.md b/docs/development/core/server/kibana-plugin-server.opsmetrics.concurrent_connections.md
new file mode 100644
index 0000000000000..cfd39a551ad34
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsmetrics.concurrent_connections.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsMetrics](./kibana-plugin-server.opsmetrics.md) > [concurrent\_connections](./kibana-plugin-server.opsmetrics.concurrent_connections.md)
+
+## OpsMetrics.concurrent\_connections property
+
+number of current concurrent connections to the server
+
+Signature:
+
+```typescript
+concurrent_connections: OpsServerMetrics['concurrent_connections'];
+```
diff --git a/docs/development/core/server/kibana-plugin-server.opsmetrics.md b/docs/development/core/server/kibana-plugin-server.opsmetrics.md
new file mode 100644
index 0000000000000..e23bd8d431d3f
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsmetrics.md
@@ -0,0 +1,24 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsMetrics](./kibana-plugin-server.opsmetrics.md)
+
+## OpsMetrics interface
+
+Regroups metrics gathered by all the collectors. This contains metrics about the os/runtime, the kibana process and the http server.
+
+Signature:
+
+```typescript
+export interface OpsMetrics
+```
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| [concurrent\_connections](./kibana-plugin-server.opsmetrics.concurrent_connections.md) | OpsServerMetrics['concurrent_connections']
| number of current concurrent connections to the server |
+| [os](./kibana-plugin-server.opsmetrics.os.md) | OpsOsMetrics
| OS related metrics |
+| [process](./kibana-plugin-server.opsmetrics.process.md) | OpsProcessMetrics
| Process related metrics |
+| [requests](./kibana-plugin-server.opsmetrics.requests.md) | OpsServerMetrics['requests']
| server requests stats |
+| [response\_times](./kibana-plugin-server.opsmetrics.response_times.md) | OpsServerMetrics['response_times']
| server response time stats |
+
diff --git a/docs/development/core/server/kibana-plugin-server.opsmetrics.os.md b/docs/development/core/server/kibana-plugin-server.opsmetrics.os.md
new file mode 100644
index 0000000000000..993a1d7a2d7b7
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsmetrics.os.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsMetrics](./kibana-plugin-server.opsmetrics.md) > [os](./kibana-plugin-server.opsmetrics.os.md)
+
+## OpsMetrics.os property
+
+OS related metrics
+
+Signature:
+
+```typescript
+os: OpsOsMetrics;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.opsmetrics.process.md b/docs/development/core/server/kibana-plugin-server.opsmetrics.process.md
new file mode 100644
index 0000000000000..53d3a33d66e06
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsmetrics.process.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsMetrics](./kibana-plugin-server.opsmetrics.md) > [process](./kibana-plugin-server.opsmetrics.process.md)
+
+## OpsMetrics.process property
+
+Process related metrics
+
+Signature:
+
+```typescript
+process: OpsProcessMetrics;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.opsmetrics.requests.md b/docs/development/core/server/kibana-plugin-server.opsmetrics.requests.md
new file mode 100644
index 0000000000000..9cd6b85e507f0
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsmetrics.requests.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsMetrics](./kibana-plugin-server.opsmetrics.md) > [requests](./kibana-plugin-server.opsmetrics.requests.md)
+
+## OpsMetrics.requests property
+
+server requests stats
+
+Signature:
+
+```typescript
+requests: OpsServerMetrics['requests'];
+```
diff --git a/docs/development/core/server/kibana-plugin-server.opsmetrics.response_times.md b/docs/development/core/server/kibana-plugin-server.opsmetrics.response_times.md
new file mode 100644
index 0000000000000..358699071b1c3
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsmetrics.response_times.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsMetrics](./kibana-plugin-server.opsmetrics.md) > [response\_times](./kibana-plugin-server.opsmetrics.response_times.md)
+
+## OpsMetrics.response\_times property
+
+server response time stats
+
+Signature:
+
+```typescript
+response_times: OpsServerMetrics['response_times'];
+```
diff --git a/docs/development/core/server/kibana-plugin-server.opsosmetrics.distro.md b/docs/development/core/server/kibana-plugin-server.opsosmetrics.distro.md
new file mode 100644
index 0000000000000..338164f173d02
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsosmetrics.distro.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsOsMetrics](./kibana-plugin-server.opsosmetrics.md) > [distro](./kibana-plugin-server.opsosmetrics.distro.md)
+
+## OpsOsMetrics.distro property
+
+The os distrib. Only present for linux platforms
+
+Signature:
+
+```typescript
+distro?: string;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.opsosmetrics.distrorelease.md b/docs/development/core/server/kibana-plugin-server.opsosmetrics.distrorelease.md
new file mode 100644
index 0000000000000..24c5a1f00b64c
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsosmetrics.distrorelease.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsOsMetrics](./kibana-plugin-server.opsosmetrics.md) > [distroRelease](./kibana-plugin-server.opsosmetrics.distrorelease.md)
+
+## OpsOsMetrics.distroRelease property
+
+The os distrib release, prefixed by the os distrib. Only present for linux platforms
+
+Signature:
+
+```typescript
+distroRelease?: string;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.opsosmetrics.load.md b/docs/development/core/server/kibana-plugin-server.opsosmetrics.load.md
new file mode 100644
index 0000000000000..0bf17502ce34e
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsosmetrics.load.md
@@ -0,0 +1,17 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsOsMetrics](./kibana-plugin-server.opsosmetrics.md) > [load](./kibana-plugin-server.opsosmetrics.load.md)
+
+## OpsOsMetrics.load property
+
+cpu load metrics
+
+Signature:
+
+```typescript
+load: {
+ '1m': number;
+ '5m': number;
+ '15m': number;
+ };
+```
diff --git a/docs/development/core/server/kibana-plugin-server.opsosmetrics.md b/docs/development/core/server/kibana-plugin-server.opsosmetrics.md
new file mode 100644
index 0000000000000..0fb4e59fdf539
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsosmetrics.md
@@ -0,0 +1,26 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsOsMetrics](./kibana-plugin-server.opsosmetrics.md)
+
+## OpsOsMetrics interface
+
+OS related metrics
+
+Signature:
+
+```typescript
+export interface OpsOsMetrics
+```
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| [distro](./kibana-plugin-server.opsosmetrics.distro.md) | string
| The os distrib. Only present for linux platforms |
+| [distroRelease](./kibana-plugin-server.opsosmetrics.distrorelease.md) | string
| The os distrib release, prefixed by the os distrib. Only present for linux platforms |
+| [load](./kibana-plugin-server.opsosmetrics.load.md) | {
'1m': number;
'5m': number;
'15m': number;
}
| cpu load metrics |
+| [memory](./kibana-plugin-server.opsosmetrics.memory.md) | {
total_in_bytes: number;
free_in_bytes: number;
used_in_bytes: number;
}
| system memory usage metrics |
+| [platform](./kibana-plugin-server.opsosmetrics.platform.md) | NodeJS.Platform
| The os platform |
+| [platformRelease](./kibana-plugin-server.opsosmetrics.platformrelease.md) | string
| The os platform release, prefixed by the platform name |
+| [uptime\_in\_millis](./kibana-plugin-server.opsosmetrics.uptime_in_millis.md) | number
| the OS uptime |
+
diff --git a/docs/development/core/server/kibana-plugin-server.opsosmetrics.memory.md b/docs/development/core/server/kibana-plugin-server.opsosmetrics.memory.md
new file mode 100644
index 0000000000000..4a1becaeeaec7
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsosmetrics.memory.md
@@ -0,0 +1,17 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsOsMetrics](./kibana-plugin-server.opsosmetrics.md) > [memory](./kibana-plugin-server.opsosmetrics.memory.md)
+
+## OpsOsMetrics.memory property
+
+system memory usage metrics
+
+Signature:
+
+```typescript
+memory: {
+ total_in_bytes: number;
+ free_in_bytes: number;
+ used_in_bytes: number;
+ };
+```
diff --git a/docs/development/core/server/kibana-plugin-server.opsosmetrics.platform.md b/docs/development/core/server/kibana-plugin-server.opsosmetrics.platform.md
new file mode 100644
index 0000000000000..411d0fc546dc0
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsosmetrics.platform.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsOsMetrics](./kibana-plugin-server.opsosmetrics.md) > [platform](./kibana-plugin-server.opsosmetrics.platform.md)
+
+## OpsOsMetrics.platform property
+
+The os platform
+
+Signature:
+
+```typescript
+platform: NodeJS.Platform;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.opsosmetrics.platformrelease.md b/docs/development/core/server/kibana-plugin-server.opsosmetrics.platformrelease.md
new file mode 100644
index 0000000000000..1071b4a38f588
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsosmetrics.platformrelease.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsOsMetrics](./kibana-plugin-server.opsosmetrics.md) > [platformRelease](./kibana-plugin-server.opsosmetrics.platformrelease.md)
+
+## OpsOsMetrics.platformRelease property
+
+The os platform release, prefixed by the platform name
+
+Signature:
+
+```typescript
+platformRelease: string;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.opsosmetrics.uptime_in_millis.md b/docs/development/core/server/kibana-plugin-server.opsosmetrics.uptime_in_millis.md
new file mode 100644
index 0000000000000..dfff1a1f1da0b
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsosmetrics.uptime_in_millis.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsOsMetrics](./kibana-plugin-server.opsosmetrics.md) > [uptime\_in\_millis](./kibana-plugin-server.opsosmetrics.uptime_in_millis.md)
+
+## OpsOsMetrics.uptime\_in\_millis property
+
+the OS uptime
+
+Signature:
+
+```typescript
+uptime_in_millis: number;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.opsprocessmetrics.event_loop_delay.md b/docs/development/core/server/kibana-plugin-server.opsprocessmetrics.event_loop_delay.md
new file mode 100644
index 0000000000000..f61c8b0995324
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsprocessmetrics.event_loop_delay.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsProcessMetrics](./kibana-plugin-server.opsprocessmetrics.md) > [event\_loop\_delay](./kibana-plugin-server.opsprocessmetrics.event_loop_delay.md)
+
+## OpsProcessMetrics.event\_loop\_delay property
+
+node event loop delay
+
+Signature:
+
+```typescript
+event_loop_delay: number;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.opsprocessmetrics.md b/docs/development/core/server/kibana-plugin-server.opsprocessmetrics.md
new file mode 100644
index 0000000000000..92fd8471cce7d
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsprocessmetrics.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsProcessMetrics](./kibana-plugin-server.opsprocessmetrics.md)
+
+## OpsProcessMetrics interface
+
+Process related metrics
+
+Signature:
+
+```typescript
+export interface OpsProcessMetrics
+```
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| [event\_loop\_delay](./kibana-plugin-server.opsprocessmetrics.event_loop_delay.md) | number
| node event loop delay |
+| [memory](./kibana-plugin-server.opsprocessmetrics.memory.md) | {
heap: {
total_in_bytes: number;
used_in_bytes: number;
size_limit: number;
};
resident_set_size_in_bytes: number;
}
| process memory usage |
+| [pid](./kibana-plugin-server.opsprocessmetrics.pid.md) | number
| pid of the kibana process |
+| [uptime\_in\_millis](./kibana-plugin-server.opsprocessmetrics.uptime_in_millis.md) | number
| uptime of the kibana process |
+
diff --git a/docs/development/core/server/kibana-plugin-server.opsprocessmetrics.memory.md b/docs/development/core/server/kibana-plugin-server.opsprocessmetrics.memory.md
new file mode 100644
index 0000000000000..5c1a8de70dc01
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsprocessmetrics.memory.md
@@ -0,0 +1,20 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsProcessMetrics](./kibana-plugin-server.opsprocessmetrics.md) > [memory](./kibana-plugin-server.opsprocessmetrics.memory.md)
+
+## OpsProcessMetrics.memory property
+
+process memory usage
+
+Signature:
+
+```typescript
+memory: {
+ heap: {
+ total_in_bytes: number;
+ used_in_bytes: number;
+ size_limit: number;
+ };
+ resident_set_size_in_bytes: number;
+ };
+```
diff --git a/docs/development/core/server/kibana-plugin-server.opsprocessmetrics.pid.md b/docs/development/core/server/kibana-plugin-server.opsprocessmetrics.pid.md
new file mode 100644
index 0000000000000..a34187f372018
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsprocessmetrics.pid.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsProcessMetrics](./kibana-plugin-server.opsprocessmetrics.md) > [pid](./kibana-plugin-server.opsprocessmetrics.pid.md)
+
+## OpsProcessMetrics.pid property
+
+pid of the kibana process
+
+Signature:
+
+```typescript
+pid: number;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.opsprocessmetrics.uptime_in_millis.md b/docs/development/core/server/kibana-plugin-server.opsprocessmetrics.uptime_in_millis.md
new file mode 100644
index 0000000000000..24db2f017a663
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsprocessmetrics.uptime_in_millis.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsProcessMetrics](./kibana-plugin-server.opsprocessmetrics.md) > [uptime\_in\_millis](./kibana-plugin-server.opsprocessmetrics.uptime_in_millis.md)
+
+## OpsProcessMetrics.uptime\_in\_millis property
+
+uptime of the kibana process
+
+Signature:
+
+```typescript
+uptime_in_millis: number;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.opsservermetrics.concurrent_connections.md b/docs/development/core/server/kibana-plugin-server.opsservermetrics.concurrent_connections.md
new file mode 100644
index 0000000000000..ade79fedfa1b5
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsservermetrics.concurrent_connections.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsServerMetrics](./kibana-plugin-server.opsservermetrics.md) > [concurrent\_connections](./kibana-plugin-server.opsservermetrics.concurrent_connections.md)
+
+## OpsServerMetrics.concurrent\_connections property
+
+number of current concurrent connections to the server
+
+Signature:
+
+```typescript
+concurrent_connections: number;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.opsservermetrics.md b/docs/development/core/server/kibana-plugin-server.opsservermetrics.md
new file mode 100644
index 0000000000000..4e35c02bd9f28
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsservermetrics.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsServerMetrics](./kibana-plugin-server.opsservermetrics.md)
+
+## OpsServerMetrics interface
+
+server related metrics
+
+Signature:
+
+```typescript
+export interface OpsServerMetrics
+```
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| [concurrent\_connections](./kibana-plugin-server.opsservermetrics.concurrent_connections.md) | number
| number of current concurrent connections to the server |
+| [requests](./kibana-plugin-server.opsservermetrics.requests.md) | {
disconnects: number;
total: number;
statusCodes: Record<number, number>;
}
| server requests stats |
+| [response\_times](./kibana-plugin-server.opsservermetrics.response_times.md) | {
avg_in_millis: number;
max_in_millis: number;
}
| server response time stats |
+
diff --git a/docs/development/core/server/kibana-plugin-server.opsservermetrics.requests.md b/docs/development/core/server/kibana-plugin-server.opsservermetrics.requests.md
new file mode 100644
index 0000000000000..5ad2abc869557
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.opsservermetrics.requests.md
@@ -0,0 +1,17 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [OpsServerMetrics](./kibana-plugin-server.opsservermetrics.md) > [requests](./kibana-plugin-server.opsservermetrics.requests.md)
+
+## OpsServerMetrics.requests property
+
+server requests stats
+
+Signature:
+
+```typescript
+requests: {
+ disconnects: number;
+ total: number;
+ statusCodes: Record