[DOCS] Updates Graph documentation (#45597) (#45697)

This commit is contained in:
Lisa Cawley 2019-09-13 13:29:40 -07:00 committed by GitHub
parent ecbd84ef77
commit df8c71c341
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 58 additions and 50 deletions

View file

@ -48,10 +48,10 @@ Only the configuration is saved unless the user
explicitly selects the include data option.
[float]
=== Using Security to Grant Access
=== Using Security to grant access
You can also use security to grant read only or all access to different roles.
When security is used to grant read only access, the following indicator in Kibana
will be displayed. For more information on granting access to Kibana see
is displayed. For more information on granting access to Kibana, see
<<xpack-security-authorization>>.
[role="screenshot"]
@ -59,7 +59,7 @@ image::graph/images/graph-read-only-badge.png[Example of Graph's read only acces
[float]
[[disable-drill-down]]
=== Disabling Drill Down Configuration
=== Disabling drill down configuration
By default, users can configure _drill down_ URLs to display additional
information about a selected vertex in a new browser window. For example,

View file

@ -1,57 +1,62 @@
[role="xpack"]
[[graph-getting-started]]
== Getting Started
== Using Graph
Graph is automatically enabled in {es} and {kib}.
[[exploring-connections]]
To start exploring connections in your data:
. Open Kibana in your web browser and log in. If you are running Kibana
locally, go to `http://localhost:5601/`.
. Click **Graph** in the side navigation to open the graph explorer.
+
image::graph/images/graph-open.jpg["Accessing Graph"]
. From the side navigation, open the graph explorer.
. Select an index pattern to specify what indices you want to explore.
+
For example, if you are indexing log data with Logstash, you could select the
`logstash-*` index pattern to visualize connections within the log entries.
. Select one or more multi-value fields that contain the terms you want to
graph. The vertices in the graph are selected from these terms. If you're
graph.
+
The vertices in the graph are selected from these terms. If you're
visualizing connections between Apache log entries, you could select the
`url.raw` field and the `geo.src` field so you can look at which pages are
being accessed from different locations.
. Enter a search query to discover relationships between terms in the selected
fields. For example, to generate a graph of the successful requests to
particular pages from different locations, you could search for the 200
response code:
fields.
+
image::graph/images/graph-url-connections.jpg["URL connections"]
For example, to generate a graph of the successful requests to
particular pages from different locations, you could search for the 200
response code. The weight of the connection between two vertices indicates how strongly they
are related.
+
[role="screenshot"]
image::graph/images/graph-url-connections.png["URL connections"]
The weight of the connection between two vertices indicates how strongly they
are related. You can click any connection to view more information about
the relationship:
. To view more information about the relationship, click any connection.
+
[role="screenshot"]
image::graph/images/graph-link-summary.png["Link summary"]
image::graph/images/graph-link-summary.jpg["Link summary"]
Once you have your initial graph, you can use the toolbar buttons to explore
additional connections. Click the Expand button
image:graph/images/graph-expand-button.jpg[Expand Selection] to display additional vertices
that connect to your graph. Click the Link button
image:graph/images/graph-link-button.jpg[Add links to existing terms] to display additional
connections between the displayed vertices. To explore a particular area of the
graph, select the vertices you are interested in and click the Expand or Link button.
To step back through your changes to the graph, click the Undo button
. Use the toolbar buttons to explore
additional connections:
+
* To display additional vertices that connect to your graph, click Expand
image:graph/images/graph-expand-button.jpg[Expand Selection].
* To display additional
connections between the displayed vertices, click Link
image:graph/images/graph-link-button.jpg[Add links to existing terms]
* To explore a particular area of the
graph, select the vertices you are interested in, and click Expand or Link.
* To step back through your changes to the graph, click Undo
image:graph/images/graph-undo-button.jpg[Undo].
To see more relationships within your data, you can submit additional queries.
image::graph/images/graph-add-query.jpg["Adding networks"]
. To see more relationships in your data, submit additional queries.
+
[role="screenshot"]
image::graph/images/graph-add-query.png["Adding networks"]
NOTE: By default, when you submit a search query Graph searches all available
NOTE: By default, when you submit a search query, Graph searches all available
fields. You can constrain your search to a particular field using the Lucene
query syntax. For example, `machine.os: osx`.

View file

@ -5,12 +5,12 @@
--
The {kib} {graph-features} enable you to discover how items in an
Elasticsearch index are related. You can explore the connections between
indexed terms and see which connections are the most meaningful. This can be
indexed terms and see which connections are the most meaningful. This is
useful in a variety of applications, from fraud detection to recommendation
engines.
For example, graph exploration could help you uncover website vulnerabilities
that hackers are targeting so you can harden your website. Or, you might
For example, graph exploration can help you uncover website vulnerabilities
that hackers are targeting, so you can harden your website. Or, you might
provide graph-based personalized recommendations to your e-commerce customers.
The {graph-features} provide a simple, yet powerful graph exploration API, and an
@ -20,8 +20,8 @@ additional data to use these features.
[[how-graph-works]]
[float]
=== How Graphs Work
The Graph API provides an alternative way to extract and summarize information
=== How Graph works
The graph API provides an alternative way to extract and summarize information
about the documents and terms in your Elasticsearch index. A _graph_ is really
just a network of related items. In our case, this means a network of related
terms in the index.
@ -40,9 +40,9 @@ cluster.
The graph vertices are simply the terms that you've already indexed. The
connections are derived on the fly using Elasticsearch aggregations. To
identify the most _meaningful_ connections, the Graph API leverages
identify the most _meaningful_ connections, the graph API leverages
Elasticsearch relevance scoring. The same data structures and relevance ranking
tools built into Elasticsearch to support text searches enable the Graph API to
tools built into Elasticsearch to support text searches enable the graph API to
separate useful signals from the noise that is typical of most connected data.
This foundation lets you easily answer questions like:
@ -53,11 +53,13 @@ be interested in?
* Which people on Stack Overflow have expertise in both Hadoop-related
technologies and Python-related tech?
But what about performance, you ask? The Elasticsearch aggregation framework
enables the Graph API to quickly summarize millions of documents as a single
But what about performance? The Elasticsearch aggregation framework
enables the graph API to quickly summarize millions of documents as a single
super-connection. Instead of retrieving every banking transaction between
accounts A and B, it derives a single connection that represents that
relationship. And, of course, this summarization process works across
relationship.
This summarization process works across
multi-node clusters and scales with your Elasticsearch deployment.
Advanced options let you control how your data is sampled and summarized.
You can also set timeouts to prevent graph queries from adversely

Binary file not shown.

Before

Width:  |  Height:  |  Size: 340 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 376 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 234 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 295 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 245 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 296 KiB

View file

@ -1,6 +1,6 @@
[role="xpack"]
[[xpack-graph]]
= Graphing Connections in Your Data
= Graph data connections
[partintro]
--
@ -21,8 +21,8 @@ additional data to use these features.
[[how-graph-works]]
[float]
=== How Graphs Work
The Graph API provides an alternative way to extract and summarize information
=== How Graph works
The graph API provides an alternative way to extract and summarize information
about the documents and terms in your Elasticsearch index. A _graph_ is really
just a network of related items. In our case, this means a network of related
terms in the index.
@ -31,6 +31,7 @@ The terms you want to include in the graph are called _vertices_. The
relationship between any two vertices is a _connection_. The connection
summarizes the documents that contain both vertices' terms.
[role="screenshot"]
image::graph/images/graph-vertices-connections.jpg["Graph components"]
NOTE: If you're into https://en.wikipedia.org/wiki/Graph_theory[graph theory],
@ -41,9 +42,9 @@ cluster.
The graph vertices are simply the terms that you've already indexed. The
connections are derived on the fly using Elasticsearch aggregations. To
identify the most _meaningful_ connections, the Graph API leverages
identify the most _meaningful_ connections, the graph API leverages
Elasticsearch relevance scoring. The same data structures and relevance ranking
tools built into Elasticsearch to support text searches enable the Graph API to
tools built into Elasticsearch to support text searches enable the graph API to
separate useful signals from the noise that is typical of most connected data.
This foundation lets you easily answer questions like:
@ -55,7 +56,7 @@ be interested in?
technologies and Python-related tech?
But what about performance, you ask? The Elasticsearch aggregation framework
enables the Graph API to quickly summarize millions of documents as a single
enables the graph API to quickly summarize millions of documents as a single
super-connection. Instead of retrieving every banking transaction between
accounts A and B, it derives a single connection that represents that
relationship. And, of course, this summarization process works across

View file

@ -6,8 +6,8 @@
++++
[float]
=== Limited Support for Multiple Indices
The Graph API can explore multiple indices, types, or aliases in a
=== Limited support for multiple indices
The graph API can explore multiple indices, types, or aliases in a
single API request, but the assumption is that each "hop" it performs
is querying the same set of indices. Currently, it is not possible to
take a term found in a field from one index and use that value to explore