Publish

1 files changed, 35 insertions, 0 deletions

diff --git a/simplemetrics/src/main/java/com/yahoo/metrics/simple/package-info.java b/simplemetrics/src/main/java/com/yahoo/metrics/simple/package-info.java
new file mode 100644
index 00000000000..6529b804a43
--- /dev/null
+++ b/simplemetrics/src/main/java/com/yahoo/metrics/simple/package-info.java
@@ -0,0 +1,35 @@
+// Copyright 2016 Yahoo Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
+/**
+ * A metrics API with declarable metric, and also an implementation of the
+ * JDisc Metrics API where the newest state is made continously available.
+ *
+ * <p>
+ * Users should have an instance of {@link com.yahoo.metrics.simple.MetricReceiver}
+ * injected in the constructor where needed, then declare metrics as instances
+ * of {@link com.yahoo.metrics.simple.Counter} and
+ * {@link com.yahoo.metrics.simple.Gauge} using
+ * {@link com.yahoo.metrics.simple.MetricReceiver#declareCounter(String)},
+ * {@link com.yahoo.metrics.simple.MetricReceiver#declareCounter(String, Point)},
+ * {@link com.yahoo.metrics.simple.MetricReceiver#declareGauge(String)},
+ * {@link com.yahoo.metrics.simple.MetricReceiver#declareGauge(String, Point)}, or
+ * {@link com.yahoo.metrics.simple.MetricReceiver#declareGauge(String, java.util.Optional, MetricSettings)}.
+ * </p>
+ *
+ * <p>
+ * Clients input data through the API in {@link com.yahoo.metrics.simple.MetricReceiver} (or
+ * using the JDisc Metric API it will be received in
+ * {@link com.yahoo.metrics.simple.jdisc.SimpleMetricConsumer}), while the internal work is
+ * done by {@link com.yahoo.metrics.simple.MetricAggregator}. Initialization
+ * is done top-down from {@link com.yahoo.metrics.simple.MetricManager}. The link
+ * between calls to MetricReceiver and MetricAggregator is the role of
+ * {@link com.yahoo.metrics.simple.MetricUpdater}.
+ * </p>
+ *
+ * @author <a href="mailto:steinar@yahoo-inc.com">Steinar Knutsen</a>
+ */
+@PublicApi
+@ExportPackage
+package com.yahoo.metrics.simple;
+
+import com.yahoo.api.annotations.PublicApi;
+import com.yahoo.osgi.annotation.ExportPackage;