Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Revises doc on adding data #68038

Merged
merged 12 commits into from
Jun 5, 2020
Merged

[DOCS] Revises doc on adding data #68038

merged 12 commits into from
Jun 5, 2020

Conversation

gchaps
Copy link
Contributor

@gchaps gchaps commented Jun 2, 2020

Summary

This docs updates the existing doc titled "Connecting to Elasticsearch" to include additional ways you can add data to Kibana.

Preview:
https://kibana_68038.docs-preview.app.elstc.co/guide/en/kibana/master/connect-to-elasticsearch.html

@gchaps gchaps added Team:Docs v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.7.0 v7.8.0 v7.9.0 labels Jun 2, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@gchaps gchaps requested a review from debadair June 2, 2020 23:59
Copy link
Contributor

@debadair debadair left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Left a few suggestions you can accept or discard as you see fit. :-)

docs/setup/connect-to-elasticsearch.asciidoc Outdated Show resolved Hide resolved
docs/setup/connect-to-elasticsearch.asciidoc Outdated Show resolved Hide resolved
docs/setup/connect-to-elasticsearch.asciidoc Outdated Show resolved Hide resolved
docs/setup/connect-to-elasticsearch.asciidoc Outdated Show resolved Hide resolved
docs/setup/connect-to-elasticsearch.asciidoc Outdated Show resolved Hide resolved
docs/setup/connect-to-elasticsearch.asciidoc Outdated Show resolved Hide resolved
docs/setup/connect-to-elasticsearch.asciidoc Outdated Show resolved Hide resolved
gchaps and others added 8 commits June 2, 2020 17:32
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
@@ -1,44 +1,99 @@
[[connect-to-elasticsearch]]
== Connect Kibana with Elasticsearch
== Adding data
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
== Adding data
== Add data

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll make that change when I change the other titles in the section.

TIP: By default, Kibana connects to the Elasticsearch instance running on `localhost`. To connect to a
different Elasticsearch instance, modify the Elasticsearch URL in the `kibana.yml` configuration file and
restart Kibana. For information about using Kibana with your production nodes, see <<production>>.
* Use the File Data Visualizer or GeoJSON Upload feature to quickly load
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Use the File Data Visualizer or GeoJSON Upload feature to quickly load
* Quickly load data into Elasticsearch with the File Data Visualizer or GeoJSON Upload feature


All done! Kibana is now connected to your Elasticsearch data. Kibana displays a read-only list of fields
configured for the matching index.
{kib} also provides <<get-data-in, sample data sets>> for you to use.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about:

If you're not ready to use your own data, use the <<get-data-in, sample data sets>> to see all that you can do in {kib}.

TIP: By default, Kibana connects to the Elasticsearch instance running on `localhost`. To connect to a
different Elasticsearch instance, modify the Elasticsearch URL in the `kibana.yml` configuration file and
restart Kibana. For information about using Kibana with your production nodes, see <<production>>.
* Use the File Data Visualizer or GeoJSON Upload feature to quickly load
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really want to say File Data Visualizer or GeoJSON Upload feature before we tell them what these features are? I would pair down this list to:

  • Load your data from a log file
  • Index logs, metrics, events, and application data
  • Connect Kibana to your Elasticsearch indices

Then get into the nitty gritty in the sections below.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Load your data from a log file

It might be worth mentioning CSV files here also as they are a very common use case.

=== Start Exploring your Data!
You're ready to dive in to your data:
[[upload-data-kibana]]
=== Use the File Data Visualizer
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about:

Load your data from a log file


[float]
[[add-data-tutorial-kibana]]
=== Add data tutorials
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your'e not really adding data tutorials, you're using them.

Beats data shipper to periodically collect and send data to {es}.
You can then use the pre-built dashboards to explore and analyze the data.

You access the tutorials from the {kib} home page.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You access the tutorials from the {kib} home page.
You access the tutorials from the home page.

[[connect-to-es]]
=== Connect with {es} indices

To visualize data in existing {es} indices, you
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To visualize data in existing {es} indices, you
To visualize data in {es} indices, you

=== Connect with {es} indices

To visualize data in existing {es} indices, you
create index patterns that match the names of the indices you want to explore. When you add data with the File Visualizer, GeoJSON Upload,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
create index patterns that match the names of the indices you want to explore. When you add data with the File Visualizer, GeoJSON Upload,
create index patterns that match the names of the indices you want to explore. When you add data with the File Data Visualizer, GeoJSON Upload,

To visualize data in existing {es} indices, you
create index patterns that match the names of the indices you want to explore. When you add data with the File Visualizer, GeoJSON Upload,
or an Add Data tutorial, an index pattern is created for you.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To create an index pattern:

To visualize data in a CSV, JSON, or log file, you can
upload it using the File Data Visualizer. On the home page,
click *Import a CSV, NDSON, or log file*, and then drag your file into the
File Data Visualizer. You can upload a file up to 100 MB.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This value is configurable up to 1GB in kibana's advanced settings. It might be worth mentioning in these docs.

TIP: By default, Kibana connects to the Elasticsearch instance running on `localhost`. To connect to a
different Elasticsearch instance, modify the Elasticsearch URL in the `kibana.yml` configuration file and
restart Kibana. For information about using Kibana with your production nodes, see <<production>>.
* Use the File Data Visualizer or GeoJSON Upload feature to quickly load
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Load your data from a log file

It might be worth mentioning CSV files here also as they are a very common use case.

