Skip to content

Commit

Permalink
Merge branch 'master' of github.com:elastic/kibana into feature/rollu…
Browse files Browse the repository at this point in the history
…p-metrics-selectall

* 'master' of github.com:elastic/kibana: (50 commits)
  [Uptime] update monitor list configs for mobile view (elastic#43218)
  [APM] Local UI filters (elastic#41588)
  [Code] Upgrade ctags langserver (elastic#43252)
  [Code] show multiple definition results in panel (elastic#43249)
  Adds Metric Type to full screen launch tracking (elastic#42692)
  [Canvas] Convert Autocomplete to Typescript (elastic#42502)
  [telemetry] add spacesEnabled config back to xpack_main (elastic#43312)
  [ML] Adds DF Transform Analytics list to Kibana management (elastic#43151)
  Add TLS client authentication support. (elastic#43090)
  [csp] Telemetry for csp configuration (elastic#43223)
  [SIEM] Run Cypress Tests Against Elastic Cloud & Cypress Command Line / Reporting (elastic#42804)
  docs: add tip on agent config in a dt (elastic#43301)
  [ML] Adding bucket span estimator to new wizards (elastic#43288)
  disable flaky tests (elastic#43017)
  Fix percy target branch for PRs (elastic#43160)
  [ML] Adding post create job options (elastic#43205)
  Restore discover histogram selection triggering fetch (elastic#43097)
  Per panel time range (elastic#43153)
  [Infra UI] Add APM to Metadata Endpoint (elastic#42197)
  Sentence case copy changes (elastic#43215)
  ...
  • Loading branch information
jloleysens committed Aug 15, 2019
2 parents 0505101 + dbb140d commit 0e96e99
Show file tree
Hide file tree
Showing 421 changed files with 30,894 additions and 3,352 deletions.
4 changes: 2 additions & 2 deletions .ci/jobs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ JOB:
- kibana-ciGroup10
- kibana-ciGroup11
- kibana-ciGroup12
# - kibana-visualRegression
- kibana-visualRegression

# make sure all x-pack-ciGroups are listed in test/scripts/jenkins_xpack_ci_group.sh
- x-pack-firefoxSmoke
Expand All @@ -28,7 +28,7 @@ JOB:
- x-pack-ciGroup8
- x-pack-ciGroup9
- x-pack-ciGroup10
# - x-pack-visualRegression
- x-pack-visualRegression

# `~` is yaml for `null`
exclude: ~
5 changes: 5 additions & 0 deletions docs/apm/agent-configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,8 @@ Adjusting the sampling rate controls what percent of requests are traced.
`1.0` means _all_ requests are traced. If you set the `TRANSACTION_SAMPLE_RATE` to a value below `1.0`,
the agent will randomly sample only a subset of transactions.
Unsampled transactions only record the name of the transaction, the overall transaction time, and the result.

IMPORTANT: In a distributed trace, the sampling decision is propagated by the initializing Agent.
This means if you're using multiple agents, only the originating service's sampling rate will be used.
Be sure to set sensible defaults in _all_ of your agents, especially the
{apm-rum-ref}/configuration.html#transaction-sample-rate[JavaScript RUM Agent].
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [IKibanaSocket](./kibana-plugin-server.ikibanasocket.md) &gt; [authorizationError](./kibana-plugin-server.ikibanasocket.authorizationerror.md)

## IKibanaSocket.authorizationError property

The reason why the peer's certificate has not been verified. This property becomes available only when `authorized` is `false`<!-- -->.

<b>Signature:</b>

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

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [IKibanaSocket](./kibana-plugin-server.ikibanasocket.md) &gt; [authorized](./kibana-plugin-server.ikibanasocket.authorized.md)

## IKibanaSocket.authorized property

Indicates whether or not the peer certificate was signed by one of the specified CAs. When TLS isn't used the value is `undefined`<!-- -->.

<b>Signature:</b>

```typescript
readonly authorized?: boolean;
```
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@ A tiny abstraction for TCP socket.
export interface IKibanaSocket
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [authorizationError](./kibana-plugin-server.ikibanasocket.authorizationerror.md) | <code>Error</code> | The reason why the peer's certificate has not been verified. This property becomes available only when <code>authorized</code> is <code>false</code>. |
| [authorized](./kibana-plugin-server.ikibanasocket.authorized.md) | <code>boolean</code> | Indicates whether or not the peer certificate was signed by one of the specified CAs. When TLS isn't used the value is <code>undefined</code>. |

## Methods

| Method | Description |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
[[development-plugin-feature-registration]]
=== Plugin feature registration

If your plugin will be used with {kib}s default distribution, then you have the ability to register the features that your plugin provides. Features are typically apps in {kib}; once registered, you can toggle them via Spaces, and secure them via Roles when security is enabled.
If your plugin will be used with {kib}'s default distribution, then you have the ability to register the features that your plugin provides. Features are typically apps in {kib}; once registered, you can toggle them via Spaces, and secure them via Roles when security is enabled.

==== UI Capabilities

Registering features also gives your plugin access to “UI Capabilities”. These capabilities are boolean flags that you can use to conditionally render your interface, based on the current users permissions. For example, you can hide or disable a Save button if the current user is not authorized.
Registering features also gives your plugin access to “UI Capabilities”. These capabilities are boolean flags that you can use to conditionally render your interface, based on the current user's permissions. For example, you can hide or disable a Save button if the current user is not authorized.

==== Registering a feature

Feature registration is controlled via the built-in `xpack_main` plugin. To register a feature, call `xpack_main`'s `registerFeature` function from your plugins `init` function, and provide the appropriate details:
Feature registration is controlled via the built-in `xpack_main` plugin. To register a feature, call `xpack_main`'s `registerFeature` function from your plugin's `init` function, and provide the appropriate details:

["source","javascript"]
-----------
Expand Down Expand Up @@ -42,7 +42,7 @@ Registering a feature consists of the following fields. For more information, co
|`app` (required)
|`string[]`
|`["sample_app", "kibana"]`
|An array of applications this feature enables. Typically, all of your plugins apps (from `uiExports`) will be included here.
|An array of applications this feature enables. Typically, all of your plugin's apps (from `uiExports`) will be included here.

|`privileges` (required)
|{repo}blob/{branch}/x-pack/legacy/plugins/xpack_main/server/lib/feature_registry/feature_registry.ts[`FeatureWithAllOrReadPrivileges`].
Expand Down Expand Up @@ -72,7 +72,7 @@ To access capabilities, import them from `ui/capabilities`:

["source","javascript"]
-----------
import { uiCapabilities } from ui/capabilities;
import { uiCapabilities } from 'ui/capabilities';
const canUserSave = uiCapabilities.foo.save;
if (canUserSave) {
Expand Down Expand Up @@ -124,7 +124,7 @@ The `all` privilege defines a single “save” UI Capability. To access this in

["source","javascript"]
-----------
import { uiCapabilities } from ui/capabilities;
import { uiCapabilities } from 'ui/capabilities';
const canUserSave = uiCapabilities.canvas.save;
if (canUserSave) {
Expand Down
11 changes: 11 additions & 0 deletions docs/infrastructure/getting-started.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[role="xpack"]
[[xpack-metrics-getting-started]]
== Getting started with infrastructure monitoring

To get started with the Infrastructure app in Kibana, you need to start collecting metrics data for your infrastructure.

Kibana provides step-by-step instructions to help you add metrics data.
The {infra-guide}[Infrastructure Monitoring Guide] is a good source for more detailed information and instructions.

[role="screenshot"]
image::infrastructure/images/metrics-add-data.png[Screenshot showing Add metric data to Kibana UI]
Binary file removed docs/infrastructure/images/infra-sysmon.jpg
Binary file not shown.
Binary file added docs/infrastructure/images/infra-sysmon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/infrastructure/images/metrics-add-data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/infrastructure/images/time-filter-clock.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
82 changes: 15 additions & 67 deletions docs/infrastructure/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,83 +4,31 @@

[partintro]
--
Use the interactive Infrastructure UI to monitor your infrastructure and
identify problems in real time. You can explore metrics and logs for common
servers, containers, and services.
The Infrastructure app enables you to monitor your infrastructure and identify problems in real time.
You start with a visual summary of your infrastructure where you can view basic metrics for common servers, containers, and services.
Then you can drill down to view more detailed metrics or other information for that component.

[role="screenshot"]
image::infrastructure/images/infra-sysmon.jpg[Infrastructure Overview in Kibana]


[float]
== Add data

Kibana provides step-by-step instructions to help you add log data. The
{infra-guide}[Infrastructure Monitoring Guide] is a good source for more
detailed information and instructions.
You can:

[float]
== Configure data sources
* View an inventory of your infrastructure by hosts, Kubernetes pod or Docker containers.
You can group and filter the data in various ways to help you identify the items that interest you.

The `metricbeat-*` index pattern is used to query the data by default.
If your metrics are located in a different set of indices, or use a
different timestamp field, you can adjust the source configuration via the user
interface or the {kib} configuration file.
* View current and historic values for metrics such as CPU usage, memory usage, and network traffic for each component.
The available metrics depend on the kind of component being inspected.

NOTE: Logs and Infrastructure share a common data source definition in
each space. Changes in one of them can influence the data displayed in the
other.

[float]
=== Configure source

Configure source can be accessed via the corresponding
image:logs/images/logs-configure-source-gear-icon.png[Configure source icon]
button in the toolbar:

[role="screenshot"]
image::infrastructure/images/infrastructure-configure-source.png[Configure Infrastructure UI source button in Kibana]
* Use *Metrics Explorer* to group and visualize multiple customizable metrics for one or more components in a graphical format.
You can optionally save these views and add them to {kibana-ref}/dashboard.html[dashboards].

This opens the source configuration fly-out dialog, in which the following
configuration items can be inspected and adjusted:
* Seamlessly switch to view the corresponding logs, application traces or uptime information for a component.

* *Name*: The name of the source configuration.
* *Indices*: The patterns of the elasticsearch indices to read metrics and logs
from.
* *Fields*: The names of particular fields in the indices that need to be known
to the Infrastructure and Logs UIs in order to query and interpret the data
correctly.
To get started, you need to <<xpack-metrics-getting-started, start collecting metrics data from your infrastructure>>. Then you can <<infra-ui, use the Infrastructure application to inspect and analyze your data>>.

[role="screenshot"]
image::infrastructure/images/infrastructure-configure-source-dialog.png[Configure Infrastructure UI source dialog in Kibana]

TIP: If <<xpack-spaces>> are enabled in your Kibana instance, any configuration
changes performed via Configure source are specific to that space. You can
therefore easily make different subsets of the data available by creating
multiple spaces with different data source configurations.

[float]
[[infra-read-only-access]]
=== Read only access
When you have insufficient privileges to change the source configuration, the following
indicator in Kibana will be displayed. The buttons to change the source configuration
won't be visible. For more information on granting access to
Kibana see <<xpack-security-authorization>>.

[role="screenshot"]
image::infrastructure/images/read-only-badge.png[Example of Infrastructure's read only access indicator in Kibana's header]


[float]
=== Configuration file

The settings in the configuration file are used as a fallback when no other
configuration for that space has been defined. They are located in the
configuration namespace `xpack.infra.sources.default`. See
<<infrastructure-ui-settings-kb>> for a complete list of the possible entries.
image::infrastructure/images/infra-sysmon.png[Infrastructure Overview in Kibana]

--

include::monitor.asciidoc[]
include::getting-started.asciidoc[]
include::infra-ui.asciidoc[]
include::view-metrics.asciidoc[]
include::metrics-explorer.asciidoc[]
117 changes: 80 additions & 37 deletions docs/infrastructure/infra-ui.asciidoc
Original file line number Diff line number Diff line change
@@ -1,68 +1,111 @@
[role="xpack"]
[[infra-ui]]
== Using the Infrastructure UI
== Using the Infrastructure app

Use the Infrastructure UI in {kib} to monitor your infrastructure and identify
problems in real time.
Use the Infrastructure app in {kib} to monitor your infrastructure and identify problems in real time.
You can explore metrics for hosts, containers, and services.
You can also drill down to view more detailed metrics, or seamlessly switch to view the corresponding logs, application traces, and uptime information.

You start with an overview of your infrastructure.
Then you can use the interactive UI to drill down into areas of interest.
Initially, the *Inventory* tab shows an overview of the hosts in of your infrastructure and the current CPU usage for each host.
From here, you can drill down into areas of interest.

[role="screenshot"]
image::infrastructure/images/infra-sysmon.jpg[Infrastructure Overview in Kibana]

TIP: Right-click an element to jump to related logs or metrics.
image::infrastructure/images/infra-sysmon.png[Infrastructure Overview in Kibana]

[float]
[[infra-cat]]
=== View your infrastructure by hosts or container

Select the high-level view: *Hosts*, *Kubernetes*, or *Docker*.
When you change views, you can see the same data through the perspective of a
different category.
=== Choose the high-level view of your infrastructure

[float]
[[infra-search]]
=== Use the power of Search
Select the high-level view from *Hosts*, *Kubernetes*, or *Docker*.
When you change views, you see the same data through the perspective of a different category.

The Search bar is always available. You can use it to perform adhoc or structured searches.
The Search feature can surface the information you're looking for, even if the
other options you have selected would normally filter it out.
The default representation is the *Map view*, which shows your components in a _waffle map_ of one or more rectangular grids.
If the view you select has a large number of components, you can hover over a component to see the details for that component. Alternatively, if you would prefer to see your infrastructure as a table, click *Table view*.

[float]
[[infra-metric]]
=== Start at a high-level by selecting the metric
=== Select the metric to view

This filter helps you start focusing on potential problem areas that may need
further investigation. You'll see metrics that are most relevant for hosts or
the container you selected.
Select the metric to view from the *Metric* dropdown list.
The available metrics are those that are most relevant for the high-level view you selected.

[float]
[[infra-group]]
=== Group components
=== Group components

Select the way you want to group the infrastructure components from the *Group By* dropdown list.
The available options are specific to your physical, virtual, or container-based infrastructure.
Examples of grouping options include *Availability Zone*, *Machine Type*, *Project ID*, and *Cloud Provider* for hosts, and *Namespace* and *Node* for Kubernetes.

[float]
[[infra-search]]
=== Use the power of search

The *Group By* selector offers grouping options that are native and specific for
your physical, virtual, and container-based infrastructure.
Examples include Availability Zone, Machine Type, Project ID, and Cloud Provider
for Hosts, and Namespace and Node for Kubernetes.
Use the search bar to perform ad hoc or structured searches using {kibana-ref}/kuery-query.html[Kibana Query Language] which features autocomplete and a simple, easy to use syntax.
For example, enter `host.hostname : "host1"` to see only the information for `host1`.

[float]
[[infra-date]]
=== Specify the date range
=== Specify the time and date

Use the time selector to focus on a specific timeframe.
Click the time selector to choose the timeframe for the metrics.
The values shown are the values for the last minute at the specified time and date.

[float]
[[infra-refresh]]
=== Auto-refresh or pause
=== Auto-refresh metrics

Set auto-refresh to keep up-to-date information coming in, or stop
refreshing to focus on historical data without new distractions.
Select *Auto-refresh* to keep up-to-date metrics information coming in, or *Stop refreshing* to focus on historical data without new distractions.

[float]
[[infra-configure-source]]
=== Adapt to your metric source
=== Configure the data to use for your metrics

The default source configuration for metrics is specified in the {kibana-ref}/infrastructure-ui-settings-kb.html[Infrastructure app settings] in the {kibana-ref}/settings.html[Kibana configuration file].
The default configuration uses the `metricbeat-*` index pattern to query the data.
The default configuration also defines field settings for things like timestamps and container names.

If your metrics have custom index patterns, or use non-default field settings, you can override the default settings.
Click *Configuration* to change the settings.
This opens the *Configure source* fly-out dialog.

NOTE: These settings are shared with logs. Changes you make here may also affect the settings used in the *Logs* tab.

In the *Configure source* dialog, you can change the following values:

* *Name*: the name of the source configuration
* *Indices*: the index pattern or patterns in the Elasticsearch indices to read metrics data and log data
from
* *Fields*: the names of specific fields in the indices that need are used to query and interpret the data correctly

TIP: If <<xpack-spaces>> are enabled in your Kibana instance, any configuration changes you make here are specific to the current space.
You can make different subsets of data available by creating multiple spaces with different data source configurations.

TIP: If you don't see the *Configuration* option, you may not have sufficient privileges to change the source configuration.
For more information see <<xpack-security-authorization>>.

[float]
[[infra-metrics-explorer]]
=== Visualize multiple metrics in Metrics Explorer

<<metrics-explorer, Metrics Explorer>> allows you to visualize and analyze metrics for multiple components in a powerful and configurable way. Click the *Metrics Explorer* tab to get started.

[float]
[[infra-drill-down]]
=== Drill down for related information

Hover over a component to see more information about that component.

Click a component to see the other actions available for that component.
You can:

* Select *View Metrics* to <<xpack-view-metrics, view detailed infrastructure metrics>>.

* Select *View Logs* to <<xpack-logs-using, view the logs>> in the *Logs* app.

Depending on the features you have installed and configured, you may also be able to:

* Select *View APM* to <<traces, view APM traces>> in the *APM* app.

* Select *View Uptime* to <<uptime-overview, view uptime information>> in the *Uptime* app.

Using a custom index pattern to store the metrics, or want to limit the entries
presented in a space? Use configure source to change the index pattern and
other settings.
Loading

0 comments on commit 0e96e99

Please sign in to comment.