Skip to content

Commit 66eae30

Browse files
committed
update docs
1 parent ae1f9be commit 66eae30

8 files changed

+22
-52
lines changed

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ export interface CoreSetup<TPluginsStart extends object = object, TStart = unkno
2222
| [getStartServices](./kibana-plugin-core-server.coresetup.getstartservices.md) | <code>StartServicesAccessor&lt;TPluginsStart, TStart&gt;</code> | [StartServicesAccessor](./kibana-plugin-core-server.startservicesaccessor.md) |
2323
| [http](./kibana-plugin-core-server.coresetup.http.md) | <code>HttpServiceSetup &amp; {</code><br/><code> resources: HttpResources;</code><br/><code> }</code> | [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) |
2424
| [logging](./kibana-plugin-core-server.coresetup.logging.md) | <code>LoggingServiceSetup</code> | [LoggingServiceSetup](./kibana-plugin-core-server.loggingservicesetup.md) |
25-
| [metrics](./kibana-plugin-core-server.coresetup.metrics.md) | <code>MetricsServiceSetup</code> | [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) |
2625
| [savedObjects](./kibana-plugin-core-server.coresetup.savedobjects.md) | <code>SavedObjectsServiceSetup</code> | [SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) |
2726
| [status](./kibana-plugin-core-server.coresetup.status.md) | <code>StatusServiceSetup</code> | [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) |
2827
| [uiSettings](./kibana-plugin-core-server.coresetup.uisettings.md) | <code>UiSettingsServiceSetup</code> | [UiSettingsServiceSetup](./kibana-plugin-core-server.uisettingsservicesetup.md) |

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

Lines changed: 0 additions & 13 deletions
This file was deleted.

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ export interface CoreStart
1919
| [capabilities](./kibana-plugin-core-server.corestart.capabilities.md) | <code>CapabilitiesStart</code> | [CapabilitiesStart](./kibana-plugin-core-server.capabilitiesstart.md) |
2020
| [elasticsearch](./kibana-plugin-core-server.corestart.elasticsearch.md) | <code>ElasticsearchServiceStart</code> | [ElasticsearchServiceStart](./kibana-plugin-core-server.elasticsearchservicestart.md) |
2121
| [http](./kibana-plugin-core-server.corestart.http.md) | <code>HttpServiceStart</code> | [HttpServiceStart](./kibana-plugin-core-server.httpservicestart.md) |
22+
| [metrics](./kibana-plugin-core-server.corestart.metrics.md) | <code>MetricsServiceStart</code> | |
2223
| [savedObjects](./kibana-plugin-core-server.corestart.savedobjects.md) | <code>SavedObjectsServiceStart</code> | [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) |
2324
| [uiSettings](./kibana-plugin-core-server.corestart.uisettings.md) | <code>UiSettingsServiceStart</code> | [UiSettingsServiceStart](./kibana-plugin-core-server.uisettingsservicestart.md) |
2425

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
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; [CoreStart](./kibana-plugin-core-server.corestart.md) &gt; [metrics](./kibana-plugin-core-server.corestart.metrics.md)
4+
5+
## CoreStart.metrics property
6+
7+
8+
<b>Signature:</b>
9+
10+
```typescript
11+
metrics: MetricsServiceStart;
12+
```

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
112112
| [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. |
113113
| [LoggingServiceSetup](./kibana-plugin-core-server.loggingservicesetup.md) | Provides APIs to plugins for customizing the plugin's logger. |
114114
| [LogMeta](./kibana-plugin-core-server.logmeta.md) | Contextual metadata |
115-
| [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) | APIs to retrieves metrics gathered and exposed by the core platform. |
115+
| [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) | |
116116
| [NodesVersionCompatibility](./kibana-plugin-core-server.nodesversioncompatibility.md) | |
117117
| [OnPostAuthToolkit](./kibana-plugin-core-server.onpostauthtoolkit.md) | A tool set defining an outcome of OnPostAuth interceptor for incoming request. |
118118
| [OnPreAuthToolkit](./kibana-plugin-core-server.onpreauthtoolkit.md) | A tool set defining an outcome of OnPreAuth interceptor for incoming request. |

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

Lines changed: 0 additions & 24 deletions
This file was deleted.

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

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

55
## MetricsServiceSetup interface
66

7-
APIs to retrieves metrics gathered and exposed by the core platform.
8-
97
<b>Signature:</b>
108

119
```typescript
1210
export interface MetricsServiceSetup
1311
```
14-
15-
## Properties
16-
17-
| Property | Type | Description |
18-
| --- | --- | --- |
19-
| [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. |
20-

src/core/server/server.api.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -712,8 +712,6 @@ export interface CoreSetup<TPluginsStart extends object = object, TStart = unkno
712712
// (undocumented)
713713
logging: LoggingServiceSetup;
714714
// (undocumented)
715-
metrics: MetricsServiceSetup;
716-
// (undocumented)
717715
savedObjects: SavedObjectsServiceSetup;
718716
// (undocumented)
719717
status: StatusServiceSetup;
@@ -731,6 +729,11 @@ export interface CoreStart {
731729
elasticsearch: ElasticsearchServiceStart;
732730
// (undocumented)
733731
http: HttpServiceStart;
732+
// Warning: (ae-forgotten-export) The symbol "MetricsServiceStart" needs to be exported by the entry point index.d.ts
733+
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "kibana" does not have an export "MetricsServiceStart"
734+
//
735+
// (undocumented)
736+
metrics: MetricsServiceStart;
734737
// (undocumented)
735738
savedObjects: SavedObjectsServiceStart;
736739
// (undocumented)
@@ -1420,9 +1423,10 @@ export interface LogRecord {
14201423
timestamp: Date;
14211424
}
14221425

1423-
// @public
1426+
// Warning: (ae-missing-release-tag) "MetricsServiceSetup" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
1427+
//
1428+
// @public (undocumented)
14241429
export interface MetricsServiceSetup {
1425-
getOpsMetrics$: () => Observable<OpsMetrics>;
14261430
}
14271431

14281432
// @public (undocumented)

0 commit comments

Comments
 (0)