[Monitoring] Add error state for unstructured logs (#53299) (#53338)

* Add error state for unstructured logs * Fix tests
elastic · Dec 18, 2019 · 3b16d3a · 3b16d3a
1 parent 1dae172
commit 3b16d3a
Show file tree

Hide file tree

Showing 12 changed files with 87 additions and 7 deletions.
diff --git a/x-pack/legacy/plugins/monitoring/public/components/logs/__snapshots__/reason.test.js.snap b/x-pack/legacy/plugins/monitoring/public/components/logs/__snapshots__/reason.test.js.snap
diff --git a/x-pack/legacy/plugins/monitoring/public/components/logs/reason.js b/x-pack/legacy/plugins/monitoring/public/components/logs/reason.js
@@ -9,6 +9,7 @@ import { EuiCallOut, EuiLink } from '@elastic/eui';
 import { i18n } from '@kbn/i18n';
 import { FormattedMessage } from '@kbn/i18n/react';
 import { ELASTIC_WEBSITE_URL, DOC_LINK_VERSION } from 'ui/documentation_links';
+import { Monospace } from '../metricbeat_migration/instruction_steps/components/monospace/monospace';
 
 export const Reason = ({ reason }) => {
   let title = i18n.translate('xpack.monitoring.logs.reason.defaultTitle', {
@@ -91,6 +92,29 @@ export const Reason = ({ reason }) => {
         }}
       />
     );
+  } else if (false === reason.usingStructuredLogs) {
+    title = i18n.translate('xpack.monitoring.logs.reason.notUsingStructuredLogsTitle', {
+      defaultMessage: 'No structured logs found',
+    });
+    message = (
+      <FormattedMessage
+        id="xpack.monitoring.logs.reason.notUsingStructuredLogsMessage"
+        defaultMessage="Check if the {varPaths} setting {link}."
+        values={{
+          varPaths: <Monospace>var.paths</Monospace>,
+          link: (
+            <EuiLink
+              target="_blank"
+              href={`${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-module-elasticsearch.html`}
+            >
+              {i18n.translate('xpack.monitoring.logs.reason.notUsingStructuredLogsLink', {
+                defaultMessage: 'points to JSON logs',
+              })}
+            </EuiLink>
+          ),
+        }}
+      />
+    );
   } else if (false === reason.clusterExists) {
     title = i18n.translate('xpack.monitoring.logs.reason.noClusterTitle', {
       defaultMessage: 'No logs for this cluster',
@@ -103,7 +127,7 @@ export const Reason = ({ reason }) => {
           link: (
             <EuiLink
               target="_blank"
-              href={`${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-installation.html`}
+              href={`${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-module-elasticsearch.html`}
             >
               {i18n.translate('xpack.monitoring.logs.reason.noClusterLink', {
                 defaultMessage: 'setup',
@@ -125,7 +149,7 @@ export const Reason = ({ reason }) => {
           link: (
             <EuiLink
               target="_blank"
-              href={`${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-installation.html`}
+              href={`${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-module-elasticsearch.html`}
             >
               {i18n.translate('xpack.monitoring.logs.reason.noNodeLink', {
                 defaultMessage: 'setup',
@@ -147,7 +171,7 @@ export const Reason = ({ reason }) => {
           link: (
             <EuiLink
               target="_blank"
-              href={`${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-installation.html`}
+              href={`${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}/filebeat-module-elasticsearch.html`}
             >
               {i18n.translate('xpack.monitoring.logs.reason.noIndexLink', {
                 defaultMessage: 'setup',

diff --git a/x-pack/legacy/plugins/monitoring/public/components/logs/reason.test.js b/x-pack/legacy/plugins/monitoring/public/components/logs/reason.test.js
@@ -29,6 +29,13 @@ describe('Logs', () => {
     expect(component).toMatchSnapshot();
   });
 
+  it('should render with a no structured logs reason', () => {
+    const component = shallow(
+      <Reason reason={{ indexPatternExists: true, typeExists: true, usingStructuredLogs: false }} />
+    );
+    expect(component).toMatchSnapshot();
+  });
+
   it('should render with a no cluster found reason', () => {
     const component = shallow(
       <Reason reason={{ indexPatternExists: true, typeExists: true, clusterExists: false }} />

diff --git a/x-pack/legacy/plugins/monitoring/server/lib/logs/detect_reason.js b/x-pack/legacy/plugins/monitoring/server/lib/logs/detect_reason.js
@@ -16,6 +16,7 @@ async function doesFilebeatIndexExist(
   const filter = [createTimeFilter({ start, end, metric })];
 
   const typeFilter = { term: { 'service.type': 'elasticsearch' } };
+  const structuredLogsFilter = { exists: { field: 'elasticsearch.cluster' } };
   const clusterFilter = { term: { 'elasticsearch.cluster.uuid': clusterUuid } };
   const nodeFilter = { term: { 'elasticsearch.node.id': nodeUuid } };
   const indexFilter = { term: { 'elasticsearch.index.name': indexUuid } };
@@ -44,6 +45,14 @@ async function doesFilebeatIndexExist(
     },
   };
 
+  const usingStructuredLogsQuery = {
+    query: {
+      bool: {
+        filter: [...filter, typeFilter, structuredLogsFilter],
+      },
+    },
+  };
+
   const clusterExistsQuery = {
     query: {
       bool: {
@@ -81,6 +90,8 @@ async function doesFilebeatIndexExist(
     { ...defaultParams, ...typeExistsAtAnyTimeQuery },
     { index: filebeatIndexPattern },
     { ...defaultParams, ...typeExistsQuery },
+    { index: filebeatIndexPattern },
+    { ...defaultParams, ...usingStructuredLogsQuery },
   ];
 
   if (clusterUuid) {
@@ -102,6 +113,7 @@ async function doesFilebeatIndexExist(
       indexPatternExistsInTimeRangeResponse,
       typeExistsAtAnyTimeResponse,
       typeExistsResponse,
+      usingStructuredLogsResponse,
       clusterExistsResponse,
       nodeExistsResponse,
       indexExistsResponse,
@@ -114,6 +126,7 @@ async function doesFilebeatIndexExist(
       get(indexPatternExistsInTimeRangeResponse, 'hits.total.value', 0) > 0,
     typeExistsAtAnyTime: get(typeExistsAtAnyTimeResponse, 'hits.total.value', 0) > 0,
     typeExists: get(typeExistsResponse, 'hits.total.value', 0) > 0,
+    usingStructuredLogs: get(usingStructuredLogsResponse, 'hits.total.value', 0) > 0,
     clusterExists: clusterUuid ? get(clusterExistsResponse, 'hits.total.value', 0) > 0 : null,
     nodeExists: nodeUuid ? get(nodeExistsResponse, 'hits.total.value', 0) > 0 : null,
     indexExists: indexUuid ? get(indexExistsResponse, 'hits.total.value', 0) > 0 : null,

diff --git a/x-pack/test/api_integration/apis/monitoring/cluster/fixtures/overview.json b/x-pack/test/api_integration/apis/monitoring/cluster/fixtures/overview.json
@@ -69,7 +69,8 @@
         "nodeExists": null,
         "indexExists": null,
         "typeExists": false,
-        "typeExistsAtAnyTime": false
+        "typeExistsAtAnyTime": false,
+        "usingStructuredLogs": false
       },
       "types": []
     }

diff --git a/x-pack/test/api_integration/apis/monitoring/elasticsearch/fixtures/index_detail.json b/x-pack/test/api_integration/apis/monitoring/elasticsearch/fixtures/index_detail.json
@@ -17,6 +17,7 @@
       "indexPatternExists": false,
       "indexPatternInTimeRangeExists": false,
       "typeExistsAtAnyTime": false,
+      "usingStructuredLogs": false,
       "nodeExists": null,
       "indexExists": false,
       "typeExists": false

diff --git a/x-pack/test/api_integration/apis/monitoring/elasticsearch/fixtures/node_detail.json b/x-pack/test/api_integration/apis/monitoring/elasticsearch/fixtures/node_detail.json
@@ -18,6 +18,7 @@
       "indexPatternExists": false,
       "indexPatternInTimeRangeExists": false,
       "typeExistsAtAnyTime": false,
+      "usingStructuredLogs": false,
       "nodeExists": false,
       "indexExists": null,
       "typeExists": false

diff --git a/.../test/api_integration/apis/monitoring/elasticsearch/fixtures/overview_green_platinum.json b/.../test/api_integration/apis/monitoring/elasticsearch/fixtures/overview_green_platinum.json
@@ -5757,6 +5757,7 @@
       "indexPatternExists": false,
       "indexPatternInTimeRangeExists": false,
       "typeExistsAtAnyTime": false,
+      "usingStructuredLogs": false,
       "nodeExists": null,
       "indexExists": null,
       "typeExists": false

diff --git a/...ck/test/api_integration/apis/monitoring/elasticsearch/fixtures/overview_red_platinum.json b/...ck/test/api_integration/apis/monitoring/elasticsearch/fixtures/overview_red_platinum.json
@@ -22,6 +22,7 @@
       "indexPatternExists": false,
       "indexPatternInTimeRangeExists": false,
       "typeExistsAtAnyTime": false,
+      "usingStructuredLogs": false,
       "nodeExists": null,
       "indexExists": null,
       "typeExists": false

diff --git a/...st/api_integration/apis/monitoring/elasticsearch/fixtures/overview_shards_relocating.json b/...st/api_integration/apis/monitoring/elasticsearch/fixtures/overview_shards_relocating.json
@@ -22,6 +22,7 @@
       "indexPatternExists": false,
       "indexPatternInTimeRangeExists": false,
       "typeExistsAtAnyTime": false,
+      "usingStructuredLogs": false,
       "nodeExists": null,
       "indexExists": null,
       "typeExists": false

diff --git a/x-pack/test/api_integration/apis/monitoring/logs/fixtures/multiple_clusters.json b/x-pack/test/api_integration/apis/monitoring/logs/fixtures/multiple_clusters.json
@@ -5,6 +5,7 @@
     "indexPatternExists": true,
     "indexPatternInTimeRangeExists": true,
     "typeExistsAtAnyTime": true,
+    "usingStructuredLogs": true,
     "typeExists": true,
     "clusterExists": false,
     "nodeExists": null,

diff --git a/x-pack/test/api_integration/apis/monitoring/standalone_cluster/fixtures/cluster.json b/x-pack/test/api_integration/apis/monitoring/standalone_cluster/fixtures/cluster.json
@@ -16,6 +16,7 @@
         "indexPatternExists": false,
         "indexPatternInTimeRangeExists": false,
         "typeExistsAtAnyTime": false,
+        "usingStructuredLogs": false,
         "nodeExists": null,
         "indexExists": null,
         "typeExists": false