[apm] docs: add deployment annotation example #67408
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bmorelli25
added
Team:APM
|
Pinging @elastic/apm-ui (Team:apm) |
sorenlouv
reviewed
Jun 2, 2020
sorenlouv
reviewed
Jun 2, 2020
| or if the memory/CPU footprint of your application has changed. | ||
| Being able to quickly identify bad deployments enables you to rollback and fix issues without causing costly outages. | ||
|
|
||
| By default, automatic deployment annotations are enabled. |
There was a problem hiding this comment.
@dgieselaar Can automatic deployment annotations be disabled? If so, how?
There was a problem hiding this comment.
They can't really be disabled. The only thing that you can do to have them not show up is either by not setting service.version, or storing an annotation via the API, and then derived annotations will still be displayed for date ranges without a stored annotation.
sorenlouv
reviewed
Jun 2, 2020
|
|
||
| Deployment annotations are enabled by default, and can be created with the <<apm-annotation-api,annotation API>>. | ||
| If there are no created annotations for the selected time period, | ||
| the APM app will automatically annotate your data if the `service.version` of your application changes. | ||
|
|
||
| NOTE: If custom annotations have been created for the selected time period, any derived annotations, i.e., those created automatically when `service.version` changes, will not be shown. |
There was a problem hiding this comment.
@dgieselaar Oh, I guess this covers it. Still, users might want to keep automatic annotations even after posting manual annotation, so I think it should be possible to configure this.
There was a problem hiding this comment.
Do you think we should add it now or wait until there's a request from a user to support it?
sorenlouv
approved these changes
Jun 2, 2020
sorenlouv
approved these changes
Jun 2, 2020
There was a problem hiding this comment.
@bmorelli25 Thank you! This will make annotations much easier to get started with!
Co-authored-by: Søren Louv-Jansen <sorenlouv@gmail.com>
This was referenced Jun 4, 2020
bmorelli25
added a commit
to bmorelli25/kibana
that referenced
this pull request
Jun 4, 2020
jloleysens
added a commit
to jloleysens/kibana
that referenced
this pull request
Jun 4, 2020
…ms-column * 'master' of github.com:elastic/kibana: (63 commits) remove scripts. prettire update has been done (elastic#68130) Closes elastic#68055 by detecting the local Kibana version and using that as (elastic#68198) [apm] docs: add deployment annotation example (elastic#67408) [ML] Extend population preview chart to show actual and typical value (elastic#67569) Refactor index management client integration tests for scalability (elastic#67917) Add generator function that creates multiple alerts (elastic#67713) chore(NA): remove config arg from os packages (elastic#67871) [Reporting] Move code out of Legacy (elastic#67904) [Metrics UI] Add overrides to Snapshot API to support alert previews (elastic#68125) [Security] [Cases] Manage timeline UI API (elastic#67719) [ENDPOINT][INGEST]Task/endpoint ingest update (elastic#67234) Fix code coverage for jest, upload merged reports (elastic#68149) Update documentation/examples of deprecated namespaceAgnostic field (elastic#68039) [DOCS] Updates Canvas docs with new menus (elastic#66061) chore(NA): avoids imports of server or public code into common (elastic#67231) [SIEM] Fix GetOneTimeline graphql type (elastic#68137) skip flaky suite (elastic#67838) [Uptime] Add loading message for monitor list no items (elastic#67378) [Ingest Manager] Update indexing strategy docs to use dataset.* (elastic#68068) [Ingest Manager] Fix datasource validation for streams without vars (elastic#67950) ... # Conflicts: # x-pack/plugins/index_management/__jest__/client_integration/helpers/index.ts # x-pack/plugins/index_management/__jest__/client_integration/home.test.ts # x-pack/plugins/index_management/__jest__/client_integration/home/index_templates_tab.helpers.ts
gmmorris
added a commit
to gmmorris/kibana
that referenced
this pull request
Jun 4, 2020
* master: (26 commits) [Console]remove completion for type for filter queries and aggs (elastic#68103) [ML] Transforms: Filter aggregation support (elastic#67591) [ES UI Shared] Monaco XJSON (elastic#67485) [Index Management] Add data streams functionality to indices tab (elastic#67940) [Discover] Fix renaming of saved search not displayed in breadcrumb (elastic#67577) [SECURITY] Rename siem plugin to security_solution (elastic#67902) [Uptime] Fix Telemetry Api flaky test (elastic#67358) [Data plugin] Add configuration property to enable / disable autocomplete (elastic#67847) remove scripts. prettire update has been done (elastic#68130) Closes elastic#68055 by detecting the local Kibana version and using that as (elastic#68198) [apm] docs: add deployment annotation example (elastic#67408) [ML] Extend population preview chart to show actual and typical value (elastic#67569) Refactor index management client integration tests for scalability (elastic#67917) Add generator function that creates multiple alerts (elastic#67713) chore(NA): remove config arg from os packages (elastic#67871) [Reporting] Move code out of Legacy (elastic#67904) [Metrics UI] Add overrides to Snapshot API to support alert previews (elastic#68125) [Security] [Cases] Manage timeline UI API (elastic#67719) [ENDPOINT][INGEST]Task/endpoint ingest update (elastic#67234) Fix code coverage for jest, upload merged reports (elastic#68149) ...
bmorelli25
added a commit
that referenced
this pull request
Jun 4, 2020
bmorelli25
added a commit
that referenced
this pull request
Jun 4, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates the Track deployments with annotations how-to guide. The new content includes a copy/pastable cURL command as an example for easy integration with CI/CD pipelines.
Preview
coming soon