Skip to content

Commit c8bcabb

Browse files
committed
Merge branch 'master' of github.com:elastic/kibana into feature-share-policy-action
2 parents 664dc85 + 49a0035 commit c8bcabb

File tree

1,287 files changed

+40192
-38592
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,287 files changed

+40192
-38592
lines changed

docs/apm/troubleshooting.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ GET /_template/apm-{version}
4949
*Using Logstash, Kafka, etc.*
5050
If you're not outputting data directly from APM Server to Elasticsearch (perhaps you're using Logstash or Kafka),
5151
then the index template will not be set up automatically. Instead, you'll need to
52-
{apm-server-ref}/_manually_loading_template_configuration.html[load the template manually].
52+
{apm-server-ref}/configuration-template.html[load the template manually].
5353

5454
*Using a custom index names*
5555
This problem can also occur if you've customized the index name that you write APM data to.

docs/development/core/server/kibana-plugin-core-server.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
2828
| [SavedObjectsErrorHelpers](./kibana-plugin-core-server.savedobjectserrorhelpers.md) | |
2929
| [SavedObjectsRepository](./kibana-plugin-core-server.savedobjectsrepository.md) | |
3030
| [SavedObjectsSerializer](./kibana-plugin-core-server.savedobjectsserializer.md) | A serializer that can be used to manually convert [raw](./kibana-plugin-core-server.savedobjectsrawdoc.md) or [sanitized](./kibana-plugin-core-server.savedobjectsanitizeddoc.md) documents to the other kind. |
31+
| [SavedObjectsUtils](./kibana-plugin-core-server.savedobjectsutils.md) | |
3132
| [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) | Registry holding information about all the registered [saved object types](./kibana-plugin-core-server.savedobjectstype.md)<!-- -->. |
3233

3334
## Enumerations
@@ -123,7 +124,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
123124
| [LoggerFactory](./kibana-plugin-core-server.loggerfactory.md) | The single purpose of <code>LoggerFactory</code> interface is to define a way to retrieve a context-based logger instance. |
124125
| [LoggingServiceSetup](./kibana-plugin-core-server.loggingservicesetup.md) | Provides APIs to plugins for customizing the plugin's logger. |
125126
| [LogMeta](./kibana-plugin-core-server.logmeta.md) | Contextual metadata |
126-
| [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) | |
127+
| [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) | APIs to retrieves metrics gathered and exposed by the core platform. |
127128
| [NodesVersionCompatibility](./kibana-plugin-core-server.nodesversioncompatibility.md) | |
128129
| [OnPostAuthToolkit](./kibana-plugin-core-server.onpostauthtoolkit.md) | A tool set defining an outcome of OnPostAuth interceptor for incoming request. |
129130
| [OnPreAuthToolkit](./kibana-plugin-core-server.onpreauthtoolkit.md) | A tool set defining an outcome of OnPreAuth interceptor for incoming request. |
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) &gt; [collectionInterval](./kibana-plugin-core-server.metricsservicesetup.collectioninterval.md)
4+
5+
## MetricsServiceSetup.collectionInterval property
6+
7+
Interval metrics are collected in milliseconds
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
readonly collectionInterval: number;
13+
```
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) &gt; [getOpsMetrics$](./kibana-plugin-core-server.metricsservicesetup.getopsmetrics_.md)
4+
5+
## MetricsServiceSetup.getOpsMetrics$ property
6+
7+
Retrieve an observable emitting the [OpsMetrics](./kibana-plugin-core-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.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
getOpsMetrics$: () => Observable<OpsMetrics>;
13+
```
14+
15+
## Example
16+
17+
18+
```ts
19+
core.metrics.getOpsMetrics$().subscribe(metrics => {
20+
// do something with the metrics
21+
})
22+
23+
```
24+

docs/development/core/server/kibana-plugin-core-server.metricsservicesetup.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,18 @@
44

55
## MetricsServiceSetup interface
66

7+
APIs to retrieves metrics gathered and exposed by the core platform.
8+
79
<b>Signature:</b>
810

