Skip to content
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

Add mark_feature_usage as a recommended mark name #105

Closed
anniesullie opened this issue Oct 12, 2023 · 1 comment
Closed

Add mark_feature_usage as a recommended mark name #105

anniesullie opened this issue Oct 12, 2023 · 1 comment

Comments

@anniesullie
Copy link
Collaborator

As discussed in the web performance working group meeting on October 12, it would be good to add mark_use_counter as a "Recommended Mark Name" to allow a convention for noting the use of features which might affect performance in a way that enables tooling and analysis (slides, notes).

Proposed syntax:

performance.mark('mark_use_counter',
    {'detail': {
        'feature': 'NgOptimizedImage',
        'framework': 'Angular',
        // Feature-specific data
        // Future use cases may expand this, i.e.
        // 'version': '10.33.56'
        }
    }
);

In this syntax, feature is the name of the feature that might affect performance. There are some examples here, like the nuxtjs/google-fonts module which automatically self hosts fonts and supports inlining to avoid server round trips, or the next/image component which uses browser lazy loading and fetchpriority to optimize image prioritzation.

And framework is the framework or platform the feature is relevant to. In the example above, nuxtjs is the framework that uses nuxtjs/google-fonts, but the framework could be a CMS, a large commerce platform, or any other entity with multiple features.

Since marks include timings, guidance on timing of the mark should also be included.

@anniesullie
Copy link
Collaborator Author

Reopening for #108

@anniesullie anniesullie changed the title Add mark_use_counter as a recommended mark name Add mark_feature_usage as a recommended mark name Nov 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant