@gravitee/gamma-lib-observability 3.1.1-feat-obs-86-datatable-widget.b98af75 → 3.1.1-feat-obs-86-datatable-widget.4b9722a

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/QUERYING.md CHANGED
@@ -241,6 +241,7 @@ series to keep a single left axis (backward compatible).
241
241
  {
242
242
  "metric": "HTTP_ERROR_RATE",
243
243
  "measure": "PERCENTAGE",
244
+ "sentiment": "lower-is-better",
244
245
  "thresholds": [{ "op": "gte", "value": 5, "level": "critical" }]
245
246
  },
246
247
  { "metric": "HTTP_GATEWAY_RESPONSE_TIME", "measure": "P95", "pinned": true }
@@ -267,6 +268,9 @@ Facets request (`sorts` on the P95 metric only, the others unordered):
267
268
 
268
269
  Plus, because `showTotals` is on, one measures request for the same three metrics under the same
269
270
  filters and range. A column's id is `metric:measure` unless it declares an `id`; the sort refers to it.
271
+ `sentiment` is the editor's way of giving thresholds their direction (`lower-is-better` → `gte`
272
+ ceilings, `higher-is-better` → `lte` floors); rendering reads each threshold's `op` alone, so a
273
+ hand-written column without a sentiment still colours as written.
270
274
 
271
275
  ---
272
276
 
package/USAGE_GUIDE.md CHANGED
@@ -541,7 +541,9 @@ overridden). When embedding widgets yourself:
541
541
  ```
542
542
 
543
543
  Widgets rendered without an `interaction` upstream show no row affordance at all rather than a dead
544
- one. The table widget also declares `layout.minCols` / `minRows`, which `DashboardView` forwards to
544
+ one. The built-in dashboard page offers **View logs** / **View traces** only for a sibling screen the
545
+ host enabled in `defineObservabilityFeatures` (and the reader may read), and **View traces** only on
546
+ the `API` dimension, since the tracing screen is per API (`tracing/:apiId`). The table widget also declares `layout.minCols` / `minRows`, which `DashboardView` forwards to
545
547
  the grid so a reader cannot shrink it below what it can render.
546
548
 
547
549
  ---
@@ -1,8 +1,16 @@
1
- import { TableColumn } from '../../types/domain';
1
+ import { MetricTrendSentiment, TableColumn } from '../../types/domain';
2
2
  export interface TableColumnsEditorProps {
3
3
  readonly columns: readonly TableColumn[];
4
4
  readonly onChange: (columns: TableColumn[]) => void;
5
5
  }
6
+ /**
7
+ * The direction a column's thresholds guard: `lower-is-better` means values
8
+ * *above* a bound alarm (`gte`), `higher-is-better` means values *below* do
9
+ * (`lte`), and `neutral` means the column never colours. This is the vocabulary
10
+ * the KPI editor already uses for its trend arrow, so an author meets one idea,
11
+ * not two.
12
+ */
13
+ export declare function columnSentiment(column: TableColumn): MetricTrendSentiment;
6
14
  /**
7
15
  * Editor for a table's columns: what each one measures, how it reads, when it
8
16
  * turns amber or red, and whether it survives a narrow widget.
@@ -1 +1 @@
1
- {"version":3,"file":"TableColumnsEditor.d.ts","sourceRoot":"","sources":["../../../src/dashboards/editor/TableColumnsEditor.tsx"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,WAAW,EAAqC,MAAM,oBAAoB,CAAC;AAoBzF,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,OAAO,EAAE,SAAS,WAAW,EAAE,CAAC;IACzC,QAAQ,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,KAAK,IAAI,CAAC;CACrD;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,uBAAuB,2CAiJhF"}
1
+ {"version":3,"file":"TableColumnsEditor.d.ts","sourceRoot":"","sources":["../../../src/dashboards/editor/TableColumnsEditor.tsx"],"names":[],"mappings":"AA8BA,OAAO,KAAK,EAAE,oBAAoB,EAAE,WAAW,EAAqC,MAAM,oBAAoB,CAAC;AAqB/G,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,OAAO,EAAE,SAAS,WAAW,EAAE,CAAC;IACzC,QAAQ,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,KAAK,IAAI,CAAC;CACrD;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,WAAW,GAAG,oBAAoB,CAOzE;AAwDD;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,uBAAuB,2CAkJhF"}