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.

Sign up for GitHub

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

[Stack Monitoring] health api support for data ingested from package #138964

Merged
merged 11 commits into from
Sep 6, 2022
Merged

[Stack Monitoring] health api support for data ingested from package #138964

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
7483e57
query for data_stream datasets
klacabane Aug 16, 2022
fa607c0
support package collection mode
klacabane Aug 16, 2022
8ca4a83
build index with metrics pattern
klacabane Aug 17, 2022
8c39be9
trailing comma
klacabane Aug 17, 2022
aa2d98b
use getNewIndexPatterns everywhere
klacabane Aug 25, 2022
cc8f319
Merge branch 'main' into 138864-health-api-metrics
klacabane Aug 25, 2022
aec57b9
Merge branch 'main' into 138864-health-api-metrics
klacabane Aug 26, 2022
7e3a1c1
Merge branch 'main' into 138864-health-api-metrics
klacabane Aug 29, 2022
6b99818
Merge branch 'main' into 138864-health-api-metrics
klacabane Aug 29, 2022
f8d1a09
Merge branch 'main' into 138864-health-api-metrics
kibanamachine Sep 6, 2022
296cb0d
Include new stack_monitoring infix in healthcheck dataset name
matschaffer Sep 6, 2022
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
29 changes: 17 additions & 12 deletions x-pack/plugins/monitoring/server/routes/api/v1/_health/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@
import type { LegacyRequest, MonitoringCore } from '../../../../types';
import type { MonitoringConfig } from '../../../../config';
import { createValidationFunction } from '../../../../lib/create_route_validation_function';
import {
getNewIndexPatterns,
getLegacyIndexPattern,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Took the opportunity to reuse the functions used to build the patterns throughout the server code

} from '../../../../lib/cluster/get_index_patterns';
import { getHealthRequestQueryRT } from '../../../../../common/http_api/_health';
import type { TimeRange } from '../../../../../common/http_api/shared';
import { INDEX_PATTERN, INDEX_PATTERN_ENTERPRISE_SEARCH } from '../../../../../common/constants';

import { fetchMonitoredClusters } from './monitored_clusters';
import { fetchMetricbeatErrors } from './metricbeat';
Expand All @@ -21,13 +24,7 @@ const DEFAULT_QUERY_TIMEOUT_SECONDS = 15;

