[Home][Tutorial] Add Openmetrics data UI (elastic#61073)

src/plugins/home/server/tutorials/openmetrics_metrics/index.ts

@@ -0,0 +1,63 @@
+/*
+ * 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 openmetricsMetricsSpecProvider(context: TutorialContext): TutorialSchema {
+  const moduleName = 'openmetrics';
+  return {
+    id: 'openmetricsMetrics',
+    name: i18n.translate('home.tutorials.openmetricsMetrics.nameTitle', {
+      defaultMessage: 'OpenMetrics metrics',
+    }),
+    category: TutorialsCategory.METRICS,
+    shortDescription: i18n.translate('home.tutorials.openmetricsMetrics.shortDescription', {
+      defaultMessage: 'Fetch metrics from an endpoint that serves metrics in OpenMetrics format.',
+    }),
+    longDescription: i18n.translate('home.tutorials.openmetricsMetrics.longDescription', {
+      defaultMessage:
+        'The `openmetrics` Metricbeat module fetches metrics from an endpoint that serves metrics in OpenMetrics format. \
+[Learn more]({learnMoreLink}).',
+      values: {
+        learnMoreLink: '{config.docs.beats.metricbeat}/metricbeat-module-openmetrics.html',
+      },
+    }),
+    euiIconType: '/plugins/kibana/home/tutorial_resources/logos/openmetrics.svg',
+    artifacts: {
+      dashboards: [],
+      exportedFields: {
+        documentationUrl: '{config.docs.beats.metricbeat}/exported-fields-openmetrics.html',
+      },
+    },
+    completionTimeMinutes: 10,
+    onPrem: onPremInstructions(moduleName, context),
+    elasticCloud: cloudInstructions(moduleName),
+    onPremElasticCloud: onPremCloudInstructions(moduleName),
+  };
+}

src/plugins/home/server/tutorials/register.ts

@@ -87,6 +87,7 @@ import { envoyproxyMetricsSpecProvider } from './envoyproxy_metrics';
 import { ibmmqMetricsSpecProvider } from './ibmmq_metrics';
 import { statsdMetricsSpecProvider } from './statsd_metrics';
 import { redisenterpriseMetricsSpecProvider } from './redisenterprise_metrics';
+import { openmetricsMetricsSpecProvider } from './openmetrics_metrics';
 
 export const builtInTutorials = [
   systemLogsSpecProvider,
@@ -160,4 +161,5 @@ export const builtInTutorials = [
   envoyproxyMetricsSpecProvider,
   statsdMetricsSpecProvider,
   redisenterpriseMetricsSpecProvider,
+  openmetricsMetricsSpecProvider,
 ];