[7.x] [Logs UI] Shared <LogStream /> component (#76262) (#76879)

x-pack/plugins/infra/public/components/log_stream/README.md

@@ -0,0 +1,73 @@
+# Embeddable `<LogStream />` component
+
+The purpose of this component is to allow you, the developer, to have your very own Log Stream in your plugin.
+
+The plugin is exposed through `infra/public`. Since Kibana uses relative paths is up to you to find how to import it (sorry).
+
+```tsx
+import { LogStream } from '../../../../../../infra/public';
+```
+
+## Prerequisites
+
+To use the component, there are several things you need to ensure in your plugin:
+
+- In your plugin's `kibana.json` plugin, add `"infra"` to `requiredPlugins`.
+- The component needs to be mounted inside the hiearchy of a [`kibana-react` provider](https://github.com/elastic/kibana/blob/b2d0aa7b7fae1c89c8f9e8854ae73e71be64e765/src/plugins/kibana_react/README.md#L45).
+
+## Usage
+
+The simplest way to use the component is with a date range, passed with the `startTimestamp` and `endTimestamp` props.
+
+```tsx
+const endTimestamp = Date.now();
+const startTimestamp = endTimestamp - 15 * 60 * 1000; // 15 minutes
+
+<LogStream startTimestamp={startTimestamp} endTimestamp={endTimestamp} />;
+```
+
+This will show a list of log entries between the time range, in ascending order (oldest first), but with the scroll position all the way to the bottom (showing the newest entries)
+
+### Filtering data
+
+You might want to show specific data for the purpose of your plugin. Maybe you want to show log lines from a specific host, or for an APM trace. You can pass a KQL expression via the `query` prop.
+
+```tsx
+<LogStream
+ startTimestamp={startTimestamp}
+ endTimestamp={endTimestamp}
+ query="trace.id: 18fabada9384abd4"
+/>
+```
+
+### Modifying rendering
+
+By default the component will initially load at the bottom of the list, showing the newest entries. You can change what log line is shown in the center via the `center` prop. The prop takes a [`LogEntriesCursor`](https://github.com/elastic/kibana/blob/0a6c748cc837c016901f69ff05d81395aa2d41c8/x-pack/plugins/infra/common/http_api/log_entries/common.ts#L9-L13).
+
+```tsx
+<LogStream
+ startTimestamp={startTimestamp}
+ endTimestamp={endTimestamp}
+ center={{ time: ..., tiebreaker: ... }}
+/>
+```
+
+If you want to highlight a specific log line, you can do so by passing its ID in the `highlight` prop.
+
+```tsx
+<LogStream startTimestamp={startTimestamp} endTimestamp={endTimestamp} highlight="abcde12345" />
+```
+
+### Source configuration
+
+The infra plugin has the concept of "source configuration" to store settings for the logs UI. The component will use the source configuration to determine which indices to query or what columns to show.
+
+By default the `<LogStream />` uses the `"default"` source confiuration, but if your plugin uses a different one you can specify it via the `sourceId` prop.
+
+```tsx
+<LogStream startTimestamp={startTimestamp} endTimestamp={endTimestamp} sourceId="my_source" />
+```
+
+### Considerations
+
+As mentioned in the prerequisites, the component relies on `kibana-react` to access kibana's core services. If this is not the case the component will throw an exception when rendering. We advise to use an `<EuiErrorBoundary>` in your component hierarchy to catch this error if necessary.

x-pack/plugins/infra/public/components/log_stream/index.tsx

@@ -0,0 +1,133 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import React, { useMemo } from 'react';
+import { noop } from 'lodash';
+import { useMount } from 'react-use';
+import { euiStyled } from '../../../../observability/public';
+
+import { LogEntriesCursor } from '../../../common/http_api';
+
+import { useKibana } from '../../../../../../src/plugins/kibana_react/public';
+import { useLogSource } from '../../containers/logs/log_source';
+import { useLogStream } from '../../containers/logs/log_stream';
+
+import { ScrollableLogTextStreamView } from '../logging/log_text_stream';
+
+export interface LogStreamProps {
+ sourceId?: string;
+ startTimestamp: number;
+ endTimestamp: number;
+ query?: string;
+ center?: LogEntriesCursor;
+ highlight?: string;
+ height?: string | number;
+}
+
+export const LogStream: React.FC<LogStreamProps> = ({
+ sourceId = 'default',
+ startTimestamp,
+ endTimestamp,
+ query,
+ center,
+ highlight,
+ height = '400px',
+}) => {
+ // source boilerplate
+ const { services } = useKibana();
+ if (!services?.http?.fetch) {
+ throw new Error(
+ `<LogStream /> cannot access kibana core services.
+
+Ensure the component is mounted within kibana-react's <KibanaContextProvider> hierarchy.
+Read more at https://github.com/elastic/kibana/blob/master/src/plugins/kibana_react/README.md"
+`
+ );
+ }
+
+ const {
+ sourceConfiguration,
+ loadSourceConfiguration,
+ isLoadingSourceConfiguration,
+ } = useLogSource({
+ sourceId,
+ fetch: services.http.fetch,
+ });
+
+ // Internal state
+ const { loadingState, entries, fetchEntries } = useLogStream({
+ sourceId,
+ startTimestamp,
+ endTimestamp,
+ query,
+ center,
+ });
+
+ // Derived state
+ const isReloading =
+ isLoadingSourceConfiguration || loadingState === 'uninitialized' || loadingState === 'loading';
+
+ const columnConfigurations = useMemo(() => {
+ return sourceConfiguration ? sourceConfiguration.configuration.logColumns : [];
+ }, [sourceConfiguration]);
+
+ const streamItems = useMemo(
+ () =>
+ entries.map((entry) => ({
+ kind: 'logEntry' as const,
+ logEntry: entry,
+ highlights: [],
+ })),
+ [entries]
+ );
+
+ // Component lifetime
+ useMount(() => {
+ loadSourceConfiguration();
+ fetchEntries();
+ });
+
+ const parsedHeight = typeof height === 'number' ? `${height}px` : height;
+
+ return (
+ <LogStreamContent height={parsedHeight}>
+ <ScrollableLogTextStreamView
+ target={center ? center : entries.length ? entries[entries.length - 1].cursor : null}
+ columnConfigurations={columnConfigurations}
+ items={streamItems}
+ scale="medium"
+ wrap={false}
+ isReloading={isReloading}
+ isLoadingMore={false}
+ hasMoreBeforeStart={false}
+ hasMoreAfterEnd={false}
+ isStreaming={false}
+ lastLoadedTime={null}
+ jumpToTarget={noop}
+ reportVisibleInterval={noop}
+ loadNewerItems={noop}
+ reloadItems={fetchEntries}
+ highlightedItem={highlight ?? null}
+ currentHighlightKey={null}
+ startDateExpression={''}
+ endDateExpression={''}
+ updateDateRange={noop}
+ startLiveStreaming={noop}
+ hideScrollbar={false}
+ />
+ </LogStreamContent>
+ );
+};
+
+const LogStreamContent = euiStyled.div<{ height: string }>`
+ display: flex;
+ background-color: ${(props) => props.theme.eui.euiColorEmptyShade};
+ height: ${(props) => props.height};
+`;
+
+// Allow for lazy loading
+// eslint-disable-next-line import/no-default-export
+export default LogStream;

x-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx

@@ -0,0 +1,16 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import React from 'react';
+import type { LogStreamProps } from './';
+
+const LazyLogStream = React.lazy(() => import('./'));
+
+export const LazyLogStreamWrapper: React.FC<LogStreamProps> = (props) => (
+ <React.Suspense fallback={<div />}>
+ <LazyLogStream {...props} />
+ </React.Suspense>
+);

x-pack/plugins/infra/public/components/logging/log_text_stream/scrollable_log_text_stream_view.tsx

@@ -60,6 +60,7 @@ interface ScrollableLogTextStreamViewProps {
  endDateExpression: string;
  updateDateRange: (range: { startDateExpression?: string; endDateExpression?: string }) => void;
  startLiveStreaming: () => void;
+ hideScrollbar?: boolean;
 }
 
 interface ScrollableLogTextStreamViewState {
@@ -146,6 +147,7 @@ export class ScrollableLogTextStreamView extends React.PureComponent<
  setFlyoutVisibility,
  setContextEntry,
  } = this.props;
+ const hideScrollbar = this.props.hideScrollbar ?? true;
 
  const { targetId, items, isScrollLocked } = this.state;
  const hasItems = items.length > 0;
@@ -196,7 +198,7 @@ export class ScrollableLogTextStreamView extends React.PureComponent<
  width={width}
  onVisibleChildrenChange={this.handleVisibleChildrenChange}
  target={targetId}
- hideScrollbar={true}
+ hideScrollbar={hideScrollbar}
  data-test-subj={'logStream'}
  isLocked={isScrollLocked}
  entriesCount={items.length}

x-pack/plugins/infra/public/containers/logs/log_stream/index.ts

@@ -0,0 +1,89 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { useState, useMemo } from 'react';
+import { esKuery } from '../../../../../../../src/plugins/data/public';
+import { fetchLogEntries } from '../log_entries/api/fetch_log_entries';
+import { useTrackedPromise } from '../../../utils/use_tracked_promise';
+import { LogEntry, LogEntriesCursor } from '../../../../common/http_api';
+
+interface LogStreamProps {
+ sourceId: string;
+ startTimestamp: number;
+ endTimestamp: number;
+ query?: string;
+ center?: LogEntriesCursor;
+}
+
+interface LogStreamState {
+ entries: LogEntry[];
+ fetchEntries: () => void;
+ loadingState: 'uninitialized' | 'loading' | 'success' | 'error';
+}
+
+export function useLogStream({
+ sourceId,
+ startTimestamp,
+ endTimestamp,
+ query,
+ center,
+}: LogStreamProps): LogStreamState {
+ const [entries, setEntries] = useState<LogStreamState['entries']>([]);
+
+ const parsedQuery = useMemo(() => {
+ return query
+ ? JSON.stringify(esKuery.toElasticsearchQuery(esKuery.fromKueryExpression(query)))
+ : null;
+ }, [query]);
+
+ // Callbacks
+ const [entriesPromise, fetchEntries] = useTrackedPromise(
+ {
+ cancelPreviousOn: 'creation',
+ createPromise: () => {
+ setEntries([]);
+ const fetchPosition = center ? { center } : { before: 'last' };
+
+ return fetchLogEntries({
+ sourceId,
+ startTimestamp,
+ endTimestamp,
+ query: parsedQuery,
+ ...fetchPosition,
+ });
+ },
+ onResolve: ({ data }) => {
+ setEntries(data.entries);
+ },
+ },
+ [sourceId, startTimestamp, endTimestamp, query]
+ );
+
+ const loadingState = useMemo(() => convertPromiseStateToLoadingState(entriesPromise.state), [
+ entriesPromise.state,
+ ]);
+
+ return {
+ entries,
+ fetchEntries,
+ loadingState,
+ };
+}
+
+function convertPromiseStateToLoadingState(
+ state: 'uninitialized' | 'pending' | 'resolved' | 'rejected'
+): LogStreamState['loadingState'] {
+ switch (state) {
+ case 'uninitialized':
+ return 'uninitialized';
+ case 'pending':
+ return 'loading';
+ case 'resolved':
+ return 'success';
+ case 'rejected':
+ return 'error';
+ }
+}