Skip to content

Commit d8c7505

Browse files
committed
modified features section based on review
1 parent f3c29c0 commit d8c7505

14 files changed

+49
-110
lines changed

docs/features/distributed-tracing.md

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,23 @@ Distributed tracing in OpenObserve allows you to visualize the complete journey
1212
## Key Features
1313

1414
### Trace Ingestion
15+
1516
- **OpenTelemetry Native**: Full support for OpenTelemetry protocol with automatic trace collection
16-
- **Multiple Protocols**: Compatible with Jaeger, Zipkin, and custom tracing formats
17+
18+
![OpenTelemetry Native](../images/features/traces-otel-support.png)
19+
1720
- **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
2021

2122
### Trace Structure & Data
23+
2224
- **Hierarchical Spans**: Complete trace trees showing parent-child relationships between operations
25+
26+
![Hierarchical Spans](../images/features/trace-spans.png)
27+
2328
- **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
29+
30+
![Rich Metadata](../images/features/traces-metadata.png)
31+
2632
- **Custom Instrumentation**: Support for manual and automatic instrumentation
2733

2834
### Trace Analysis & Search
@@ -31,43 +37,35 @@ Distributed tracing in OpenObserve allows you to visualize the complete journey
3137

3238
![Trace Search](../images/features/trace-search.png)
3339

34-
- **Dependency Analysis**: Visualize service dependencies and communication patterns
35-
3640
- **Performance Profiling**: Identify slow operations and bottlenecks across your distributed system
3741

3842
- **Error Investigation**: Quickly locate and analyze failed requests and exceptions
3943

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
44+
![Error Investigation](../images/features/trace-error.png)
4545

46-
- **Flame Graphs**: Detailed performance analysis with hierarchical span breakdown
4746

48-
- **Trace Comparison**: Side-by-side comparison of traces for performance analysis
47+
### Visualization & Insights
4948

50-
### Correlation & Context
49+
- **Gantt Chart Views**: Interactive timeline visualization showing span relationships and durations
5150

52-
- **Metrics Correlation**: Link traces to related metrics and logs for complete observability
51+
![Traces Gnatt Chart View](../images/features/trace-timeline.png)
5352

54-
- **Log Integration**: Automatic correlation between trace spans and application logs
53+
- **Service Map**: Real-time service topology with performance metrics and error rates
5554

56-
- **Alert Integration**: Trigger alerts based on trace patterns, error rates, and performance thresholds
55+
![Traces Service Map](../images/features/traces-service-map.png)
5756

5857
### Storage & Performance
5958

6059
- **Efficient Compression**: Advanced compression techniques reduce storage overhead by up to 85%
6160

6261
- **Smart Indexing**: High-performance indexing optimized for trace queries and span searches
6362

64-
- **Tail-based Sampling**: Intelligent sampling decisions based on complete trace context
63+
![Smart Indexing](../images/features/trace-settings.png)
6564

6665
- **Retention Management**: [Flexible retention policies](../user-guide/streams/extended-retention.md) for cost-effective long-term storage
6766

6867
### Integration & Standards
6968
- **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
69+
- **Jaeger and Zipkin Compatibility**: Supports ingestion from Jaeger and Zipkin via OpenTelemetry Collector
70+
- **Kubernetes-Friendly:** Easily integrates into Kubernetes environments via OpenTelemetry Collector with support for service metadata enrichment.
7371
- **API Access**: Comprehensive REST APIs for programmatic trace access and analysis

docs/features/frontend.md

Lines changed: 22 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,109 +1,50 @@
11
# Frontend Observability
22

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.
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.
44

55
## Overview
66

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.
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+
89

910
## Key Features
1011

1112
### 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
4113

42-
- **Interaction Tracking**: Monitor clicks, scrolls, form submissions, and custom user interactions
14+
- **Page Load Performance**: Track FCP, LCP, and other performance indicators
4315

44-
- **Rage Click Detection**: Identify user frustration points with automatic rage click detection
16+
- **Web Vitals Monitoring**: Automatically capture Google's Core Web Vitals
4517

46-
- **Conversion Funnel Analysis**: Track user conversion rates and identify drop-off points
18+
![Web Vitals Monitoring](../images/features/frontend-webvitals.png)
4719

