Skip to content

Commit d511bb2

Browse files
move Metrics API to start (#69787)
* move metrics to start * update plugins accordingly * update docs * update legacy code Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
1 parent 3e7c380 commit d511bb2

24 files changed

+98
-133
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/index.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ import {
6060
} from './saved_objects';
6161
import { CapabilitiesSetup, CapabilitiesStart } from './capabilities';
6262
import { UuidServiceSetup } from './uuid';
63-
import { MetricsServiceSetup } from './metrics';
63+
import { MetricsServiceStart } from './metrics';
6464
import { StatusServiceSetup } from './status';
6565
import {
6666
LoggingServiceSetup,
@@ -403,8 +403,6 @@ export interface CoreSetup<TPluginsStart extends object = object, TStart = unkno
403403
};
404404
/** {@link LoggingServiceSetup} */
405405
logging: LoggingServiceSetup;
406-
/** {@link MetricsServiceSetup} */
407-
metrics: MetricsServiceSetup;
408406
/** {@link SavedObjectsServiceSetup} */
409407
savedObjects: SavedObjectsServiceSetup;
410408
/** {@link StatusServiceSetup} */
@@ -442,6 +440,8 @@ export interface CoreStart {
442440
elasticsearch: ElasticsearchServiceStart;
443441
/** {@link HttpServiceStart} */
444442
http: HttpServiceStart;
443+
/** {@link MetricsServiceStart} */
444+
metrics: MetricsServiceStart;
445445
/** {@link SavedObjectsServiceStart} */
446446
savedObjects: SavedObjectsServiceStart;
447447
/** {@link UiSettingsServiceStart} */

src/core/server/internal_types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import {
3030
} from './saved_objects';
3131
import { InternalUiSettingsServiceSetup, InternalUiSettingsServiceStart } from './ui_settings';
3232
import { UuidServiceSetup } from './uuid';
33-
import { InternalMetricsServiceSetup } from './metrics';
33+
import { InternalMetricsServiceStart } from './metrics';
3434
import { InternalRenderingServiceSetup } from './rendering';
3535
import { InternalHttpResourcesSetup } from './http_resources';
3636
import { InternalStatusServiceSetup } from './status';
@@ -42,7 +42,6 @@ export interface InternalCoreSetup {
4242
context: ContextSetup;
4343
http: InternalHttpServiceSetup;
4444
elasticsearch: InternalElasticsearchServiceSetup;
45-
metrics: InternalMetricsServiceSetup;
4645
savedObjects: InternalSavedObjectsServiceSetup;
4746
status: InternalStatusServiceSetup;
4847
uiSettings: InternalUiSettingsServiceSetup;
@@ -59,6 +58,7 @@ export interface InternalCoreStart {
5958
capabilities: CapabilitiesStart;
6059
elasticsearch: ElasticsearchServiceStart;
6160
http: InternalHttpServiceStart;
61+
metrics: InternalMetricsServiceStart;
6262
savedObjects: InternalSavedObjectsServiceStart;
6363
uiSettings: InternalUiSettingsServiceStart;
6464
}

src/core/server/legacy/legacy_service.test.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ import { capabilitiesServiceMock } from '../capabilities/capabilities_service.mo
4747
import { httpResourcesMock } from '../http_resources/http_resources_service.mock';
4848
import { setupMock as renderingServiceMock } from '../rendering/__mocks__/rendering_service';
4949
import { uuidServiceMock } from '../uuid/uuid_service.mock';
50-
import { metricsServiceMock } from '../metrics/metrics_service.mock';
5150
import { findLegacyPluginSpecs } from './plugins';
5251
import { LegacyVars, LegacyServiceSetupDeps, LegacyServiceStartDeps } from './types';
5352
import { LegacyService } from './legacy_service';
@@ -98,7 +97,6 @@ beforeEach(() => {
9897
contracts: new Map([['plugin-id', 'plugin-value']]),
9998
},
10099
rendering: renderingServiceMock,
101-
metrics: metricsServiceMock.createInternalSetupContract(),
102100
uuid: uuidSetup,
103101
status: statusServiceMock.createInternalSetupContract(),
104102
logging: loggingServiceMock.createInternalSetupContract(),

0 commit comments

Comments
 (0)