Skip to content

Commit 89e87bd

Browse files
committed
updated overview and features page
1 parent cebe8ff commit 89e87bd

30 files changed

+620
-0
lines changed

docs/.pages

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
nav:
2+
<<<<<<< HEAD
23
- Introduction: index.md
34
- Getting started: getting-started.md
45
- Quickstart: quickstart.md
@@ -7,6 +8,15 @@ nav:
78
- Example Queries: example-queries.md
89
- SQL Function Reference: sql_reference.md
910
- Architecture: architecture.md
11+
=======
12+
- Overview: overview
13+
- Getting started: quickstart.md
14+
- Features: features
15+
- Enterprise Edition Installation Guide: openobserve-enterprise-edition-installation-guide.md
16+
- Releases: releases.md
17+
- Example Queries: example-queries.md
18+
- SQL reference: sql_reference.md
19+
>>>>>>> e10aaee (updated overview and features page)
1020
- HA Deployment: ha_deployment.md
1121
- Environment Variables: environment-variables.md
1222
- 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+
- Frontent Observability: frontend.md
6+
- Enterprise Features: enterprise.md
7+
- What's next: upcoming.md

docs/features/distributed-tracing.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
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/tracing-page.png)
10+
*Distributed Tracing overview page*
11+
12+
## Key Features
13+
14+
### Trace Ingestion
15+
- **OpenTelemetry Native**: Full support for OpenTelemetry protocol with automatic trace collection
16+
- **Multiple Protocols**: Compatible with Jaeger, Zipkin, and custom tracing formats
17+
- **High Throughput**: Process millions of spans per second with sub-millisecond latency
18+
- **Sampling Strategies**: Intelligent sampling to balance observability with performance impact
19+
- **Batch Processing**: Optimized batch ingestion for maximum efficiency
20+
21+
### Trace Structure & Data
22+
- **Hierarchical Spans**: Complete trace trees showing parent-child relationships between operations
23+
- **Rich Metadata**: Capture detailed span attributes, tags, and contextual information
24+
- **Error Tracking**: Automatic error detection and classification within traces
25+
- **Service Mapping**: Dynamic service topology discovery and visualization
26+
- **Custom Instrumentation**: Support for manual and automatic instrumentation
27+
28+
### Trace Analysis & Search
29+
30+
- **Advanced Filtering**: Search traces by service, operation, duration, errors, and custom attributes
31+
32+
![Trace Search](../images/features/trace-search.png)
33+
34+
- **Dependency Analysis**: Visualize service dependencies and communication patterns
35+
36+
- **Performance Profiling**: Identify slow operations and bottlenecks across your distributed system
37+
38+
- **Error Investigation**: Quickly locate and analyze failed requests and exceptions
39+
40+
### Visualization & Insights
41+
42+
- **Gantt Chart Views**: Interactive timeline visualization showing span relationships and durations
43+
44+
- **Service Map**: Real-time service topology with performance metrics and error rates
45+
46+
- **Flame Graphs**: Detailed performance analysis with hierarchical span breakdown
47+
48+
- **Trace Comparison**: Side-by-side comparison of traces for performance analysis
49+
50+
### Correlation & Context
51+
52+
- **Metrics Correlation**: Link traces to related metrics and logs for complete observability
53+
54+
- **Log Integration**: Automatic correlation between trace spans and application logs
55+
56+
- **Alert Integration**: Trigger alerts based on trace patterns, error rates, and performance thresholds
57+
58+
### Storage & Performance
59+
60+
- **Efficient Compression**: Advanced compression techniques reduce storage overhead by up to 85%
61+
62+
- **Smart Indexing**: High-performance indexing optimized for trace queries and span searches
63+
64+
- **Tail-based Sampling**: Intelligent sampling decisions based on complete trace context
65+
66+
- **Retention Management**: [Flexible retention policies](../user-guide/streams/extended-retention.md) for cost-effective long-term storage
67+
68+
### Integration & Standards
69+
- **OpenTelemetry Ecosystem**: Full compatibility with OpenTelemetry collectors and instrumentation libraries
70+
- **Jaeger Integration**: Seamless migration from Jaeger with native protocol support
71+
- **Zipkin Compatibility**: Support for Zipkin trace format and existing instrumentation
72+
- **Cloud Native**: Native Kubernetes integration with automatic service discovery
73+
- **API Access**: Comprehensive REST APIs for programmatic trace access and analysis

docs/features/enterprise.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
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 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+
- **Sensitive Data Redaction** - Automatically mask sensitive information
16+
- **Cipher Keys** - Encryption and compliance support for HIPAA and PCI
17+
18+
### Operations
19+
- **Query Management** - Optimize and manage query performance
20+
- **Workload Management (QoS)** - Prioritize and allocate resources
21+
- **Audit Trail** - Track all system activities and changes