911
```typescript
1012
export interface MetricsServiceSetup
1113
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [collectionInterval](./kibana-plugin-core-server.metricsservicesetup.collectioninterval.md) | <code>number</code> | Interval metrics are collected in milliseconds |
20+
| [getOpsMetrics$](./kibana-plugin-core-server.metricsservicesetup.getopsmetrics_.md) | <code>() =&gt; Observable&lt;OpsMetrics&gt;</code> | Retrieve an observable emitting the [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) gathered. The observable will emit an initial value during core's <code>start</code> phase, and a new value every fixed interval of time, based on the <code>opts.interval</code> configuration property. |
21+
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [OpsMetrics](./kibana-plugin-core-server.opsmetrics.md) &gt; [collected\_at](./kibana-plugin-core-server.opsmetrics.collected_at.md)
4+
5+
## OpsMetrics.collected\_at property
6+
7+
Time metrics were recorded at.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
collected_at: Date;
13+
```

docs/development/core/server/kibana-plugin-core-server.opsmetrics.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ export interface OpsMetrics
1616

1717
| Property | Type | Description |
1818
| --- | --- | --- |
19+
| [collected\_at](./kibana-plugin-core-server.opsmetrics.collected_at.md) | <code>Date</code> | Time metrics were recorded at. |
1920
| [concurrent\_connections](./kibana-plugin-core-server.opsmetrics.concurrent_connections.md) | <code>OpsServerMetrics['concurrent_connections']</code> | number of current concurrent connections to the server |
2021
| [os](./kibana-plugin-core-server.opsmetrics.os.md) | <code>OpsOsMetrics</code> | OS related metrics |
2122
| [process](./kibana-plugin-core-server.opsmetrics.process.md) | <code>OpsProcessMetrics</code> | Process related metrics |
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) &gt; [cpu](./kibana-plugin-core-server.opsosmetrics.cpu.md)
4+
5+
## OpsOsMetrics.cpu property
6+
7+
cpu cgroup metrics, undefined when not running in a cgroup
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
cpu?: {
13+
control_group: string;
14+
cfs_period_micros: number;
15+
cfs_quota_micros: number;
16+
stat: {
17+
number_of_elapsed_periods: number;
18+
number_of_times_throttled: number;
19+
time_throttled_nanos: number;
20+
};
21+
};
22+
```
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [OpsOsMetrics](./kibana-plugin-core-server.opsosmetrics.md) &gt; [cpuacct](./kibana-plugin-core-server.opsosmetrics.cpuacct.md)
4+
5+
## OpsOsMetrics.cpuacct property
6+
7+
cpu accounting metrics, undefined when not running in a cgroup
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
cpuacct?: {
13+
control_group: string;
14+
usage_nanos: number;
15+
};
16+
```

docs/development/core/server/kibana-plugin-core-server.opsosmetrics.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ export interface OpsOsMetrics
1616

1717
| Property | Type | Description |
1818
| --- | --- | --- |
19+
| [cpu](./kibana-plugin-core-server.opsosmetrics.cpu.md) | <code>{</code><br/><code> control_group: string;</code><br/><code> cfs_period_micros: number;</code><br/><code> cfs_quota_micros: number;</code><br/><code> stat: {</code><br/><code> number_of_elapsed_periods: number;</code><br/><code> number_of_times_throttled: number;</code><br/><code> time_throttled_nanos: number;</code><br/><code> };</code><br/><code> }</code> | cpu cgroup metrics, undefined when not running in a cgroup |
20+
| [cpuacct](./kibana-plugin-core-server.opsosmetrics.cpuacct.md) | <code>{</code><br/><code> control_group: string;</code><br/><code> usage_nanos: number;</code><br/><code> }</code> | cpu accounting metrics, undefined when not running in a cgroup |
1921
| [distro](./kibana-plugin-core-server.opsosmetrics.distro.md) | <code>string</code> | The os distrib. Only present for linux platforms |
2022
| [distroRelease](./kibana-plugin-core-server.opsosmetrics.distrorelease.md) | <code>string</code> | The os distrib release, prefixed by the os distrib. Only present for linux platforms |
2123
| [load](./kibana-plugin-core-server.opsosmetrics.load.md) | <code>{</code><br/><code> '1m': number;</code><br/><code> '5m': number;</code><br/><code> '15m': number;</code><br/><code> }</code> | cpu load metrics |

0 commit comments

Comments
 (0)