Skip to content

Commit

Permalink
Add googlecloud metricbeat module to Kibana Home
Browse files Browse the repository at this point in the history
  • Loading branch information
kaiyan-sheng committed Jul 2, 2020
1 parent 854e7a5 commit 007086c
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 1 deletion.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ export interface TutorialSchema {
name: string;
isBeta?: boolean;
shortDescription: string;
euiIconType?: IconType; // EUI icon type string, one of https://elastic.github.io/eui/#/icon;
euiIconType?: IconType; // EUI icon type string, one of https://elastic.github.io/eui/#/display/icons;
longDescription: string;
completionTimeMinutes?: number;
previewImagePath?: string;
Expand Down
77 changes: 77 additions & 0 deletions src/plugins/home/server/tutorials/googlecloud_metrics/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
/*
* 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 { TutorialsCategory } from '../../services/tutorials';
import {
onPremInstructions,
cloudInstructions,
onPremCloudInstructions,
} from '../instructions/metricbeat_instructions';
import {
TutorialContext,
TutorialSchema,
} from '../../services/tutorials/lib/tutorials_registry_types';

export function googlecloudMetricsSpecProvider(context: TutorialContext): TutorialSchema {
const moduleName = 'googlecloud';
return {
id: 'googlecloudMetrics',
name: i18n.translate('home.tutorials.googlecloudMetrics.nameTitle', {
defaultMessage: 'Google Cloud metrics',
}),
category: TutorialsCategory.METRICS,
shortDescription: i18n.translate('home.tutorials.googlecloudMetrics.shortDescription', {
defaultMessage:
'Fetch monitoring metrics from Google Cloud Platform using Stackdriver Monitoring API.',
}),
longDescription: i18n.translate('home.tutorials.googlecloudMetrics.longDescription', {
defaultMessage:
'The `googlecloud` Metricbeat module fetches monitoring metrics from Google Cloud Platform using Stackdriver Monitoring API. \
[Learn more]({learnMoreLink}).',
values: {
learnMoreLink: '{config.docs.beats.metricbeat}/metricbeat-module-googlecloud.html',
},
}),
euiIconType: 'logoGCP',
isBeta: false,
artifacts: {
dashboards: [
{
id: 'f40ee870-5e4a-11ea-a4f6-717338406083',
linkLabel: i18n.translate(
'home.tutorials.googlecloudMetrics.artifacts.dashboards.linkLabel',
{
defaultMessage: 'Google Cloud metrics dashboard',
}
),
isOverview: true,
},
],
exportedFields: {
documentationUrl: '{config.docs.beats.metricbeat}/exported-fields-googlecloud.html',
},
},
completionTimeMinutes: 10,
previewImagePath: '/plugins/home/assets/googlecloud_metrics/screenshot.png',
onPrem: onPremInstructions(moduleName, context),
elasticCloud: cloudInstructions(moduleName),
onPremElasticCloud: onPremCloudInstructions(moduleName),
};
}
2 changes: 2 additions & 0 deletions src/plugins/home/server/tutorials/register.ts
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ import { openmetricsMetricsSpecProvider } from './openmetrics_metrics';
import { oracleMetricsSpecProvider } from './oracle_metrics';
import { iisMetricsSpecProvider } from './iis_metrics';
import { azureLogsSpecProvider } from './azure_logs';
import { googlecloudMetricsSpecProvider } from './googlecloud_metrics';

export const builtInTutorials = [
systemLogsSpecProvider,
Expand Down Expand Up @@ -168,4 +169,5 @@ export const builtInTutorials = [
oracleMetricsSpecProvider,
iisMetricsSpecProvider,
azureLogsSpecProvider,
googlecloudMetricsSpecProvider,
];

0 comments on commit 007086c

Please sign in to comment.