docs/features/frontend.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
# Frontend Observability
2+
3+
OpenObserve provides comprehensive frontend observability capabilities that enable you to monitor user experiences, track performance metrics, and diagnose issues in web applications and mobile apps. Gain complete visibility into how users interact with your frontend applications and ensure optimal user experience across all devices and browsers.
4+
5+
## Overview
6+
7+
Frontend Observability in OpenObserve allows you to monitor real user experiences, track Core Web Vitals, capture JavaScript errors, and analyze user journeys across your web and mobile applications. Built for modern frontend architectures, OpenObserve efficiently collects, processes, and analyzes frontend telemetry data while maintaining minimal impact on application performance.
8+
9+
## Key Features
10+
11+
### Real User Monitoring (RUM)
12+
- **User Session Tracking**: Complete user session recording with interaction timelines
13+
- **Page Performance**: Detailed page load times, rendering metrics, and resource loading analysis
14+
- **Core Web Vitals**: Automatic tracking of LCP, FID, CLS, and other Google Core Web Vitals
15+
- **Geographic Insights**: User experience analysis by geographic location and network conditions
16+
- **Device & Browser Analytics**: Performance breakdowns by device type, browser, and OS
17+
18+
### [Error Tracking & Debugging](../user-guide/rum.md#error-tracking)
19+
20+
- **JavaScript Error Capture**: Automatic collection of JavaScript errors, exceptions, and promise rejections
21+
22+
- **Source Map Integration**: Detailed stack traces with original source code for minified applications
23+
24+
- **Error Context**: Rich error context including user actions, browser state, and session information
25+
26+
- **Error Grouping**: Intelligent error grouping and deduplication for efficient issue management
27+
28+
### [Performance Monitoring](../user-guide/rum.md#performance-monitoring)
29+
30+
- **Page Load Analytics**: Comprehensive page load performance with waterfall charts and timing breakdowns
31+
32+
- **Resource Monitoring**: Track loading times for images, scripts, stylesheets, and API calls
33+
34+
- **Runtime Performance**: Monitor JavaScript execution times, memory usage, and CPU utilization
35+
36+
- **Custom Performance Metrics**: Track application-specific performance indicators and business metrics
37+
38+
### User Experience Analytics
39+
40+
- **User Journey Mapping**: Visualize complete user paths through your application
41+
42+
- **Interaction Tracking**: Monitor clicks, scrolls, form submissions, and custom user interactions
43+
44+
- **Rage Click Detection**: Identify user frustration points with automatic rage click detection
45+
46+
- **Conversion Funnel Analysis**: Track user conversion rates and identify drop-off points
47+
48+
### Network & API Monitoring
49+
50+
- **AJAX/Fetch Tracking**: Monitor all HTTP requests with response times, status codes, and payload sizes
51+
52+
- **API Performance**: Detailed API call analysis with success rates and error patterns
53+
54+
- **Network Conditions**: Track user network speed and connection quality impact on performance
55+
56+
- **Third-Party Service Monitoring**: Monitor external service dependencies and their impact on user experience
57+
58+
### Browser & Device Insights
59+
60+
- **Browser Compatibility**: Identify browser-specific issues and compatibility problems
61+
62+
- **Device Performance**: Analyze performance across different device capabilities and screen sizes
63+
64+
- **Viewport Analytics**: Understanding of how users interact with different screen resolutions
65+
66+
### [Session Replay & Recording](../user-guide/rum.md#session-replay)
67+
68+
- **Session Recordings**: Visual playback of user sessions for detailed investigation
69+
70+
- **Privacy Controls**: Configurable data masking and privacy protection for sensitive information
71+
72+
- **Event Timeline**: Synchronized timeline of user actions, network requests, and application state
73+
74+
- **Issue Correlation**: Link session recordings to specific errors and performance issues
75+
76+
77+
### Mobile App Observability
78+
79+
- **Crash Reporting**: Comprehensive crash reporting for iOS and Android applications
80+
81+
- **App Performance**: Monitor app launch times, screen rendering, and memory usage
82+
83+
- **User Engagement**: Track app usage patterns, feature adoption, and user retention
84+
85+
- **Network Performance**: Monitor API calls and network conditions in mobile environments
86+
87+
### Data Collection & Privacy
88+
89+
- **Lightweight SDKs**: Minimal impact JavaScript and mobile SDKs with optimized performance
90+
91+
- **Sampling Strategies**: Intelligent sampling to balance data quality with performance impact
92+
93+
- **GDPR Compliance**: Built-in privacy controls and data anonymization features
94+
95+
- **Custom Data Collection**: Flexible APIs for collecting custom frontend metrics and events
96+
97+
## Integration
98+
99+
### Web Applications
100+
- **JavaScript SDK**: Easy integration with vanilla JavaScript, React, Vue, Angular, and other frameworks
101+
- **NPM Package**: Simple installation via package managers with TypeScript support
102+
- **CDN Integration**: Quick setup with CDN-hosted SDK for immediate implementation
103+
- **Framework Plugins**: Native plugins for popular frameworks and build tools
104+
105+
### CI/CD Integration
106+
- **Build Integration**: Integrate observability setup into your build and deployment pipelines
107+
- **Source Map Upload**: Automatic source map upload for enhanced error debugging
108+
- **Performance Budgets**: Set performance budgets and fail builds on regression
109+
- **Release Tracking**: Correlate frontend performance with deployments and releases

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 various log shipping protocols including HTTP, syslog, and popular log shippers
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 parsing and extraction of log fields.
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/full-text-search.png)
30+
31+
- **SQL Queries**: Use familiar SQL syntax for complex log analysis
32+
33+
![SQL Queries](../images/features/sql-based-log-search.png)
34+
35+
- **Time-based Filtering**: Efficient time range queries for targeted log exploration
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/index.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 various metrics formats including Prometheus, InfluxDB, and JSON
16+
- **Push & Pull Models**: Flexible ingestion supporting both push-based and pull-based collection methods
17+
- **High Throughput**: Handle millions of metrics per second with minimal latency
18+
- **Batch Processing**: Efficient batch ingestion for optimal performance
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 by up to 90%
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+
- **Grafana Integration**: Native support for Grafana dashboards and visualization
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+
Explore our current roadmap and upcoming features **[here](https://github.com/openobserve/openobserve/milestones)**
8+
9+
Have ideas that could make OpenObserve even better? We'd love to hear from you! Share your thoughts and feature requests in our **[GitHub Discussions](https://github.com/openobserve/openobserve/discussions)** - your input directly shapes what we build next 🚀
175 KB
Loading
372 KB
Loading

0 commit comments

Comments
 (0)