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] APM troubleshooting section #47073

Merged
merged 4 commits into from Oct 7, 2019

Conversation

@bmorelli25
Copy link
Member

commented Oct 1, 2019

Adds an APM troubleshooting section which includes information on loading the APM index template. Click here for a preview of these changes.

Closes elastic/apm-server#2470.

@bmorelli25 bmorelli25 requested a review from sqren Oct 1, 2019
@bmorelli25 bmorelli25 self-assigned this Oct 1, 2019
@elasticmachine

This comment has been minimized.

Copy link
Contributor

commented Oct 1, 2019

Pinging @elastic/apm-ui (Team:apm)

@bmorelli25

This comment has been minimized.

Copy link
Member Author

commented Oct 1, 2019

@sqren can you take a look at my first draft of this please

@elasticmachine

This comment has been minimized.

Copy link
Contributor

commented Oct 1, 2019

@elasticmachine

This comment has been minimized.

Copy link
Contributor

commented Oct 1, 2019

@sqren

This comment has been minimized.

Copy link
Member

commented Oct 2, 2019

Thanks for creating this @bmorelli25!
Two things:

  1. Perhaps add a comment about messages queues? Eg. if users are using Kafka setting setup.template.enabled: true won't have any effect.
  2. Users might have set setup.template.enabled: true but the index template is still not created (because they are using Kafka or similar). Can we add a command to the docs that users can run to determine whether the index template has been correctly created?

cc @jalvz

@bmorelli25

This comment has been minimized.

Copy link
Member Author

commented Oct 2, 2019

Perhaps add a comment about messages queues? Eg. if users are using Kafka setting setup.template.enabled: true won't have any effect.

I'm not sure what you mean by message queues?

Users might have set setup.template.enabled: true but the index template is still not created (because they are using Kafka or similar). Can we add a command to the docs that users can run to determine whether the index template has been correctly created?

This makes sense. I'm not sure what that command is though. Do you mean something like this: GET /_template/apm-{version}? Or some kind of APM Server command?

@sqren

This comment has been minimized.

Copy link
Member

commented Oct 2, 2019

This makes sense. I'm not sure what that command is though. Do you mean something like this: GET /_template/apm-{version}?

Yes, exactly. Something like that. I think perhaps @jalvz or @simitt has a better idea for how to verify the existence of the APM index template.

@sqren

This comment has been minimized.

Copy link
Member

commented Oct 2, 2019

I'm not sure what you mean by message queues?

Maybe message queues is the wrong term :D Some users have kafka between APM Server and Elasticsearch. So APM Server cannot create the index pattern. Maybe we just need to link to this: https://www.elastic.co/guide/en/apm/server/current/_manually_loading_template_configuration.html#load-template-manually-alternate

More information is available in {apm-server-ref}/apm-server-configuration.html[Set up and configure].

If you're not outputting data from APM Server directly to Elasticsearch, you'll need to
{apm-server-ref}/_manually_loading_template_configuration.html[load the template manually].

This comment has been minimized.

Copy link
@bmorelli25

bmorelli25 Oct 2, 2019

Author Member

@sqren, that's what I was attempting to say here. I'll make it more clear and update the link to point to that anchor. Thanks!

@elasticmachine

This comment has been minimized.

Copy link
Contributor

commented Oct 2, 2019

@bmorelli25

This comment has been minimized.

Copy link
Member Author

commented Oct 7, 2019

@sqren can I get a final 👍/ 👎please

@bmorelli25

This comment has been minimized.

Copy link
Member Author

commented Oct 7, 2019

Ah, sorry for the ping, just realized I need to make another update still.

@bmorelli25 bmorelli25 force-pushed the bmorelli25:add-apm-troubleshooting branch from 132a3b8 to 01a9783 Oct 7, 2019
@bmorelli25

This comment has been minimized.

Copy link
Member Author

commented Oct 7, 2019

Now it's ready!

@elasticmachine

This comment has been minimized.

Copy link
Contributor

commented Oct 7, 2019

@sqren
sqren approved these changes Oct 7, 2019
Copy link
Member

left a comment

🎉

bmorelli25 added 4 commits Oct 1, 2019
@bmorelli25 bmorelli25 force-pushed the bmorelli25:add-apm-troubleshooting branch from 01a9783 to aa127c3 Oct 7, 2019
@elasticmachine

This comment has been minimized.

Copy link
Contributor

commented Oct 7, 2019