48-
### Network & API Monitoring
20+
- **Geographic & Device Context**: Analyze user experience by browser, device, and approximate location.
4921

50-
- **AJAX/Fetch Tracking**: Monitor all HTTP requests with response times, status codes, and payload sizes
22+
- **Network Insights**: Track HTTP requests and network timing
5123

52-
- **API Performance**: Detailed API call analysis with success rates and error patterns
5324

54-
- **Network Conditions**: Track user network speed and connection quality impact on performance
25+
### [Error Tracking](../user-guide/rum.md#error-tracking)
5526

56-
- **Third-Party Service Monitoring**: Monitor external service dependencies and their impact on user experience
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
5730

58-
### Browser & Device Insights
31+
![Error Tracking](../images/frontend/error-tracking.webp)
5932

60-
- **Browser Compatibility**: Identify browser-specific issues and compatibility problems
33+
### [Session Replay](../user-guide/rum.md#session-replay)
6134

62-
- **Device Performance**: Analyze performance across different device capabilities and screen sizes
35+
- **User Interaction Recording**: Replay user sessions to understand behavior and debug issues
6336

64-
- **Viewport Analytics**: Understanding of how users interact with different screen resolutions
37+
![User Interaction Recording](../images/features/user-interaction.png)
6538

66-
### [Session Replay & Recording](../user-guide/rum.md#session-replay)
39+
- **Event Timeline**: View DOM changes, clicks, inputs, and navigation in order
6740

68-
- **Session Recordings**: Visual playback of user sessions for detailed investigation
41+
![Event Timeline](../images/features/event-timeline.png)
6942

70-
- **Privacy Controls**: Configurable data masking and privacy protection for sensitive information
43+
- **Privacy Features**: Configurable masking for sensitive fields
7144

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
9645

9746
## Integration
9847

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
48+
- **Web SDK**: Easily add via CDN or NPM (`@openobserve/browser-rum`)
49+
- **Framework Support**: Works with vanilla JS, React, Vue, Angular, and more
50+

docs/features/logs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ Logs in OpenObserve offer comprehensive observability into your system's behavio
1212
## Key Features
1313

1414
### Log Ingestion
15-
- **Multiple Protocols**: Support for various log shipping protocols including HTTP, syslog, and popular log shippers
15+
- **Multiple Protocols**: Support for multiple ingestion methods including HTTP and integration with popular log shippers like FluentBit, Vector, etc.
1616
- **Structured & Unstructured**: Handle both JSON structured logs and plain text logs
1717
- **Real-time Processing**: Immediate indexing and availability for search and analysis
1818

1919
### Search & Query
2020

21-
- **Field Extraction**: Automatic parsing and extraction of log fields.
21+
- **Field Extraction**: Automatic field detection and parsing for structured data.
2222

2323
![Field Extraction](../images/features/log-feilds-detection.png)
2424

@@ -28,11 +28,11 @@ The [Schema Settings](../user-guide/streams/schema-settings.md) tab in the Strea
2828

2929
![Full-text Search](../images/features/log-settings.png)
3030

31-
- **SQL Queries**: Use familiar SQL syntax for complex log analysis
31+
- **SQL Queries**: Use familiar SQL syntax for complex filtering and aggregation.
3232

3333
![SQL Queries](../images/features/sql-based-log-search.png)
3434

35-
- **Time-based Filtering**: Efficient time range queries for targeted log exploration
35+
- **Time-based Filtering**: Query logs within specific time windows using absolute or relative ranges.
3636

3737
![Time-based Filtering](../images/features/time-selection.png)
3838

docs/features/metrics.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ Metrics in OpenObserve enable you to track key performance indicators, monitor s
1212
## Key Features
1313

1414
### 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
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.
1717
- **High Throughput**: Handle millions of metrics per second with minimal latency
18-
- **Batch Processing**: Efficient batch ingestion for optimal performance
18+
- **Optimized Processing**: Optimized ingestion pipelines for high-throughput environments.
1919

2020
### Data Types & Structure
2121
- **Time Series Data**: Native support for time-series metrics with timestamp precision
486 KB
Loading
293 KB
Loading
1.13 MB
Loading
375 KB
Loading
542 KB
Loading
137 KB
Loading

0 commit comments

Comments
 (0)