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.

Sign up for GitHub

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

add release notes for 6.4 #1277

Merged
merged 2 commits into from
Aug 13, 2018
Merged

add release notes for 6.4 #1277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b901d4
add release notes for 6.4
jalvz Aug 13, 2018
eaf82ea
link to Kibana
jalvz Aug 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 44 additions & 1 deletion docs/guide/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Elastic APM consists of four components:
* {ref}/index.html[Elasticsearch]
* {apm-agents-ref}/index.html[APM agents]
* {apm-server-ref}/index.html[APM Server]
* Kibana APM UI
* {kibana-ref}/xpack-apm.html[Kibana APM UI]

image::apm-architecture.png[Architecture of Elastic APM]

Expand All @@ -56,6 +56,49 @@ To visualize the data after it's sent to Elasticsearch,
you can use the the dedicated APM UI bundled in X-Pack,
or the pre-built open source Kibana dashboards that can be loaded directly in the Kibana UI.

[[apm-release-notes]]
=== Release notes

[float]
==== APM version 6.4

[float]
===== Breaking changes

We previously split APM data into separate indices (transaction, span, error, etc.).
In 6.4 APM Kibana UI starts to leverage those separate indices for queries.
In case you only update Kibana but run an older version of APM Server you will not be able to see any APM data by default.
To fix this, use the Kibana APM configuration options to specify the location of the APM index.
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you link to https://github.com/elastic/kibana/blob/2ad265b73f47efe2cfc5d209d8a4f006f3e5ca09/docs/settings/apm-settings.asciidoc?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done here eaf82ea

See {kibana-ref}/apm-settings-kb.html[Kibana APM settings] for details.

When upgrading to Kibana 6.4, you might need to refresh your APM index pattern for certain APM UI features to work.

[float]
===== New features
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it would make sense to link to the according changelog sections or if not available to the overview for Server, UI and Agents.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

agents are not adding their changelogs to the Elastic docs, and I'd prefer not to link to GH because we can't detect broken links.
(also personally I don't think it looks very nice to follow a link from elastic docs to a GH readme, even thou i don't know if others are doing that)


*APM Server*

* Logstash output
* Kafka output


*APM UI*

* Query bar
* Machine Learning integration: Anomaly detection on service response times
* Kibana objects (index pattern, dashboards, etc.) can now be imported via the Kibana setup instuctions


*APM agents*

* RUM is now GA
* Ruby is now GA
* Java is now Beta
* Go is now Beta
* Python added instrumentation for Cassandra, PyODBC and PyMSSQL
* Node.js added instrumentation for Cassandra and broader MySQL support


[[install-and-run]]
== Install and run Elastic APM

Expand Down
2 changes: 1 addition & 1 deletion docs/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:logstashdoc: https://www.elastic.co/guide/en/logstash/{doc-branch}
:elasticsearch: https://www.elastic.co/guide/en/elasticsearch/reference/{doc-branch}
:securitydoc: https://www.elastic.co/guide/en/elastic-stack-overview/{doc-branch}
:deprecate_dashboard_loading: 6.4.0
:deprecate_dashboard_loading: 6.4.0

ifdef::env-github[]
NOTE: For the best reading experience,
Expand Down
2 changes: 1 addition & 1 deletion docs/overview.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The APM Server receives data from APM agents and transforms them into Elasticsea
It works by exposing an HTTP server to which agents post the APM data they collect.

APM Server is built with the Beats framework,
and as such it levarages its functionality.
and as such it leverages its functionality.

To get an overview of the whole Elastic APM system,
also have a look at:
Expand Down