Histogram versions and extended error codes for SQLite databases.

tools/metrics/histograms/histograms.xml

 <!--
 Copyright 2013 The Chromium Authors. All rights reserved.
 Use of this source code is governed by a BSD-style license that can be
 found in the LICENSE file.
 -->
 
 <!--
 This file is used to generate a comprehensive list of Chrome histograms along
 with a detailed description for each histogram.
 
@@ skipping 6902 matching lines @@
   <summary>
     The platform error of attempting to create a new cache entry.
   </summary>
 </histogram>
 
 <histogram name="SimpleCache.SyncOpenResult" enum="SimpleCacheSyncOpenResult">
   <summary>The result of attempting to create a new cache entry.</summary>
 </histogram>
 
 <histogram name="Sqlite.AppCache.Error" enum="SqliteErrorCode">
-  <summary>Error codes returned by sqlite for the appcache db.</summary>
+  <summary>SQLite extended error codes for appcache db.</summary>
+</histogram>
+
+<histogram name="Sqlite.AppCache.Version">

[jar (doing other things), 2013/05/14 02:12:46]

nit: A bunch of these histograms have a postfix of either ".Version" or
".Error".  You can really nicely use the FieldTrial construct in this file to
only have to list the prefix once, and then have the FieldTrial provide the two
alternative completion (and provide appropriate prose to add to the shared
prose).

Please take a look at it... It will make this change smaller... and easier to
maintain going forward.

[Scott Hess - ex-Googler, 2013/05/14 03:43:18]

I am not sure I understand your suggestion.  Using a fake FieldTrial to vary
between Error and Version would be weird - they aren't the same units, so it
would seem misleading.  [I admit that it is all synthetic with labels so it can
be done.  It just seems odd to have a single histogram which records either
error codes or version number depending on field trial.]

I suppose you could turn everything over and have histograms Sqlite.Error and
Sqlite.Version, with FieldTrials "AppCache", "Cookie", etc.  Then the result
would be Sqlite.Error.AppCache, Sqlite.Error.Cookie, etc, and might give some
histograms.xml savings along the lines you're suggesting.  Is that what you're
thinking?

The above assumes that <fieldtrial> only has name= and optional separator=
fields.  I don't see any other cases which would imply that it could insert
things elsewhere than as a suffix to the histogram.

+  <summary>Appcache db version at startup.</summary>
 </histogram>
 
 <histogram name="Sqlite.Cookie.Error" enum="SqliteErrorCode">
-  <summary>Error codes returned by sqlite the cookie db.</summary>
+  <summary>SQLite extended error codes for cookie db.</summary>
+</histogram>
+
+<histogram name="Sqlite.Cookie.Version">
+  <summary>Cookie db version at startup.</summary>
 </histogram>
 
 <histogram name="Sqlite.DatabaseTracker.Error" enum="SqliteErrorCode">
-  <summary>Error codes returned by sqlite the websqldb tracker db.</summary>
+  <summary>SQLite extended error codes for websqldb tracker db.</summary>
+</histogram>
+
+<histogram name="Sqlite.DatabaseTracker.Version">
+  <summary>Websqldb tracker db version at startup.</summary>
 </histogram>
 
 <histogram name="Sqlite.DomainBoundCerts.Error" enum="SqliteErrorCode">
-  <summary>
-    Error codes returned by sqlite for the domain-bound certs db.
-  </summary>
+  <summary>SQLite extended error codes for domain-bound certs db.</summary>
+</histogram>
+
+<histogram name="Sqlite.DomainBoundCerts.Version">
+  <summary>Domain-bound certs db version at startup.</summary>
 </histogram>
 
 <histogram name="Sqlite.DomStorageDatabase.Error" enum="SqliteErrorCode">
-  <summary>Error codes returned by sqlite for the domstorage db.</summary>
+  <summary>SQLite extended error codes for domstorage db.</summary>
+</histogram>
+
+<histogram name="Sqlite.DomStorageDatabase.Version">
+  <summary>Domstorage db version at startup.</summary>
 </histogram>
 
 <histogram name="Sqlite.Error" enum="SqliteErrorCode">
-  <summary>Error codes returned by sqlite for all databases.</summary>
+  <summary>SQLite extended error codes for all databases.</summary>
 </histogram>
 
 <histogram name="Sqlite.Error.IOERR" enum="SqliteIOERRCode">