@gchaps gchaps merged commit 891e3c5 into elastic:master Jun 5, 2020
gchaps added a commit to gchaps/kibana that referenced this pull request Jun 5, 2020
* [DOCS] Revises doc on adding data

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* [DOCS] Minor edits to add data doc

* [DOCS] Incorporated review comments

* [DOCS] Incorporates review comments

* [DOCS] Removes link to advanced settings

Co-authored-by: debadair <debadair@elastic.co>
gchaps added a commit to gchaps/kibana that referenced this pull request Jun 5, 2020
* [DOCS] Revises doc on adding data

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* [DOCS] Minor edits to add data doc

* [DOCS] Incorporated review comments

* [DOCS] Incorporates review comments

* [DOCS] Removes link to advanced settings

Co-authored-by: debadair <debadair@elastic.co>
gchaps added a commit to gchaps/kibana that referenced this pull request Jun 5, 2020
* [DOCS] Revises doc on adding data

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* [DOCS] Minor edits to add data doc

* [DOCS] Incorporated review comments

* [DOCS] Incorporates review comments

* [DOCS] Removes link to advanced settings

Co-authored-by: debadair <debadair@elastic.co>
gchaps added a commit to gchaps/kibana that referenced this pull request Jun 5, 2020
* [DOCS] Revises doc on adding data

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* [DOCS] Minor edits to add data doc

* [DOCS] Incorporated review comments

* [DOCS] Incorporates review comments

* [DOCS] Removes link to advanced settings

Co-authored-by: debadair <debadair@elastic.co>
gchaps added a commit to gchaps/kibana that referenced this pull request Jun 5, 2020
* [DOCS] Revises doc on adding data

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* [DOCS] Minor edits to add data doc

* [DOCS] Incorporated review comments

* [DOCS] Incorporates review comments

* [DOCS] Removes link to advanced settings

Co-authored-by: debadair <debadair@elastic.co>
gchaps added a commit that referenced this pull request Jun 5, 2020
* [DOCS] Revises doc on adding data

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* [DOCS] Minor edits to add data doc

* [DOCS] Incorporated review comments

* [DOCS] Incorporates review comments

* [DOCS] Removes link to advanced settings

Co-authored-by: debadair <debadair@elastic.co>

Co-authored-by: debadair <debadair@elastic.co>
gchaps added a commit that referenced this pull request Jun 5, 2020
* [DOCS] Revises doc on adding data

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* [DOCS] Minor edits to add data doc

* [DOCS] Incorporated review comments

* [DOCS] Incorporates review comments

* [DOCS] Removes link to advanced settings

Co-authored-by: debadair <debadair@elastic.co>

Co-authored-by: debadair <debadair@elastic.co>
gchaps added a commit that referenced this pull request Jun 5, 2020
* [DOCS] Revises doc on adding data

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* [DOCS] Minor edits to add data doc

* [DOCS] Incorporated review comments

* [DOCS] Incorporates review comments

* [DOCS] Removes link to advanced settings

Co-authored-by: debadair <debadair@elastic.co>

Co-authored-by: debadair <debadair@elastic.co>
gchaps added a commit that referenced this pull request Jun 5, 2020
* [DOCS] Revises doc on adding data

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* [DOCS] Minor edits to add data doc

* [DOCS] Incorporated review comments

* [DOCS] Incorporates review comments

* [DOCS] Removes link to advanced settings

Co-authored-by: debadair <debadair@elastic.co>

Co-authored-by: debadair <debadair@elastic.co>
gchaps added a commit that referenced this pull request Jun 5, 2020
* [DOCS] Revises doc on adding data

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: debadair <debadair@elastic.co>

* [DOCS] Minor edits to add data doc

* [DOCS] Incorporated review comments

* [DOCS] Incorporates review comments

* [DOCS] Removes link to advanced settings

Co-authored-by: debadair <debadair@elastic.co>

Co-authored-by: debadair <debadair@elastic.co>
gmmorris added a commit to gmmorris/kibana that referenced this pull request Jun 8, 2020
* master: (57 commits)
  Add app arch team as owner of datemath package (elastic#66880)
  [Observability] Landing page for Observability (elastic#67467)
  [SIEM] Fix timeline buildGlobalQuery (elastic#68320)
  Optimize saved objects getScopedClient and HTTP API (elastic#68221)
  [Maps] Fix mb-style interpolate style rule (elastic#68413)
  update script to always download node (elastic#68421)
  [SECURITY SOLEIL] Fix selection of event type when no siem index signal created (elastic#68291)
  [DOCS] Adds note about configuring File Data Visualizer (elastic#68407)
  [DOCS] Adds link from remote clusters to index patterns (elastic#68406)
  [QA] slack notify on failure (elastic#68126)
  upgrade eslint-plugin-react-hooks from 2.3.0 to 4.0.4 (elastic#68295)
  moving to jira to a gold license (elastic#67178)
  [DOCS] Revises doc on adding data (elastic#68038)
  [APM] Add ThemeProvider to support dark mode (elastic#68242)
  Make welcome screen disabling first action in loginIfPrompted (elastic#68238)
  [QA] Code coverage: unskip tests, collect tests results, exclude bundles from report (elastic#64477)
  [ML] Functional tests - disable flaky regression and classification creation test
  [Alerting] change eventLog ILM requests to absolute URLs (elastic#68331)
  Report page load asset size (elastic#66224)
  [SIEM][CASE] Change SIEM to Security (elastic#68365)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants