DOCSEARCHbyAlgolia
Submit Docs

OpenSearch Dashboards Documentation

repository·main·Indexed 21 days ago

https://github.com/opensearch-project/opensearch-dashboards

OpenSearch Dashboards is an open-source data visualization platform and browser-based analytics dashboard for OpenSearch. This documentation covers the OpenSearch Dashboards API (including Saved Objects and Index Patterns), plugin development, state management using RxJS and Redux, and developer examples for implementing UI actions, custom routes, and embeddables.

Tokens
436.5K
Snippets
738
Records
3.5K
Agent score
84%

What's inside OpenSearch Dashboards

  1. Overview of Discover Traces and React Flow integration

    main

    OpenSearch Dashboards 3.3 introduces several observability enhancements:

    • Discover Traces: A centralized interface built on the Discover UI for querying traces across distributed systems. It features a click-to-filter interface that constructs complex PPL (Piped Processing Language) queries automatically. It also includes a trace details page for inspecting individual trace journeys, metadata, and execution context.
    • React Flow Integration: OpenSearch Dashboards now includes the React Flow library as a core experimental feature. This provides a standardized framework for interactive node-based visualizations (like service maps) and prevents version conflicts between plugins. It supports drag-and-drop interactions and efficient rendering of large network diagrams.
    • Trace to Log Correlation: If trace and log index patterns are configured with matching correlation objects (using common identifiers like trace ID and span ID), users can navigate directly from a trace span to its associated log entries.

  3. Overview of Saved Objects Management

    main

    The Saved Objects Management UI (provided by the management plugin) allows users to find and manage all saved objects in a centralized location. You can access the primary page at /app/management/opensearch-dashboards/objects.

    Key capabilities include:

    1. Search/View/Delete: Manage saved objects and their relationships.
    2. Import/Export: Move saved objects between environments.
    3. Inspect/Edit: View and edit raw saved object values without validation.

    Note: This is distinct from the savedObjects plugin, which provides the core underlying capabilities for saved objects.

  4. Overview of Data Explorer

    main
    Data Explorer is a unified platform within OpenSearch Dashboards designed to consolidate various data exploration tools—such as Discover, Visbuilder, and Event Analytics—into a single environment. It serves as a shell that manages shared responsibilities like data sources, state management, and view registration, while allowing individual applications to function as specialized 'views' within the platform.

  6. Overview of the Visualization Infrastructure

    main
    The visualization plugin provides the core infrastructure for creating and displaying data visualizations within OpenSearch Dashboards. This includes the visualization type registry, which manages the available visualization types, and the visualization embeddable, which allows visualizations to be integrated into other parts of the application.

  7. Overview of @osd/apm-config-loader

    main

    The @osd/apm-config-loader is a specialized configuration loader designed specifically for the APM (Application Performance Monitoring) instrumentation script (src/apm.js). Its primary purpose is to extract necessary configuration options from the opensearch_dashboards.yaml file and apply default values.

    Unlike the standard @osd/config package, this loader is optimized for minimal dependency overhead. This ensures that the APM instrumentation can be initialized early in the process, before opensearch-apm-node is loaded, preventing the loss of instrumentation on modules that are loaded during the standard configuration phase.

  9. Overview of development certificates

    main

    OpenSearch Dashboards provides development certificates to facilitate easy setup of TLS-encrypted communications with OpenSearch.

    WARNING: These certificates must NEVER be used in production environments.

    These certificates are available in multiple formats (PEM and PKCS #12) and can be used to set up a local OpenSearch Stack. Note that the Certificate Authority (CA) private key is intentionally omitted from this package for security reasons.

  10. Overview of @osd/config-schema

    main

    @osd/config-schema is a TypeScript library designed for run-time validation of OpenSearch Dashboards configuration entries. It provides a fully typed model of validated data, ensuring that configuration data is both secure and easy to use within a codebase.

    Key benefits include:

    • Limited API surface: A controlled, auditable API designed for security.
    • Custom error messages: Ability to control error detail to prevent leaking sensitive information (like passwords) into logs.
    • Type information: Provides compile-time guarantees by offering a fully typed model of the validated data.
    • Upgradability: Full control over the library's lifecycle and security patching without relying on external release cadences.

  12. Overview of TSVB (Time Series Visual Builder)

    main
    The vis_type_timeseries plugin provides the complete ecosystem for TSVB (Time Series Visual Builder) within OpenSearch Dashboards. This includes the visual editor interface, the specific visualization implementations used in dashboards, and the backend logic required to process time-series data. TSVB is designed for creating complex time-series visualizations through a guided editor experience.