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

Add new tutorials: Osquery, RabbitMQ, and uWSGI #20944

Merged
merged 4 commits into from
Jul 19, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 54 additions & 0 deletions src/core_plugins/kibana/server/tutorials/osquery_logs/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

import { TUTORIAL_CATEGORY } from '../../../common/tutorials/tutorial_category';
import { onPremInstructions, cloudInstructions, onPremCloudInstructions } from '../../../common/tutorials/filebeat_instructions';

export function osqueryLogsSpecProvider() {
const moduleName = 'osquery';
const geoipRequired = false;
const uaRequired = false;
const platforms = ['OSX', 'DEB', 'RPM', 'WINDOWS'];
return {
id: 'osqueryLogs',
name: 'Osquery logs',
category: TUTORIAL_CATEGORY.SECURITY,
shortDescription: 'Collect the result logs created by osqueryd.',
longDescription: 'The `osquery` Filebeat module collects the JSON result logs collected by `osqueryd`.' +
' [Learn more]({config.docs.beats.filebeat}/filebeat-module-osquery.html).',
//euiIconType: 'logoOsquery',
artifacts: {
dashboards: [
{
id: '69f5ae20-eb02-11e7-8f04-51231daa5b05',
linkLabel: 'Osquery logs dashboard',
isOverview: true
}
],
exportedFields: {
documentationUrl: '{config.docs.beats.filebeat}/exported-fields-osquery.html'
}
},
completionTimeMinutes: 10,
previewImagePath: '/plugins/kibana/home/tutorial_resources/osquery_logs/screenshot.png',
onPrem: onPremInstructions(moduleName, platforms, geoipRequired, uaRequired),
elasticCloud: cloudInstructions(moduleName, platforms),
onPremElasticCloud: onPremCloudInstructions(moduleName, platforms)
};
}
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ export function phpfpmMetricsSpecProvider() {
id: 'phpfpmMetrics',
name: 'PHP-FPM metrics',
category: TUTORIAL_CATEGORY.METRICS,
isBeta: true,
shortDescription: 'Fetch internal metrics from PHP-FPM.',
longDescription: 'The `php_fpm` Metricbeat module fetches internal metrics from the PHP-FPM server.' +
' [Learn more]({config.docs.beats.metricbeat}/metricbeat-module-php_fpm.html).',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ export function postgresqlMetricsSpecProvider() {
id: 'postgresqlMetrics',
name: 'PostgreSQL metrics',
category: TUTORIAL_CATEGORY.METRICS,
isBeta: true,
shortDescription: 'Fetch internal metrics from PostgreSQL.',
longDescription: 'The `postgresql` Metricbeat module fetches internal metrics from the PostgreSQL server.' +
' [Learn more]({config.docs.beats.metricbeat}/metricbeat-module-postgresql.html).',
Expand Down
52 changes: 52 additions & 0 deletions src/core_plugins/kibana/server/tutorials/rabbitmq_metrics/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

import { TUTORIAL_CATEGORY } from '../../../common/tutorials/tutorial_category';
import { onPremInstructions, cloudInstructions, onPremCloudInstructions } from '../../../common/tutorials/metricbeat_instructions';

export function rabbitmqMetricsSpecProvider() {
const moduleName = 'rabbitmq';
return {
id: 'rabbitmqMetrics',
name: 'RabbitMQ metrics',
category: TUTORIAL_CATEGORY.METRICS,
shortDescription: 'Fetch internal metrics from the RabbitMQ server.',
longDescription: 'The `rabbitmq` Metricbeat module fetches internal metrics from the RabbitMQ server.' +
' [Learn more]({config.docs.beats.metricbeat}/metricbeat-module-rabbitmq.html).',
//euiIconType: 'logoRabbitMQ',
isBeta: true,
artifacts: {
dashboards: [
{
id: 'AV4YobKIge1VCbKU_qVo',
linkLabel: 'RabbitMQ metrics dashboard',
isOverview: true
}
],
exportedFields: {
documentationUrl: '{config.docs.beats.metricbeat}/exported-fields-rabbitmq.html'
}
},
completionTimeMinutes: 10,
previewImagePath: '/plugins/kibana/home/tutorial_resources/rabbitmq_metrics/screenshot.png',
onPrem: onPremInstructions(moduleName),
elasticCloud: cloudInstructions(moduleName),
onPremElasticCloud: onPremCloudInstructions(moduleName)
};
}
6 changes: 6 additions & 0 deletions src/core_plugins/kibana/server/tutorials/register.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,15 @@ import { nginxMetricsSpecProvider } from './nginx_metrics';
import { mysqlLogsSpecProvider } from './mysql_logs';
import { mysqlMetricsSpecProvider } from './mysql_metrics';
import { mongodbMetricsSpecProvider } from './mongodb_metrics';
import { osqueryLogsSpecProvider } from './osquery_logs';
import { phpfpmMetricsSpecProvider } from './php_fpm_metrics';
import { postgresqlMetricsSpecProvider } from './postgresql_metrics';
import { rabbitmqMetricsSpecProvider } from './rabbitmq_metrics';
import { redisLogsSpecProvider } from './redis_logs';
import { redisMetricsSpecProvider } from './redis_metrics';
import { dockerMetricsSpecProvider } from './docker_metrics';
import { kubernetesMetricsSpecProvider } from './kubernetes_metrics';
import { uwsgiMetricsSpecProvider } from './uwsgi_metrics';
import { netflowSpecProvider } from './netflow';
import { apmSpecProvider } from './apm';
import { cephMetricsSpecProvider } from './ceph_metrics';
Expand All @@ -48,12 +51,15 @@ export function registerTutorials(server) {
server.registerTutorial(mysqlLogsSpecProvider);
server.registerTutorial(mysqlMetricsSpecProvider);
server.registerTutorial(mongodbMetricsSpecProvider);
server.registerTutorial(osqueryLogsSpecProvider);
server.registerTutorial(phpfpmMetricsSpecProvider);
server.registerTutorial(postgresqlMetricsSpecProvider);
server.registerTutorial(rabbitmqMetricsSpecProvider);
server.registerTutorial(redisLogsSpecProvider);
server.registerTutorial(redisMetricsSpecProvider);
server.registerTutorial(dockerMetricsSpecProvider);
server.registerTutorial(kubernetesMetricsSpecProvider);
server.registerTutorial(uwsgiMetricsSpecProvider);
server.registerTutorial(netflowSpecProvider);
server.registerTutorial(apmSpecProvider);
server.registerTutorial(cephMetricsSpecProvider);
Expand Down
52 changes: 52 additions & 0 deletions src/core_plugins/kibana/server/tutorials/uwsgi_metrics/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

import { TUTORIAL_CATEGORY } from '../../../common/tutorials/tutorial_category';
import { onPremInstructions, cloudInstructions, onPremCloudInstructions } from '../../../common/tutorials/metricbeat_instructions';

export function uwsgiMetricsSpecProvider() {
const moduleName = 'uwsgi';
return {
id: 'uwsgiMetrics',
name: 'uWSGI metrics',
category: TUTORIAL_CATEGORY.METRICS,
shortDescription: 'Fetch internal metrics from the uWSGI server.',
longDescription: 'The `uwsgi` Metricbeat module fetches internal metrics from the uWSGI server.' +
' [Learn more]({config.docs.beats.metricbeat}/metricbeat-module-uwsgi.html).',
//euiIconType: 'logouWSGI',
Copy link
Contributor

Choose a reason for hiding this comment

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

Did you keep them in on purpose?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, so it's easy to enable them when they are added.

isBeta: true,
artifacts: {
dashboards: [
{
id: '32fca290-f0af-11e7-b9ff-9f96241065de',
linkLabel: 'uWSGI metrics dashboard',
isOverview: true
}
],
exportedFields: {
documentationUrl: '{config.docs.beats.metricbeat}/exported-fields-uwsgi.html'
}
},
completionTimeMinutes: 10,
previewImagePath: '/plugins/kibana/home/tutorial_resources/uwsgi_metrics/screenshot.png',
onPrem: onPremInstructions(moduleName),
elasticCloud: cloudInstructions(moduleName),
onPremElasticCloud: onPremCloudInstructions(moduleName)
};
}