@splunk/visualizations 28.6.0 → 28.8.0

package/docs-llm/events/examples-react.md

@@ -0,0 +1,536 @@
+# Events Examples
+
+**Component Reference:** Events or @splunk/visualizations/Events
+
+## Basic Events
+
+- **Key:** Basic
+
+```jsx
+import React from 'react';
+import Events from '@splunk/visualizations/Events';
+
+export default () => (
+    <Events
+        dataSources={{
+            primary: {
+                requestParams: { offset: 0, count: 5 },
+                data: {
+                    fields: [
+                        { name: 'host' },
+                        { name: 'source' },
+                        { name: 'sourcetype' },
+                        { name: 'index' },
+                        { name: 'linecount' },
+                        { name: '_raw' },
+                        { name: '_time' },
+                    ],
+                    columns: [
+                        [
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                        ],
+                        [
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                        ],
+                        ['splunkd', 'splunkd', 'splunkd', 'splunkd', 'splunkd'],
+                        ['_internal', '_internal', '_internal', '_internal', '_internal'],
+                        ['1', '1', '1', '1', '1'],
+                        [
+                            '{"datetime":"07-16-2018 16:38:11.545 -0700","log_level":"INFO","component":"KVStoreServerStats","data":{"host":"ssingamneni-mbp13:8191","pid":21585,"uptime":20886}}',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                        ],
+                        [
+                            '2018-07-16T16:38:11.545-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                        ],
+                    ],
+                },
+                meta: { totalCount: 5 },
+            },
+        }}
+        options={{
+            height: 600,
+        }}
+    />
+);
+```
+
+## Event Actions
+
+- **Key:** Event Actions
+
+```jsx
+import React from 'react';
+import Events from '@splunk/visualizations/Events';
+
+export default () => (
+    <Events
+        dataSources={{
+            primary: {
+                requestParams: { offset: 0, count: 5 },
+                data: {
+                    fields: [
+                        { name: 'host' },
+                        { name: 'source' },
+                        { name: 'sourcetype' },
+                        { name: 'index' },
+                        { name: 'linecount' },
+                        { name: '_raw' },
+                        { name: '_time' },
+                    ],
+                    columns: [
+                        [
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                        ],
+                        [
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                        ],
+                        ['splunkd', 'splunkd', 'splunkd', 'splunkd', 'splunkd'],
+                        ['_internal', '_internal', '_internal', '_internal', '_internal'],
+                        ['1', '1', '1', '1', '1'],
+                        [
+                            '{"datetime":"07-16-2018 16:38:11.545 -0700","log_level":"INFO","component":"KVStoreServerStats","data":{"host":"ssingamneni-mbp13:8191","pid":21585,"uptime":20886}}',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                        ],
+                        [
+                            '2018-07-16T16:38:11.545-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                        ],
+                    ],
+                },
+                meta: { totalCount: 5 },
+            },
+        }}
+        options={{
+            height: 600,
+            eventActions: [
+                // This event action appears in the dropdown as there are no eventtypeValues or fieldFilters restrictions by default.
+                {
+                    eventType: 'eventAction.showSource.click',
+                    label: 'Show Source',
+                },
+                // This event action appears in the dropdown as there are no eventtypeValues or fieldFilters restrictions.
+                {
+                    eventType: 'eventAction.buildEventType.click',
+                    label: 'Build Event Type',
+                    eventtypeValues: [],
+                    fieldFilters: [],
+                },
+                // This event action appears in the dropdown as there are no eventtypeValues or fieldFilters restrictions.
+                {
+                    eventType: 'eventAction.extractFields.click',
+                    label: 'Extract Fields',
+                    eventtypeValues: ['*'],
+                    fieldFilters: ['*'],
+                },
+                // This event action appears in the dropdown as the `host` field, which matches the `h*` filter, exists on the event.
+                {
+                    eventType: 'eventAction.eventTypeValueExists.click',
+                    label: 'Show If h* Field Exists on Event',
+                    eventtypeValues: [],
+                    fieldFilters: ['h*'],
+                },
+                // This event action does not appear since `eventtype` does not exist on this event.
+                {
+                    eventType: 'eventAction.eventTypeValueExists.click',
+                    label: 'Show If Eventtype Value Exists',
+                    eventtypeValues: ['valueA'],
+                    fieldFilters: [],
+                },
+            ],
+        }}
+    />
+);
+```
+
+## Field Actions
+
+- **Key:** Field Actions
+
+```jsx
+import React from 'react';
+import Events from '@splunk/visualizations/Events';
+
+export default () => (
+    <Events
+        dataSources={{
+            primary: {
+                requestParams: { offset: 0, count: 5 },
+                data: {
+                    fields: [
+                        { name: 'host' },
+                        { name: 'source' },
+                        { name: 'sourcetype' },
+                        { name: 'index' },
+                        { name: 'linecount' },
+                        { name: '_raw' },
+                        { name: '_time' },
+                    ],
+                    columns: [
+                        [
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                        ],
+                        [
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                        ],
+                        ['splunkd', 'splunkd', 'splunkd', 'splunkd', 'splunkd'],
+                        ['_internal', '_internal', '_internal', '_internal', '_internal'],
+                        ['1', '1', '1', '1', '1'],
+                        [
+                            '{"datetime":"07-16-2018 16:38:11.545 -0700","log_level":"INFO","component":"KVStoreServerStats","data":{"host":"ssingamneni-mbp13:8191","pid":21585,"uptime":20886}}',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                        ],
+                        [
+                            '2018-07-16T16:38:11.545-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                        ],
+                    ],
+                },
+                meta: { totalCount: 5 },
+            },
+        }}
+        options={{
+            height: 600,
+            fieldActions: {
+                // Two of these field actions appear in the dropdown for all fields, per the '*' field name. The third field action does not appear in the dropdown since `eventtype` does not exist on this event.
+                '*': [
+                    {
+                        eventType: 'fieldAction.commonAction1.click',
+                        label: 'Common Action 1',
+                    },
+                    {
+                        eventType: 'fieldAction.commonAction2.click',
+                        label: 'Common Action 2',
+                    },
+                    {
+                        eventType: 'fieldAction.specificSourceAction1.click',
+                        label: 'Specific Source Action 1',
+                        eventtypeValues: ['valueA'],
+                    },
+                ],
+                // This field action appears in the dropdown for only the 'host' field.
+                host: [
+                    {
+                        eventType: 'fieldAction.specificHostAction1.click',
+                        label: 'Specific Host Action 1',
+                    },
+                ],
+                // This field action appears in the dropdown for only the 'source' field.
+                source: [
+                    {
+                        eventType: 'fieldAction.specificSourceAction1.click',
+                        label: 'Specific Source Action 1',
+                    },
+                ],
+                // This field action appears in the dropdown for all fields that start with 'source', such as the 'source' and 'sourcetype' fields. Special parameter syntax here is used to show the field name in the field action label.
+                // For more information on special parameters: https://dev.splunk.com/enterprise/docs/devtools/customworkflowactions/#Special-parameters
+                'source*': [
+                    {
+                        eventType: 'fieldAction.startsWithSource.click',
+                        label: 'Action for source* Fields: matches $@field_name$',
+                    },
+                ],
+            },
+        }}
+    />
+);
+```
+
+## Field Summary with fieldsummary Datasource
+
+- **Key:** Field Summary
+
+```jsx
+import React from 'react';
+import Events from '@splunk/visualizations/Events';
+
+export default () => (
+    <Events
+        dataSources={{
+            primary: {
+                requestParams: { offset: 0, count: 5 },
+                data: {
+                    fields: [
+                        { name: 'host' },
+                        { name: 'source' },
+                        { name: 'sourcetype' },
+                        { name: 'index' },
+                        { name: 'linecount' },
+                        { name: '_raw' },
+                        { name: '_time' },
+                    ],
+                    columns: [
+                        [
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                        ],
+                        [
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                        ],
+                        ['splunkd', 'splunkd', 'splunkd', 'splunkd', 'splunkd'],
+                        ['_internal', '_internal', '_internal', '_internal', '_internal'],
+                        ['1', '1', '1', '1', '1'],
+                        [
+                            '{"datetime":"07-16-2018 16:38:11.545 -0700","log_level":"INFO","component":"KVStoreServerStats","data":{"host":"ssingamneni-mbp13:8191","pid":21585,"uptime":20886}}',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                        ],
+                        [
+                            '2018-07-16T16:38:11.545-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                        ],
+                    ],
+                },
+                meta: { totalCount: 5 },
+            },
+            fieldsummary: {
+                requestParams: {},
+                data: {
+                    fields: [
+                        { name: 'field' },
+                        { name: 'count' },
+                        { name: 'distinct_count' },
+                        { name: 'is_exact' },
+                        { name: 'max' },
+                        { name: 'mean' },
+                        { name: 'min' },
+                        { name: 'numeric_count' },
+                        { name: 'stdev' },
+                        { name: 'values' },
+                    ],
+                    columns: [
+                        ['host', 'index', 'linecount', 'source', 'sourcetype', 'splunk_server'],
+                        ['5', '5', '5', '5', '5', '5'],
+                        ['1', '1', '1', '1', '1', '1'],
+                        ['1', '1', '1', '1', '1', '1'],
+                        [null, null, '1', null, null, null],
+                        [null, null, '1', null, null, null],
+                        [null, null, '1', null, null, null],
+                        ['0', '0', '5', '0', '0', '0'],
+                        [null, null, '0', null, null, null],
+                        [
+                            '[{"value":"jbreeden-mbpr15","count":5}]',
+                            '[{"value":"_internal","count":5}]',
+                            '[{"value":"1","count":5}]',
+                            '[{"value":"/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log","count":5}]',
+                            '[{"value":"splunkd","count":5}]',
+                            '[{"value":"jbreeden-mbpr15","count":5}]',
+                        ],
+                    ],
+                },
+                meta: { totalCount: 6 },
+            },
+        }}
+        options={{
+            height: 600,
+        }}
+    />
+);
+```
+
+## Footer Fields and Field Value Highlighting
+
+- **Key:** Footer And Highlighting
+
+```jsx
+import React from 'react';
+import Events from '@splunk/visualizations/Events';
+
+export default () => (
+    <Events
+        dataSources={{
+            primary: {
+                requestParams: { offset: 0, count: 5 },
+                data: {
+                    fields: [
+                        { name: 'host' },
+                        { name: 'source' },
+                        { name: 'sourcetype' },
+                        { name: 'index' },
+                        { name: 'linecount' },
+                        { name: '_raw' },
+                        { name: '_time' },
+                    ],
+                    columns: [
+                        [
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                            'jbreeden-mbpr15',
+                        ],
+                        [
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                        ],
+                        ['splunkd', 'splunkd', 'splunkd', 'splunkd', 'splunkd'],
+                        ['_internal', '_internal', '_internal', '_internal', '_internal'],
+                        ['1', '1', '1', '1', '1'],
+                        [
+                            '{"datetime":"07-16-2018 16:38:11.545 -0700","log_level":"INFO","component":"KVStoreServerStats","data":{"host":"ssingamneni-mbp13:8191","pid":21585,"uptime":20886}}',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                            '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                        ],
+                        [
+                            '2018-07-16T16:38:11.545-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                            '2018-04-02T16:33:49.691-0700',
+                        ],
+                    ],
+                },
+                meta: { totalCount: 5 },
+            },
+        }}
+        options={{
+            height: 600,
+            footerFields: ['host', 'source', 'sourcetype'],
+            highlightValuesByField: {
+                host: 'jbreeden-mbpr15',
+                sourcetype: 'splunkd',
+            },
+        }}
+    />
+);
+```
+
+## Tags
+
+- **Key:** Tags
+
+```jsx
+import React from 'react';
+import Events from '@splunk/visualizations/Events';
+import { FeatureFlagContextProvider } from '@splunk/visualization-context/FeatureFlagContext';
+
+export default () => (
+    <FeatureFlagContextProvider value={{ visualizations_enableEventsViewerTags: true }}>
+        <Events
+            dataSources={{
+                primary: {
+                    requestParams: { offset: 0, count: 5 },
+                    data: {
+                        fields: [
+                            { name: 'host' },
+                            { name: 'source' },
+                            { name: 'sourcetype' },
+                            { name: 'index' },
+                            { name: 'linecount' },
+                            { name: '_raw' },
+                            { name: '_time' },
+                        ],
+                        columns: [
+                            [
+                                'jbreeden-mbpr15',
+                                'jbreeden-mbpr15',
+                                'jbreeden-mbpr15',
+                                'jbreeden-mbpr15',
+                                'jbreeden-mbpr15',
+                            ],
+                            [
+                                '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                                '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                                '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                                '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                                '/Users/jbreeden/splunk/releases-builds/splunk-nightlight/splunk/var/log/splunk/metrics.log',
+                            ],
+                            ['splunkd', 'splunkd', 'splunkd', 'splunkd', 'splunkd'],
+                            ['_internal', '_internal', '_internal', '_internal', '_internal'],
+                            ['1', '1', '1', '1', '1'],
+                            [
+                                '{"datetime":"07-16-2018 16:38:11.545 -0700","log_level":"INFO","component":"KVStoreServerStats","data":{"host":"ssingamneni-mbp13:8191","pid":21585,"uptime":20886}}',
+                                '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                                '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                                '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                                '04-02-2018 16:33:49.691 -0700 INFO  Metrics - group=thruput, name=thruput, instantaneous_kbps=0.8775482519547254, instantaneous_eps=3.5802456751680514, average_kbps=0.7280928568987709, total_k_processed=4794, kb=27.20703125, ev=111, load_average=2.87744140625',
+                            ],
+                            [
+                                '2018-07-16T16:38:11.545-0700',
+                                '2018-04-02T16:33:49.691-0700',
+                                '2018-04-02T16:33:49.691-0700',
+                                '2018-04-02T16:33:49.691-0700',
+                                '2018-04-02T16:33:49.691-0700',
+                            ],
+                        ],
+                    },
+                    meta: {
+                        totalCount: 5,
+                        tags: {
+                            sourcetype: {
+                                splunkd: ['tag1', 'tag2'],
+                            },
+                            index: {
+                                _internal: ['0_=.Aa'],
+                            },
+                        },
+                    },
+                },
+            }}
+            options={{
+                height: 600,
+                footerFields: ['host', 'source', 'sourcetype'],
+            }}
+        />
+    </FeatureFlagContextProvider>
+);
+```

