Skip to content

Commit a0f4a60

Browse files
committed
[Server] Fix types and documentation
1 parent 46f799d commit a0f4a60

File tree

47 files changed

+673
-52
lines changed

Some content is hidden

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

47 files changed

+673
-52
lines changed

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

+1
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,6 @@ export interface CoreSetup<TPluginsStart extends object = object, TStart = unkno
2525
| [savedObjects](./kibana-plugin-core-server.coresetup.savedobjects.md) | <code>SavedObjectsServiceSetup</code> | [SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) |
2626
| [status](./kibana-plugin-core-server.coresetup.status.md) | <code>StatusServiceSetup</code> | [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) |
2727
| [uiSettings](./kibana-plugin-core-server.coresetup.uisettings.md) | <code>UiSettingsServiceSetup</code> | [UiSettingsServiceSetup](./kibana-plugin-core-server.uisettingsservicesetup.md) |
28+
| [usageCollection](./kibana-plugin-core-server.coresetup.usagecollection.md) | <code>UsageCollectionSetup</code> | [UsageCollectionSetup](./kibana-plugin-core-server.usagecollectionsetup.md) |
2829
| [uuid](./kibana-plugin-core-server.coresetup.uuid.md) | <code>UuidServiceSetup</code> | [UuidServiceSetup](./kibana-plugin-core-server.uuidservicesetup.md) |
2930

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; [CoreSetup](./kibana-plugin-core-server.coresetup.md) &gt; [usageCollection](./kibana-plugin-core-server.coresetup.usagecollection.md)
4+
5+
## CoreSetup.usageCollection property
6+
7+
[UsageCollectionSetup](./kibana-plugin-core-server.usagecollectionsetup.md)
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
usageCollection: UsageCollectionSetup;
13+
```

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

+8
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
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. |
3131
| [SavedObjectTypeRegistry](./kibana-plugin-core-server.savedobjecttyperegistry.md) | Registry holding information about all the registered [saved object types](./kibana-plugin-core-server.savedobjectstype.md)<!-- -->. |
32+
| [UsageCollectionCollector](./kibana-plugin-core-server.usagecollectioncollector.md) | Collector for reporting system stats |
33+
| [UsageCollectionUsageCollector](./kibana-plugin-core-server.usagecollectionusagecollector.md) | Collector for reporting Usage stats |
3234

3335
## Enumerations
3436

@@ -196,6 +198,8 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
196198
| [UiSettingsServiceSetup](./kibana-plugin-core-server.uisettingsservicesetup.md) | |
197199
| [UiSettingsServiceStart](./kibana-plugin-core-server.uisettingsservicestart.md) | |
198200
| [URLMeaningfulParts](./kibana-plugin-core-server.urlmeaningfulparts.md) | We define our own typings because the current version of @<!-- -->types/node declares properties to be optional "hostname?: string". Although, parse call returns "hostname: null \| string". |
201+
| [UsageCollectionCollectorOptions](./kibana-plugin-core-server.usagecollectioncollectoroptions.md) | Collector definition |
202+
| [UsageCollectionCollectorSet](./kibana-plugin-core-server.usagecollectioncollectorset.md) | |
199203
| [UserProvidedValues](./kibana-plugin-core-server.userprovidedvalues.md) | Describes the values explicitly set by user. |
200204
| [UuidServiceSetup](./kibana-plugin-core-server.uuidservicesetup.md) | APIs to access the application's instance uuid. |
201205

@@ -289,4 +293,8 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
289293
| [StartServicesAccessor](./kibana-plugin-core-server.startservicesaccessor.md) | Allows plugins to get access to APIs available in start inside async handlers. Promise will not resolve until Core and plugin dependencies have completed <code>start</code>. This should only be used inside handlers registered during <code>setup</code> that will only be executed after <code>start</code> lifecycle. |
290294
| [StringValidation](./kibana-plugin-core-server.stringvalidation.md) | Allows regex objects or a regex string |
291295
| [UiSettingsType](./kibana-plugin-core-server.uisettingstype.md) | UI element type to represent the settings. |
296+
| [UsageCollectionAllowedSchemaTypes](./kibana-plugin-core-server.usagecollectionallowedschematypes.md) | Allowed types in the schema definition |
297+
| [UsageCollectionMakeSchemaFrom](./kibana-plugin-core-server.usagecollectionmakeschemafrom.md) | Schema definition of the returned object in the fetch method |
298+
| [UsageCollectionPurify](./kibana-plugin-core-server.usagecollectionpurify.md) | |
299+
| [UsageCollectionSetup](./kibana-plugin-core-server.usagecollectionsetup.md) | |
292300

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; [UsageCollectionAllowedSchemaTypes](./kibana-plugin-core-server.usagecollectionallowedschematypes.md)
4+
5+
## UsageCollectionAllowedSchemaTypes type
6+
7+
Allowed types in the schema definition
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export declare type AllowedSchemaTypes = 'keyword' | 'text' | 'number' | 'boolean' | 'long' | 'date' | 'float';
13+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
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; [UsageCollectionCollector](./kibana-plugin-core-server.usagecollectioncollector.md) &gt; [(constructor)](./kibana-plugin-core-server.usagecollectioncollector._constructor_.md)
4+
5+
## UsageCollectionCollector.(constructor)
6+
7+
Constructs a new instance of the `Collector` class
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
constructor(log: Logger, { type, init, fetch, formatForBulkUpload, isReady, ...options }: CollectorOptions<T, U>);
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| log | <code>Logger</code> | |
20+
| { type, init, fetch, formatForBulkUpload, isReady, ...options } | <code>CollectorOptions&lt;T, U&gt;</code> | |
21+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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; [UsageCollectionCollector](./kibana-plugin-core-server.usagecollectioncollector.md) &gt; [fetch](./kibana-plugin-core-server.usagecollectioncollector.fetch.md)
4+
5+
## UsageCollectionCollector.fetch property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
readonly fetch: CollectorOptions<T, U>['fetch'];
11+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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; [UsageCollectionCollector](./kibana-plugin-core-server.usagecollectioncollector.md) &gt; [init](./kibana-plugin-core-server.usagecollectioncollector.init.md)
4+
5+
## UsageCollectionCollector.init property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
readonly init?: CollectorOptions<T, U>['init'];
11+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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; [UsageCollectionCollector](./kibana-plugin-core-server.usagecollectioncollector.md) &gt; [isReady](./kibana-plugin-core-server.usagecollectioncollector.isready.md)
4+
5+
## UsageCollectionCollector.isReady property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
readonly isReady: CollectorOptions<T, U>['isReady'];
11+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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; [UsageCollectionCollector](./kibana-plugin-core-server.usagecollectioncollector.md) &gt; [log](./kibana-plugin-core-server.usagecollectioncollector.log.md)
4+
5+
## UsageCollectionCollector.log property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
protected readonly log: Logger;
11+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
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; [UsageCollectionCollector](./kibana-plugin-core-server.usagecollectioncollector.md)
4+
5+
## UsageCollectionCollector class
6+
7+
Collector for reporting system stats
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export declare class Collector<T = unknown, U = T>
13+
```
14+
15+
## Constructors
16+
17+
| Constructor | Modifiers | Description |
18+
| --- | --- | --- |
19+
| [(constructor)(log, { type, init, fetch, formatForBulkUpload, isReady, ...options })](./kibana-plugin-core-server.usagecollectioncollector._constructor_.md) | | Constructs a new instance of the <code>Collector</code> class |
20+
21+
## Properties
22+
23+
| Property | Modifiers | Type | Description |
24+
| --- | --- | --- | --- |
25+
| [fetch](./kibana-plugin-core-server.usagecollectioncollector.fetch.md) | | <code>CollectorOptions&lt;T, U&gt;['fetch']</code> | |
26+
| [init](./kibana-plugin-core-server.usagecollectioncollector.init.md) | | <code>CollectorOptions&lt;T, U&gt;['init']</code> | |
27+
| [isReady](./kibana-plugin-core-server.usagecollectioncollector.isready.md) | | <code>CollectorOptions&lt;T, U&gt;['isReady']</code> | |
28+
| [log](./kibana-plugin-core-server.usagecollectioncollector.log.md) | | <code>Logger</code> | |
29+
| [type](./kibana-plugin-core-server.usagecollectioncollector.type.md) | | <code>CollectorOptions&lt;T, U&gt;['type']</code> | |
30+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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; [UsageCollectionCollector](./kibana-plugin-core-server.usagecollectioncollector.md) &gt; [type](./kibana-plugin-core-server.usagecollectioncollector.type.md)
4+
5+
## UsageCollectionCollector.type property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
readonly type: CollectorOptions<T, U>['type'];
11+
```
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; [UsageCollectionCollectorOptions](./kibana-plugin-core-server.usagecollectioncollectoroptions.md) &gt; [fetch](./kibana-plugin-core-server.usagecollectioncollectoroptions.fetch.md)
4+
5+
## UsageCollectionCollectorOptions.fetch property
6+
7+
Method to fetch the stats to report. The returned object is embedded in the final telemetry payload
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
fetch: (callCluster: LegacyAPICaller) => Promise<T> | T;
13+
```
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; [UsageCollectionCollectorOptions](./kibana-plugin-core-server.usagecollectioncollectoroptions.md) &gt; [init](./kibana-plugin-core-server.usagecollectioncollectoroptions.init.md)
4+
5+
## UsageCollectionCollectorOptions.init property
6+
7+
Optional init function to set up the collector during startup. Only called once at the time of registering
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
init?: Function;
13+
```
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; [UsageCollectionCollectorOptions](./kibana-plugin-core-server.usagecollectioncollectoroptions.md) &gt; [isReady](./kibana-plugin-core-server.usagecollectioncollectoroptions.isready.md)
4+
5+
## UsageCollectionCollectorOptions.isReady property
6+
7+
A method that must return `true` when ready to report stats.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
isReady: () => Promise<boolean> | boolean;
13+
```
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; [UsageCollectionCollectorOptions](./kibana-plugin-core-server.usagecollectioncollectoroptions.md)
4+
5+
## UsageCollectionCollectorOptions interface
6+
7+
Collector definition
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface CollectorOptions<T = unknown, U = T>
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [fetch](./kibana-plugin-core-server.usagecollectioncollectoroptions.fetch.md) | <code>(callCluster: LegacyAPICaller) =&gt; Promise&lt;T&gt; &#124; T</code> | Method to fetch the stats to report. The returned object is embedded in the final telemetry payload |
20+
| [init](./kibana-plugin-core-server.usagecollectioncollectoroptions.init.md) | <code>Function</code> | Optional init function to set up the collector during startup. Only called once at the time of registering |
21+
| [isReady](./kibana-plugin-core-server.usagecollectioncollectoroptions.isready.md) | <code>() =&gt; Promise&lt;boolean&gt; &#124; boolean</code> | A method that must return <code>true</code> when ready to report stats. |
22+
| [schema](./kibana-plugin-core-server.usagecollectioncollectoroptions.schema.md) | <code>MakeSchemaFrom&lt;T&gt;</code> | Schema definition of the returned object in the fetch method |
23+
| [type](./kibana-plugin-core-server.usagecollectioncollectoroptions.type.md) | <code>string</code> | The name of the collector (it will be reported under stack\_stats.kibana.plugins\[type\]) |
24+
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; [UsageCollectionCollectorOptions](./kibana-plugin-core-server.usagecollectioncollectoroptions.md) &gt; [schema](./kibana-plugin-core-server.usagecollectioncollectoroptions.schema.md)
4+
5+
## UsageCollectionCollectorOptions.schema property
6+
7+
Schema definition of the returned object in the fetch method
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
schema?: MakeSchemaFrom<T>;
13+
```
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; [UsageCollectionCollectorOptions](./kibana-plugin-core-server.usagecollectioncollectoroptions.md) &gt; [type](./kibana-plugin-core-server.usagecollectioncollectoroptions.type.md)
4+
5+
## UsageCollectionCollectorOptions.type property
6+
7+
The name of the collector (it will be reported under stack\_stats.kibana.plugins\[type\])
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
type: string;
13+
```
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; [UsageCollectionCollectorSet](./kibana-plugin-core-server.usagecollectioncollectorset.md) &gt; [makeStatsCollector](./kibana-plugin-core-server.usagecollectioncollectorset.makestatscollector.md)
4+
5+
## UsageCollectionCollectorSet.makeStatsCollector property
6+
7+
Create a Collector to report system stats
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
makeStatsCollector: <T, U>(options: CollectorOptions<T, U>) => Collector<T, U>;
13+
```
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; [UsageCollectionCollectorSet](./kibana-plugin-core-server.usagecollectioncollectorset.md) &gt; [makeUsageCollector](./kibana-plugin-core-server.usagecollectioncollectorset.makeusagecollector.md)
4+
5+
## UsageCollectionCollectorSet.makeUsageCollector property
6+
7+
Create a Collector to report usage stats
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
makeUsageCollector: <T, U = T>(options: CollectorOptions<T, U>) => UsageCollector<T, U>;
13+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
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; [UsageCollectionCollectorSet](./kibana-plugin-core-server.usagecollectioncollectorset.md)
4+
5+
## UsageCollectionCollectorSet interface
6+
7+
8+
<b>Signature:</b>
9+
10+
```typescript
11+
export interface UsageCollectionCollectorSet
12+
```
13+
14+
## Properties
15+
16+
| Property | Type | Description |
17+
| --- | --- | --- |
18+
| [makeStatsCollector](./kibana-plugin-core-server.usagecollectioncollectorset.makestatscollector.md) | <code>&lt;T, U&gt;(options: CollectorOptions&lt;T, U&gt;) =&gt; Collector&lt;T, U&gt;</code> | Create a Collector to report system stats |
19+
| [makeUsageCollector](./kibana-plugin-core-server.usagecollectioncollectorset.makeusagecollector.md) | <code>&lt;T, U = T&gt;(options: CollectorOptions&lt;T, U&gt;) =&gt; UsageCollector&lt;T, U&gt;</code> | Create a Collector to report usage stats |
20+
| [registerCollector](./kibana-plugin-core-server.usagecollectioncollectorset.registercollector.md) | <code>&lt;T, U&gt;(collector: Collector&lt;T, U&gt;) =&gt; void</code> | Register the collector generated by either of the <code>makeStatsCollector</code> or <code>makeUsageCollector</code> methods |
21+
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; [UsageCollectionCollectorSet](./kibana-plugin-core-server.usagecollectioncollectorset.md) &gt; [registerCollector](./kibana-plugin-core-server.usagecollectioncollectorset.registercollector.md)
4+
5+
## UsageCollectionCollectorSet.registerCollector property
6+
7+
Register the collector generated by either of the `makeStatsCollector` or `makeUsageCollector` methods
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
registerCollector: <T, U>(collector: Collector<T, U>) => void;
13+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
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; [UsageCollectionMakeSchemaFrom](./kibana-plugin-core-server.usagecollectionmakeschemafrom.md)
4+
5+
## UsageCollectionMakeSchemaFrom type
6+
7+
Schema definition of the returned object in the fetch method
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export declare type MakeSchemaFrom<Base> = {
13+
[Key in Purify<Extract<keyof Base, string>>]: Base[Key] extends Array<infer U> ? {
14+
type: AllowedSchemaTypes;
15+
} : Base[Key] extends object ? MakeSchemaFrom<Base[Key]> : {
16+
type: AllowedSchemaTypes;
17+
};
18+
};
19+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
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; [UsageCollectionPurify](./kibana-plugin-core-server.usagecollectionpurify.md)
4+
5+
## UsageCollectionPurify type
6+
7+
8+
<b>Signature:</b>
9+
10+
```typescript
11+
export declare type Purify<T extends string> = {
12+
[P in T]: T;
13+
}[T];
14+
```
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; [UsageCollectionSetup](./kibana-plugin-core-server.usagecollectionsetup.md)
4+
5+
## UsageCollectionSetup type
6+
7+
8+
<b>Signature:</b>
9+
10+
```typescript
11+
export declare type UsageCollectionSetup = Pick<UsageCollectionCollectorSet, 'makeStatsCollector' | 'makeUsageCollector' | 'registerCollector' | 'areAllCollectorsReady' | 'bulkFetchUsage' | 'toObject' | 'toApiFieldNames' | 'getFilteredCollectorSet' | 'isUsageCollector' | 'getCollectorByType'>;
12+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
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; [UsageCollectionUsageCollector](./kibana-plugin-core-server.usagecollectionusagecollector.md)
4+
5+
## UsageCollectionUsageCollector class
6+
7+
Collector for reporting Usage stats
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export declare class UsageCollector<T = unknown, U = {
13+
usage: {
14+
[key: string]: T;
15+
};
16+
}> extends Collector<T, U>
17+
```

0 commit comments

Comments
 (0)