Merge remote-tracking branch 'origin/master' into alerting/audit-logging

Author: thomheymann

docs/developer/getting-started/index.asciidoc

@@ -110,6 +110,20 @@ View all available options by running `yarn start --help`
 
 Read about more advanced options for <<running-kibana-advanced>>.
 
+[discrete]
+=== Install pre-commit hook (optional)
+
+In case you want to run a couple of checks like linting or check the file casing of the files to commit, we provide 
+a way to install a pre-commit hook. To configure it you just need to run the following:
+
+[source,bash]
+----
+node scripts/register_git_hook
+----
+
+After the script completes the pre-commit hook will be created within the file `.git/hooks/pre-commit`.
+If you choose to not install it, don't worry, we still run a quick ci check to provide feedback earliest as we can about the same checks. 
+
 [discrete]
 === Code away!
 

docs/development/core/public/kibana-plugin-core-public.uisettingsparams.md

@@ -19,7 +19,7 @@ export interface UiSettingsParams<T = unknown>
 |  [category](./kibana-plugin-core-public.uisettingsparams.category.md) | <code>string[]</code> | used to group the configured setting in the UI |
 |  [deprecation](./kibana-plugin-core-public.uisettingsparams.deprecation.md) | <code>DeprecationSettings</code> | optional deprecation information. Used to generate a deprecation warning. |
 |  [description](./kibana-plugin-core-public.uisettingsparams.description.md) | <code>string</code> | description provided to a user in UI |
-|  [metric](./kibana-plugin-core-public.uisettingsparams.metric.md) | <code>{</code><br/><code>        type: UiStatsMetricType;</code><br/><code>        name: string;</code><br/><code>    }</code> | Metric to track once this property changes |
+|  [metric](./kibana-plugin-core-public.uisettingsparams.metric.md) | <code>{</code><br/><code>        type: UiCounterMetricType;</code><br/><code>        name: string;</code><br/><code>    }</code> | Metric to track once this property changes |
 |  [name](./kibana-plugin-core-public.uisettingsparams.name.md) | <code>string</code> | title in the UI |
 |  [optionLabels](./kibana-plugin-core-public.uisettingsparams.optionlabels.md) | <code>Record&lt;string, string&gt;</code> | text labels for 'select' type UI element |
 |  [options](./kibana-plugin-core-public.uisettingsparams.options.md) | <code>string[]</code> | array of permitted values for this setting |

docs/development/core/public/kibana-plugin-core-public.uisettingsparams.metric.md

@@ -15,7 +15,7 @@ Metric to track once this property changes
 
 ```typescript
 metric?: {
-        type: UiStatsMetricType;
+        type: UiCounterMetricType;
         name: string;
     };
 ```

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

@@ -177,6 +177,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [SavedObjectsImportSuccess](./kibana-plugin-core-server.savedobjectsimportsuccess.md) | Represents a successful import. |
 |  [SavedObjectsImportUnknownError](./kibana-plugin-core-server.savedobjectsimportunknownerror.md) | Represents a failure to import due to an unknown reason. |
 |  [SavedObjectsImportUnsupportedTypeError](./kibana-plugin-core-server.savedobjectsimportunsupportedtypeerror.md) | Represents a failure to import due to having an unsupported saved object type. |
+|  [SavedObjectsIncrementCounterField](./kibana-plugin-core-server.savedobjectsincrementcounterfield.md) |  |
 |  [SavedObjectsIncrementCounterOptions](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.md) |  |
 |  [SavedObjectsMappingProperties](./kibana-plugin-core-server.savedobjectsmappingproperties.md) | Describe the fields of a [saved object type](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md)<!-- -->. |
 |  [SavedObjectsMigrationLogger](./kibana-plugin-core-server.savedobjectsmigrationlogger.md) |  |

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsIncrementCounterField](./kibana-plugin-core-server.savedobjectsincrementcounterfield.md) &gt; [fieldName](./kibana-plugin-core-server.savedobjectsincrementcounterfield.fieldname.md)
+
+## SavedObjectsIncrementCounterField.fieldName property
+
+The field name to increment the counter by.
+
+<b>Signature:</b>
+
+```typescript
+fieldName: string;
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsIncrementCounterField](./kibana-plugin-core-server.savedobjectsincrementcounterfield.md) &gt; [incrementBy](./kibana-plugin-core-server.savedobjectsincrementcounterfield.incrementby.md)
+
+## SavedObjectsIncrementCounterField.incrementBy property
+
+The number to increment the field by (defaults to 1).
+
+<b>Signature:</b>
+
+```typescript
+incrementBy?: number;
+```

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

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsIncrementCounterField](./kibana-plugin-core-server.savedobjectsincrementcounterfield.md)
+
+## SavedObjectsIncrementCounterField interface
+
+
+<b>Signature:</b>
+
+```typescript
+export interface SavedObjectsIncrementCounterField 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [fieldName](./kibana-plugin-core-server.savedobjectsincrementcounterfield.fieldname.md) | <code>string</code> | The field name to increment the counter by. |
+|  [incrementBy](./kibana-plugin-core-server.savedobjectsincrementcounterfield.incrementby.md) | <code>number</code> | The number to increment the field by (defaults to 1). |
+

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