package/docs-llm/events/options.md

@@ -0,0 +1,18 @@
+# Events Visualization Options
+
+**Component Reference:** Events or @splunk/visualizations/events
+
+Source: `@splunk/visualization-schemas/eventsOptionsSchema`
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `backgroundColor` | string | `> themes.defaultBackgroundColor` | Specify the color used for the background by using a hexadecimal code. For example, #0000FF. Pattern: `^#(?:[0-9a-fA-F]{3,4}\|[0-9a-fA-F]{6}\|[0-9a-fA-F]{8})$\|^transparent$\|^rgb\\(\\s*(\\d{1,3}),\\s*(\\d{1,3}),\\s*(\\d{1,3})\\)$\|^rgba\\(\\s*(\\d{1,3}%?),\\s*(\\d{1,3}%?),\\s*(\\d{1,3}%?),\\s*(\\d*(?:\\.\\d+)?)\\)$\|\\$(\\w+:)?([^$\|:]+?)(\\\|[\|\\w]+)?\\$` |
+| `eventActions` | array<object> | `[]` | Specify the available actions to take for an event. For example, `[{ "eventType": "eventAction.buildEventType.click", "label": "Build Event Type" }]`. Event types should end in `.click` if utilizing event handlers. Note that both `eventtypeValues` and `fieldFilters` keys support wildcard values. Items: object |
+| `fieldActions` | object | — | Specify the available actions for this field. For example, `{ *: [{ "eventType": "fieldAction.sharedAction1.click", "label": "Shared Action 1", "eventtypeValues": ["*"], "fieldFilters": ["*"] }] }`. Event types should end in `.click` if utilizing event handlers. Actions under the `*` key are shared across all field dropdowns. Note that both `eventtypeValues` and `fieldFilters` keys, as well as the field names, support wildcard values. |
+| `footerFields` | array<string> | `[]` | Specify field(s) that should be displayed in the footer component. Specify one or more fields to display in the footer component. For example, specify ["source", "dest"] to display the source and destination fields. Items: string |
+| `highlightFromSource` | string | `none` | Specify a segmentation mode to use for search based highlighting. Specifying "none" will turn search based highlighting off. For more about segmentation, search for "event segmentation" in the Getting Data In manual in the Splunk Docs. Allowed values: `none`, `inner` |
+| `highlightValuesByField` | object | — | Specify the field and value pairs for manual highlighting. For example, `{"source": "$srcToken$", "dest": "12.21.1.11", "tag": ["tag1", "tag2"]}`. |
+| `pageCount` | number | `10` | Specify the maximum number of rows to display per page. |
+| `showFieldSummary` | boolean | `true` | Specify that a field summary popup appears when a field is selected. To show field summaries for a search, configure an additional datasource called `fieldsummary` using the original search followed by the `... \| fieldsummary maxvals=10` SPL command. |
+
+_Auto-generated; do not edit by hand._

package/docs-llm/events/overview.md

@@ -0,0 +1,5 @@
+# Events Visualization Guide
+
+**Component Reference:** Events or @splunk/visualizations/Events
+
+_Overview content not available for this visualization._