-  <summary>Error codes returned by sqlite for all databases.</summary>
+  <obsolete>
+    Replaced 5/8/2013 by Sqlite.Error sparse histogram.
+  </obsolete>
+  <summary>SQLite extended SQLITE_IOERR codes for all databases.</summary>
 </histogram>
 
 <histogram name="Sqlite.History.Error" enum="SqliteErrorCode">
-  <summary>Error codes returned by sqlite for the history db.</summary>
+  <summary>SQLite extended error codes for history db.</summary>
+</histogram>
+
+<histogram name="Sqlite.History.Version">
+  <summary>History db version at startup.</summary>
 </histogram>
 
 <histogram name="Sqlite.Quota.Error" enum="SqliteErrorCode">
-  <summary>Error codes returned by sqlite for the quota db.</summary>
+  <summary>SQLite extended error codes for quota db.</summary>
+</histogram>
+
+<histogram name="Sqlite.Quota.Version">
+  <summary>Quota db version at startup.</summary>
 </histogram>
 
 <histogram name="Sqlite.Text.Error" enum="SqliteErrorCode">
-  <summary>Error codes returned by sqlite the full text db.</summary>
+  <summary>SQLite extended error codes for full text db.</summary>
+</histogram>
+
+<histogram name="Sqlite.Text.Version">
+  <summary>Full-text db version at startup.</summary>
 </histogram>
 
 <histogram name="Sqlite.Thumbnail.Error" enum="SqliteErrorCode">
-  <summary>Error codes returned by sqlite for the thumbnail db.</summary>
+  <summary>SQLite extended error codes for thumbnail db.</summary>
+</histogram>
+
+<histogram name="Sqlite.Thumbnail.Version">
+  <summary>Thumbnail db version at startup.</summary>
+</histogram>
+
+<histogram name="Sqlite.TopSites.Error" enum="SqliteErrorCode">
+  <summary>SQLite extended error codes for top sites db.</summary>
+</histogram>
+
+<histogram name="Sqlite.TopSites.Version">
+  <summary>Top sites db version at startup.</summary>
 </histogram>
 
 <histogram name="Sqlite.Web.Error" enum="SqliteErrorCode">
-  <summary>Error codes returned by sqlite the web db.</summary>
+  <summary>SQLite extended error codes for web db.</summary>
+</histogram>
+
+<histogram name="Sqlite.Web.Version">
+  <summary>Web db version at startup.</summary>
 </histogram>
 
 <histogram name="Tab.SwitchedToForegroundAge" units="ms">
   <summary>Age (in ms) when the tab was switched to foreground.</summary>
 </histogram>
 
 <histogram name="Tab.SwitchedToForegroundLaunchedWithURL"
     enum="TabSwitchedToForegroundLaunchedWithURL">
   <summary>
     Each time a tab is brought to the foreground, this histogram indicates if
@@ skipping 3731 matching lines @@
   <int value="0" label="not received"/>
   <int value="1" label="received"/>
 </enum>
 
 <enum name="SpdySettingsSent" type="int">
   <int value="0" label="not sent"/>
   <int value="1" label="sent"/>
 </enum>
 
 <enum name="SqliteErrorCode" type="int">
-  <summary>Error codes returned by SQLite - see sqlite.h</summary>
+  <summary>Error codes returned by SQLite - see sqlite3.h</summary>
   <int value="0" label="SQLITE_OK">Successful result</int>
   <int value="1" label="SQLITE_ERROR">SQL error or missing database</int>
   <int value="2" label="SQLITE_INTERNAL">
     NOT USED. Internal logic error in SQLite
   </int>
   <int value="3" label="SQLITE_PERM">Access permission denied</int>
   <int value="4" label="SQLITE_ABORT">Callback routine requested an abort</int>
   <int value="5" label="SQLITE_BUSY">The database file is locked</int>
   <int value="6" label="SQLITE_LOCKED">A table in the database is locked</int>
   <int value="7" label="SQLITE_NOMEM">A malloc() failed</int>
@@ skipping 26 matching lines @@
     Abort due to contraint violation
   </int>
   <int value="20" label="SQLITE_MISMATCH">Data type mismatch</int>
   <int value="21" label="SQLITE_MISUSE">Library used incorrectly</int>
   <int value="22" label="SQLITE_NOLFS">
     Uses OS features not supported on host
   </int>
   <int value="23" label="SQLITE_AUTH">Authorization denied</int>
   <int value="24" label="SQLITE_FORMAT">Auxiliary database format error</int>
   <int value="25" label="SQLITE_RANGE">
