Skip to content

Commit

Permalink
Merge branch 'master' into reporting/pre-perf-instrument
Browse files Browse the repository at this point in the history
  • Loading branch information
tsullivan committed Oct 8, 2019
2 parents 42a1e4c + 963d2c8 commit 88e1ad1
Show file tree
Hide file tree
Showing 306 changed files with 52,384 additions and 6,175 deletions.
44 changes: 44 additions & 0 deletions docs/apm/troubleshooting.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
[[troubleshooting]]
=== Troubleshooting common problems

If you have something to add to this section, please consider creating a pull request with
your proposed changes at https://github.com/elastic/kibana.

Also check out the https://discuss.elastic.co/c/apm[APM discussion forum].

==== No APM data found

This section can help with any of the following:

* Data isn't displaying in the APM app
* You're seeing a message like "No Services Found",
* You're seeing errors like "Fielddata is disabled on text fields by default..."

There are a number of factors that could be at play here.
One important thing to double-check first is your index template.

An APM index template must exist for the APM app to work correctly.
By default, this index template is created by APM Server on startup.
However, this only happens if `setup.template.enabled` is `true` in `apm-server.yml`.
You can create the index template manually by running `apm-server setup`.
Take note that index templates *cannot* be applied retroactively -- they are only applied at index creation time.
More information is available in {apm-server-ref}/apm-server-configuration.html[Set up and configure].

You can check for the existence of an APM index template using the
{ref}/indices-get-template.html[Get index template API].
If you're using the default index naming pattern, that request would be:

[source,js]
--------------------------------------------------
GET /_template/apm-{version}
--------------------------------------------------
// CONSOLE

If you're not outputting data directly from APM Server to Elasticsearch (perhaps you're using Logstash or Kafka),
then the index template will not be set up automatically. Instead, you'll need to
{apm-server-ref}/_manually_loading_template_configuration.html#load-template-manually-alternate[load the template manually].

Finally, this problem can also occur if you've changed the index name that you write APM data to.
The default index pattern can be found {apm-server-ref}/elasticsearch-output.html#index-option-es[here].
If you change this setting, you must also configure the `setup.template.name` and `setup.template.pattern` options.
See {apm-server-ref}/configuration-template.html[Load the Elasticsearch index template].
2 changes: 2 additions & 0 deletions docs/apm/using-the-apm-ui.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,5 @@ include::metrics.asciidoc[]
include::agent-configuration.asciidoc[]

include::advanced-queries.asciidoc[]

include::troubleshooting.asciidoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The list of common parameters:
- *responseHandler*: <string> one of the available response handlers or a <function> for a custom response handler
- *editor*: <string> one of the available editors or Editor class for custom one
- *editorConfig*: object holding editor parameters
- *options.showTimePicker*: <bool> show or hide time picker (defaults to true)
- *options.showTimePicker*: <bool> show or hide time filter (defaults to true)
- *options.showQueryBar*: <bool> show or hide query bar (defaults to true)
- *options.showFilterBar*: <bool> show or hide filter bar (defaults to true)
- *options.showIndexSelection*: <bool> show or hide index selection (defaults to true)
Expand Down Expand Up @@ -275,7 +275,7 @@ VisTypesRegistryProvider.register(MyNewVisType);
[[development-visualization-request-handlers]]
=== Visualization Request Handlers
Request handler gets called when one of the following keys on AppState change:
`vis`, `query`, `filters` or `uiState` and when timepicker is updated. On top
`vis`, `query`, `filters` or `uiState` and when the time filter is updated. On top
of that it will also get called on force refresh.

By default visualizations will use the `courier` request handler. They can also choose to use any of the other provided
Expand Down Expand Up @@ -417,7 +417,7 @@ The `vis` object holds the visualization state and is the window into kibana:
- *vis.getUiState()*: gets UI state of visualization
- *vis.uiStateVal(name, val)*: updates a property in UI state
- *vis.isEditorMode()*: returns true if in editor mode
- *vis.API.timeFilter*: allows you to access time picker
- *vis.API.timeFilter*: allows you to access time filter
- *vis.API.queryFilter*: gives you access to queryFilter
- *vis.API.events.click*: default click handler
- *vis.API.events.brush*: default brush handler
Expand All @@ -430,12 +430,12 @@ visualization's render method.
For the parameters that should not be saved with the visualization you should use the UI state.
These hold viewer-specific state, such as popup open/closed, custom colors applied to the series etc.

You can access filter bar and time picker through the objects defined on `vis.API`
You can access the filter bar and time filter through the objects defined on `vis.API`

[[development-vis-timefilter]]
==== timeFilter

Update the timefilter time values and call update() method on it to update time picker
Update the timefilter time values and call update() method on it to update the time filter

["source","js"]
-----------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [APICaller](./kibana-plugin-server.apicaller.md)

## APICaller type
## APICaller interface


<b>Signature:</b>

```typescript
export declare type APICaller = (endpoint: string, clientParams: Record<string, any>, options?: CallAPIOptions) => Promise<unknown>;
export interface APICaller
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [AssistanceAPIResponse](./kibana-plugin-server.assistanceapiresponse.md) &gt; [indices](./kibana-plugin-server.assistanceapiresponse.indices.md)

## AssistanceAPIResponse.indices property

<b>Signature:</b>

```typescript
indices: {
[indexName: string]: {
action_required: MIGRATION_ASSISTANCE_INDEX_ACTION;
};
};
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [AssistanceAPIResponse](./kibana-plugin-server.assistanceapiresponse.md)

## AssistanceAPIResponse interface

<b>Signature:</b>

```typescript
export interface AssistanceAPIResponse
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [indices](./kibana-plugin-server.assistanceapiresponse.indices.md) | <code>{</code><br/><code> [indexName: string]: {</code><br/><code> action_required: MIGRATION_ASSISTANCE_INDEX_ACTION;</code><br/><code> };</code><br/><code> }</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [AssistantAPIClientParams](./kibana-plugin-server.assistantapiclientparams.md)

## AssistantAPIClientParams interface

<b>Signature:</b>

```typescript
export interface AssistantAPIClientParams extends GenericParams
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [method](./kibana-plugin-server.assistantapiclientparams.method.md) | <code>'GET'</code> | |
| [path](./kibana-plugin-server.assistantapiclientparams.path.md) | <code>'/_migration/assistance'</code> | |
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [AssistantAPIClientParams](./kibana-plugin-server.assistantapiclientparams.md) &gt; [method](./kibana-plugin-server.assistantapiclientparams.method.md)

## AssistantAPIClientParams.method property

<b>Signature:</b>

```typescript
method: 'GET';
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [AssistantAPIClientParams](./kibana-plugin-server.assistantapiclientparams.md) &gt; [path](./kibana-plugin-server.assistantapiclientparams.path.md)

## AssistantAPIClientParams.path property

<b>Signature:</b>

```typescript
path: '/_migration/assistance';
```
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Creates an instance of `ScopedClusterClient` based on the configuration the curr
<b>Signature:</b>

```typescript
asScoped(request?: KibanaRequest | LegacyRequest | FakeRequest): ScopedClusterClient;
asScoped(request?: KibanaRequest | LegacyRequest | FakeRequest): IScopedClusterClient;
```

## Parameters
Expand All @@ -20,5 +20,5 @@ asScoped(request?: KibanaRequest | LegacyRequest | FakeRequest): ScopedClusterCl

<b>Returns:</b>

`ScopedClusterClient`
`IScopedClusterClient`

Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Calls specified endpoint with provided clientParams on behalf of the Kibana inte
<b>Signature:</b>

```typescript
callAsInternalUser: (endpoint: string, clientParams?: Record<string, any>, options?: CallAPIOptions | undefined) => Promise<any>;
callAsInternalUser: APICaller;
```
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@

Represents an Elasticsearch cluster API client and allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers (via `asScoped(...)`<!-- -->).

See [ClusterClient](./kibana-plugin-server.clusterclient.md)<!-- -->.

<b>Signature:</b>

```typescript
export declare class ClusterClient
export declare class ClusterClient implements IClusterClient
```
## Constructors
Expand All @@ -22,7 +24,7 @@ export declare class ClusterClient
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [callAsInternalUser](./kibana-plugin-server.clusterclient.callasinternaluser.md) | | <code>(endpoint: string, clientParams?: Record&lt;string, any&gt;, options?: CallAPIOptions &#124; undefined) =&gt; Promise&lt;any&gt;</code> | Calls specified endpoint with provided clientParams on behalf of the Kibana internal user. |
| [callAsInternalUser](./kibana-plugin-server.clusterclient.callasinternaluser.md) | | <code>APICaller</code> | Calls specified endpoint with provided clientParams on behalf of the Kibana internal user. |
## Methods
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@

```typescript
elasticsearch: {
adminClient$: Observable<ClusterClient>;
dataClient$: Observable<ClusterClient>;
createClient: (type: string, clientConfig?: Partial<ElasticsearchClientConfig>) => ClusterClient;
adminClient$: Observable<IClusterClient>;
dataClient$: Observable<IClusterClient>;
createClient: (type: string, clientConfig?: Partial<ElasticsearchClientConfig>) => IClusterClient;
};
```
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ export interface CoreSetup
| Property | Type | Description |
| --- | --- | --- |
| [context](./kibana-plugin-server.coresetup.context.md) | <code>{</code><br/><code> createContextContainer: ContextSetup['createContextContainer'];</code><br/><code> }</code> | |
| [elasticsearch](./kibana-plugin-server.coresetup.elasticsearch.md) | <code>{</code><br/><code> adminClient$: Observable&lt;ClusterClient&gt;;</code><br/><code> dataClient$: Observable&lt;ClusterClient&gt;;</code><br/><code> createClient: (type: string, clientConfig?: Partial&lt;ElasticsearchClientConfig&gt;) =&gt; ClusterClient;</code><br/><code> }</code> | |
| [elasticsearch](./kibana-plugin-server.coresetup.elasticsearch.md) | <code>{</code><br/><code> adminClient$: Observable&lt;IClusterClient&gt;;</code><br/><code> dataClient$: Observable&lt;IClusterClient&gt;;</code><br/><code> createClient: (type: string, clientConfig?: Partial&lt;ElasticsearchClientConfig&gt;) =&gt; IClusterClient;</code><br/><code> }</code> | |
| [http](./kibana-plugin-server.coresetup.http.md) | <code>{</code><br/><code> createCookieSessionStorageFactory: HttpServiceSetup['createCookieSessionStorageFactory'];</code><br/><code> registerOnPreAuth: HttpServiceSetup['registerOnPreAuth'];</code><br/><code> registerAuth: HttpServiceSetup['registerAuth'];</code><br/><code> registerOnPostAuth: HttpServiceSetup['registerOnPostAuth'];</code><br/><code> basePath: HttpServiceSetup['basePath'];</code><br/><code> isTlsEnabled: HttpServiceSetup['isTlsEnabled'];</code><br/><code> registerRouteHandlerContext: &lt;T extends keyof RequestHandlerContext&gt;(name: T, provider: RequestHandlerContextProvider&lt;T&gt;) =&gt; RequestHandlerContextContainer;</code><br/><code> createRouter: () =&gt; IRouter;</code><br/><code> }</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [DeprecationAPIClientParams](./kibana-plugin-server.deprecationapiclientparams.md)

## DeprecationAPIClientParams interface

<b>Signature:</b>

```typescript
export interface DeprecationAPIClientParams extends GenericParams
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [method](./kibana-plugin-server.deprecationapiclientparams.method.md) | <code>'GET'</code> | |
| [path](./kibana-plugin-server.deprecationapiclientparams.path.md) | <code>'/_migration/deprecations'</code> | |
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [DeprecationAPIClientParams](./kibana-plugin-server.deprecationapiclientparams.md) &gt; [method](./kibana-plugin-server.deprecationapiclientparams.method.md)