@bmorelli25 bmorelli25 merged commit 3fad5c2 into elastic:master Oct 7, 2019
51 checks passed
51 checks passed
API integration tests node scripts/functional_tests --config test/api_integration/config.js --bail --debug
Details
Browser tests yarn run grunt test:browser-ci
Details
Build kbn_tp_sample_panel_action yarn build
Details
CLA All commits in pull request signed
Details
Check core API changes node scripts/check_core_api_changes
Details
Check file casing node scripts/check_file_casing --quiet
Details
Check licenses node scripts/check_licenses --dev
Details
Firefox smoke test node scripts/functional_tests --bail --debug --kibana-install-dir /var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/build/oss/kibana-8.0.0-SNAPSHOT-linux-x86_64 --include-tag smoke --config test/functional/config.firefox.js
Details
Functional tests / Group 1 yarn run grunt run:functionalTests_ciGroup1
Details
Functional tests / Group 10 yarn run grunt run:functionalTests_ciGroup10
Details
Functional tests / Group 11 yarn run grunt run:functionalTests_ciGroup11
Details
Functional tests / Group 12 yarn run grunt run:functionalTests_ciGroup12
Details
Functional tests / Group 2 yarn run grunt run:functionalTests_ciGroup2
Details
Functional tests / Group 3 yarn run grunt run:functionalTests_ciGroup3
Details
Functional tests / Group 4 yarn run grunt run:functionalTests_ciGroup4
Details
Functional tests / Group 5 yarn run grunt run:functionalTests_ciGroup5
Details
Functional tests / Group 6 yarn run grunt run:functionalTests_ciGroup6
Details
Functional tests / Group 7 yarn run grunt run:functionalTests_ciGroup7
Details
Functional tests / Group 8 yarn run grunt run:functionalTests_ciGroup8
Details
Functional tests / Group 9 yarn run grunt run:functionalTests_ciGroup9
Details
Internationalization check node scripts/i18n_check --ignore-missing
Details
Interpreter functional tests node scripts/functional_tests --config test/interpreter_functional/config.js --bail --debug --kibana-install-dir /var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/build/oss/kibana-8.0.0-SNAPSHOT-linux-x86_64-1
Details
Jest integration tests yarn run grunt test:jest_integration
Details
Jest tests yarn run grunt test:jest
Details
Mocha tests node scripts/mocha
Details
Plugin functional tests node scripts/functional_tests --config test/plugin_functional/config.js --bail --debug --kibana-install-dir /var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/build/oss/kibana-8.0.0-SNAPSHOT-linux-x86_64-1
Details
Project tests yarn run grunt test:projects
Details
Type check node scripts/type_check
Details
TypeScript - all files belong to a TypeScript project node scripts/check_ts_projects
Details
Verify NOTICE.txt node scripts/notice --validate
Details
Verify dependency versions yarn run grunt verifyDependencyVersions
Details
X-Pack Chrome Functional tests / Group 1 node scripts/functional_tests --debug --bail --kibana-install-dir /var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/install/kibana-1 --include-tag ciGroup1
Details
X-Pack Chrome Functional tests / Group 10 node scripts/functional_tests --debug --bail --kibana-install-dir /var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/install/kibana-5 --include-tag ciGroup10
Details
X-Pack Chrome Functional tests / Group 2 node scripts/functional_tests --debug --bail --kibana-install-dir /var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/install/kibana-2 --include-tag ciGroup2
Details
X-Pack Chrome Functional tests / Group 3 node scripts/functional_tests --debug --bail --kibana-install-dir /var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/install/kibana-3 --include-tag ciGroup3
Details
X-Pack Chrome Functional tests / Group 4 node scripts/functional_tests --debug --bail --kibana-install-dir /var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/install/kibana-4 --include-tag ciGroup4
Details
X-Pack Chrome Functional tests / Group 5 node scripts/functional_tests --debug --bail --kibana-install-dir /var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/install/kibana-5 --include-tag ciGroup5
Details
X-Pack Chrome Functional tests / Group 6 node scripts/functional_tests --debug --bail --kibana-install-dir /var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/install/kibana-1 --include-tag ciGroup6
Details
X-Pack Chrome Functional tests / Group 7 node scripts/functional_tests --debug --bail --kibana-install-dir /var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/install/kibana-2 --include-tag ciGroup7
Details
X-Pack Chrome Functional tests / Group 8 node scripts/functional_tests --debug --bail --kibana-install-dir /var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/install/kibana-3 --include-tag ciGroup8
Details
X-Pack Chrome Functional tests / Group 9 node scripts/functional_tests --debug --bail --kibana-install-dir /var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/install/kibana-4 --include-tag ciGroup9
Details
X-Pack Jest node scripts/jest --ci --verbose
Details
X-Pack Mocha yarn test
Details
X-Pack SIEM cyclic dependency test node legacy/plugins/siem/scripts/check_circular_deps
Details
X-Pack firefox smoke test node scripts/functional_tests --debug --bail --kibana-install-dir /var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/install/kibana-6 --include-tag smoke --config test/functional/config.firefox.js
Details
elasticsearch-ci/docs Build finished.
Details
eslint node scripts/eslint --no-cache
Details
kibana-ci Build finished.
Details
prbot:release note labels
prbot:release version labels
sasslint node scripts/sasslint
Details
@bmorelli25 bmorelli25 deleted the bmorelli25:add-apm-troubleshooting branch Oct 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.