Skip to content

Commit e97b25e

Browse files
update javadoc
1 parent 589e23a commit e97b25e

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

Diff for: instrumentation-annotations-incubator/src/main/java/io/opentelemetry/instrumentation/annotations/incubator/Counted.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
/**
3838
* Name of the Counter metric.
3939
*
40-
* <p>The name should follow the metric naming rule: <a
40+
* <p>The name should follow the metric naming rules: <a
4141
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/api.md#instrument-name-syntax">https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/api.md#instrument-name-syntax</a>
4242
*/
4343
String value();

Diff for: instrumentation-annotations-incubator/src/main/java/io/opentelemetry/instrumentation/annotations/incubator/StaticAttribute.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212
import java.lang.annotation.Target;
1313

1414
/**
15-
* This annotation allows for adding attributes to the metrics recorded using {@link Timed} and
16-
* {@link Counted} annotations.
15+
* This annotation allows for adding static attributes to the metrics recorded using {@link Timed}
16+
* and {@link Counted} annotations.
1717
*
1818
* <p>Application developers can use this annotation to signal OpenTelemetry auto-instrumentation
19-
* that the attribute should be created.
19+
* that the static attributes should be captured.
2020
*
2121
* <p>If you are a library developer, then probably you should NOT use this annotation, because it
2222
* is non-functional without the OpenTelemetry auto-instrumentation agent, or some other annotation
@@ -27,9 +27,9 @@
2727
@Repeatable(StaticAttributes.class)
2828
public @interface StaticAttribute {
2929

30-
/** Name of the attribute. */
30+
/** Name of the static attribute. */
3131
String name();
3232

33-
/** Value of the attribute. */
33+
/** Value of the static attribute. */
3434
String value();
3535
}

Diff for: instrumentation-annotations-incubator/src/main/java/io/opentelemetry/instrumentation/annotations/incubator/StaticAttributes.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111
import java.lang.annotation.Target;
1212

1313
/**
14-
* This annotation allows for adding attributes to the metrics recorded using {@link Timed} and
15-
* {@link Counted} annotations.
14+
* This annotation allows for adding static attributes to the metrics recorded using {@link Timed}
15+
* and {@link Counted} annotations.
1616
*
1717
* <p>Application developers can use this annotation to signal OpenTelemetry auto-instrumentation
18-
* that the attribute should be created.
18+
* that the static attributes should be captured.
1919
*
2020
* <p>If you are a library developer, then probably you should NOT use this annotation, because it
2121
* is non-functional without the OpenTelemetry auto-instrumentation agent, or some other annotation
@@ -25,6 +25,6 @@
2525
@Retention(RetentionPolicy.RUNTIME)
2626
public @interface StaticAttributes {
2727

28-
/** Array of {@link StaticAttribute} annotations describing the added attributes. */
28+
/** Array of {@link StaticAttribute} annotations describing the attributes to capture. */
2929
StaticAttribute[] value();
3030
}

Diff for: instrumentation-annotations-incubator/src/main/java/io/opentelemetry/instrumentation/annotations/incubator/Timed.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
/**
3939
* Name of the Histogram metric.
4040
*
41-
* <p>The name should follow the metric naming rule: <a
41+
* <p>The name should follow the metric naming rules: <a
4242
* href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/api.md#instrument-naming-rule">https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/api.md#instrument-naming-rule</a>
4343
*/
4444
String value();

0 commit comments

Comments
 (0)