Skip to content

Commit

Permalink
[7.2][docs] Asciidoctor built HTML fixes (#2649) (#2653)
Browse files Browse the repository at this point in the history
  • Loading branch information
bmorelli25 authored Aug 28, 2019
1 parent a5381a4 commit c1c11be
Show file tree
Hide file tree
Showing 11 changed files with 33 additions and 35 deletions.
2 changes: 1 addition & 1 deletion changelogs/6.1.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,4 @@ https://github.com/elastic/apm-server/compare/v6.0.1\...v6.1.0[View commits]
- Show transaction.result in Requests per Minute {pull}226[226].
- Added Kibana 5.6 compatible dashboards {pull}208[208].
- Send document to output on start of server {pull}117[117].
- Log frontend status at startup {pull}284[284].
- Log frontend status at startup {pull}284[284].
2 changes: 1 addition & 1 deletion changelogs/6.2.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ https://github.com/elastic/apm-server/compare/v6.1.4\...v6.2.0[View commits]
- Move process related fields to their own namespace {pull}445[445].
- Rename Kibana directories according to changed structure in beats framework. {pull}454[454]
- Change config option `max_header_bytes` to `max_header_size` {pull}492[492].
- Change config option `frontend.sourcemapping.index` to `frontend.source_mapping.index_pattern` and remove adding a '*' by default.{pull}492[492].
- Change config option `frontend.sourcemapping.index` to `frontend.source_mapping.index_pattern` and remove adding a '*' by default. {pull}492[492].
- Remove untested config options from config yml files {pull}496[496]

[float]
Expand Down
4 changes: 2 additions & 2 deletions changelogs/6.4.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ https://github.com/elastic/apm-server/compare/v6.3.2\...v6.4.0[View commits]
- Add optional tracing for the server's API and event publisher {pull}816[816].
- Read sourcemap content and fill context lines {pull}972[972].
- Add source_mapping.elasticsearch configuration option {pull}1114[1114].
- Add /v1/metrics endpoint {pull}1000[1000] {pull}1121[1121].
- Add /v1/metrics endpoint {pull}1000[1000], {pull}1121[1121].
- Push onboarding doc to separate ES index {pull}1159[1159].
- Deprecate usage of `apm-server setup` for dashboards and index-pattern {pull}1142[1142],{pull}1261[1261].
- Deprecate usage of `apm-server setup` for dashboards and index-pattern {pull}1142[1142], {pull}1261[1261].
- Disable metrics logging by default {pull}1127[1127].
2 changes: 1 addition & 1 deletion changelogs/6.5.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ https://github.com/elastic/apm-server/compare/v6.4.2\...v6.5.0[View commits]
==== Added

- Provide basic server information at `/` {pull}1197[1197].
- Add pipeline registration and pipeline usage {pull}1258[1258],{pull}1296[1296].
- Add pipeline registration and pipeline usage {pull}1258[1258], {pull}1296[1296].
- Allow sending `tags` for `spans`, that get indexed in ES {pull}1156[1156].
- Add apm-server monitoring {pull}1382[1382].
- Enable sending instrumentation to a remote APM Server with `instrumentation.hosts` {pull}1389[1389].
Expand Down
4 changes: 2 additions & 2 deletions changelogs/7.0.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Also see:

[float]
==== Breaking Changes
- Move fields in ES to be ECS compliant. {apm-overview-ref-v}/breaking-7.0.0.html#breaking-ecs[More information], {pull}1766[1766],{pull}1783[1783],{pull}1813[1813],{pull}1836[1836],{pull}1838[1838],{pull}1844[1844],{pull}1848[1848],{pull}1849[1849],{pull}1863[1863],{pull}1870[1870].
- Move fields in ES to be ECS compliant. {apm-overview-ref-v}/breaking-7.0.0.html#breaking-ecs[More information], {pull}1766[1766], {pull}1783[1783], {pull}1813[1813], {pull}1836[1836], {pull}1838[1838], {pull}1844[1844], {pull}1848[1848], {pull}1849[1849], {pull}1863[1863], {pull}1870[1870].
- Rename `transaction.span_count.dropped.total` to `transaction.span_count.dropped` {pull}1809[1809].
- Rename `span.hex_id` to `span.id` {pull}1811[1811].
- Index `error.exception` as array of objects {pull}1825[1825]
Expand Down Expand Up @@ -104,7 +104,7 @@ https://github.com/elastic/apm-server/compare/v7.0.0-alpha2\...v7.0.0-beta1[View

[float]
==== Breaking Changes
- Move fields in ES to be ECS compliant. {apm-overview-ref-v}/breaking-7.0.0.html#breaking-ecs[More information], {pull}1766[1766],{pull}1783[1783],{pull}1813[1813],{pull}1836[1836],{pull}1838[1838],{pull}1844[1844],{pull}1848[1848],{pull}1849[1849],{pull}1863[1863],{pull}1870[1870].
- Move fields in ES to be ECS compliant. {apm-overview-ref-v}/breaking-7.0.0.html#breaking-ecs[More information], {pull}1766[1766], {pull}1783[1783], {pull}1813[1813], {pull}1836[1836], {pull}1838[1838], {pull}1844[1844], {pull}1848[1848], {pull}1849[1849], {pull}1863[1863], {pull}1870[1870].

[float]
==== Added
Expand Down
18 changes: 8 additions & 10 deletions changelogs/7.1.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,19 @@

https://github.com/elastic/apm-server/compare/7.0\...7.1[View commits]

* <<release-notes-7.1.1>>
* <<release-notes-7.1.0>>

[[release-notes-7.1.1]]
=== APM Server version 7.1.1

https://github.com/elastic/apm-server/compare/v7.1.0\...v7.1.1[View commits]

No significant changes.

[[release-notes-7.1.0]]
=== APM Server version 7.1.0

https://github.com/elastic/apm-server/compare/v7.0.1\...v7.1.0[View commits]

No significant changes.
////
[float]
==== Added
[float]
==== Removed
[float]
==== Bug fixes
////
6 changes: 3 additions & 3 deletions changelogs/7.2.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ https://github.com/elastic/apm-server/compare/v7.2.0\...v7.2.1[View commits]
- Upgrade Go to 1.12.4 {pull}2132[2132].
- Add geoip processing to the default ingest pipeline {pull}2177[2177].
- Add ephemeral_id attribute in the metadata {pull}2179[2179].
- Add ILM support for APM Server, using fixed policies {pull}2099[2099],{pull}2209[2209].
- Add `setup --index-management` cmd, deprecate `setup --template` cmd {pull}2180[2180],{pull}2099[2099].
- Support more SSL config options for agent/server communication {pull}2224[2224],{pull}2281[2281].
- Add ILM support for APM Server, using fixed policies {pull}2099[2099], {pull}2209[2209].
- Add `setup --index-management` cmd, deprecate `setup --template` cmd {pull}2180[2180], {pull}2099[2099].
- Support more SSL config options for agent/server communication {pull}2224[2224], {pull}2281[2281].
4 changes: 2 additions & 2 deletions docs/copied-from-beats/command-reference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -651,12 +651,12 @@ Sets up components related to Elasticsearch index management including
template, ilm policy, and write alias.

*`--template`*::
deprecated[7.2]
deprecated:[7.2]
Sets up the index template only.
It is recommended to use `--index-management` instead.

*`--ilm-policy`*::
deprecated[7.2]
deprecated:[7.2]
Sets up the index lifecycle policy.
It is recommended to use `--index-management` instead.

Expand Down
14 changes: 7 additions & 7 deletions docs/copied-from-beats/outputconfig.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -219,15 +219,15 @@ for more information about the environment variables.

ifndef::apm-server[]
The index name to write events to. The default is
+"{beatname_lc}-%\{[{beat_version_key}]\}-%\{+yyyy.MM.dd\}"+ (for example,
+"{beatname_lc}-%{[{beat_version_key}]}-%{+yyyy.MM.dd}"+ (for example,
+"{beatname_lc}-{version}-{localdate}"+). If you change this setting, you also
need to configure the `setup.template.name` and `setup.template.pattern` options
(see <<configuration-template>>).
endif::apm-server[]

ifdef::apm-server[]
The index name to write events to. The default is
+"apm-%\{[{beat_version_key}]\}-{type\}-%\{+yyyy.MM.dd\}"+ (for example,
+"apm-%{[{beat_version_key}]}-{type}-%{+yyyy.MM.dd}"+ (for example,
+"apm-{version}-transaction-{localdate}"+). See
<<exploring-es-data,Exploring data in Elasticsearch>> for more information on
default index configuration.
Expand Down Expand Up @@ -256,7 +256,7 @@ to set the index:
------------------------------------------------------------------------------
output.elasticsearch:
hosts: ["http://localhost:9200"]
index: "%\{[fields.log_type]\}-%\{[{beat_version_key}]\}-%\{+yyyy.MM.dd}\" <1>
index: "%{[fields.log_type]}-%{[{beat_version_key}]}-%{+yyyy.MM.dd}" <1>
------------------------------------------------------------------------------

<1> We recommend including +{beat_version_key}+ in the name to avoid mapping issues
Expand All @@ -277,7 +277,7 @@ to set the index:
------------------------------------------------------------------------------
output.elasticsearch:
hosts: ["http://localhost:9200"]
index: "apm-%\{[observer.version]\}-%\{[processor.event]\}-%\{+yyyy.MM.dd}\" <1>
index: "apm-%{[observer.version]}-%{[processor.event]}-%{+yyyy.MM.dd}" <1>
------------------------------------------------------------------------------

<1> `observer` refers to {beatname_uc}. We recommend including
Expand Down Expand Up @@ -404,7 +404,7 @@ NOTE: `observer` refers to {beatname_uc}. We recommend including
{beatname_uc}.

This is the default configuration for {beatname_uc} and results in indices
named in the following format: +"apm-%\{[{beat_version_key}]\}-{type\}-%\{+yyyy.MM.dd\}"+
named in the following format: +"apm-%{[{beat_version_key}]}-{type}-%{+yyyy.MM.dd}"+
For example: +"apm-{version}-transaction-{localdate}"+.

The following example sets the index by taking the name returned by the `index`
Expand Down Expand Up @@ -467,7 +467,7 @@ access any event field. For example, this configuration uses a custom field,
------------------------------------------------------------------------------
output.elasticsearch:
hosts: ["http://localhost:9200"]
pipeline: "%\{[fields.log_type]\}_pipeline"
pipeline: "%{[fields.log_type]}_pipeline"
------------------------------------------------------------------------------


Expand All @@ -485,7 +485,7 @@ access any event field. For example, this configuration uses the field,
------------------------------------------------------------------------------
output.elasticsearch:
hosts: ["http://localhost:9200"]
pipeline: "%\{[processor.event]\}_pipeline"
pipeline: "%{[processor.event]}_pipeline"
------------------------------------------------------------------------------


Expand Down
6 changes: 3 additions & 3 deletions docs/copied-from-beats/template-config.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,18 @@ you must <<load-template-manually,load the template manually>>.

*`setup.template.name`*:: The name of the template. The default is
+{beatname_lc}+. The {beatname_uc} version is always appended to the given
name, so the final name is +{beatname_lc}-%\{[{beat_version_key}]\}+.
name, so the final name is +{beatname_lc}-%{[{beat_version_key}]}+.

// Maintainers: a backslash character is required to escape curly braces and
// asterisks in inline code examples that contain asciidoc attributes. You'll
// note that a backslash does not appear before the asterisk
// in +{beatname_lc}-%\{[{beat_version_key}]\}-*+. This is intentional and formats
// in +{beatname_lc}-%{[{beat_version_key}]}-*+. This is intentional and formats
// the example as expected.

*`setup.template.pattern`*:: The template pattern to apply to the default index
settings. The default pattern is +{beat_default_index_prefix}-\*+. The {beatname_uc} version is always
included in the pattern, so the final pattern is
+{beat_default_index_prefix}-%\{[{beat_version_key}]\}-*+. The wildcard character `-*` is used to
+{beat_default_index_prefix}-%{[{beat_version_key}]}-*+. The wildcard character `-*` is used to
match all daily indices.
+
Example:
Expand Down
6 changes: 3 additions & 3 deletions docs/storage-management.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ _15 spans with 15 frames each_ |300 events/second |600 events/second |2400 event
_30 spans with 30 frames each_ |150 events/second |300 events/second |1400 events/second
|=======================================================================

In other words, a 512 Mb instance can process \~3 Mbs per second,
In other words, a 512 Mb instance can process ~3 Mbs per second,
while an 8 Gb instance can process ~20 Mbs per second.

APM Server is CPU bound, so it scales better from 2 Gb to 8 Gb than it does from 512 Mb to 2 Gb.
Expand Down Expand Up @@ -166,7 +166,7 @@ With the curator command line interface you can, for instance, see all your exis

["source","sh",subs="attributes"]
------------------------------------------------------------
curator_cli --host localhost show_indices --filter_list '[\{"filtertype":"pattern","kind":"prefix","value":"apm-"\}]'
curator_cli --host localhost show_indices --filter_list '[{"filtertype":"pattern","kind":"prefix","value":"apm-"}]'
apm-{stack-version}-error-{sample_date_0}
apm-{stack-version}-error-{sample_date_1}
Expand All @@ -184,7 +184,7 @@ And then delete any span indices older than 1 day:

["source","sh",subs="attributes"]
------------------------------------------------------------
curator_cli --host localhost delete_indices --filter_list '[\{"filtertype":"pattern","kind":"prefix","value":"apm-{stack-version}-span-"\}, \{"filtertype":"age","source":"name","timestring":"%Y.%m.%d","unit":"days","unit_count":1,"direction":"older"\}]'
curator_cli --host localhost delete_indices --filter_list '[{"filtertype":"pattern","kind":"prefix","value":"apm-{stack-version}-span-"}, {"filtertype":"age","source":"name","timestring":"%Y.%m.%d","unit":"days","unit_count":1,"direction":"older"}]'
INFO Deleting selected indices: [apm-{stack-version}-span-{sample_date_0}, apm-{stack-version}-span-{sample_date_1}]
INFO ---deleting index apm-{stack-version}-span-{sample_date_0}
Expand Down

0 comments on commit c1c11be

Please sign in to comment.