## DeprecationAPIClientParams.method property

<b>Signature:</b>

```typescript
method: 'GET';
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [DeprecationAPIClientParams](./kibana-plugin-server.deprecationapiclientparams.md) &gt; [path](./kibana-plugin-server.deprecationapiclientparams.path.md)

## DeprecationAPIClientParams.path property

<b>Signature:</b>

```typescript
path: '/_migration/deprecations';
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [DeprecationAPIResponse](./kibana-plugin-server.deprecationapiresponse.md) &gt; [cluster\_settings](./kibana-plugin-server.deprecationapiresponse.cluster_settings.md)

## DeprecationAPIResponse.cluster\_settings property

<b>Signature:</b>

```typescript
cluster_settings: DeprecationInfo[];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [DeprecationAPIResponse](./kibana-plugin-server.deprecationapiresponse.md) &gt; [index\_settings](./kibana-plugin-server.deprecationapiresponse.index_settings.md)

## DeprecationAPIResponse.index\_settings property

<b>Signature:</b>

```typescript
index_settings: IndexSettingsDeprecationInfo;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [DeprecationAPIResponse](./kibana-plugin-server.deprecationapiresponse.md)

## DeprecationAPIResponse interface

<b>Signature:</b>

```typescript
export interface DeprecationAPIResponse
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [cluster\_settings](./kibana-plugin-server.deprecationapiresponse.cluster_settings.md) | <code>DeprecationInfo[]</code> | |
| [index\_settings](./kibana-plugin-server.deprecationapiresponse.index_settings.md) | <code>IndexSettingsDeprecationInfo</code> | |
| [ml\_settings](./kibana-plugin-server.deprecationapiresponse.ml_settings.md) | <code>DeprecationInfo[]</code> | |
| [node\_settings](./kibana-plugin-server.deprecationapiresponse.node_settings.md) | <code>DeprecationInfo[]</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [DeprecationAPIResponse](./kibana-plugin-server.deprecationapiresponse.md) &gt; [ml\_settings](./kibana-plugin-server.deprecationapiresponse.ml_settings.md)

## DeprecationAPIResponse.ml\_settings property

<b>Signature:</b>

```typescript
ml_settings: DeprecationInfo[];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [DeprecationAPIResponse](./kibana-plugin-server.deprecationapiresponse.md) &gt; [node\_settings](./kibana-plugin-server.deprecationapiresponse.node_settings.md)

## DeprecationAPIResponse.node\_settings property

<b>Signature:</b>

```typescript
node_settings: DeprecationInfo[];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [DeprecationInfo](./kibana-plugin-server.deprecationinfo.md) &gt; [details](./kibana-plugin-server.deprecationinfo.details.md)

## DeprecationInfo.details property

<b>Signature:</b>

```typescript
details?: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [DeprecationInfo](./kibana-plugin-server.deprecationinfo.md) &gt; [level](./kibana-plugin-server.deprecationinfo.level.md)

## DeprecationInfo.level property

<b>Signature:</b>

```typescript
level: MIGRATION_DEPRECATION_LEVEL;
```
Loading

0 comments on commit 88e1ad1

Please sign in to comment.