Merge pull request #171 from jpinsonneau/372

NETOBSERV-372 UI: Improve loki error messages

Author: jpinsonneau

Makefile

@@ -129,7 +129,7 @@ push:
 
 .PHONY: serve
 serve:
-	./plugin-backend
+	./plugin-backend --loglevel trace
 
 .PHONY: serve-mock
 serve-mock:

pkg/handler/flows.go

@@ -159,7 +159,7 @@ func getFlows(cfg loki.Config, client httpclient.Caller, params url.Values) (*mo
 		}
 		code, err := fetchParallel(client, queries, merger)
 		if err != nil {
-			return nil, code, errors.New("Error while fetching flows from Loki: " + err.Error())
+			return nil, code, err
 		}
 	} else {
 		// else, run all at once
@@ -173,7 +173,7 @@ func getFlows(cfg loki.Config, client httpclient.Caller, params url.Values) (*mo
 		query := qb.Build()
 		code, err := fetchSingle(client, query, merger)
 		if err != nil {
-			return nil, code, errors.New("Error while fetching flows from Loki: " + err.Error())
+			return nil, code, err
 		}
 	}
 

pkg/handler/loki.go

@@ -10,6 +10,7 @@ import (
 	"time"
 
 	"github.com/sirupsen/logrus"
+	"gopkg.in/yaml.v3"
 
 	"github.com/netobserv/network-observability-console-plugin/pkg/handler/lokiclientmock"
 	"github.com/netobserv/network-observability-console-plugin/pkg/httpclient"
@@ -18,6 +19,11 @@ import (
 	"github.com/netobserv/network-observability-console-plugin/pkg/model"
 )
 
+type LokiError struct {
+	DisplayMessage string
+	Message        string
+}
+
 var hlog = logrus.WithField("module", "handler")
 
 const (
@@ -52,15 +58,18 @@ func EncodeQuery(url string) string {
 
 func getLokiError(resp []byte, code int) string {
 	var f map[string]string
+	if code == http.StatusBadRequest {
+		return fmt.Sprintf("Loki message: %s", resp)
+	}
 	err := json.Unmarshal(resp, &f)
 	if err != nil {
-		return fmt.Sprintf("Unknown error from Loki - cannot unmarshal (code: %d resp: %s)", code, resp)
+		return fmt.Sprintf("Unknown error from Loki\ncannot unmarshal\n%s", resp)
 	}
 	message, ok := f["message"]
 	if !ok {
-		return fmt.Sprintf("Unknown error from Loki - no message found (code: %d)", code)
+		return "Unknown error from Loki\nno message found"
 	}
-	return fmt.Sprintf("Error from Loki (code: %d): %s", code, message)
+	return fmt.Sprintf("Loki message: %s", message)
 }
 
 func executeLokiQuery(flowsURL string, lokiClient httpclient.Caller) ([]byte, int, error) {
@@ -77,7 +86,7 @@ func executeLokiQuery(flowsURL string, lokiClient httpclient.Caller) ([]byte, in
 	}
 	if code != http.StatusOK {
 		msg := getLokiError(resp, code)
-		return nil, http.StatusBadRequest, errors.New("Loki backend responded: " + msg)
+		return nil, http.StatusBadRequest, errors.New(msg)
 	}
 	code = http.StatusOK
 	return resp, code, nil
@@ -154,3 +163,80 @@ func fetchParallel(lokiClient httpclient.Caller, queries []string, merger loki.M
 	codeOut = http.StatusOK
 	return codeOut, nil
 }
+
+func LokiReady(cfg loki.Config) func(w http.ResponseWriter, r *http.Request) {
+	lokiClient := newLokiClient(&cfg)
+
+	return func(w http.ResponseWriter, r *http.Request) {
+		baseURL := strings.TrimRight(cfg.URL.String(), "/")
+
+		resp, code, err := executeLokiQuery(fmt.Sprintf("%s/%s", baseURL, "ready"), lokiClient)
+		if err != nil {
+			writeError(w, code, err.Error())
+			return
+		}
+
+		status := string(resp)
+		if strings.Contains(status, "ready") {
+			code = http.StatusOK
+			writeText(w, code, resp)
+			return
+		}
+
+		writeError(w, code, fmt.Sprintf("Loki returned a non ready status: %s", status))
+	}
+}
+
+func LokiMetrics(cfg loki.Config) func(w http.ResponseWriter, r *http.Request) {
+	lokiClient := newLokiClient(&cfg)
+
+	return func(w http.ResponseWriter, r *http.Request) {
+		baseURL := strings.TrimRight(cfg.URL.String(), "/")
+
+		resp, code, err := executeLokiQuery(fmt.Sprintf("%s/%s", baseURL, "metrics"), lokiClient)
+		if err != nil {
+			writeError(w, code, err.Error())
+			return
+		}
+
+		writeText(w, code, resp)
+	}
+}
+
+func LokiBuildInfos(cfg loki.Config) func(w http.ResponseWriter, r *http.Request) {
+	lokiClient := newLokiClient(&cfg)
+
+	return func(w http.ResponseWriter, r *http.Request) {
+		baseURL := strings.TrimRight(cfg.URL.String(), "/")
+
+		resp, code, err := executeLokiQuery(fmt.Sprintf("%s/%s", baseURL, "loki/api/v1/status/buildinfo"), lokiClient)
+		if err != nil {
+			writeError(w, code, err.Error())
+			return
+		}
+
+		writeText(w, code, resp)
+	}
+}
+
+func LokiConfig(cfg loki.Config, param string) func(w http.ResponseWriter, r *http.Request) {
+	lokiClient := newLokiClient(&cfg)
+
+	return func(w http.ResponseWriter, r *http.Request) {
+		baseURL := strings.TrimRight(cfg.URL.String(), "/")
+
+		resp, code, err := executeLokiQuery(fmt.Sprintf("%s/%s", baseURL, "config"), lokiClient)
+		if err != nil {
+			writeError(w, code, err.Error())
+			return
+		}
+
+		cfg := make(map[string]interface{})
+		err = yaml.Unmarshal(resp, &cfg)
+		if err != nil {
+			writeError(w, code, err.Error())
+			return
+		}
+		writeJSON(w, code, cfg[param])
+	}
+}

pkg/handler/response.go

@@ -11,6 +11,15 @@ import (
 	"github.com/netobserv/network-observability-console-plugin/pkg/model"
 )
 
+func writeText(w http.ResponseWriter, code int, bytes []byte) {
+	w.Header().Set("Content-Type", "text/plain")
+	w.WriteHeader(code)
+	_, err := w.Write(bytes)
+	if err != nil {
+		hlog.Errorf("Error while responding Text: %v", err)
+	}
+}
+
 func writeJSON(w http.ResponseWriter, code int, payload interface{}) {
 	response, err := json.Marshal(payload)
 	if err != nil {

pkg/handler/topology.go

@@ -79,7 +79,7 @@ func getTopologyFlows(cfg loki.Config, client httpclient.Caller, params url.Valu
 		}
 		code, err := fetchParallel(client, queries, merger)
 		if err != nil {
-			return nil, code, errors.New("Error while fetching flows from Loki: " + err.Error())
+			return nil, code, err
 		}
 	} else {
 		// else, run all at once
@@ -93,7 +93,7 @@ func getTopologyFlows(cfg loki.Config, client httpclient.Caller, params url.Valu
 		}
 		code, err = fetchSingle(client, query, merger)
 		if err != nil {
-			return nil, code, errors.New("Error while fetching flows from Loki: " + err.Error())
+			return nil, code, err
 		}
 	}
 

pkg/server/routes.go

@@ -12,6 +12,10 @@ import (
 func setupRoutes(cfg *Config) *mux.Router {
 	r := mux.NewRouter()
 	r.HandleFunc("/api/status", handler.Status)
+	r.HandleFunc("/api/loki/ready", handler.LokiReady(cfg.Loki))
+	r.HandleFunc("/api/loki/metrics", handler.LokiMetrics(cfg.Loki))
+	r.HandleFunc("/api/loki/buildinfo", handler.LokiBuildInfos(cfg.Loki))
+	r.HandleFunc("/api/loki/config/limits", handler.LokiConfig(cfg.Loki, "limits_config"))
 	r.HandleFunc("/api/loki/flows", handler.GetFlows(cfg.Loki))
 	r.HandleFunc("/api/loki/export", handler.ExportFlows(cfg.Loki))
 	r.HandleFunc("/api/loki/topology", handler.GetTopology(cfg.Loki))

web/locales/en/plugin__network-observability-plugin.json

@@ -62,6 +62,21 @@
   "Filter already exists": "Filter already exists",
   "Clear all filters": "Clear all filters",
   "Edit filters": "Edit filters",
+  "Build info": "Build info",
+  "Configuration limits": "Configuration limits",
+  "Metrics": "Metrics",
+  "You may consider the following query changes to avoid this error": "You may consider the following query changes to avoid this error",
+  "Reduce the Query Options -> limit to reduce the number of results": "Reduce the Query Options -> limit to reduce the number of results",
+  "Increase Loki \"max_entries_limit_per_query\" entry in configuration file": "Increase Loki \"max_entries_limit_per_query\" entry in configuration file",
+  "Add some filters like Namespace or Name to reduce the number of results": "Add some filters like Namespace or Name to reduce the number of results",
+  "Reduce the time range to decrease the number of results": "Reduce the time range to decrease the number of results",
+  "Increase Loki \"max_query_length\" entry in configuration file": "Increase Loki \"max_query_length\" entry in configuration file",
+  "Configuring Grafana Loki": "Configuring Grafana Loki",
+  "Show metrics": "Show metrics",
+  "Show build info": "Show build info",
+  "Show configuration limits": "Show configuration limits",
+  "Copy": "Copy",
+  "Copied": "Copied",
   "Manage columns": "Manage columns",
   "Selected columns will appear in the table.": "Selected columns will appear in the table.",
   "Click and drag the items to reorder the columns in the table.": "Click and drag the items to reorder the columns in the table.",
@@ -90,8 +105,6 @@
   "Filter on {{name}}": "Filter on {{name}}",
   "Flow Details": "Flow Details",
   "JSON": "JSON",
-  "Copy": "Copy",
-  "Copied": "Copied",
   "Kind not managed": "Kind not managed",
   "Unable to get flows": "Unable to get flows",
   "No results found": "No results found",

web/setup-tests.ts

@@ -87,13 +87,17 @@ jest.mock('react-router-dom', () => ({
   useHistory: () => ({
     push: jest.fn(),
   }),
+  Link: () => {
+    return null;
+  }
 }));
 
 //Mock routes
 jest.mock('./src/api/routes', () => ({
   getPods: jest.fn(async () => ['ABCD']),
   getNamespaces: jest.fn(async () => ['EFGH']),
-  getConfig: jest.fn(async () => ({ portNaming: { enable: true, portNames: new Map() } }))
+  getConfig: jest.fn(async () => ({ portNaming: { enable: true, portNames: new Map() } })),
+  getLokiReady: jest.fn(async () => 'ready'),
 }));
 
 global.console = {

web/src/api/routes.ts

@@ -84,3 +84,39 @@ export const getConfig = (): Promise<Config> => {
     };
   });
 };
+
+export const getLokiReady = (): Promise<string> => {
+  return axios.get(ContextSingleton.getHost() + '/api/loki/ready').then(r => {
+    if (r.status >= 400) {
+      throw new Error(`${r.statusText} [code=${r.status}]`);
+    }
+    return r.data;
+  });
+};
+
+export const getMetrics = (): Promise<string> => {
+  return axios.get(ContextSingleton.getHost() + '/api/loki/metrics').then(r => {
+    if (r.status >= 400) {
+      throw new Error(`${r.statusText} [code=${r.status}]`);
+    }
+    return r.data;
+  });
+};
+
+export const getBuildInfo = (): Promise<unknown> => {
+  return axios.get(ContextSingleton.getHost() + '/api/loki/buildinfo').then(r => {
+    if (r.status >= 400) {
+      throw new Error(`${r.statusText} [code=${r.status}]`);
+    }
+    return r.data;
+  });
+};
+
+export const getLimits = (): Promise<unknown> => {
+  return axios.get(ContextSingleton.getHost() + '/api/loki/config/limits').then(r => {
+    if (r.status >= 400) {
+      throw new Error(`${r.statusText} [code=${r.status}]`);
+    }
+    return r.data;
+  });
+};

web/src/components/messages/loki-error.css

@@ -0,0 +1,26 @@
+#loki-error-container {
+  overflow: auto;
+  height: 100%;
+}
+
+.error-text-content {
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  justify-content: center;
+}
+
+.loki-error-icon,
+.loki-error-message {
+  color: #A30000 !important;
+  margin-bottom: 1em;
+}
+
+.health-config-text,
+.error-text-content>p {
+  margin-top: 1em !important;
+}
+
+.error-text-content>blockquote {
+  width: 50%;
+}