Skip to content

Commit

Permalink
[beats/heartbeat] Fix heartbeat add data instructions (elastic#24795) (
Browse files Browse the repository at this point in the history
…elastic#24813)

This commit does three things:
0. This fixes the instructions for interacting with the heartbeat service, which is called `heartbeat-elastic` not `heartbeat`
1. This removes some extraneous text that should be reserved for the subsequent section.
2. This makes the instructions for creating a monitor more explicit
  • Loading branch information
ruflin authored and andrewvc committed Oct 30, 2018
1 parent a659fc3 commit 23d89c8
Showing 1 changed file with 16 additions and 23 deletions.
39 changes: 16 additions & 23 deletions src/core_plugins/kibana/common/tutorials/heartbeat_instructions.js
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ export const createHeartbeatInstructions = context => ({
}),
commands: [
'sudo heartbeat setup',
'sudo service heartbeat start',
'sudo service heartbeat-elastic start',
]
},
RPM: {
Expand All @@ -131,7 +131,7 @@ export const createHeartbeatInstructions = context => ({
}),
commands: [
'sudo heartbeat setup',
'sudo service heartbeat start',
'sudo service heartbeat-elastic start',
],
},
WINDOWS: {
Expand Down Expand Up @@ -169,13 +169,11 @@ export const createHeartbeatInstructions = context => ({
],
textPost: i18n.translate('kbn.common.tutorials.heartbeatInstructions.config.osxTextPost', {
defaultMessage: 'Where {passwordTemplate} is the password of the `elastic` user, {esUrlTemplate} is the URL of Elasticsearch, \
and {kibanaUrlTemplate} is the URL of Kibana. \
To configure your own monitors check [configure Hearbeat docs]({configureLink}).',
and {kibanaUrlTemplate} is the URL of Kibana.',
values: {
passwordTemplate: '`<password>`',
esUrlTemplate: '`<es_url>`',
kibanaUrlTemplate: '`<kibana_url>`',
configureLink: '{config.docs.beats.heartbeat}/heartbeat-configuration.html',
},
}),
},
Expand All @@ -200,13 +198,11 @@ and {kibanaUrlTemplate} is the URL of Kibana. \
],
textPost: i18n.translate('kbn.common.tutorials.heartbeatInstructions.config.debTextPost', {
defaultMessage: 'Where {passwordTemplate} is the password of the `elastic` user, {esUrlTemplate} is the URL of Elasticsearch, \
and {kibanaUrlTemplate} is the URL of Kibana. \
To configure your own monitors check [configure Hearbeat docs]({configureLink}).',
and {kibanaUrlTemplate} is the URL of Kibana.',
values: {
passwordTemplate: '`<password>`',
esUrlTemplate: '`<es_url>`',
kibanaUrlTemplate: '`<kibana_url>`',
configureLink: '{config.docs.beats.heartbeat}/heartbeat-configuration.html',
},
}),
},
Expand All @@ -231,13 +227,11 @@ and {kibanaUrlTemplate} is the URL of Kibana. \
],
textPost: i18n.translate('kbn.common.tutorials.heartbeatInstructions.config.rpmTextPost', {
defaultMessage: 'Where {passwordTemplate} is the password of the `elastic` user, {esUrlTemplate} is the URL of Elasticsearch, \
and {kibanaUrlTemplate} is the URL of Kibana. \
To configure your own monitors check [configure Hearbeat docs]({configureLink}).',
and {kibanaUrlTemplate} is the URL of Kibana.',
values: {
passwordTemplate: '`<password>`',
esUrlTemplate: '`<es_url>`',
kibanaUrlTemplate: '`<kibana_url>`',
configureLink: '{config.docs.beats.heartbeat}/heartbeat-configuration.html',
},
}),
},
Expand All @@ -262,13 +256,11 @@ and {kibanaUrlTemplate} is the URL of Kibana. \
],
textPost: i18n.translate('kbn.common.tutorials.heartbeatInstructions.config.windowsTextPost', {
defaultMessage: 'Where {passwordTemplate} is the password of the `elastic` user, {esUrlTemplate} is the URL of Elasticsearch, \
and {kibanaUrlTemplate} is the URL of Kibana. \
To configure your own monitors check [configure Hearbeat docs]({configureLink}).',
and {kibanaUrlTemplate} is the URL of Kibana.',
values: {
passwordTemplate: '`<password>`',
esUrlTemplate: '`<es_url>`',
kibanaUrlTemplate: '`<kibana_url>`',
configureLink: '{config.docs.beats.heartbeat}/heartbeat-configuration.html',
},
}),
}
Expand Down Expand Up @@ -361,6 +353,7 @@ export function heartbeatEnableInstructionsOnPrem() {
defaultMessage: 'Edit the configuration - Add monitors',
});
const defaultCommands = [
'heartbeat.monitors:',
'- type: http',
' urls: ["<http://localhost:9200>"]',
' schedule: "@every 10s"'
Expand All @@ -377,31 +370,31 @@ export function heartbeatEnableInstructionsOnPrem() {
OSX: {
title: defaultTitle,
textPre: i18n.translate('kbn.common.tutorials.heartbeatEnableOnPremInstructions.osxTextPre', {
defaultMessage: 'Modify the settings in the `heartbeat.yml` file.',
defaultMessage: 'Edit the `heartbeat.monitors` setting in the `heartbeat.yml` file.',
}),
commands: defaultCommands,
textPost: defaultTextPost
},
DEB: {
title: defaultTitle,
textPre: i18n.translate('kbn.common.tutorials.heartbeatEnableOnPremInstructions.debTextPre', {
defaultMessage: 'Modify the monitors in the `/etc/heartbeat/heartbeat.yml` file.',
defaultMessage: 'Edit the `heartbeat.monitors` setting in the `heartbeat.yml` file.',
}),
commands: defaultCommands,
textPost: defaultTextPost
},
RPM: {
title: defaultTitle,
textPre: i18n.translate('kbn.common.tutorials.heartbeatEnableOnPremInstructions.rpmTextPre', {
defaultMessage: 'Modify the monitors in the `/etc/heartbeat/heartbeat.yml` file.',
defaultMessage: 'Edit the `heartbeat.monitors` setting in the `heartbeat.yml` file.',
}),
commands: defaultCommands,
textPost: defaultTextPost
},
WINDOWS: {
title: defaultTitle,
textPre: i18n.translate('kbn.common.tutorials.heartbeatEnableOnPremInstructions.windowsTextPre', {
defaultMessage: 'Modify the monitors in the `/etc/heartbeat/heartbeat.yml` file.',
defaultMessage: 'Edit the `heartbeat.monitors` setting in the `heartbeat.yml` file.',
}),
commands: defaultCommands,
textPost: defaultTextPost
Expand All @@ -414,6 +407,7 @@ export function heartbeatEnableInstructionsCloud() {
defaultMessage: 'Edit the configuration - Add monitors',
});
const defaultCommands = [
'heartbeat.monitors:',
'- type: http',
' urls: ["http://elastic.co"]',
' schedule: "@every 10s"'
Expand All @@ -426,32 +420,31 @@ export function heartbeatEnableInstructionsCloud() {
OSX: {
title: defaultTitle,
textPre: i18n.translate('kbn.common.tutorials.heartbeatEnableCloudInstructions.osxTextPre', {
defaultMessage: 'Modify the settings in the `heartbeat.yml` file.',
defaultMessage: 'Edit the `heartbeat.monitors` setting in the `heartbeat.yml` file.',
}),
commands: defaultCommands,
textPost: defaultTextPost
},
DEB: {
title: defaultTitle,
textPre: i18n.translate('kbn.common.tutorials.heartbeatEnableCloudInstructions.debTextPre', {
defaultMessage: 'Modify the monitors in the `/etc/heartbeat/heartbeat.yml` file.',
defaultMessage: 'Edit the `heartbeat.monitors` setting in the `heartbeat.yml` file.',
}),
commands: defaultCommands,
textPost: defaultTextPost
},
RPM: {
title: defaultTitle,
textPre: i18n.translate('kbn.common.tutorials.heartbeatEnableCloudInstructions.rpmTextPre', {
defaultMessage: 'Modify the monitors in the `/etc/heartbeat/heartbeat.yml` file.',
defaultMessage: 'Edit the `heartbeat.monitors` setting in the `heartbeat.yml` file.',
}),
commands: defaultCommands,
textPost: defaultTextPost
},
WINDOWS: {
title: defaultTitle,
textPre: i18n.translate('kbn.common.tutorials.heartbeatEnableCloudInstructions.windowsTextPre', {
defaultMessage: 'From the {path} folder, run:',
values: { path: `C:\\Program Files\\Heartbeat` },
defaultMessage: 'Edit the `heartbeat.monitors` setting in the `heartbeat.yml` file.',
}),
commands: defaultCommands,
textPost: defaultTextPost
Expand Down

0 comments on commit 23d89c8

Please sign in to comment.