export function registerV1HealthRoute(server: MonitoringCore) {
const validateQuery = createValidationFunction(getHealthRequestQueryRT);

const withCCS = (indexPattern: string) => {
if (server.config.ui.ccs.enabled) {
return `${indexPattern},*:${indexPattern}`;
}
return indexPattern;
};
const { config } = server;

server.route({
method: 'get',
Expand All @@ -44,7 +41,7 @@ export function registerV1HealthRoute(server: MonitoringCore) {
const timeout = req.query.timeout || DEFAULT_QUERY_TIMEOUT_SECONDS;
const { callWithRequest } = req.server.plugins.elasticsearch.getCluster('monitoring');

const settings = extractSettings(server.config);
const settings = extractSettings(config);

const fetchArgs: FetchParameters = {
timeout,
Expand All @@ -53,11 +50,19 @@ export function registerV1HealthRoute(server: MonitoringCore) {
logger,
};

const monitoringIndex = [
getNewIndexPatterns({ config, moduleType: 'elasticsearch' }),
getNewIndexPatterns({ config, moduleType: 'kibana' }),
getNewIndexPatterns({ config, moduleType: 'logstash' }),
getLegacyIndexPattern({ config, moduleType: 'beats' }),
klacabane marked this conversation as resolved.
Show resolved Hide resolved
].join(',');
const entSearchIndex = getLegacyIndexPattern({ config, moduleType: 'enterprisesearch' });

const monitoredClustersFn = () =>
fetchMonitoredClusters({
...fetchArgs,
monitoringIndex: withCCS(INDEX_PATTERN),
entSearchIndex: withCCS(INDEX_PATTERN_ENTERPRISE_SEARCH),
monitoringIndex,
entSearchIndex,
}).catch((err: Error) => {
logger.error(`_health: failed to retrieve monitored clusters:\n${err.stack}`);
return { error: err.message };
Expand All @@ -66,7 +71,7 @@ export function registerV1HealthRoute(server: MonitoringCore) {
const metricbeatErrorsFn = () =>
fetchMetricbeatErrors({
...fetchArgs,
metricbeatIndex: server.config.ui.metricbeat.index,
metricbeatIndex: config.ui.metricbeat.index,
}).catch((err: Error) => {
logger.error(`_health: failed to retrieve metricbeat data:\n${err.stack}`);
return { error: err.message };
Expand Down
24 changes: 24 additions & 0 deletions ...nitoring/server/routes/api/v1/_health/monitored_clusters/build_monitored_clusters.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,22 @@ describe(__filename, () => {
},
},
},
{
key: 'node_two',
shard: {
by_index: {
buckets: [
{
key: '.ds-metrics-elasticsearch.shard-default-2022.08.16-000001',
last_seen: {
value: 123,
value_as_string: '2022-08-06',
},
},
],
},
},
},
],
},
},
Expand All @@ -52,6 +68,14 @@ describe(__filename, () => {
},
},
},
node_two: {
shard: {
package: {
index: '.ds-metrics-elasticsearch.shard-default-2022.08.16-000001',
lastSeen: '2022-08-06',
},
},
},
},
},
});
Expand Down
3 changes: 3 additions & 0 deletions ...ns/monitoring/server/routes/api/v1/_health/monitored_clusters/build_monitored_clusters.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ enum CollectionMode {
Internal = 'internal-monitoring',
Metricbeat7 = 'metricbeat-7',
Metricbeat8 = 'metricbeat-8',
Package = 'package',
Unknown = 'unknown',
}

Expand Down Expand Up @@ -42,11 +43,13 @@ const metricbeatMonitoring7Pattern =
/(.*:)?\.monitoring-(es|kibana|beats|logstash|ent-search)-7.*-mb.*/;
const metricbeatMonitoring8Pattern =
/(.*:)?\.ds-\.monitoring-(es|kibana|beats|logstash|ent-search)-8-mb.*/;
const packagePattern = /(.*:)?\.ds-metrics-(elasticsearch|kibana|logstash)\..*/;

const getCollectionMode = (index: string): CollectionMode => {
if (internalMonitoringPattern.test(index)) return CollectionMode.Internal;
if (metricbeatMonitoring7Pattern.test(index)) return CollectionMode.Metricbeat7;
if (metricbeatMonitoring8Pattern.test(index)) return CollectionMode.Metricbeat8;
if (packagePattern.test(index)) return CollectionMode.Package;

return CollectionMode.Unknown;
};
Expand Down
55 changes: 55 additions & 0 deletions ...ns/monitoring/server/routes/api/v1/_health/monitored_clusters/monitored_clusters_query.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ import { TimeRange } from '../../../../../../common/http_api/shared';

const MAX_BUCKET_SIZE = 100;

const getDataset = (product: string) => (metricset: string) => `${product}.${metricset}`;
const getElasticsearchDataset = getDataset('elasticsearch');
const getKibanaDataset = getDataset('kibana');
const getLogstashDataset = getDataset('logstash');

interface QueryOptions {
timeRange?: TimeRange;
timeout: number; // in seconds
Expand Down Expand Up @@ -72,6 +77,11 @@ export const persistentMetricsetsQuery = ({ timeout }: QueryOptions) => {
'metricset.name': 'shard',
},
},
{
term: {
'data_stream.dataset': getElasticsearchDataset('shard'),
},
},
];

const logstashStateMatches = [
Expand All @@ -85,6 +95,11 @@ export const persistentMetricsetsQuery = ({ timeout }: QueryOptions) => {
'metricset.name': 'node',
},
},
{
term: {
'data_stream.dataset': getLogstashDataset('node'),
},
},
];

const metricsetsAggregations = {
Expand Down Expand Up @@ -260,6 +275,11 @@ const clusterAggregation = {
'metricset.name': 'cluster_stats',
},
},
{
term: {
'data_stream.dataset': getElasticsearchDataset('cluster_stats'),
},
},
],
},
},
Expand All @@ -279,6 +299,11 @@ const clusterAggregation = {
'metricset.name': 'ccr',
},
},
{
term: {
'data_stream.dataset': getElasticsearchDataset('ccr'),
},
},
],
},
},
Expand All @@ -298,6 +323,11 @@ const clusterAggregation = {
'metricset.name': 'index',
},
},
{
term: {
'data_stream.dataset': getElasticsearchDataset('index'),
},
},
],
},
},
Expand All @@ -317,6 +347,11 @@ const clusterAggregation = {
'metricset.name': 'index_summary',
},
},
{
term: {
'data_stream.dataset': getElasticsearchDataset('index_summary'),
},
},
],
},
},
Expand All @@ -336,6 +371,11 @@ const clusterAggregation = {
'metricset.name': 'index_recovery',
},
},
{
term: {
'data_stream.dataset': getElasticsearchDataset('index_recovery'),
},
},
],
},
},
Expand Down Expand Up @@ -364,6 +404,11 @@ const esAggregation = {
'metricset.name': 'node_stats',
},
},
{
term: {
'data_stream.dataset': getElasticsearchDataset('node_stats'),
},
},
],
},
},
Expand Down Expand Up @@ -391,6 +436,11 @@ const kibanaAggregation = {
'metricset.name': 'stats',
},
},
{
term: {
'data_stream.dataset': getKibanaDataset('stats'),
},
},
],
},
},
Expand Down Expand Up @@ -418,6 +468,11 @@ const logstashAggregation = {
'metricset.name': 'node_stats',
},
},
{
term: {
'data_stream.dataset': getLogstashDataset('node_stats'),
},
},
],
},
},
Expand Down