Skip to content

Commit 11d97e0

Browse files
ManazsharmaManazsharma
authored
Merge pull request #73 from simranquirky/overview-pages
Overview pages
2 parents cebe8ff + a32487a commit 11d97e0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+609
-105
lines changed

‎docs/.pages

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
nav:
2+
<<<<<<< HEAD
3+
<<<<<<< HEAD
24
- Introduction: index.md
35
- Getting started: getting-started.md
46
- Quickstart: quickstart.md
@@ -7,6 +9,17 @@ nav:
79
- Example Queries: example-queries.md
810
- SQL Function Reference: sql_reference.md
911
- Architecture: architecture.md
12+
=======
13+
=======
14+
>>>>>>> b992089 (nav bar modification:)
15+
- Overview: overview
16+
- Architecture: architecture.md
17+
- Getting started: getting-started.md
18+
- Features: features
19+
- Enterprise Edition Installation Guide: openobserve-enterprise-edition-installation-guide.md
20+
- Releases: releases.md
21+
- Example Queries: example-queries.md
22+
- SQL Function Reference: sql_reference.md
1023
- HA Deployment: ha_deployment.md
1124
- Environment Variables: environment-variables.md
1225
- Data Management: data-management

‎docs/features/.pages

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
nav:
2+
- Log Management: logs.md
3+
- Metric Monitoring: metrics.md
4+
- Distributed Tracing: distributed-tracing.md
5+
- Frontend Observability: frontend.md
6+
- Enterprise Features: enterprise.md
7+
- What's next: upcoming.md

‎docs/features/distributed-tracing.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Distributed Tracing
2+
3+
OpenObserve provides powerful distributed tracing capabilities that enable you to track requests as they flow through your microservices architecture, identify performance bottlenecks, and troubleshoot complex distributed systems with ease.
4+
5+
## Overview
6+
7+
Distributed tracing in OpenObserve allows you to visualize the complete journey of requests across multiple services, understand service dependencies, and pinpoint the root cause of performance issues. Built for modern cloud-native applications, OpenObserve efficiently handles trace ingestion, correlation, and analysis at enterprise scale while maintaining exceptional query performance.
8+
9+
![Tracing Page](../images/features/traces-hero.png)
10+
*Distributed Tracing overview page*
11+
12+
## Key Features
13+
14+
### Trace Ingestion
15+
16+
- **OpenTelemetry Native**: Full support for OpenTelemetry protocol with automatic trace collection
17+
18+
![OpenTelemetry Native](../images/features/traces-otel-support.png)
19+
20+
- **High Throughput**: Process millions of spans per second with sub-millisecond latency
21+
22+
### Trace Structure & Data
23+
24+
- **Hierarchical Spans**: Complete trace trees showing parent-child relationships between operations
25+
26+
![Hierarchical Spans](../images/features/trace-spans.png)
27+
28+
- **Rich Metadata**: Capture detailed span attributes, tags, and contextual information
29+
30+
![Rich Metadata](../images/features/traces-metadata.png)
31+
32+
- **Custom Instrumentation**: Support for manual and automatic instrumentation
33+
34+
### Trace Analysis & Search
35+
36+
- **Advanced Filtering**: Search traces by service, operation, duration, errors, and custom attributes
37+
38+
![Trace Search](../images/features/trace-search.png)
39+
40+
- **Performance Profiling**: Identify slow operations and bottlenecks across your distributed system
41+
42+
- **Error Investigation**: Quickly locate and analyze failed requests and exceptions
43+
44+
![Error Investigation](../images/features/trace-error.png)
45+
46+
47+
### Visualization & Insights
48+
49+
- **Gantt Chart Views**: Interactive timeline visualization showing span relationships and durations
50+
51+
![Traces Gnatt Chart View](../images/features/trace-timeline.png)
52+
53+
- **Service Map**: Real-time service topology with performance metrics and error rates
54+
55+
![Traces Service Map](../images/features/traces-service-map.png)
56+
57+
### Storage & Performance
58+
59+
- **Smart Indexing**: High-performance indexing optimized for trace queries and span searches
60+
61+
![Smart Indexing](../images/features/trace-settings.png)
62+
63+
- **Retention Management**: [Flexible retention policies](../user-guide/streams/extended-retention.md) for cost-effective long-term storage
64+
65+
### Integration & Standards
66+
- **OpenTelemetry Ecosystem**: Full compatibility with OpenTelemetry collectors and instrumentation libraries
67+
- **Jaeger and Zipkin Compatibility**: Supports ingestion from Jaeger and Zipkin via OpenTelemetry Collector
68+
- **Kubernetes-Friendly:** Easily integrates into Kubernetes environments via OpenTelemetry Collector with support for service metadata enrichment.
69+
- **API Access**: Comprehensive REST APIs for programmatic trace access and analysis