@@ -4,12 +4,12 @@
 
 ## SavedObjectsRepository.incrementCounter() method
 
-Increments all the specified counter fields by one. Creates the document if one doesn't exist for the given id.
+Increments all the specified counter fields (by one by default). Creates the document if one doesn't exist for the given id.
 
 <b>Signature:</b>
 
 ```typescript
-incrementCounter<T = unknown>(type: string, id: string, counterFieldNames: string[], options?: SavedObjectsIncrementCounterOptions): Promise<SavedObject<T>>;
+incrementCounter<T = unknown>(type: string, id: string, counterFields: Array<string | SavedObjectsIncrementCounterField>, options?: SavedObjectsIncrementCounterOptions): Promise<SavedObject<T>>;
 ```
 
 ## Parameters
@@ -18,7 +18,7 @@ incrementCounter<T = unknown>(type: string, id: string, counterFieldNames: strin
 |  --- | --- | --- |
 |  type | <code>string</code> | The type of saved object whose fields should be incremented |
 |  id | <code>string</code> | The id of the document whose fields should be incremented |
-|  counterFieldNames | <code>string[]</code> | An array of field names to increment |
+|  counterFields | <code>Array&lt;string &#124; SavedObjectsIncrementCounterField&gt;</code> | An array of field names to increment or an array of [SavedObjectsIncrementCounterField](./kibana-plugin-core-server.savedobjectsincrementcounterfield.md) |
 |  options | <code>SavedObjectsIncrementCounterOptions</code> | [SavedObjectsIncrementCounterOptions](./kibana-plugin-core-server.savedobjectsincrementcounteroptions.md) |
 
 <b>Returns:</b>

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

@@ -26,7 +26,7 @@ export declare class SavedObjectsRepository
 |  [deleteFromNamespaces(type, id, namespaces, options)](./kibana-plugin-core-server.savedobjectsrepository.deletefromnamespaces.md) |  | Removes one or more namespaces from a given multi-namespace saved object. If no namespaces remain, the saved object is deleted entirely. This method and \[<code>addToNamespaces</code>\][SavedObjectsRepository.addToNamespaces()](./kibana-plugin-core-server.savedobjectsrepository.addtonamespaces.md) are the only ways to change which Spaces a multi-namespace saved object is shared to. |
 |  [find(options)](./kibana-plugin-core-server.savedobjectsrepository.find.md) |  |  |
 |  [get(type, id, options)](./kibana-plugin-core-server.savedobjectsrepository.get.md) |  | Gets a single object |
-|  [incrementCounter(type, id, counterFieldNames, options)](./kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md) |  | Increments all the specified counter fields by one. Creates the document if one doesn't exist for the given id. |
+|  [incrementCounter(type, id, counterFields, options)](./kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md) |  | Increments all the specified counter fields (by one by default). Creates the document if one doesn't exist for the given id. |
 |  [removeReferencesTo(type, id, options)](./kibana-plugin-core-server.savedobjectsrepository.removereferencesto.md) |  | Updates all objects containing a reference to the given {<!-- -->type, id<!-- -->} tuple to remove the said reference. |
 |  [update(type, id, attributes, options)](./kibana-plugin-core-server.savedobjectsrepository.update.md) |  | Updates an object |
 

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

@@ -19,7 +19,7 @@ export interface UiSettingsParams<T = unknown>
 |  [category](./kibana-plugin-core-server.uisettingsparams.category.md) | <code>string[]</code> | used to group the configured setting in the UI |
 |  [deprecation](./kibana-plugin-core-server.uisettingsparams.deprecation.md) | <code>DeprecationSettings</code> | optional deprecation information. Used to generate a deprecation warning. |
 |  [description](./kibana-plugin-core-server.uisettingsparams.description.md) | <code>string</code> | description provided to a user in UI |
-|  [metric](./kibana-plugin-core-server.uisettingsparams.metric.md) | <code>{</code><br/><code>        type: UiStatsMetricType;</code><br/><code>        name: string;</code><br/><code>    }</code> | Metric to track once this property changes |
+|  [metric](./kibana-plugin-core-server.uisettingsparams.metric.md) | <code>{</code><br/><code>        type: UiCounterMetricType;</code><br/><code>        name: string;</code><br/><code>    }</code> | Metric to track once this property changes |
 |  [name](./kibana-plugin-core-server.uisettingsparams.name.md) | <code>string</code> | title in the UI |
 |  [optionLabels](./kibana-plugin-core-server.uisettingsparams.optionlabels.md) | <code>Record&lt;string, string&gt;</code> | text labels for 'select' type UI element |
 |  [options](./kibana-plugin-core-server.uisettingsparams.options.md) | <code>string[]</code> | array of permitted values for this setting |