| Index: pkg/analyzer_experimental/lib/src/generated/instrumentation.dart
|
| diff --git a/pkg/analyzer_experimental/lib/src/generated/instrumentation.dart b/pkg/analyzer_experimental/lib/src/generated/instrumentation.dart
|
| index 7da792ef062cdebb8d53a936250ea80b2eacbe55..c27fd8855806e6b51418f8dcfe0990be34a683a0 100644
|
| --- a/pkg/analyzer_experimental/lib/src/generated/instrumentation.dart
|
| +++ b/pkg/analyzer_experimental/lib/src/generated/instrumentation.dart
|
| @@ -7,24 +7,30 @@ import 'java_core.dart';
|
| *
|
| * Instrumentation information consists of information about specific operations. Those operations
|
| * can range from user-facing operations, such as saving the changes to a file, to internal
|
| - * operations, such as tokenizing source code. The information to be logged is gathered by[InstrumentationBuilder instrumentation builder], created by one of the static methods on
|
| + * operations, such as tokenizing source code. The information to be logged is gathered by
|
| + * [InstrumentationBuilder], created by one of the static methods on
|
| * this class such as [builder] or [builder].
|
| *
|
| - * Note, however, that until an instrumentation logger is installed using the method[setLogger], all instrumentation data will be lost.
|
| + * Note, however, that until an instrumentation logger is installed using the method
|
| + * [setLogger], all instrumentation data will be lost.
|
| *
|
| * <b>Example</b>
|
| *
|
| * To collect metrics about how long it took to save a file, you would write something like the
|
| * following:
|
| + *
|
| * <pre>
|
| * InstrumentationBuilder instrumentation = Instrumentation.builder(this.getClass());
|
| * // save the file
|
| * instrumentation.metric("chars", fileLength).log();
|
| * </pre>
|
| - * The `Instrumentation.builder` method creates a new [InstrumentationBuilderinstrumentation builder] and records the time at which it was created. The[InstrumentationBuilder#metric] appends the information specified by the
|
| + * The `Instrumentation.builder` method creates a new [InstrumentationBuilder
|
| + ] and records the time at which it was created. The
|
| + * [InstrumentationBuilder#metric] appends the information specified by the
|
| * arguments and records the time at which the method is called so that the time to complete the
|
| * save operation can be calculated. The `log` method tells the builder that all of the data
|
| * has been collected and that the resulting information should be logged.
|
| + *
|
| * @coverage dart.engine.utilities
|
| */
|
| class Instrumentation {
|
| @@ -32,13 +38,13 @@ class Instrumentation {
|
| /**
|
| * A builder that will silently ignore all data and logging requests.
|
| */
|
| - static InstrumentationBuilder _NULL_INSTRUMENTATION_BUILDER = new InstrumentationBuilder_12();
|
| + static InstrumentationBuilder _NULL_INSTRUMENTATION_BUILDER = new InstrumentationBuilder_13();
|
|
|
| /**
|
| * An instrumentation logger that can be used when no other instrumentation logger has been
|
| * configured. This logger will silently ignore all data and logging requests.
|
| */
|
| - static InstrumentationLogger _NULL_LOGGER = new InstrumentationLogger_13();
|
| + static InstrumentationLogger _NULL_LOGGER = new InstrumentationLogger_14();
|
|
|
| /**
|
| * The current instrumentation logger.
|
| @@ -47,6 +53,7 @@ class Instrumentation {
|
|
|
| /**
|
| * Create a builder that can collect the data associated with an operation.
|
| + *
|
| * @param clazz the class performing the operation (not `null`)
|
| * @return the builder that was created (not `null`)
|
| */
|
| @@ -54,6 +61,7 @@ class Instrumentation {
|
|
|
| /**
|
| * Create a builder that can collect the data associated with an operation.
|
| + *
|
| * @param name the name used to uniquely identify the operation (not `null`)
|
| * @return the builder that was created (not `null`)
|
| */
|
| @@ -66,6 +74,7 @@ class Instrumentation {
|
|
|
| /**
|
| * Return a builder that will silently ignore all data and logging requests.
|
| + *
|
| * @return the builder (not `null`)
|
| */
|
| static InstrumentationBuilder get nullBuilder => _NULL_INSTRUMENTATION_BUILDER;
|
| @@ -73,19 +82,21 @@ class Instrumentation {
|
| /**
|
| * Is this instrumentation system currently configured to drop instrumentation data provided to
|
| * it?
|
| + *
|
| * @return
|
| */
|
| static bool get isNullLogger => identical(_CURRENT_LOGGER, _NULL_LOGGER);
|
|
|
| /**
|
| * Set the logger that should receive instrumentation information to the given logger.
|
| + *
|
| * @param logger the logger that should receive instrumentation information
|
| */
|
| static void set logger(InstrumentationLogger logger2) {
|
| _CURRENT_LOGGER = logger2 == null ? _NULL_LOGGER : logger2;
|
| }
|
| }
|
| -class InstrumentationBuilder_12 implements InstrumentationBuilder {
|
| +class InstrumentationBuilder_13 implements InstrumentationBuilder {
|
| InstrumentationBuilder data(String name, bool value) => this;
|
| InstrumentationBuilder data2(String name, int value) => this;
|
| InstrumentationBuilder data3(String name, String value) => this;
|
| @@ -99,7 +110,7 @@ class InstrumentationBuilder_12 implements InstrumentationBuilder {
|
| InstrumentationBuilder metric4(String name, List<String> value) => this;
|
| InstrumentationBuilder record(Exception exception) => this;
|
| }
|
| -class InstrumentationLogger_13 implements InstrumentationLogger {
|
| +class InstrumentationLogger_14 implements InstrumentationLogger {
|
| InstrumentationBuilder createBuilder(String name) => Instrumentation._NULL_INSTRUMENTATION_BUILDER;
|
| }
|
| /**
|
| @@ -107,6 +118,7 @@ class InstrumentationLogger_13 implements InstrumentationLogger {
|
| * about an operation that has occurred and record that data through an instrumentation logger.
|
| *
|
| * For an example of using objects that implement this interface, see [Instrumentation].
|
| + *
|
| * @coverage dart.engine.utilities
|
| */
|
| abstract class InstrumentationBuilder {
|
| @@ -115,6 +127,7 @@ abstract class InstrumentationBuilder {
|
| * Append the given data to the data being collected by this builder. The information is declared
|
| * to potentially contain data that is either user identifiable or contains user intellectual
|
| * property (but is not guaranteed to contain either).
|
| + *
|
| * @param name the name used to identify the data
|
| * @param value the value of the data to be collected
|
| * @return this builder
|
| @@ -125,6 +138,7 @@ abstract class InstrumentationBuilder {
|
| * Append the given data to the data being collected by this builder. The information is declared
|
| * to potentially contain data that is either user identifiable or contains user intellectual
|
| * property (but is not guaranteed to contain either).
|
| + *
|
| * @param name the name used to identify the data
|
| * @param value the value of the data to be collected
|
| * @return this builder
|
| @@ -135,6 +149,7 @@ abstract class InstrumentationBuilder {
|
| * Append the given data to the data being collected by this builder. The information is declared
|
| * to potentially contain data that is either user identifiable or contains user intellectual
|
| * property (but is not guaranteed to contain either).
|
| + *
|
| * @param name the name used to identify the data
|
| * @param value the value of the data to be collected
|
| * @return this builder
|
| @@ -145,6 +160,7 @@ abstract class InstrumentationBuilder {
|
| * Append the given data to the data being collected by this builder. The information is declared
|
| * to potentially contain data that is either user identifiable or contains user intellectual
|
| * property (but is not guaranteed to contain either).
|
| + *
|
| * @param name the name used to identify the data
|
| * @param value the value of the data to be collected
|
| * @return this builder
|
| @@ -153,7 +169,9 @@ abstract class InstrumentationBuilder {
|
|
|
| /**
|
| * Answer the [InstrumentationLevel] of this `InstrumentationBuilder`.
|
| - * @return one of [InstrumentationLevel#EVERYTHING], [InstrumentationLevel#METRICS],[InstrumentationLevel#OFF]
|
| + *
|
| + * @return one of [InstrumentationLevel#EVERYTHING], [InstrumentationLevel#METRICS],
|
| + * [InstrumentationLevel#OFF]
|
| */
|
| InstrumentationLevel get instrumentationLevel;
|
|
|
| @@ -168,6 +186,7 @@ abstract class InstrumentationBuilder {
|
| * Append the given metric to the data being collected by this builder. The information is
|
| * declared to contain only metrics data (data that is not user identifiable and does not contain
|
| * user intellectual property).
|
| + *
|
| * @param name the name used to identify the data
|
| * @param value the value of the data to be collected
|
| * @return this builder
|
| @@ -178,6 +197,7 @@ abstract class InstrumentationBuilder {
|
| * Append the given metric to the data being collected by this builder. The information is
|
| * declared to contain only metrics data (data that is not user identifiable and does not contain
|
| * user intellectual property).
|
| + *
|
| * @param name the name used to identify the data
|
| * @param value the value of the data to be collected
|
| * @return this builder
|
| @@ -188,6 +208,7 @@ abstract class InstrumentationBuilder {
|
| * Append the given metric to the data being collected by this builder. The information is
|
| * declared to contain only metrics data (data that is not user identifiable and does not contain
|
| * user intellectual property).
|
| + *
|
| * @param name the name used to identify the data
|
| * @param value the value of the data to be collected
|
| * @return this builder
|
| @@ -198,6 +219,7 @@ abstract class InstrumentationBuilder {
|
| * Append the given metric to the data being collected by this builder. The information is
|
| * declared to contain only metrics data (data that is not user identifiable and does not contain
|
| * user intellectual property).
|
| + *
|
| * @param name the name used to identify the data
|
| * @param value the value of the data to be collected
|
| * @return this builder
|
| @@ -208,7 +230,9 @@ abstract class InstrumentationBuilder {
|
| * Append the given exception to the information being collected by this builder. The exception's
|
| * class name is captured using [metric]. Other aspects of the exception
|
| * may contain either user identifiable or contains user intellectual property (but is not
|
| - * guaranteed to contain either) and thus are captured using the various data methods such as[data].
|
| + * guaranteed to contain either) and thus are captured using the various data methods such as
|
| + * [data].
|
| + *
|
| * @param exception the exception (may be `null`)
|
| */
|
| InstrumentationBuilder record(Exception exception);
|
| @@ -217,23 +241,18 @@ abstract class InstrumentationBuilder {
|
| * The instrumentation recording level representing (1) recording [EVERYTHING] recording of
|
| * all instrumentation data, (2) recording only [METRICS] information, or (3) recording
|
| * turned [OFF] in which case nothing is recorded.
|
| + *
|
| * @coverage dart.engine.utilities
|
| */
|
| class InstrumentationLevel implements Comparable<InstrumentationLevel> {
|
|
|
| - /**
|
| - * Recording all instrumented information
|
| - */
|
| + /** Recording all instrumented information */
|
| static final InstrumentationLevel EVERYTHING = new InstrumentationLevel('EVERYTHING', 0);
|
|
|
| - /**
|
| - * Recording only metrics
|
| - */
|
| + /** Recording only metrics */
|
| static final InstrumentationLevel METRICS = new InstrumentationLevel('METRICS', 1);
|
|
|
| - /**
|
| - * Nothing recorded
|
| - */
|
| + /** Nothing recorded */
|
| static final InstrumentationLevel OFF = new InstrumentationLevel('OFF', 2);
|
| static final List<InstrumentationLevel> values = [EVERYTHING, METRICS, OFF];
|
|
|
| @@ -265,6 +284,7 @@ class InstrumentationLevel implements Comparable<InstrumentationLevel> {
|
| * instrumentation data.
|
| *
|
| * For an example of using objects that implement this interface, see [Instrumentation].
|
| + *
|
| * @coverage dart.engine.utilities
|
| */
|
| abstract class InstrumentationLogger {
|
| @@ -272,6 +292,7 @@ abstract class InstrumentationLogger {
|
| /**
|
| * Create a builder that can collect the data associated with an operation identified by the given
|
| * name.
|
| + *
|
| * @param name the name used to uniquely identify the operation
|
| * @return the builder that was created
|
| */
|
|
|