From d06ed3226c8971a1c03a728efa8d1fa3f96af811 Mon Sep 17 00:00:00 2001
From: Hamas Shafiq <hamas.shafiq@grafana.com>
Date: Tue, 20 Sep 2022 12:48:17 +0100
Subject: [PATCH] Jaeger: Add cheat sheet (#54521)

---
 .../plugins/datasource/jaeger/CheatSheet.tsx  | 58 +++++++++++++++++++
 .../app/plugins/datasource/jaeger/module.ts   |  6 +-
 2 files changed, 63 insertions(+), 1 deletion(-)
 create mode 100644 public/app/plugins/datasource/jaeger/CheatSheet.tsx

diff --git a/public/app/plugins/datasource/jaeger/CheatSheet.tsx b/public/app/plugins/datasource/jaeger/CheatSheet.tsx
new file mode 100644
index 00000000000..89329d94e66
--- /dev/null
+++ b/public/app/plugins/datasource/jaeger/CheatSheet.tsx
@@ -0,0 +1,58 @@
+import { css } from '@emotion/css';
+import React from 'react';
+
+import { GrafanaTheme2 } from '@grafana/data';
+import { useStyles2 } from '@grafana/ui';
+
+export default function CheatSheet() {
+  const styles = useStyles2(getStyles);
+  return (
+    <>
+      <h2 id="jaeger-cheat-sheet">Jaeger Cheat Sheet</h2>
+      <p>
+        This cheat sheet provides a quick overview of the query types that are available. For more details about the
+        Jaeger data source, check out{' '}
+        <a
+          href="https://grafana.com/docs/grafana/latest/datasources/jaeger"
+          target="_blank"
+          rel="noreferrer"
+          className={styles.anchorTag}
+        >
+          the documentation
+        </a>
+        .
+      </p>
+
+      <hr />
+      <ul className={styles.unorderedList}>
+        <li>
+          Search - filter traces by service name. Addtionally, you can filter by tags or min/max duration, as well as
+          limit the number of traces that are returned.
+        </li>
+        <li>TraceID - if you have a trace ID, simply enter the trace ID to see the trace.</li>
+        <li>
+          JSON File - you can upload a JSON file that contains a single trace to visualize it. If the file has multiple
+          traces then the first trace is used for visualization. An example of a valid JSON file can be found in{' '}
+          <a
+            href="https://grafana.com/docs/grafana/latest/datasources/jaeger/#upload-json-trace-file"
+            target="_blank"
+            rel="noreferrer"
+            className={styles.anchorTag}
+          >
+            this section
+          </a>{' '}
+          of the documentation.
+        </li>
+      </ul>
+    </>
+  );
+}
+
+const getStyles = (theme: GrafanaTheme2) => ({
+  anchorTag: css`
+    color: ${theme.colors.text.link};
+  `,
+  unorderedList: css`
+    list-style-type: none;
+  `,
+});
diff --git a/public/app/plugins/datasource/jaeger/module.ts b/public/app/plugins/datasource/jaeger/module.ts
index 07dca616b63..7ff12082d39 100644
--- a/public/app/plugins/datasource/jaeger/module.ts
+++ b/public/app/plugins/datasource/jaeger/module.ts
@@ -1,7 +1,11 @@
 import { DataSourcePlugin } from '@grafana/data';
 
+import CheatSheet from './CheatSheet';
 import { ConfigEditor } from './components/ConfigEditor';
 import { QueryEditor } from './components/QueryEditor';
 import { JaegerDatasource } from './datasource';
 
-export const plugin = new DataSourcePlugin(JaegerDatasource).setConfigEditor(ConfigEditor).setQueryEditor(QueryEditor);
+export const plugin = new DataSourcePlugin(JaegerDatasource)
+  .setConfigEditor(ConfigEditor)
+  .setQueryEditor(QueryEditor)
+  .setQueryEditorHelp(CheatSheet);