-
Notifications
You must be signed in to change notification settings - Fork 116
chore: update web vitals monitoring doc #1796
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from all commits
Commits
Show all changes
39 commits
Select commit
Hold shift + click to select a range
ac5af72
chore: update web vitals monitoring doc
amlannandy 17e53d5
chore: update web vitals monitoring doc
amlannandy c0dad7f
chore: update web vitals monitoring doc
amlannandy 038ce45
chore: update web vitals monitoring doc
amlannandy 03e4728
add dashboard template for web vitals
amlannandy 8950543
add both traces and metrics as options
amlannandy c60dd40
update images and links
amlannandy 26832a3
add description for each dependency
amlannandy 8b43cdf
update options grid
amlannandy 8dc86b0
chore: address comments
amlannandy 7e97eaa
additional changes
amlannandy e3c6b17
address comments
amlannandy c0b1403
additonal changes
amlannandy fae411f
chore: update side nav
amlannandy 40e7b0f
chore: additional changes
amlannandy 6804ccb
chore: add dashboard section
amlannandy a8ef24b
chore: update side nav
amlannandy c446620
chore: address comments
amlannandy e5f4a50
chore: update lock file
amlannandy 978b821
chore: fix build issue
amlannandy 1d7301d
chore: update dashboard info
amlannandy bdbf658
chore: minor fixes
amlannandy 32cb263
chore: minor fixes
amlannandy 7755d6e
chore: address comments
amlannandy 5ace295
chore: address additonal comments
amlannandy 0570945
chore: address additional comments
amlannandy 9caa6d6
chore: address additional comments
amlannandy 21708ac
Update data/docs/frontend-monitoring/web-vitals-with-traces.mdx
amlannandy 7c39823
Update data/docs/frontend-monitoring/web-vitals-with-traces.mdx
amlannandy e490f5b
Update data/docs/frontend-monitoring/web-vitals-with-metrics.mdx
amlannandy abd0a4e
Update data/docs/frontend-monitoring/web-vitals-with-metrics.mdx
amlannandy 9ba1f38
chore: address additional comments
amlannandy 7a5c2e4
chore: address additional comments
amlannandy c664272
chore: fix metadata issue
amlannandy eb27c98
chore: fix metadata issue
amlannandy c35d7fa
chore: address comments
amlannandy b9aa155
chore: address comments
amlannandy 36d9a73
chore: address comments
amlannandy 664d71a
chore: fix metadata test
amlannandy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| import React from 'react' | ||
| import { | ||
| FiBarChart | ||
| } from 'react-icons/fi' | ||
| import { TbTimeline } from 'react-icons/tb' | ||
|
|
||
| interface IconCardData { | ||
| name: string | ||
| href: string | ||
| icon: React.ReactNode | ||
| clickName: string | ||
| } | ||
|
|
||
| const integrationsData: IconCardData[] = [ | ||
| { | ||
| name: 'Sending Web Vitals as Metrics', | ||
| href: '/docs/frontend-monitoring/web-vitals-with-metrics', | ||
| icon: <FiBarChart className="h-7 w-7 text-red-500" />, | ||
| clickName: 'Sending Web Vitals as Metrics', | ||
| }, | ||
| { | ||
| name: 'Sending Web Vitals as Traces', | ||
| href: '/docs/frontend-monitoring/web-vitals-with-traces', | ||
| icon: <TbTimeline className="h-7 w-7 text-blue-600" />, | ||
| clickName: 'Sending Web Vitals as Traces', | ||
| }, | ||
| ] | ||
|
|
||
| export default function Integrations() { | ||
| return ( | ||
| <div> | ||
| <div className="mb-6 text-left"> | ||
| <h2 className="mb-2 text-2xl font-semibold text-signoz_vanilla-100">Web Vitals</h2> | ||
| <p className="text-base text-signoz_vanilla-400">Send web vitals to SigNoz using OpenTelemetry</p> | ||
| </div> | ||
| <div className={`grid gap-4 grid-cols-2`}> | ||
| {integrationsData.map((card, index) => ( | ||
| <a | ||
| key={index} | ||
| href={card.href} | ||
| className="flex flex-col items-center justify-center rounded-lg border border-signoz_slate-400 bg-signoz_ink-400 p-4 text-center no-underline transition-all hover:border-signoz_robin-500 hover:bg-signoz_ink-300" | ||
| > | ||
| <div className="mb-3 flex h-12 w-12 items-center justify-center rounded-md"> | ||
| {card.icon} | ||
| </div> | ||
| <span className="text-sm font-medium text-signoz_vanilla-100">{card.name}</span> | ||
| </a> | ||
| ))} | ||
| </div> | ||
| </div> | ||
| ) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
100 changes: 100 additions & 0 deletions
100
data/docs/dashboards/dashboard-templates/frontend-monitoring.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| --- | ||
| date: 2025-11-11 | ||
| id: frontend-monitoring | ||
| title: Frontend Monitoring Dashboards | ||
| description: Monitor your website's performance and user experience with Core Web Vitals metrics using OpenTelemetry. | ||
| tags: [SigNoz Cloud, Self-Host] | ||
| --- | ||
amlannandy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
amlannandy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| SigNoz provides comprehensive frontend monitoring capabilities through Core Web Vitals tracking. These dashboards help you measure real user experience by capturing essential performance metrics from actual user sessions across your web applications. | ||
|
|
||
| ## Dashboard Preview | ||
|
|
||
| <Figure | ||
amlannandy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| src="/img/docs/dashboards/dashboard-templates/web-vitals-dashboard.webp" | ||
| alt="Web Vitals" | ||
| caption="Web Vitals Dashboard Template" | ||
| /> | ||
|
|
||
| ## Available Dashboard Templates | ||
|
|
||
| We provide two dashboard templates based on how you choose to export your web vitals data: | ||
|
|
||
| ### Web Vitals with Metrics | ||
|
|
||
| <div className="flex justify-center"> | ||
| <DashboardActions | ||
| dashboardJsonUrl="https://raw.githubusercontent.com/SigNoz/dashboards/refs/heads/main/frontend-monitoring/web-vitals-monitoring-with-metrics.json" | ||
| dashboardName="Web Vitals Metrics Dashboard" | ||
| /> | ||
| </div> | ||
amlannandy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| **Best for**: Large-scale deployments requiring sampling and aggregated statistical analysis | ||
|
|
||
| - Learn how to set up: [Web Vitals Monitoring with Metrics](/docs/frontend-monitoring/web-vitals-with-metrics) | ||
amlannandy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Web Vitals with Traces | ||
|
|
||
| <div className="flex justify-center"> | ||
| <DashboardActions | ||
amlannandy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| dashboardJsonUrl="https://raw.githubusercontent.com/SigNoz/dashboards/refs/heads/main/frontend-monitoring/web-vitals-monitoring-with-traces.json" | ||
| dashboardName="Web Vitals Traces Dashboard" | ||
| /> | ||
| </div> | ||
|
|
||
| **Best for**: Debugging specific user issues and detailed performance analysis | ||
amlannandy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| - Learn how to set up: [Web Vitals Monitoring with Traces](/docs/frontend-monitoring/web-vitals-with-traces) | ||
|
|
||
| ## What These Dashboards Monitor | ||
|
|
||
| Both dashboard templates track the Core Web Vitals—essential metrics for measuring user experience on your website: | ||
|
|
||
| ### Core Web Vitals | ||
|
|
||
| - **Largest Contentful Paint (LCP)**: Measures loading performance. Marks the time when the largest content element becomes visible. | ||
| - **Interaction to Next Paint (INP)**: Measures interactivity. Assesses page responsiveness to user interactions. | ||
| - **Cumulative Layout Shift (CLS)**: Measures visual stability. Quantifies unexpected layout shifts during page load. | ||
|
|
||
| ### Additional Web Vitals | ||
|
|
||
| - **Time to First Byte (TTFB)**: Measures server response time. The time from request to first byte received. | ||
| - **First Contentful Paint (FCP)**: Measures when the first content element renders on screen. | ||
|
|
||
| ## Choosing Between Metrics and Traces | ||
|
|
||
| Both approaches capture the same web vitals but differ in how they're exported and analyzed: | ||
|
|
||
| ### Metrics Approach | ||
|
|
||
| - **Ideal for**: Production environments with high traffic | ||
| - **Benefits**: | ||
| - Efficient aggregation with percentiles and histograms | ||
| - Better for trend analysis and alerting | ||
| - Supports sampling strategies for cost optimization | ||
| - Lower storage requirements | ||
| - **Use when**: You need to monitor overall performance trends across your user base | ||
|
|
||
| ### Traces Approach | ||
|
|
||
| - **Ideal for**: Development and debugging scenarios | ||
| - **Benefits**: | ||
| - Granular visibility into individual user experiences | ||
| - Easier correlation with other trace data | ||
| - Rich context with custom attributes (browser, user ID, device type) | ||
| - Better for investigating specific user issues | ||
| - **Use when**: You need detailed insights for troubleshooting or development | ||
amlannandy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Learn more about choosing the right approach: [Web Vitals Overview](/docs/frontend-monitoring/opentelemetry-web-vitals) | ||
|
|
||
amlannandy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Dashboard Features | ||
|
|
||
| Both dashboard templates include: | ||
|
|
||
| - **Real-time monitoring**: Track web vitals as users interact with your site | ||
| - **Filtering capabilities**: Segment data by page, browser, device, or custom attributes | ||
| - **Historical trends**: Analyze performance changes over time | ||
|
|
||
amlannandy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Additional Resources | ||
|
|
||
amlannandy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - [OpenTelemetry Web Vitals Overview](/docs/frontend-monitoring/web-vitals) | ||
amlannandy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.