Handle missing index/message on permalink page properly.

changelog/unreleased/issue-21653.toml

@@ -0,0 +1,5 @@
+type = "f"
+message = "Show helpful error/explanation on message permalink page when index/message is missing."
+
+pulls = ["21663"]
+issues = ["21653"]

graylog2-server/src/main/java/org/graylog2/rest/resources/messages/MessageResource.java

@@ -40,6 +40,7 @@
 import org.apache.shiro.authz.annotation.RequiresAuthentication;
 import org.apache.shiro.authz.annotation.RequiresPermissions;
 import org.graylog2.audit.jersey.NoAuditEvent;
+import org.graylog2.indexer.IndexNotFoundException;
 import org.graylog2.indexer.IndexSetRegistry;
 import org.graylog2.indexer.messages.DocumentNotFoundException;
 import org.graylog2.indexer.messages.Messages;
@@ -110,9 +111,9 @@ public ResultMessage search(@ApiParam(name = "index", value = "The index this me
 
             return resultMessage;
         } catch (DocumentNotFoundException e) {
-            final String msg = "Message " + messageId + " does not exist in index " + index;
-            LOG.error(msg, e);
-            throw new NotFoundException(msg, e);
+            throw new NotFoundException("Message " + messageId + " does not exist in index " + index, e);
+        } catch (IndexNotFoundException e) {
+            throw new NotFoundException("Index " + index + " does not exist.", e);
         }
     }
 

graylog2-web-interface/src/logic/errors/FetchError.ts

@@ -35,11 +35,14 @@ export default class FetchError extends Error {
 
   status: Additional['status'];
 
+  details: string;
+
   constructor(message: string, status: number, additional: any) {
     super(message);
     this.name = 'FetchError';
 
     const details = isString(additional) ? additional : (additional?.message ?? 'Not available');
+    this.details = details;
     this.message = `There was an error fetching a resource: ${message}. Additional information: ${details}`;
 
     this.responseMessage = additional?.message ?? undefined;

graylog2-web-interface/src/pages/ShowMessagePage.fixtures.ts

@@ -0,0 +1,134 @@
+/*
+ * Copyright (C) 2020 Graylog, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the Server Side Public License, version 1,
+ * as published by MongoDB, Inc.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * Server Side Public License for more details.
+ *
+ * You should have received a copy of the Server Side Public License
+ * along with this program. If not, see
+ * <http://www.mongodb.com/licensing/server-side-public-license>.
+ */
+const fields = {
+  level: 6,
+  gl2_remote_ip: '192.168.1.47',
+  gl2_remote_port: 35024,
+  streams: ['000000000000000000000001'],
+  gl2_message_id: '01DFZKQF4D3642JY91FM6Z1WQG',
+  source: 'babbage',
+  message:
+    'babbage 30ac6e35e442[27354]: [2019-07-17T09:20:33,415][WARN ][o.e.d.c.ParseField       ] [Mc1oQWu] Deprecated field [split_on_whitespace] used, replaced by [This setting is ignored, the parser always splits on operator]',
+  gl2_source_input: '5c26a37b3885e50480aa12a2',
+  hostname: 'babbage',
+  gl2_source_node: '4c0cbe7b-c51a-4617-bb50-ea01fe6dbfd0',
+  _id: '20f683d2-a874-11e9-8a11-0242ac130004',
+  facility: 'user-level',
+  timestamp: '2019-07-17T11:20:33.000Z',
+};
+
+export const message = {
+  message: {
+    fields,
+    fields_entries: Object.entries(fields),
+    field_names: Object.keys(fields),
+    field_count: Object.keys(fields).length,
+    id: '20f683d2-a874-11e9-8a11-0242ac130004',
+    timestamp: '2019-07-17T11:20:33.000Z',
+    stream_ids: [],
+    index_sets: [],
+    source_node_id: '4c0cbe7b-c51a-4617-bb50-ea01fe6dbfd0',
+    source_input_id: '5c26a37b3885e50480aa12a2',
+    is_source_inet_address: false,
+    complete: true,
+    sequence_nr: 0,
+    receive_time: null,
+    processing_time: null,
+    inet_address: null,
+    source: fields.source,
+    message: fields.message,
+    message_queue_id: null,
+    size: 1024,
+    message_id: '01JM9FG216038BN33H6SZF8BPS',
+    journal_offset: -9223372036854775808,
+    filter_out: false,
+    streams: [],
+  },
+  index: 'graylog_5',
+  highlight_ranges: {},
+};
+
+export const input = {
+  title: 'syslog udp',
+  global: true,
+  name: 'Syslog UDP',
+  content_pack: null,
+  created_at: '2019-07-15T07:25:12.397Z',
+  type: 'org.graylog2.inputs.syslog.udp.SyslogUDPInput',
+  creator_user_id: 'admin',
+  attributes: {
+    expand_structured_data: false,
+    recv_buffer_size: 262144,
+    port: 12514,
+    number_worker_threads: 8,
+    override_source: null,
+    force_rdns: false,
+    allow_override_date: true,
+    bind_address: '0.0.0.0',
+    store_full_message: false,
+  },
+  static_fields: {},
+  node: '4c0cbe7b-c51a-4617-bb50-ea01fe6dbfd0',
+  id: '5c26a37b3885e50480aa12a2',
+};
+
+const eventFields = {
+  timestamp_processing: '2019-07-17 10:20:59.668',
+  origin_context: 'urn:graylog:message:es:netflow_13:459cb2f1-a878-11e9-8a11-0242ac130004',
+  streams: ['000000000000000000000002'],
+  source: 'localhost',
+  message: 'SSH Brute Force',
+  priority: 2,
+  key_tuple: [],
+  alert: false,
+  event_definition_type: 'aggregation-v1',
+  event_definition_id: '5d2d8350e117dc4659d2dfcc',
+  _id: '01DFZQ64CMGV30NT7DW2P7HQX2',
+  id: '01DFZQ64CMGV30NT7DW2P7HQX2',
+  fields: { ssh_target: '10.0.0.82' },
+  timestamp: '2019-07-17T09:50:12.886Z',
+};
+export const event = {
+  message: {
+    fields: eventFields,
+    fields_entries: Object.entries(eventFields),
+    field_names: Object.keys(eventFields),
+    field_count: Object.keys(eventFields).length,
+    id: '01DFZQ64CMGV30NT7DW2P7HQX2',
+    timestamp: '2019-07-17T09:50:12.000Z',
+    stream_ids: [],
+    index_sets: [],
+    source_node_id: '4c0cbe7b-c51a-4617-bb50-ea01fe6dbfd0',
+    source_input_id: '5c26a37b3885e50480aa12a2',
+    is_source_inet_address: false,
+    complete: true,
+    sequence_nr: 0,
+    receive_time: null,
+    processing_time: null,
+    inet_address: null,
+    source: eventFields.source,
+    message: eventFields.message,
+    message_queue_id: null,
+    size: 1024,
+    message_id: '01JM9FG216038BN33H6SZF8BPS',
+    journal_offset: -9223372036854775808,
+    filter_out: false,
+    streams: [],
+  },
+  index: 'gl-events_0',
+  highlight_ranges: {},
+};