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 Kibana Home Tutorial for Filebeat zeek module #31774

Merged
merged 3 commits into from
Feb 28, 2019
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.
2 changes: 2 additions & 0 deletions src/legacy/core_plugins/kibana/server/tutorials/register.js
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ import { awsMetricsSpecProvider } from './aws_metrics';
import { mssqlMetricsSpecProvider } from './mssql_metrics';
import { natsMetricsSpecProvider } from './nats_metrics';
import { natsLogsSpecProvider } from './nats_logs';
import { zeekLogsSpecProvider } from './zeek_logs';

export function registerTutorials(server) {
server.registerTutorial(systemLogsSpecProvider);
Expand Down Expand Up @@ -119,4 +120,5 @@ export function registerTutorials(server) {
server.registerTutorial(mssqlMetricsSpecProvider);
server.registerTutorial(natsMetricsSpecProvider);
server.registerTutorial(natsLogsSpecProvider);
server.registerTutorial(zeekLogsSpecProvider);
}
65 changes: 65 additions & 0 deletions src/legacy/core_plugins/kibana/server/tutorials/zeek_logs/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
/*
* 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 { i18n } from '@kbn/i18n';
import { TUTORIAL_CATEGORY } from '../../../common/tutorials/tutorial_category';
import { onPremInstructions, cloudInstructions, onPremCloudInstructions } from '../../../common/tutorials/filebeat_instructions';

export function zeekLogsSpecProvider(server, context) {
const moduleName = 'zeek';
const platforms = ['OSX', 'DEB', 'RPM'];
return {
id: 'zeekLogs',
name: i18n.translate('kbn.server.tutorials.zeekLogs.nameTitle', {
defaultMessage: 'Zeek logs',
}),
category: TUTORIAL_CATEGORY.SECURITY,
shortDescription: i18n.translate('kbn.server.tutorials.zeekLogs.shortDescription', {
defaultMessage: 'Collect the logs created by Zeek/Bro.',
alakahakai marked this conversation as resolved.
Show resolved Hide resolved
}),
longDescription: i18n.translate('kbn.server.tutorials.zeekLogs.longDescription', {
defaultMessage: 'The `zeek` Filebeat module collects the logs from \
[Zeek](https://www.zeek.org//documentation/index.html). \
[Learn more]({learnMoreLink}).',
values: {
learnMoreLink: '{config.docs.beats.filebeat}/filebeat-module-zeek.html',
},
}),
//TODO: euiIconType: 'logoZeek',
artifacts: {
dashboards: [
{
id: '7cbb5410-3700-11e9-aa6d-ff445a78330c',
linkLabel: i18n.translate('kbn.server.tutorials.zeekLogs.artifacts.dashboards.linkLabel', {
defaultMessage: 'Zeek logs dashboard',
}),
isOverview: true
}
],
exportedFields: {
documentationUrl: '{config.docs.beats.filebeat}/exported-fields-zeek.html'
}
},
completionTimeMinutes: 10,
previewImagePath: '/plugins/kibana/home/tutorial_resources/zeek_logs/screenshot.png',
onPrem: onPremInstructions(moduleName, platforms, context),
elasticCloud: cloudInstructions(moduleName, platforms),
onPremElasticCloud: onPremCloudInstructions(moduleName, platforms)
};
}