-    2nd parameter to sqlite3_bind out of range
+    2nd parameter to sqlite3_bind() out of range
   </int>
   <int value="26" label="SQLITE_NOTADB">
     File opened that is not a database file
   </int>
   <int value="100" label="SQLITE_ROW">sqlite3_step() has another row ready</int>
   <int value="101" label="SQLITE_DONE">
     sqlite3_step() has finished executing
   </int>
+  <int value="261" label="SQLITE_BUSY_RECOVERY">TBD</int>
+  <int value="262" label="SQLITE_LOCKED_SHAREDCACHE">TBD</int>
+  <int value="266" label="SQLITE_IOERR_READ">Error reading from file</int>
+  <int value="270" label="SQLITE_CANTOPEN_NOTEMPDIR">TBD</int>
+  <int value="522" label="SQLITE_IOERR_SHORT_READ">Short read from file</int>
+  <int value="778" label="SQLITE_IOERR_WRITE">
+    Error writing to file (other than SQLITE_FULL)
+  </int>
+  <int value="1034" label="SQLITE_IOERR_FSYNC">Error syncing to disk</int>
+  <int value="1290" label="SQLITE_IOERR_DIR_FSYNC">
+    Error syncing directory changes to disk
+  </int>
+  <int value="1546" label="SQLITE_IOERR_TRUNCATE">Error truncating file</int>
+  <int value="1802" label="SQLITE_IOERR_FSTAT">Error reading file metadata</int>
+  <int value="2058" label="SQLITE_IOERR_UNLOCK">Error unlocking file</int>
+  <int value="2314" label="SQLITE_IOERR_RDLOCK">
+    Error getting read lock - should not be possible
+  </int>
+  <int value="2570" label="SQLITE_IOERR_DELETE">Error deleting file</int>
+  <int value="2826" label="SQLITE_IOERR_BLOCKED">
+    Deadlock due to other process access to SQLite files
+  </int>
+  <int value="3082" label="SQLITE_IOERR_NOMEM">Error mapping shared memory</int>
+  <int value="3338" label="SQLITE_IOERR_ACCESS">
+    Error getting file attributes (other than not found)
+  </int>
+  <int value="3594" label="SQLITE_IOERR_CHECKRESERVEDLOCK">
+    Error while querying lock status
+  </int>
+  <int value="3850" label="SQLITE_IOERR_LOCK">Error acquiring lock</int>
+  <int value="4106" label="SQLITE_IOERR_CLOSE">Error closing file</int>
+  <int value="4362" label="SQLITE_IOERR_DIR_CLOSE">Unused</int>
+  <int value="4618" label="SQLITE_IOERR_SHMOPEN">Error mmapping file</int>
+  <int value="4874" label="SQLITE_IOERR_SHMSIZE">
+    Error in stat while mmapping file
+  </int>
+  <int value="5130" label="SQLITE_IOERR_SHMLOCK">Unused</int>
 </enum>
 
 <enum name="SqliteIOERRCode" type="int">
-  <summary>Extended error codes returned by SQLite - see sqlite.h</summary>
+  <obsolete>
+    Replaced 5/8/2013 by Sqlite.Error sparse histogram.
+  </obsolete>
+  <summary>Extended error codes returned by SQLite - see sqlite3.h</summary>
   <int value="0" label="SQLITE_IOERR">No extended code given</int>
   <int value="1" label="SQLITE_IOERR_READ">Error reading from file</int>
   <int value="2" label="SQLITE_IOERR_SHORT_READ">Short read from file</int>
   <int value="3" label="SQLITE_IOERR_WRITE">
     Error writing to file (other than SQLITE_FULL)
   </int>
   <int value="4" label="SQLITE_IOERR_FSYNC">Error syncing to disk</int>
   <int value="5" label="SQLITE_IOERR_DIR_FSYNC">
     Error syncing directory changes to disk
   </int>
@@ skipping 1417 matching lines @@
 <fieldtrial name="SSLResumption">
   <group name="Resume_Handshake" label="Session Resumption"/>
   <group name="Full_Handshake" label="Full"/>
   <affected-histogram name="Net.SSL_Connection_Latency"/>
   <affected-histogram name="Net.SSL_Connection_Latency_Google"/>
 </fieldtrial>
 
 </fieldtrials>
 
 </histogram-configuration>