kibana/api_docs/logs_explorer.mdx

62 lines
1.8 KiB
Text

---
####
#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
#### Reach out in #docs-engineering for more info.
####
id: kibLogsExplorerPluginApi
slug: /kibana-dev-docs/api/logsExplorer
title: "logsExplorer"
image: https://source.unsplash.com/400x175/?github
description: API docs for the logsExplorer plugin
date: 2024-09-12
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'logsExplorer']
---
import logsExplorerObj from './logs_explorer.devdocs.json';
This plugin provides a LogsExplorer component using the Discover customization framework, offering several affordances specifically designed for log consumption.
Contact [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux-logs-team) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 120 | 4 | 120 | 23 |
## Client
### Setup
<DocDefinitionList data={[logsExplorerObj.client.setup]}/>
### Start
<DocDefinitionList data={[logsExplorerObj.client.start]}/>
### Objects
<DocDefinitionList data={logsExplorerObj.client.objects}/>
### Functions
<DocDefinitionList data={logsExplorerObj.client.functions}/>
### Interfaces
<DocDefinitionList data={logsExplorerObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={logsExplorerObj.client.misc}/>
## Common
### Objects
<DocDefinitionList data={logsExplorerObj.common.objects}/>
### Functions
<DocDefinitionList data={logsExplorerObj.common.functions}/>
### Classes
<DocDefinitionList data={logsExplorerObj.common.classes}/>
### Interfaces
<DocDefinitionList data={logsExplorerObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={logsExplorerObj.common.misc}/>