‎docs/features/enterprise.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Enterprise Features
2+
3+
## Overview
4+
Enterprise tier includes all standard features plus the following enterprise-specific capabilities. Available free for up to 200 GB of ingestion per day.
5+
6+
## Enterprise-Only Features
7+
8+
### Data Management
9+
- **Extended Data Retention** - Keep data longer than standard retention periods
10+
- **Federated Search / Super Cluster** - Search across multiple Openobserve clusters from single interface
11+
12+
### Security & Access
13+
- **SSO (Single Sign On)** - Integrate with existing identity providers
14+
- **Role-Based Access Control (RBAC)** - Manage user permissions by role
15+
- **Cipher Keys** - Encryption and compliance support for HIPAA and PCI
16+
17+
### Operations
18+
- [**Query Management**](../work_group.md) - Optimize and manage query performance
19+
- **Workload Management (QoS)** - Prioritize and allocate resources
20+
- **Audit Trail** - Track all system activities and changes

‎docs/features/frontend.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Frontend Observability
2+
3+
OpenObserve provides robust frontend observability tools that help monitor user experience, track performance metrics, and capture errors in web applications. With minimal overhead, you can gain deep visibility into how users interact with your frontend—ensuring smooth performance across devices and browsers.
4+
5+
## Overview
6+
7+
Frontend Observability in OpenObserve enables real user monitoring, performance tracking (including Core Web Vitals), JavaScript error capture, and session replay. These tools are optimized for modern frontend architectures and come with a lightweight SDK for easy integration.
8+
9+
10+
## Key Features
11+
12+
### Real User Monitoring (RUM)
13+
14+
- **Page Load Performance**: Track FCP, LCP, and other performance indicators
15+
16+
- **Web Vitals Monitoring**: Automatically capture Google's Core Web Vitals
17+
18+
![Web Vitals Monitoring](../images/features/frontend-webvitals.png)
19+
20+
- **Geographic & Device Context**: Analyze user experience by browser, device, and approximate location.
21+
22+
- **Network Insights**: Track HTTP requests and network timing
23+
24+
25+
### [Error Tracking](../user-guide/rum.md#error-tracking)
26+
27+
- **JavaScript Errors**: Automatically capture exceptions and errors with full stack traces
28+
- **Source Maps**: View original source files when source maps are uploaded.
29+
- **Error Context**: Includes user session metadata and browser details
30+
31+
![Error Tracking](../images/frontend/error-tracking.webp)
32+
33+
### [Session Replay](../user-guide/rum.md#session-replay)
34+
35+
- **User Interaction Recording**: Replay user sessions to understand behavior and debug issues
36+
37+
![User Interaction Recording](../images/features/user-interaction.png)
38+
39+
- **Event Timeline**: View DOM changes, clicks, inputs, and navigation in order
40+
41+
![Event Timeline](../images/features/event-timeline.png)
42+
43+
- **Privacy Features**: Configurable masking for sensitive fields
44+
45+
46+
## Integration
47+
48+
Getting started with [OpenObserve's RUM](../user-guide/rum.md) is straightforward. Add our JavaScript snippet to your application's entry point eg: index.js or main.js, and you'll begin collecting user experience data immediately.
49+

‎docs/features/logs.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Logs
2+
3+
OpenObserve provides powerful log management capabilities for collecting, storing, and analyzing log data from your applications and infrastructure.
4+
5+
## Overview
6+
7+
Logs in OpenObserve offer comprehensive observability into your system's behavior, allowing you to track events, debug issues, and monitor application performance. Built with high performance and cost efficiency in mind, OpenObserve handles log ingestion and querying at scale.
8+
9+
![Logs Page](../images/features/logs-page.png)
10+
*Logs Page view*
11+
12+
## Key Features
13+
14+
### Log Ingestion
15+
- **Multiple Protocols**: Support for multiple ingestion methods including HTTP and integration with popular log shippers like FluentBit, Vector, etc.
16+
- **Structured & Unstructured**: Handle both JSON structured logs and plain text logs
17+
- **Real-time Processing**: Immediate indexing and availability for search and analysis
18+
19+
### Search & Query
20+
21+
- **Field Extraction**: Automatic field detection and parsing for structured data.
22+
23+
![Field Extraction](../images/features/log-feilds-detection.png)
24+
25+
The [Schema Settings](../user-guide/streams/schema-settings.md) tab in the Stream Details panel allows you to inspect and manage the schema used to store and query ingested data.
26+
27+
- **Full-text Search**: Powerful search capabilities across all log fields
28+
29+
![Full-text Search](../images/features/log-settings.png)
30+
31+
- **SQL Queries**: Use familiar SQL syntax for complex filtering and aggregation.
32+
33+
![SQL Queries](../images/features/sql-based-log-search.png)
34+
35+
- **Time-based Filtering**: Query logs within specific time windows using absolute or relative ranges.
36+
37+
![Time-based Filtering](../images/features/time-selection.png)
38+
39+
### Storage & Performance
40+
- **Compressed Storage**: Efficient compression reduces storage costs significantly
41+
42+
![Compressed Storage](../images/features/data-compression.png)
43+
44+
- **Fast Retrieval**: Optimized indexing for quick log searches and aggregations
45+
46+
![Indexing](../images/features/log-settings.png)
47+
48+
Know more about [Streams](../user-guide/streams/streams-in-openobserve.md) and its [details](../user-guide/streams/stream-details.md#stream-details)
49+
50+
- **Retention Policies**: [Configurable data retention](../user-guide/streams/extended-retention.md) to manage storage costs
51+
52+
![Retention Policies](../images/features/data-retention.png)

‎docs/features/metrics.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Metrics
2+
3+
OpenObserve provides comprehensive metrics collection, storage, and visualization capabilities for monitoring your applications and infrastructure performance in real-time.
4+
5+
## Overview
6+
7+
Metrics in OpenObserve enable you to track key performance indicators, monitor system health, and gain insights into your application's behavior over time. Designed for high-throughput environments, OpenObserve efficiently handles metrics ingestion, storage, and querying at scale while maintaining cost-effectiveness.
8+
9+
![Metrics Page](../images/features/metrics-page.png)
10+
*Metrics Page view*
11+
12+
## Key Features
13+
14+
### Metrics Ingestion
15+
- **Multiple Formats**: Support for multiple formats including Prometheus remote-write and structured JSON metrics via HTTP ingestion.
16+
- **Push & Pull Models**: Supports push-based ingestion and integration with systems like Prometheus for pull-based scraping.
17+
- **High Throughput**: Handle millions of metrics per second with minimal latency
18+
- **Optimized Processing**: Optimized ingestion pipelines for high-throughput environments.
19+
20+
### Data Types & Structure
21+
- **Time Series Data**: Native support for time-series metrics with timestamp precision
22+
- **Multi-dimensional**: Handle metrics with multiple labels and dimensions for detailed analysis
23+
- **Aggregation Functions**: Built-in support for common aggregation functions (sum, avg, min, max, count)
24+
- **Custom Metrics**: Flexible schema for application-specific metrics and KPIs
25+
26+
### Query & Analysis
27+
28+
- **PromQL Support**: Full compatibility with Prometheus Query Language for familiar querying
29+
30+
![PromQL Queries](../images/features/promql-queries.png)
31+
32+
- **SQL Interface**: Use SQL syntax for complex metrics analysis and reporting
33+
34+
- **Time Range Selection**: Flexible time range queries with support for relative and absolute time periods
35+
36+
![Time Range Selection](../images/features/metrics-time-selection.png)
37+
38+
- **Mathematical Operations**: Perform calculations and transformations on metrics data
39+
40+
### Visualization & Dashboards
41+
42+
- **Real-time Charts**: Interactive time-series visualizations with multiple chart types
43+
44+
![Metrics Visualization](../images/features/metrics-charts.png)
45+
46+
- **Custom Dashboards**: Create comprehensive dashboards with multiple metrics panels
47+
48+
- **Alerting Integration**: Set up alerts based on metrics thresholds and conditions
49+
50+
![Metrics Alerting](../images/features/metrics-alerts.png)
51+
52+
### Storage & Performance
53+
54+
- **Optimized Compression**: Advanced compression algorithms reduce storage costs.
55+
56+
![Metrics Compression](../images/features/metrics-compression.png)
57+
58+
- **Efficient Indexing**: High-performance indexing for fast query execution across large datasets
59+
60+
- **Downsampling**: Automatic data [downsampling](../user-guide/metrics/downsampling-metrics.md) for long-term storage optimization
61+
62+
- **Retention Policies**: [Configurable retention settings](../user-guide/streams/extended-retention.md) to balance storage costs and data availability
63+
64+
![Metrics Retention](../images/features/metrics-retention.png)
65+
66+
### Integration & Compatibility
67+
- **Prometheus Compatible**: Full compatibility with Prometheus ecosystem and exporters
68+
- **OpenTelemetry Ecosystem**: Full compatibility with OpenTelemetry collectors and instrumentation libraries
69+
- **API Access**: RESTful APIs for programmatic access to metrics data
70+
- **Standard Exporters**: Support for popular metrics exporters (Node Exporter, cAdvisor, etc.)

‎docs/features/upcoming.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Product Roadmap
2+
3+
Our vision is to build the most performant and cost-effective observability platform that scales from startup to enterprise. We're committed to delivering lightning-fast analytics across logs, metrics, traces, RUM, error tracking, and session replay while keeping your storage costs 140x lower than traditional solutions.
4+
5+
Every feature we develop is driven by real user needs and our commitment to making observability simple, powerful, and accessible to teams everywhere.
6+
7+
Want to help shape the future of OpenObserve? We're always evolving and welcome contributions, feedback, and new ideas from the community.
8+
9+
Have a feature request or improvement in mind? Jump into our **[GitHub Discussions](https://github.com/openobserve/openobserve/discussions)** or explore the **[official repository](https://github.com/openobserve/openobserve)** to get involved. Whether it’s ideas, code, or just curiosity — we’d love to have you onboard 🚀

0 commit comments

Comments
 (0)