package googlechrome.lighthouse
Get desktop application:
View/edit binary Protocol Buffers messages
message
lighthouse-result.proto:359Message containing the result of an individual Lighthouse audit.
Used in:
string id = 1
The internal audit id
string title = 2
A brief description of the audit. The text can change depending on if the audit passed or failed.
string description = 3
A more detailed description that describes why the audit is important and links to Lighthouse documentation on the audit; markdown links supported.
optional score = 4
The scored value determined by the audit, in the range `0-1`, or NaN if `score_display_mode` indicates not scored. This value is nullable, so is a `Value` type
ScoreDisplayMode score_display_mode = 5
The mode for how the score should be interpreted.
string display_value = 6
The human readable value that is displayed as the audit's result
string explanation = 7
An explanation of audit-related issues encountered on the test page.
string error_message = 8
Error message from any exception thrown while running this audit.
optional details = 9
Extra information provided by some types of audits. Given as an arbitrary object.
optional warnings = 10
List of warnings associated with this audit type of `Value` since this can be null
optional numeric_value = 11
A numeric value that has a meaning specific to the audit, e.g. the number of nodes in the DOM or the timestamp of a specific load event. More information can be found in the audit details, if present.
string numeric_unit = 12
The unit of the numeric_value field. Used to format the numeric value for display.
string errorStack = 13
Stacktrace of error, if any occurred while processing the audit.
optional metricSavings = 14
The audit's MetricSavings.
optional scoringOptions = 15
The audit's ScoringOption.
optional guidanceLevel = 16
An audit's guidance level.
optional replacesAudits = 17
Audits that this audit replaces.
message
lighthouse-result.proto:409Message containing the audit's MetricSavings.
Used in:
optional LCP = 1
Optional numeric value representing the audit's savings for the LCP metric.
optional FCP = 2
Optional numeric value representing the audit's savings for the FCP metric.
optional CLS = 3
Optional numeric value representing the audit's savings for the CLS metric.
optional TBT = 4
Optional numeric value representing the audit's savings for the TBT metric.
optional INP = 5
Optional numeric value representing the audit's savings for the INP metric.
message
lighthouse-result.proto:435Message containing ScoringOptions.
Used in:
optional p10 = 1
Scoring option's p10.
optional median = 2
Scoring option's median.
message
lighthouse-result.proto:276Message containing a category
Used in:
string title = 1
The human readable title of the group
string description = 2
The description of what the category is grouping
message
lighthouse-result.proto:454Message containing the i18n data for the LHR - Version 1
Used in:
optional renderer_formatted_strings = 1
The message holding all formatted strings used in the renderer.
map<string, > icu_message_paths = 2
Holds all message paths used. The locale of the report has already be used to translated the strings in this LighthouseResult, but this field can be used to translate into another language.
message
lighthouse-result.proto:456Message holding the formatted strings used in the renderer
Used in:
string variance_disclaimer = 1
The disclaimer shown below a performance metric value
string opportunity_resource_column_label = 2
The heading for the estimated page load savings opportunity of an audit
string opportunity_savings_column_label = 3
The heading for the estimated page load savings of opportunitu audits
string error_missing_audit_info = 4
The error string shown next to an erroring audit
string error_label = 5
The label shown next to an audit or metric that has had an error
string warning_header = 6
The label shown above a bulleted list of warnings
string audit_group_expand_tooltip = 7
The tooltip text on an expandable chevron icon
string passed_audits_group_title = 8
The heading that is shown above a list of audits that are passing
string not_applicable_audits_group_title = 9
The heading shown above a list of audits that do not apply to a page
string manual_audits_group_title = 10
The heading shown above a list of audits that were not computerd in the run
string toplevel_warnings_message = 11
The label shown preceding important warnings that may have invalidated an entire report
string scorescale_label = 12
The label that explains the score gauges scale (0-49, 50-89, 90-100)
string crc_longest_duration_label = 13
The label for values shown in the summary of critical request chains
string crc_initial_navigation = 14
The label for the initial request in a critical request chain
string ls_performance_category_description = 15
The disclaimer shown under performance explaining that the network can vary
string lab_data_title = 16
The title of the lab data performance category
string warning_audits_group_title = 17
The heading that is shown above a list of audits that have warnings
string snippet_expand_button_label = 18
The label for the button to show all lines of a snippet
string snippet_collapse_button_label = 19
The label for the button to show only a few lines of a snippet
string third_party_resources_label = 20
This label is for a filter checkbox above a table of items
string runtime_desktop_emulation = 21
Descriptive explanation for emulation setting when emulating a generic desktop form factor, as opposed to a mobile-device like form factor.
string runtime_mobile_emulation = 22
Descriptive explanation for emulation setting when emulating a Nexus 5X mobile device.
string runtime_no_emulation = 23
Descriptive explanation for emulation setting when no device emulation is set.
string runtime_settings_benchmark = 24
Label for a row in a table that shows the estimated CPU power of the machine running Lighthouse. Example row values: 532, 1492, 783.
string runtime_settings_CPU_throttling = 25
Label for a row in a table that describes the CPU throttling conditions that were used during a Lighthouse run, if any.
string runtime_settings_device = 26
Label for a row in a table that describes the kind of device that was emulated for the Lighthouse run. Example values for row elements: 'No Emulation', 'Emulated Desktop', etc.
string runtime_settings_fetch_time = 27
Label for a row in a table that shows the time at which a Lighthouse run was conducted; formatted as a timestamp, e.g. Jan 1, 1970 12:00 AM UTC.
string runtime_settings_network_throttling = 28
Label for a row in a table that describes the network throttling conditions that were used during a Lighthouse run, if any.
string runtime_settings_title = 29
Title of the Runtime settings table in a Lighthouse report. Runtime settings are the environment configurations that a specific report used at auditing time.
string runtime_settings_UA = 30
Label for a row in a table that shows the User Agent that was detected on the Host machine that ran Lighthouse.
string runtime_settings_UA_network = 31
Label for a row in a table that shows the User Agent that was used to send out all network requests during the Lighthouse run.
string runtime_settings_Url = 32
Label for a row in a table that shows the URL that was audited during a Lighthouse run.
string runtime_unknown = 33
Descriptive explanation for a runtime setting that is set to an unknown value.
string dropdown_copy_JSON = 34
Option in a dropdown menu that copies the Lighthouse JSON object to the system clipboard.
string dropdown_dark_theme = 35
Option in a dropdown menu that toggles the themeing of the report between Light(default) and Dark themes.
string dropdown_print_expanded = 36
Option in a dropdown menu that opens a full Lighthouse report in a print dialog.
string dropdown_print_summary = 37
Option in a dropdown menu that opens a small, summary report in a print dialog.
string dropdown_save_gist = 38
Option in a dropdown menu that saves the current report as a new GitHub Gist.
string dropdown_save_HTML = 39
Option in a dropdown menu that saves the Lighthouse report HTML locally to the system as a '.html' file.
string dropdown_save_JSON = 40
Option in a dropdown menu that saves the Lighthouse JSON object to the local system as a '.json' file.
string dropdown_viewer = 41
Option in a dropdown menu that opens the current report in the Lighthouse Viewer Application.
string footer_issue = 42
Label for button to create an issue against the Lighthouse GitHub project.
string throttling_provided = 43
Descriptive explanation for environment throttling that was provided by the runtime environment instead of provided by Lighthouse throttling.
string runtime_settings_channel = 44
Label for a row in a table that shows in what tool Lighthouse is being run (e.g. The lighthouse CLI, Chrome DevTools, Lightrider, WebPageTest, etc).
string calculator_link = 45
Text link pointing to the Lighthouse scoring calculator. This link immediately follows a sentence stating the performance score is calculated from the perf metrics.
string runtime_settings_axe_version = 46
Label for a row in a table that shows the version of the Axe library used
string view_treemap_label = 47
Label for a button that opens the Treemap App
string show_relevant_audits = 48
Label preceding a radio control for filtering the list of audits. The radio choices are various performance metrics (FCP, LCP, TBT), and if chosen, the audits in the report are hidden if they are not relevant to the selected metric.
string runtime_single_load = 49
Descriptive label that this analysis run was from a single pageload of a browser (not a summary of hundreds of loads)
string runtime_single_load_tooltip = 50
Descriptive explanation that this analysis run was from a single pageload of a browser, whereas field data often summarizes hundreds+ of page loads
string runtime_analysis_window = 51
Descriptive label that this analysis only considers the initial load of the page, and no interaction beyond when the page had "fully loaded"
string show = 52
Label for an interactive control that will reveal or hide a group of content. This control toggles between the text 'Show' and 'Hide'.
string hide = 53
Label for an interactive control that will reveal or hide a group of content. This control toggles between the text 'Show' and 'Hide'.
string expand_view = 54
Label for an interactive control that will reveal or hide a group of content. This control toggles between the text 'Expand view' and 'Collapse view'.
string collapse_view = 55
Label for an interactive control that will reveal or hide a group of content. This control toggles between the text 'Expand view' and 'Collapse view'.
string runtime_slow_4g = 56
Label indicating that Lighthouse throttled the page to emulate a slow 4G network connection.
string runtime_custom = 57
Label indicating that Lighthouse throttled the page using custom throttling settings.
string view_trace_label = 58
This label is for a button that will show the user a trace of the page.
string view_original_trace_label = 59
This label is for a button that will show the user a trace of the page.
string runtime_settings_screen_emulation = 60
Label for a row in a table that shows the screen emulation used
string first_party_chip_label = 61
Label for a row decorative chip indiciating entity is first-party.
string open_in_a_new_tab_tooltip = 62
Label for a link tooltip indicating that it will be opened in a new tab of the browser.
string unattributable = 63
Label for a generic category for all resources that could not be attributed against a 1st or 3rd party entity.
string dropdown_view_unthrottled_trace = 64
This label is for a button that will show the user a trace of the page.
string runtime_analysis_window_timespan = 65
Descriptive label that this analysis considers some arbitrary period of time containing user interactions
string runtime_analysis_window_snapshot = 66
Descriptive label that this analysis considers a snapshot of the page at a single point in time
string pwa_removal_message = 67
Message for PWA deprecation.
string dropdown_insights_toggle = 68
Option in a dropdown menu that toggles the performance audits between new insights from RPP and legacy perf audits.
string insights_notice = 69
Notice about upcoming planned changes to Lighthouse, to replace most performance audits with a new set of "insight" audits.
string try_insights = 70
Text for a button to try out "Performance insight audits", a new set of performance advice that will replace performance audits.
string go_back_to_audits = 71
Text for a button for going back to normal "Performance audits", instead of using the new set of performance insight audits that will replace performance audits.
message
lighthouse-result.proto:285Message containing a category of audits and their combined weighted score.
Used in:
string id = 1
the internal id of the category
string title = 2
The human-friendly name of the category.
string description = 3
A description of what this category is about (e.g. these help you validate your seo).
optional score = 4
The overall score of the category, the weighted average of all its audits, from 0-1. This value is nullable, so is a `Value` type
string manual_description = 5
An description for manual audits within this category.
repeated audit_refs = 6
References to all the audit members and their weight in this category.
repeated string supported_modes = 7
List of gather modes this category is available in.
message
lighthouse-result.proto:306A Category's reference to an AuditResult, with a weight for category scoring.
Used in:
string id = 1
Matches a key in the top-level `audits` map.
optional weight = 2
The weight of the audit's score in the overall category score.
string group = 3
The category group that the audit belongs to.
string acronym = 4
The conventional acronym for the audit/metric.
repeated string relevant_audits = 5
Any audit IDs closely relevant to this one.
message
lighthouse-result.proto:751Message containing an Entity.
Used in:
string name = 1
Name of the entity.
optional string homepage = 2
An optional homepage URL of the entity.
optional string category = 3
An optional category name for the entity.
optional bool is_first_party = 4
An optional flag indicating if the entity is the first party.
optional bool is_unrecognized = 5
An optional flag indicating if the entity is not recognized.
repeated string origins = 6
A list of URL origin strings that belong to this entity.
Canonical list of errors created by Lighthouse.
Used in:
NO_ERROR = 0
No error in Lighthouse; the results are reliable.
UNKNOWN_ERROR = 1
An uncategorized error occurred, likely a JavaScript exception.
NO_SPEEDLINE_FRAMES = 2
The trace did not contain any screenshot events.
SPEEDINDEX_OF_ZERO = 3
No visual change between the beginning and end of load.
NO_SCREENSHOTS = 4
The trace did not contain any screenshot events.
INVALID_SPEEDLINE = 5
The computed speedindex results are non-finite.
NO_TRACING_STARTED = 6
The trace did not contain a TracingStartedInPage event.
NO_NAVSTART = 7
The trace did not contain a navigationStart event.
NO_FCP = 8
The trace did not contain a firstContentfulPaint event.
NO_DCL = 9
The trace did not contain a domContentLoaded event.
NO_DOCUMENT_REQUEST = 10
No network request could be identified as the primary HTML document.
FAILED_DOCUMENT_REQUEST = 11
The HTML document's network request failed due to Chrome-internal reasons (canceled, blocked, etc).
ERRORED_DOCUMENT_REQUEST = 12
The HTML document's network request completed, but returned an HTTP status code of 4xx or 5xx.
TRACING_ALREADY_STARTED = 13
Chromium's tracing controller did not manage to begin tracing across processes. Typically fixed by restarting Chromium.
PARSING_PROBLEM = 14
The trace data wasn't parsed correctly.
READ_FAILED = 15
The trace data failed to stream over the protocol.
INSECURE_DOCUMENT_REQUEST = 16
Used when security error prevents page load.
PROTOCOL_TIMEOUT = 17
Used when protocol command times out.
PAGE_HUNG = 18
Used when the page is not responding after maxWaitForLoad.
DNS_FAILURE = 19
DNS failure on main document (no resolution, timed out, etc)
CRI_TIMEOUT = 20
A timeout in the initial connection to the debugger protocol.
NOT_HTML = 21
The page requested was not HTML.
NO_RESOURCE_REQUEST = 22
The trace did not contain a ResourceSendRequest event.
CHROME_INTERSTITIAL_ERROR = 23
Used when any Chrome interstitial error prevents page load.
TARGET_CRASHED = 24
The page has crashed and will no longer respond to 99% of CDP commmands.
message
lighthouse-result.proto:72The overarching Lighthouse Response object (LHR) https://github.com/GoogleChrome/lighthouse/blob/main/types/lhr.d.ts
optional fetch_time = 1
The timestamp of when the results were generated.
string requested_url = 2
The url requested to lightrider.
string final_url = 3
The final analyzed URL, differs from requested_url when there were redirects.
string lighthouse_version = 4
The version of Lighthouse with which these results were generated.
optional environment = 5
The environment that the audit was run in
string user_agent = 6
The user agent that was used to run the audit
optional run_warnings = 7
Any top level warnings that this run encountered default is [] hence ListValue
optional runtime_error = 8
A runtime error that was encountered during the run
map<string, > audits = 9
A map containing the results of the audits, keyed by audit id. Audits may be referenced within more than one category.
map<string, > categories = 10
A map containing the categories of audits, keyed by category id.
map<string, > category_groups = 11
A map containing groups that categories can belong to, keyed by group id
optional config_settings = 12
The settings that were used to run this audit
optional i18n = 13
i18n info in version 1 message format
optional timing = 14
The performance timing data for the Lighthouse run
repeated stack_packs = 15
The Stack Pack data used by audits in this run.
string gather_mode = 16
Gather mode used to collect artifacts.
string main_document_url = 17
URL of the main document request of the final navigation.
string final_displayed_url = 18
URL displayed on the page after Lighthouse finishes.
optional full_page_screenshot = 19
Screenshot data of the full page, along with node rects relevant to the audit results.
repeated entities = 20
Entity classification data.
message
lighthouse-result.proto:136Message containing the configuration settings for the LH run Next ID: 11
Used in:
ConfigSettings.EmulatedFormFactor emulated_form_factor = 1
Removed in v7. Do not use.
ConfigSettings.EmulatedFormFactor form_factor = 5
How Lighthouse should interpret this run in regards to scoring performance metrics and skipping mobile-only tests in desktop.
string locale = 2
The locale that was active during the audit
optional only_categories = 3
List of the categories that were run, empty if all were run nullable list of strings
string channel = 4
How Lighthouse was run, e.g. from the Chrome extension or from the npm module
optional throttling = 7
The throttling config settings.
string throttling_method = 8
The method used to throttle the network.
optional screen_emulation = 9
Screen emulation properties (width, height, dpr, mobile viewport) to apply or an object of `{disabled: true}` if Lighthouse should avoid applying screen emulation. If either emulation is applied outside of Lighthouse, or it's being run on a mobile device, it typically should be set to disabled. For desktop, we recommend applying consistent desktop screen emulation.
bool ignore_status_code = 10
Indicating whether Lighthouse should ignore status codes.
The possible form factors an audit can be run in. This enum served the emulated_form_factor field, but in v7, that field was deprecated. Meanwhile in v7, the form_factor field was added and has a mobile/desktop enum, so we simplify reuse, minus the `none` option. See https://github.com/GoogleChrome/lighthouse/blob/main/docs/emulation.md#changes-made-in-v7
Used in:
UNKNOWN_FORM_FACTOR = 0
mobile = 1
desktop = 2
none = 3
message
lighthouse-result.proto:195Used in:
double width = 1
Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.
double height = 2
Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.
double deviceScaleFactor = 3
Overriding device scale factor value. 0 disables the override.
bool mobile = 4
Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more.
bool disabled = 5
Whether screen emulation is disabled. If true, the other emulation settings are ignored.
message
lighthouse-result.proto:169Next ID: 7
Used in:
double rtt_ms = 1
The round trip time in milliseconds.
double throughput_kbps = 2
The network throughput in kilobits per second.
double request_latency_ms = 3
The network request latency in milliseconds.
double download_throughput_kbps = 4
The network download throughput in kilobits per second.
double upload_throughput_kbps = 5
The network upload throughput in kilobits per second.
double cpu_slowdown_multiplier = 6
The amount of slowdown applied to the cpu (1/<cpuSlowdownMultiplier>).
message
lighthouse-result.proto:87Message containing environment configuration for a LH run
Used in:
string network_user_agent = 1
The user agent that was used by the network
string host_user_agent = 2
The user agent used by the host
optional benchmark_index = 3
The benchmark index that indicates rough device class
map<string, string> credits = 4
The version of libraries with which these results were generated. Ex: axe-core.
message
lighthouse-result.proto:113Message containing a runtime error config
Used in:
LighthouseError code = 1
The text repr of the error type
string message = 2
The error explanitory message
message
lighthouse-result.proto:231Message containing the performance timing data for the Lighthouse run
Used in:
optional total = 1
The total duration of Lighthouse's run
repeated entries = 2
Corresponds to: https://www.w3.org/TR/performance-timeline-2/#idl-def-performanceentrylist
message
lighthouse-result.proto:234Corresponds to: https://www.w3.org/TR/performance-timeline-2/#dom-performanceentry
Used in:
string name = 1
string entry_type = 2
optional start_time = 3
optional duration = 4
bool gather = 5
Whether timing entry was collected during artifact gathering.
The ways an audit score should be interpreted:
Used in:
SCORE_DISPLAY_MODE_UNSPECIFIED = 0
Unknown mode. This should not be used.
binary = 1
Pass/fail audit (0 and 1 are the only possible scores).
numeric = 2
Scores of 0-1, inclusive.
metricSavings = 8
Audit result score is determined by the metric savings and product score. 1 - audit passed 0.5 - audit failed and had no metric savings 0 - audit failed and had metric savings
informative = 3
The audit is an FYI only, and can't be interpreted as pass/fail. Score is NaN and should be ignored.
not_applicable = 4
The audit turned out to not apply to the page. Score is NaN and should be ignored.
notApplicable = 7
manual = 5
The audit exists only to tell you to review something yourself. Score is NaN and should be ignored
error = 6
There was an error while running the audit (check `error_message` for details). Score is NaN and should be ignored.
message
lighthouse-result.proto:736Message containing Stack Pack information.
Used in:
string id = 1
The human readable id of the Stack Pack.
string title = 2
The user facing title of the Stack Pack.
string icon_data_URL = 3
The icon as a data url.
map<string, string> descriptions = 4
Map of audit-ids to Stack Pack descriptions.