Skip to content

Commit

Permalink
docs + copyright
Browse files Browse the repository at this point in the history
  • Loading branch information
@Channyboy
Channyboy committed Jul 20, 2022
1 parent 3079cac commit 026b999
Show file tree
Hide file tree
Showing 19 changed files with 45 additions and 21 deletions.
4 changes: 2 additions & 2 deletions api/src/main/java/org/eclipse/microprofile/metrics/MetricType.java
View file
@@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2017, 2019 Contributors to the Eclipse Foundation
* Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation
* 2017 Red Hat, Inc. and/or its affiliates
* and other contributors as indicated by the @author tags.
*
Expand Down Expand Up @@ -48,7 +48,7 @@ public enum MetricType {
HISTOGRAM("histogram", Histogram.class),

/**
* A timer aggregates timing durations and provides duration statistics, plus throughput statistics
* A timer aggregates timing durations and provides duration statistics
*/
TIMER("timer", Timer.class),

Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/org/eclipse/microprofile/metrics/Timer.java
View file
@@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2017, 2020 Contributors to the Eclipse Foundation
* Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation
* 2010, 2013 Coda Hale, Yammer.com
*
* See the NOTICES file(s) distributed with this work for additional
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/org/eclipse/microprofile/metrics/annotation/Counted.java
View file
@@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2017 Contributors to the Eclipse Foundation
* Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation
* 2012 Ryan W Tenney (ryan@10e.us)
*
* See the NOTICES file(s) distributed with this work for additional
Expand Down
4 changes: 2 additions & 2 deletions api/src/main/java/org/eclipse/microprofile/metrics/annotation/Timed.java
View file
@@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2017, 2020 Contributors to the Eclipse Foundation
* Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation
* 2010-2013 Coda Hale, Yammer.com
*
* See the NOTICES file(s) distributed with this work for additional
Expand Down Expand Up @@ -37,7 +37,7 @@
/**
* An annotation for marking a method, constructor, or class as timed. The underlying
* {@link org.eclipse.microprofile.metrics.Timer Timer} metric aggregates timing durations and provides duration
* statistics, plus throughput statistics. There is a lightweight alternative
* statistics.
* <p>
* Given a method annotated with {@literal @}Timed like this:
* </p>
Expand Down
5 changes: 2 additions & 3 deletions api/src/main/java/org/eclipse/microprofile/metrics/annotation/package-info.java
View file
@@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2017, 2019 Contributors to the Eclipse Foundation
* Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation
*
* See the NOTICES file(s) distributed with this work for additional
* information regarding copyright ownership.
Expand Down Expand Up @@ -44,8 +44,7 @@
* <h2>Interceptor Bindings</h2>
* <p>
* MicroProfile Metrics provides interceptor bindings which can be used to instrument an application:
* {@literal @}Counted, {@literal @}Gauge, {@literal @}Metered, {@literal @}Timed, {@literal @}SimplyTimed and
* {@literal @}ConcurrentGauge.
* {@literal @}Counted, {@literal @}Gauge and {@literal @}Timed
* <p>
* An example using {@literal @}Counted,
*
Expand Down
6 changes: 3 additions & 3 deletions api/src/main/java/org/eclipse/microprofile/metrics/package-info.java
View file
@@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2017, 2018 Contributors to the Eclipse Foundation
* Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation
*
* See the NOTICES file(s) distributed with this work for additional
* information regarding copyright ownership.
Expand All @@ -23,7 +23,7 @@
/**
* MicroProfile Metrics
*
* <h2>Rational</h2>
* <h2>Rationale</h2>
*
* <p>
* To ensure reliable operation of software it is necessary to monitor essential system parameters. There is already JMX
Expand All @@ -34,7 +34,7 @@
*
* <h2>Adding Metrics</h2>
* <p>
* MicroProfile Metrics provides 6 different metric types that can be used to instrument an application. Developers can
* MicroProfile Metrics provides 4 different metric types that can be used to instrument an application. Developers can
* create an accompanying {@link org.eclipse.microprofile.metrics.Metadata Metadata} object to supply the metric's name,
* description, display name, and units. Once the metric and the metadata are registered against the application
* {@link org.eclipse.microprofile.metrics.MetricRegistry MetricRegistry}, the metrics will be available in the REST
Expand Down
2 changes: 1 addition & 1 deletion tck/api/src/main/java/org/eclipse/microprofile/metrics/tck/MetricRegistryTest.java
View file
@@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2017, 2019 Contributors to the Eclipse Foundation
* Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation
*
* See the NOTICES file(s) distributed with this work for additional
* information regarding copyright ownership.
Expand Down
5 changes: 5 additions & 0 deletions ...c/main/java/org/eclipse/microprofile/metrics/tck/metrics/DefaultNameMetricMethodBean.java
View file
@@ -1,5 +1,10 @@
/**
**********************************************************************
* Copyright (c) 2013, 2022 Contributors to the Eclipse Foundation
* Copyright © 2013 Antonin Stefanutti (antonin.stefanutti@gmail.com)
*
* See the NOTICES file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
5 changes: 5 additions & 0 deletions ...ain/java/org/eclipse/microprofile/metrics/tck/metrics/MultipleMetricsConstructorBean.java
View file
@@ -1,5 +1,10 @@
/**
**********************************************************************
* Copyright (c) 2013, 2022 Contributors to the Eclipse Foundation
* Copyright © 2013 Antonin Stefanutti (antonin.stefanutti@gmail.com)
*
* See the NOTICES file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
5 changes: 5 additions & 0 deletions ...java/org/eclipse/microprofile/metrics/tck/metrics/MultipleMetricsConstructorBeanTest.java
View file
@@ -1,5 +1,10 @@
/**
**********************************************************************
* Copyright (c) 2013, 2022 Contributors to the Eclipse Foundation
* Copyright © 2013 Antonin Stefanutti (antonin.stefanutti@gmail.com)
*
* See the NOTICES file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
7 changes: 6 additions & 1 deletion ...src/main/java/org/eclipse/microprofile/metrics/tck/metrics/MultipleMetricsMethodBean.java
View file
@@ -1,6 +1,11 @@
/**
**********************************************************************
* Copyright (c) 2013, 2022 Contributors to the Eclipse Foundation
* Copyright © 2013 Antonin Stefanutti (antonin.stefanutti@gmail.com)
*
*
* See the NOTICES file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
Expand Down
5 changes: 5 additions & 0 deletions ...main/java/org/eclipse/microprofile/metrics/tck/metrics/MultipleMetricsMethodBeanTest.java
View file
@@ -1,5 +1,10 @@
/**
**********************************************************************
* Copyright (c) 2013, 2022 Contributors to the Eclipse Foundation
* Copyright © 2013 Antonin Stefanutti (antonin.stefanutti@gmail.com)
*
* See the NOTICES file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion tck/api/src/main/java/org/eclipse/microprofile/metrics/tck/metrics/TimerTest.java
View file
@@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2017, 2020 Contributors to the Eclipse Foundation
* Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation
* 2010-2013 Coda Hale, Yammer.com
*
* See the NOTICES file(s) distributed with this work for additional
Expand Down
2 changes: 1 addition & 1 deletion tck/api/src/main/java/org/eclipse/microprofile/metrics/tck/tags/TagsTest.java
View file
@@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2017, 2018 Contributors to the Eclipse Foundation
* Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation
*
* See the NOTICES file(s) distributed with this work for additional
* information regarding copyright ownership.
Expand Down
2 changes: 1 addition & 1 deletion tck/rest/src/main/java/org/eclipse/microprofile/metrics/test/MetricAppBean.java
View file
@@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2017, 2019 Contributors to the Eclipse Foundation
* Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation
*
* See the NOTICES file(s) distributed with this work for additional
* information regarding copyright ownership.
Expand Down
2 changes: 1 addition & 1 deletion tck/rest/src/main/java/org/eclipse/microprofile/metrics/test/MpMetricTest.java
View file
@@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2017, 2019 Contributors to the Eclipse Foundation
* Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation
*
* See the NOTICES file(s) distributed with this work for additional
* information regarding copyright ownership.
Expand Down
2 changes: 1 addition & 1 deletion tck/rest/src/main/java/org/eclipse/microprofile/metrics/test/ReusedMetricsTest.java
View file
@@ -1,6 +1,6 @@
/*
* ********************************************************************
* Copyright (c) 2017, 2019 Contributors to the Eclipse Foundation
* Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation
*
* See the NOTICES file(s) distributed with this work for additional
* information regarding copyright ownership.
Expand Down
2 changes: 1 addition & 1 deletion ...ain/java/org/eclipse/microprofile/metrics/test/multipleinstances/DependentScopedBean.java
View file
@@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2019 Contributors to the Eclipse Foundation
* Copyright (c) 2019, 2022 Contributors to the Eclipse Foundation
*
* See the NOTICES file(s) distributed with this work for additional
* information regarding copyright ownership.
Expand Down
2 changes: 1 addition & 1 deletion ...va/org/eclipse/microprofile/metrics/test/multipleinstances/MultipleBeanInstancesTest.java
View file
@@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (c) 2019 Contributors to the Eclipse Foundation
* Copyright (c) 2019, 2022 Contributors to the Eclipse Foundation
*
* See the NOTICES file(s) distributed with this work for additional
* information regarding copyright ownership.
Expand Down

0 comments on commit 026b999

Please sign in to comment.